1 | <?php |
||
2 | /** |
||
3 | * Payment response |
||
4 | * |
||
5 | * @author Pronamic <[email protected]> |
||
6 | * @copyright 2005-2019 Pronamic |
||
7 | * @license GPL-3.0-or-later |
||
8 | * @package Pronamic\WordPress\Pay\Gateways\Adyen |
||
9 | */ |
||
10 | |||
11 | namespace Pronamic\WordPress\Pay\Gateways\Adyen; |
||
12 | |||
13 | /** |
||
14 | * Payment response |
||
15 | * |
||
16 | * @link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v41/payments |
||
17 | * |
||
18 | * @author Remco Tolsma |
||
19 | * @version 1.0.0 |
||
20 | * @since 1.0.0 |
||
21 | */ |
||
22 | class PaymentResponse { |
||
23 | /** |
||
24 | * This field contains additional data, which may be required to return in a particular payment response. |
||
25 | * |
||
26 | * @var object|null |
||
27 | */ |
||
28 | private $additional_data; |
||
29 | |||
30 | /** |
||
31 | * When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. |
||
32 | * |
||
33 | * @var array|null |
||
34 | */ |
||
35 | private $details; |
||
36 | |||
37 | /** |
||
38 | * The fraud result properties of the payment |
||
39 | * |
||
40 | * @var object|null |
||
41 | */ |
||
42 | private $fraud_result; |
||
43 | |||
44 | /** |
||
45 | * Contains the details that will be presented to the shopper |
||
46 | * |
||
47 | * @var object|null |
||
48 | */ |
||
49 | private $output_details; |
||
50 | |||
51 | /** |
||
52 | * When non-empty, contains a value that you must submit to the `/payments/details` endpoint. |
||
53 | * |
||
54 | * @var string|null |
||
55 | */ |
||
56 | private $payment_data; |
||
57 | |||
58 | /** |
||
59 | * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. |
||
60 | * |
||
61 | * `pspReference` is returned only for non-redirect payment methods. |
||
62 | * |
||
63 | * @var string|null |
||
64 | */ |
||
65 | private $psp_reference; |
||
66 | |||
67 | /** |
||
68 | * When the payment flow requires a redirect, this object contains information about the redirect URL. |
||
69 | * |
||
70 | * @var RedirectInformation|null |
||
71 | */ |
||
72 | private $redirect; |
||
73 | |||
74 | /** |
||
75 | * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. |
||
76 | * |
||
77 | * When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. |
||
78 | * |
||
79 | * @var string|null |
||
80 | */ |
||
81 | private $refusal_reason; |
||
82 | |||
83 | /** |
||
84 | * Code that specifies the refusal reason. |
||
85 | * |
||
86 | * @var string|null |
||
87 | */ |
||
88 | private $refusal_reason_code; |
||
89 | |||
90 | /** |
||
91 | * The result of the payment. |
||
92 | * |
||
93 | * @var string |
||
94 | */ |
||
95 | private $result_code; |
||
96 | |||
97 | /** |
||
98 | * Construct payment response object. |
||
99 | * |
||
100 | * @param string $result_code Result code. |
||
101 | */ |
||
102 | public function __construct( $result_code ) { |
||
103 | $this->result_code = $result_code; |
||
104 | } |
||
105 | |||
106 | /** |
||
107 | * Get PSP reference. |
||
108 | * |
||
109 | * @return string|null |
||
110 | */ |
||
111 | public function get_psp_reference() { |
||
112 | return $this->psp_reference; |
||
113 | } |
||
114 | |||
115 | /** |
||
116 | * Set PSP reference. |
||
117 | * |
||
118 | * @param string|null $psp_reference PSP reference. |
||
119 | */ |
||
120 | public function set_psp_reference( $psp_reference ) { |
||
121 | $this->psp_reference = $psp_reference; |
||
122 | } |
||
123 | |||
124 | /** |
||
125 | * Get redirect. |
||
126 | * |
||
127 | * @return RedirectInformation|null |
||
128 | */ |
||
129 | public function get_redirect() { |
||
130 | return $this->redirect; |
||
131 | } |
||
132 | |||
133 | /** |
||
134 | * Set redirect. |
||
135 | * |
||
136 | * @param RedirectInformation|null $redirect Redirect information. |
||
137 | */ |
||
138 | public function set_redirect( RedirectInformation $redirect = null ) { |
||
139 | $this->redirect = $redirect; |
||
140 | } |
||
141 | |||
142 | /** |
||
143 | * Create payment repsonse from object. |
||
144 | * |
||
145 | * @param object $object Object. |
||
146 | * @return PaymentResponse |
||
147 | * @throws InvalidArgumentException Throws invalid argument exception when object does not contains the required properties. |
||
148 | */ |
||
149 | public static function from_object( $object ) { |
||
150 | if ( ! isset( $object->resultCode ) ) { |
||
151 | throw new InvalidArgumentException( 'Object must contain `resultCode` property.' ); |
||
0 ignored issues
–
show
Bug
introduced
by
![]() |
|||
152 | } |
||
153 | |||
154 | $payment_response = new self( $object->resultCode ); |
||
155 | |||
156 | if ( isset( $object->pspReference ) ) { |
||
157 | $payment_response->set_psp_reference( $object->pspReference ); |
||
158 | } |
||
159 | |||
160 | if ( isset( $object->redirect ) ) { |
||
161 | $payment_response->set_redirect( RedirectInformation::from_object( $object->redirect ) ); |
||
162 | } |
||
163 | |||
164 | return $payment_response; |
||
165 | } |
||
166 | } |
||
167 |