Note: For error handling and troubleshooting, see Orders v2 errors.+ +```php +function ordersCreate(array $options): ApiResponse +``` + +## Parameters + +| Parameter | Type | Tags | Description | +| --- | --- | --- | --- | +| `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - | +| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.+ +```php +function ordersGet(array $options): ApiResponse +``` + +## Parameters + +| Parameter | Type | Tags | Description | +| --- | --- | --- | --- | +| `id` | `string` | Template, Required | The ID of the order for which to show details.
\"/purchase_units/@reference_id=='default'/{attribute-or-object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.email_address | replace, add | |
purchase_units[].shipping.phone_number | replace, add | |
purchase_units[].shipping.options | replace, add | |
purchase_units[].shipping.address | replace, add | |
purchase_units[].shipping.type | replace, add | |
purchase_units[].soft_descriptor | replace, remove | |
purchase_units[].amount | replace | |
purchase_units[].items | replace, add, remove | |
purchase_units[].invoice_id | replace, add, remove | |
purchase_units[].payment_instruction | replace | |
purchase_units[].payment_instruction.disbursement_mode | replace | By default, disbursement_mode is INSTANT. |
purchase_units[].payment_instruction.payee_receivable_fx_rate_id | replace, add, remove | |
purchase_units[].payment_instruction.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.@@ -35,7 +218,7 @@ function ordersAuthorize(array $options): ApiResponse | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `string` | Template, Required | The ID of the order for which to authorize.
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.+ +```php +function ordersCapture(array $options): ApiResponse +``` + +## Parameters + +| Parameter | Type | Tags | Description | +| --- | --- | --- | --- | +| `id` | `string` | Template, Required | The ID of the order for which to capture a payment.
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.- -```php -function ordersCreate(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - | -| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.\"/purchase_units/@reference_id=='default'/{attribute-or-object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.email_address | replace, add | |
purchase_units[].shipping.phone_number | replace, add | |
purchase_units[].shipping.options | replace, add | |
purchase_units[].shipping.address | replace, add | |
purchase_units[].shipping.type | replace, add | |
purchase_units[].soft_descriptor | replace, remove | |
purchase_units[].amount | replace | |
purchase_units[].items | replace, add, remove | |
purchase_units[].invoice_id | replace, add, remove | |
purchase_units[].payment_instruction | replace | |
purchase_units[].payment_instruction.disbursement_mode | replace | By default, disbursement_mode is INSTANT. |
purchase_units[].payment_instruction.payee_receivable_fx_rate_id | replace, add, remove | |
purchase_units[].payment_instruction.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
Note: For error handling and troubleshooting, see Orders v2 errors.- -```php -function ordersCapture(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order for which to capture a payment.
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.- -```php -function ordersGet(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `id` | `string` | Template, Required | The ID of the order for which to show details.
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.| Attribute | Op | Notes |
|---|---|---|
items | replace | Using replace op for items will replace the entire items object with the value sent in request. |
notify_payer | replace, add | |
status | replace | Only patching status to CANCELLED is currently supported. |
Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| ## Response Type @@ -42,9 +43,11 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR ## Example Usage ```php -$authorizationId = 'authorization_id8'; +$collect = [ + 'authorizationId' => 'authorization_id8' +]; -$apiResponse = $paymentsController->authorizationsGet($authorizationId); +$apiResponse = $paymentsController->authorizationsGet($collect); ``` ## Errors @@ -52,7 +55,6 @@ $apiResponse = $paymentsController->authorizationsGet($authorizationId); | HTTP Status Code | Error Description | Exception Class | | --- | --- | --- | | 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | -| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | | 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | | 500 | The request failed because an internal server error occurred. | `ApiException` | | Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | @@ -73,6 +75,7 @@ function authorizationsCapture(array $options): ApiResponse | `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to capture. | | `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. | | `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| | `body` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - | ## Response Type @@ -107,51 +110,6 @@ $apiResponse = $paymentsController->authorizationsCapture($collect); | Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | -# Authorizations Void - -Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured. - -```php -function authorizationsVoid(array $options): ApiResponse -``` - -## Parameters - -| Parameter | Type | Tags | Description | -| --- | --- | --- | --- | -| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. | -| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).
Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| -| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: This request is currently not supported for Partner use cases.@@ -167,6 +125,7 @@ function authorizationsReauthorize(array $options): ApiResponse | `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. | | `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. | | `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| | `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - | ## Response Type @@ -190,8 +149,52 @@ $apiResponse = $paymentsController->authorizationsReauthorize($collect); | --- | --- | --- | | 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | | 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) | +| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) | +| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | +| 500 | The request failed because an internal server error occurred. | `ApiException` | +| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | + + +# Authorizations Void + +Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured. + +```php +function authorizationsVoid(array $options): ApiResponse +``` + +## Parameters + +| Parameter | Type | Tags | Description | +| --- | --- | --- | --- | +| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. | +| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).
Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| +| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. | +| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.| ## Response Type @@ -302,9 +306,11 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR ## Example Usage ```php -$refundId = 'refund_id4'; +$collect = [ + 'refundId' => 'refund_id4' +]; -$apiResponse = $paymentsController->refundsGet($refundId); +$apiResponse = $paymentsController->refundsGet($collect); ``` ## Errors diff --git a/doc/controllers/vault.md b/doc/controllers/vault.md index dd1caed..feb2743 100644 --- a/doc/controllers/vault.md +++ b/doc/controllers/vault.md @@ -12,14 +12,57 @@ $vaultController = $client->getVaultController(); ## Methods +* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create) * [Customer Payment-Tokens Get](../../doc/controllers/vault.md#customer-payment-tokens-get) * [Payment-Tokens Get](../../doc/controllers/vault.md#payment-tokens-get) -* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create) -* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create) * [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete) +* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create) * [Setup-Tokens Get](../../doc/controllers/vault.md#setup-tokens-get) +# Payment-Tokens Create + +Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer. + +```php +function paymentTokensCreate(array $options): ApiResponse +``` + +## Parameters + +| Parameter | Type | Tags | Description | +| --- | --- | --- | --- | +| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. | +| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. | + +## Response Type + +This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md). + +## Example Usage + +```php +$collect = [ + 'paypalRequestId' => 'PayPal-Request-Id6', + 'body' => PaymentTokenRequestBuilder::init( + PaymentTokenRequestPaymentSourceBuilder::init()->build() + )->build() +]; + +$apiResponse = $vaultController->paymentTokensCreate($collect); +``` + +## Errors + +| HTTP Status Code | Error Description | Exception Class | +| --- | --- | --- | +| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | +| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) | +| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) | +| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) | +| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | + + # Customer Payment-Tokens Get Returns all payment tokens for a customer. @@ -99,36 +142,30 @@ $apiResponse = $vaultController->paymentTokensGet($id); | 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) | -# Payment-Tokens Create +# Payment-Tokens Delete -Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer. +Delete the payment token associated with the payment token id. ```php -function paymentTokensCreate(array $options): ApiResponse +function paymentTokensDelete(string $id): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. | -| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. | +| `id` | `string` | Template, Required | ID of the payment token.
Note: The regular expression provides guidance but does not reject all invalid dates.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Note: For error handling and troubleshooting, see Orders v2 errors. + *+ * + * @param array $options Array with all options for search + * + * @return ApiResponse Response from the API call + */ + public function ordersCreate(array $options): ApiResponse + { + $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders') + ->auth('Oauth2') + ->parameters( + HeaderParam::init('Content-Type', 'application/json'), + BodyParam::init($options)->extract('body'), + HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), + HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'), + HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), + HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion') + ); + + $_resHandler = $this->responseHandler() + ->throwErrorOn( + '400', + ErrorType::init( + 'Request is not well-formed, syntactically incorrect, or violates schema.', + ErrorException::class + ) + ) + ->throwErrorOn( + '401', + ErrorType::init( + 'Authentication failed due to missing authorization header, or invalid auth' . + 'entication credentials.', + ErrorException::class + ) + ) + ->throwErrorOn( + '422', + ErrorType::init( + 'The requested action could not be performed, semantically incorrect, or fa' . + 'iled business validation.', + ErrorException::class + ) + ) + ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) + ->type(Order::class) + ->returnApiResponse(); + + return $this->execute($_reqBuilder, $_resHandler); + } + + /** + * Shows details for an order, by ID.
Note: For error handling and + * troubleshooting, see Orders v2 errors.+ * + * @param array $options Array with all options for search + * + * @return ApiResponse Response from the API call + */ + public function ordersGet(array $options): ApiResponse + { + $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}') + ->auth('Oauth2') + ->parameters( + TemplateParam::init('id', $options)->extract('id'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), + QueryParam::init('fields', $options)->extract('fields') + ); + + $_resHandler = $this->responseHandler() + ->throwErrorOn( + '401', + ErrorType::init( + 'Authentication failed due to missing authorization header, or invalid auth' . + 'entication credentials.', + ErrorException::class + ) + ) + ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) + ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) + ->type(Order::class) + ->returnApiResponse(); + + return $this->execute($_reqBuilder, $_resHandler); + } + + /** + * Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the + * `COMPLETED` status.
\"/purchase_units/@reference_id=='default'/{attribute-or-
+ * object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and
+ * payment processing costs. For more information about processing payments, see checkout or multiparty checkout.
+ * Note: For error handling and troubleshooting, see Orders v2 errors. + *Patchable attributes or objects: + *
| Attribute | Op | Notes |
|---|---|---|
inte
+ * nt | replace | |
payer | replace, + * add | Using replace op for payer will replace the whole payer object
+ * with the value sent in request. |
purchase_units | replace, + * add | |
purchase_units[].custom_id | replace, add, + * remove | |
purchase_units[].description | replace, add, + * remove | |
purchase_units[].payee.
+ * email | replace | |
purchase_units[].shipping.
+ * name | replace, add | |
purchase_units[].shipping.
+ * email_address | replace, add | |
purchase_units[].shipping.
+ * phone_number | replace, add | |
purchase_units[].shipping.
+ * options | replace, add | |
purchase_units[].shipping.
+ * address | replace, add | |
purchase_units[].shipping.
+ * type | replace, add | |
purchase_units[].
+ * soft_descriptor | replace, remove | |
purchase_units[].
+ * amount | replace | |
purchase_units[].
+ * items | replace, add, remove | |
purchase_units[].
+ * invoice_id | replace, add, remove | |
purchase_units[].
+ * payment_instruction | replace | |
purchase_units[].
+ * payment_instruction.disbursement_mode | replace | By default,
+ * disbursement_mode is INSTANT. |
purchase_units[].
+ * payment_instruction.payee_receivable_fx_rate_id | replace, add, + * remove | |
purchase_units[].payment_instruction.
+ * platform_fees | replace, add, remove | |
purchase_units[].
+ * supplementary_data.airline | replace, add, + * remove | |
purchase_units[].supplementary_data.
+ * card | replace, add, remove | |
application_context.
+ * client_configuration | replace, add |
Note: For error handling and troubleshooting, see Orders v2 errors. - *- * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersCreate(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders') - ->auth('Oauth2') - ->parameters( - HeaderParam::init('Content-Type', 'application/json'), - BodyParam::init($options)->extract('body'), - HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), - HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'), - HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Order::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the - * `COMPLETED` status.
\"/purchase_units/@reference_id=='default'/{attribute-or-
- * object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and
- * payment processing costs. For more information about processing payments, see checkout or multiparty checkout.
- * Note: For error handling and troubleshooting, see Orders v2 errors. - *Patchable attributes or objects: - *
| Attribute | Op | Notes |
|---|---|---|
inte
- * nt | replace | |
payer | replace, - * add | Using replace op for payer will replace the whole payer object
- * with the value sent in request. |
purchase_units | replace, - * add | |
purchase_units[].custom_id | replace, add, - * remove | |
purchase_units[].description | replace, add, - * remove | |
purchase_units[].payee.
- * email | replace | |
purchase_units[].shipping.
- * name | replace, add | |
purchase_units[].shipping.
- * email_address | replace, add | |
purchase_units[].shipping.
- * phone_number | replace, add | |
purchase_units[].shipping.
- * options | replace, add | |
purchase_units[].shipping.
- * address | replace, add | |
purchase_units[].shipping.
- * type | replace, add | |
purchase_units[].
- * soft_descriptor | replace, remove | |
purchase_units[].
- * amount | replace | |
purchase_units[].
- * items | replace, add, remove | |
purchase_units[].
- * invoice_id | replace, add, remove | |
purchase_units[].
- * payment_instruction | replace | |
purchase_units[].
- * payment_instruction.disbursement_mode | replace | By default,
- * disbursement_mode is INSTANT. |
purchase_units[].
- * payment_instruction.payee_receivable_fx_rate_id | replace, add, - * remove | |
purchase_units[].payment_instruction.
- * platform_fees | replace, add, remove | |
purchase_units[].
- * supplementary_data.airline | replace, add, - * remove | |
purchase_units[].supplementary_data.
- * card | replace, add, remove | |
application_context.
- * client_configuration | replace, add |
Note: For error handling and - * troubleshooting, see Orders v2 errors.+ * Adds tracking information for an Order. * * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function ordersGet(array $options): ApiResponse + public function ordersTrackCreate(array $options): ApiResponse { - $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}') - ->auth('Oauth2') - ->parameters( - TemplateParam::init('id', $options)->extract('id'), - QueryParam::init('fields', $options)->extract('fields') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(Order::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - - /** - * Payer confirms their intent to pay for the the Order with the given payment source. - * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function ordersConfirm(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder( - RequestMethod::POST, - '/v2/checkout/orders/{id}/confirm-payment-source' - ) + $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track') ->auth('Oauth2') ->parameters( TemplateParam::init('id', $options)->extract('id'), HeaderParam::init('Content-Type', 'application/json'), - HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - BodyParam::init($options)->extract('body') + BodyParam::init($options)->extract('body'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion') ); $_resHandler = $this->responseHandler() @@ -414,6 +417,7 @@ class OrdersController extends BaseController '403', ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) ) + ->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class)) ->throwErrorOn( '422', ErrorType::init( @@ -455,6 +459,7 @@ class OrdersController extends BaseController TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('tracker_id', $options)->extract('trackerId'), HeaderParam::init('Content-Type', 'application/json'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), BodyParam::init($options)->extract('body') ); diff --git a/src/Controllers/PaymentsController.php b/src/Controllers/PaymentsController.php index 59b4b34..17a46ff 100644 --- a/src/Controllers/PaymentsController.php +++ b/src/Controllers/PaymentsController.php @@ -26,15 +26,18 @@ class PaymentsController extends BaseController /** * Shows details for an authorized payment, by ID. * - * @param string $authorizationId The ID of the authorized payment for which to show details. + * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function authorizationsGet(string $authorizationId): ApiResponse + public function authorizationsGet(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/authorizations/{authorization_id}') ->auth('Oauth2') - ->parameters(TemplateParam::init('authorization_id', $authorizationId)); + ->parameters( + TemplateParam::init('authorization_id', $options)->extract('authorizationId'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion') + ); $_resHandler = $this->responseHandler() ->throwErrorOn( @@ -45,13 +48,6 @@ class PaymentsController extends BaseController ErrorException::class ) ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) ->throwErrorOn( '404', ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) @@ -83,6 +79,7 @@ class PaymentsController extends BaseController HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), BodyParam::init($options)->extract('body') ); @@ -136,6 +133,76 @@ class PaymentsController extends BaseController return $this->execute($_reqBuilder, $_resHandler); } + /** + * Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, + * reauthorize a payment after its initial three-day honor period expires. Within the 29-day + * authorization period, you can issue multiple re-authorizations after the honor period expires. + *
Note: This request is currently not supported for Partner use cases. + *+ * + * @param array $options Array with all options for search + * + * @return ApiResponse Response from the API call + */ + public function authorizationsReauthorize(array $options): ApiResponse + { + $_reqBuilder = $this->requestBuilder( + RequestMethod::POST, + '/v2/payments/authorizations/{authorization_id}/reauthorize' + ) + ->auth('Oauth2') + ->parameters( + TemplateParam::init('authorization_id', $options)->extract('authorizationId'), + HeaderParam::init('Content-Type', 'application/json'), + HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), + HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), + BodyParam::init($options)->extract('body') + ); + + $_resHandler = $this->responseHandler() + ->throwErrorOn( + '400', + ErrorType::init( + 'The request failed because it is not well-formed or is syntactically incor' . + 'rect or violates schema.', + ErrorException::class + ) + ) + ->throwErrorOn( + '401', + ErrorType::init( + 'Authentication failed due to missing authorization header, or invalid auth' . + 'entication credentials.', + ErrorException::class + ) + ) + ->throwErrorOn( + '404', + ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) + ) + ->throwErrorOn( + '422', + ErrorType::init( + 'The request failed because it either is semantically incorrect or failed b' . + 'usiness validation.', + ErrorException::class + ) + ) + ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) + ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) + ->type(PaymentAuthorization::class) + ->returnApiResponse(); + + return $this->execute($_reqBuilder, $_resHandler); + } + /** * Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been * fully captured. @@ -154,18 +221,11 @@ class PaymentsController extends BaseController ->parameters( TemplateParam::init('authorization_id', $options)->extract('authorizationId'), HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), + HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal') ); $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'The request failed because it is not well-formed or is syntactically incor' . - 'rect or violates schema.', - ErrorException::class - ) - ) ->throwErrorOn( '401', ErrorType::init( @@ -209,82 +269,6 @@ class PaymentsController extends BaseController return $this->execute($_reqBuilder, $_resHandler); } - /** - * Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, - * reauthorize a payment after its initial three-day honor period expires. Within the 29-day - * authorization period, you can issue multiple re-authorizations after the honor period expires. - *
Note: This request is currently not supported for Partner use cases. - *- * - * @param array $options Array with all options for search - * - * @return ApiResponse Response from the API call - */ - public function authorizationsReauthorize(array $options): ApiResponse - { - $_reqBuilder = $this->requestBuilder( - RequestMethod::POST, - '/v2/payments/authorizations/{authorization_id}/reauthorize' - ) - ->auth('Oauth2') - ->parameters( - TemplateParam::init('authorization_id', $options)->extract('authorizationId'), - HeaderParam::init('Content-Type', 'application/json'), - HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), - HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), - BodyParam::init($options)->extract('body') - ); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'The request failed because it is not well-formed or is syntactically incor' . - 'rect or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '401', - ErrorType::init( - 'Authentication failed due to missing authorization header, or invalid auth' . - 'entication credentials.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init( - 'The request failed because the caller has insufficient permissions.', - ErrorException::class - ) - ) - ->throwErrorOn( - '404', - ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The request failed because it either is semantically incorrect or failed b' . - 'usiness validation.', - ErrorException::class - ) - ) - ->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.')) - ->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class)) - ->type(PaymentAuthorization::class) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - /** * Shows details for a captured payment, by ID. * @@ -402,15 +386,18 @@ class PaymentsController extends BaseController /** * Shows details for a refund, by ID. * - * @param string $refundId The PayPal-generated ID for the refund for which to show details. + * @param array $options Array with all options for search * * @return ApiResponse Response from the API call */ - public function refundsGet(string $refundId): ApiResponse + public function refundsGet(array $options): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/refunds/{refund_id}') ->auth('Oauth2') - ->parameters(TemplateParam::init('refund_id', $refundId)); + ->parameters( + TemplateParam::init('refund_id', $options)->extract('refundId'), + HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion') + ); $_resHandler = $this->responseHandler() ->throwErrorOn( diff --git a/src/Controllers/VaultController.php b/src/Controllers/VaultController.php index b7eba3c..738c23a 100644 --- a/src/Controllers/VaultController.php +++ b/src/Controllers/VaultController.php @@ -24,6 +24,58 @@ use PaypalServerSdkLib\Models\SetupTokenResponse; class VaultController extends BaseController { + /** + * Creates a Payment Token from the given payment source and adds it to the Vault of the associated + * customer. + * + * @param array $options Array with all options for search + * + * @return ApiResponse Response from the API call + */ + public function paymentTokensCreate(array $options): ApiResponse + { + $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens') + ->auth('Oauth2') + ->parameters( + HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), + HeaderParam::init('Content-Type', 'application/json'), + BodyParam::init($options)->extract('body') + ); + + $_resHandler = $this->responseHandler() + ->throwErrorOn( + '400', + ErrorType::init( + 'Request is not well-formed, syntactically incorrect, or violates schema.', + ErrorException::class + ) + ) + ->throwErrorOn( + '403', + ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) + ) + ->throwErrorOn( + '404', + ErrorType::init( + 'Request contains reference to resources that do not exist.', + ErrorException::class + ) + ) + ->throwErrorOn( + '422', + ErrorType::init( + 'The requested action could not be performed, semantically incorrect, or fa' . + 'iled business validation.', + ErrorException::class + ) + ) + ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) + ->type(PaymentTokenResponse::class) + ->returnApiResponse(); + + return $this->execute($_reqBuilder, $_resHandler); + } + /** * Returns all payment tokens for a customer. * @@ -96,22 +148,17 @@ class VaultController extends BaseController } /** - * Creates a Payment Token from the given payment source and adds it to the Vault of the associated - * customer. + * Delete the payment token associated with the payment token id. * - * @param array $options Array with all options for search + * @param string $id ID of the payment token. * * @return ApiResponse Response from the API call */ - public function paymentTokensCreate(array $options): ApiResponse + public function paymentTokensDelete(string $id): ApiResponse { - $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens') + $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}') ->auth('Oauth2') - ->parameters( - HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), - HeaderParam::init('Content-Type', 'application/json'), - BodyParam::init($options)->extract('body') - ); + ->parameters(TemplateParam::init('id', $id)); $_resHandler = $this->responseHandler() ->throwErrorOn( @@ -125,23 +172,7 @@ class VaultController extends BaseController '403', ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) ) - ->throwErrorOn( - '404', - ErrorType::init( - 'Request contains reference to resources that do not exist.', - ErrorException::class - ) - ) - ->throwErrorOn( - '422', - ErrorType::init( - 'The requested action could not be performed, semantically incorrect, or fa' . - 'iled business validation.', - ErrorException::class - ) - ) ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->type(PaymentTokenResponse::class) ->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); @@ -192,37 +223,6 @@ class VaultController extends BaseController return $this->execute($_reqBuilder, $_resHandler); } - /** - * Delete the payment token associated with the payment token id. - * - * @param string $id ID of the payment token. - * - * @return ApiResponse Response from the API call - */ - public function paymentTokensDelete(string $id): ApiResponse - { - $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}') - ->auth('Oauth2') - ->parameters(TemplateParam::init('id', $id)); - - $_resHandler = $this->responseHandler() - ->throwErrorOn( - '400', - ErrorType::init( - 'Request is not well-formed, syntactically incorrect, or violates schema.', - ErrorException::class - ) - ) - ->throwErrorOn( - '403', - ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class) - ) - ->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class)) - ->returnApiResponse(); - - return $this->execute($_reqBuilder, $_resHandler); - } - /** * Returns a readable representation of temporarily vaulted payment source associated with the setup * token id. diff --git a/src/Models/Builders/CardVerificationDetailsBuilder.php b/src/Models/Builders/CardVerificationDetailsBuilder.php index 6c663bb..33e6f09 100644 --- a/src/Models/Builders/CardVerificationDetailsBuilder.php +++ b/src/Models/Builders/CardVerificationDetailsBuilder.php @@ -94,6 +94,15 @@ class CardVerificationDetailsBuilder return $this; } + /** + * Sets three d secure field. + */ + public function threeDSecure($value): self + { + $this->instance->setThreeDSecure($value); + return $this; + } + /** * Initializes a new card verification details object. */ diff --git a/src/Models/Builders/ConfirmOrderRequestBuilder.php b/src/Models/Builders/ConfirmOrderRequestBuilder.php index c906952..a58856f 100644 --- a/src/Models/Builders/ConfirmOrderRequestBuilder.php +++ b/src/Models/Builders/ConfirmOrderRequestBuilder.php @@ -43,7 +43,7 @@ class ConfirmOrderRequestBuilder /** * Sets processing instruction field. */ - public function processingInstruction(?string $value): self + public function processingInstruction($value): self { $this->instance->setProcessingInstruction($value); return $this; diff --git a/src/Models/Builders/GooglePayCardBuilder.php b/src/Models/Builders/GooglePayCardBuilder.php new file mode 100644 index 0000000..1413d56 --- /dev/null +++ b/src/Models/Builders/GooglePayCardBuilder.php @@ -0,0 +1,112 @@ +instance = $instance; + } + + /** + * Initializes a new google pay card Builder object. + */ + public static function init(): self + { + return new self(new GooglePayCard()); + } + + /** + * Sets name field. + */ + public function name(?string $value): self + { + $this->instance->setName($value); + return $this; + } + + /** + * Sets number field. + */ + public function number(?string $value): self + { + $this->instance->setNumber($value); + return $this; + } + + /** + * Sets expiry field. + */ + public function expiry(?string $value): self + { + $this->instance->setExpiry($value); + return $this; + } + + /** + * Sets last digits field. + */ + public function lastDigits(?string $value): self + { + $this->instance->setLastDigits($value); + return $this; + } + + /** + * Sets type field. + */ + public function type(?string $value): self + { + $this->instance->setType($value); + return $this; + } + + /** + * Sets brand field. + */ + public function brand(?string $value): self + { + $this->instance->setBrand($value); + return $this; + } + + /** + * Sets billing address field. + */ + public function billingAddress(?PortablePostalAddressMediumGrained $value): self + { + $this->instance->setBillingAddress($value); + return $this; + } + + /** + * Initializes a new google pay card object. + */ + public function build(): GooglePayCard + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php b/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php index 974223e..4d46394 100644 --- a/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php +++ b/src/Models/Builders/GooglePayDecryptedTokenDataBuilder.php @@ -11,6 +11,7 @@ declare(strict_types=1); namespace PaypalServerSdkLib\Models\Builders; use Core\Utils\CoreHelper; +use PaypalServerSdkLib\Models\GooglePayCard; use PaypalServerSdkLib\Models\GooglePayDecryptedTokenData; /** @@ -33,9 +34,9 @@ class GooglePayDecryptedTokenDataBuilder /** * Initializes a new google pay decrypted token data Builder object. */ - public static function init(string $paymentMethod, string $authenticationMethod): self + public static function init(string $paymentMethod, GooglePayCard $card, string $authenticationMethod): self { - return new self(new GooglePayDecryptedTokenData($paymentMethod, $authenticationMethod)); + return new self(new GooglePayDecryptedTokenData($paymentMethod, $card, $authenticationMethod)); } /** diff --git a/src/Models/Builders/OrderAuthorizeResponseBuilder.php b/src/Models/Builders/OrderAuthorizeResponseBuilder.php index e3face0..7bd11a3 100644 --- a/src/Models/Builders/OrderAuthorizeResponseBuilder.php +++ b/src/Models/Builders/OrderAuthorizeResponseBuilder.php @@ -88,7 +88,7 @@ class OrderAuthorizeResponseBuilder /** * Sets processing instruction field. */ - public function processingInstruction(?string $value): self + public function processingInstruction($value): self { $this->instance->setProcessingInstruction($value); return $this; diff --git a/src/Models/Builders/OrderBuilder.php b/src/Models/Builders/OrderBuilder.php index 3819fd4..8a85b1b 100644 --- a/src/Models/Builders/OrderBuilder.php +++ b/src/Models/Builders/OrderBuilder.php @@ -88,7 +88,7 @@ class OrderBuilder /** * Sets processing instruction field. */ - public function processingInstruction(?string $value): self + public function processingInstruction($value): self { $this->instance->setProcessingInstruction($value); return $this; diff --git a/src/Models/Builders/PortablePostalAddressMediumGrainedBuilder.php b/src/Models/Builders/PortablePostalAddressMediumGrainedBuilder.php new file mode 100644 index 0000000..cf5a606 --- /dev/null +++ b/src/Models/Builders/PortablePostalAddressMediumGrainedBuilder.php @@ -0,0 +1,93 @@ +instance = $instance; + } + + /** + * Initializes a new portable postal address medium grained Builder object. + */ + public static function init(string $countryCode): self + { + return new self(new PortablePostalAddressMediumGrained($countryCode)); + } + + /** + * Sets address line 1 field. + */ + public function addressLine1(?string $value): self + { + $this->instance->setAddressLine1($value); + return $this; + } + + /** + * Sets address line 2 field. + */ + public function addressLine2(?string $value): self + { + $this->instance->setAddressLine2($value); + return $this; + } + + /** + * Sets admin area 2 field. + */ + public function adminArea2(?string $value): self + { + $this->instance->setAdminArea2($value); + return $this; + } + + /** + * Sets admin area 1 field. + */ + public function adminArea1(?string $value): self + { + $this->instance->setAdminArea1($value); + return $this; + } + + /** + * Sets postal code field. + */ + public function postalCode(?string $value): self + { + $this->instance->setPostalCode($value); + return $this; + } + + /** + * Initializes a new portable postal address medium grained object. + */ + public function build(): PortablePostalAddressMediumGrained + { + return CoreHelper::clone($this->instance); + } +} diff --git a/src/Models/CardVerificationDetails.php b/src/Models/CardVerificationDetails.php index 0bf9107..a0a75f1 100644 --- a/src/Models/CardVerificationDetails.php +++ b/src/Models/CardVerificationDetails.php @@ -47,6 +47,11 @@ class CardVerificationDetails implements \JsonSerializable */ private $processorResponse; + /** + * @var mixed + */ + private $threeDSecure; + /** * Returns Network Transaction Id. * Transaction Identifier as given by the network to indicate a previously executed CIT authorization. @@ -175,6 +180,32 @@ class CardVerificationDetails implements \JsonSerializable $this->processorResponse = $processorResponse; } + /** + * Returns Three D Secure. + * DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in + * 'three_d_secure' object under 'authentication_result' object instead of the 'verification' field. + * + * @return mixed + */ + public function getThreeDSecure() + { + return $this->threeDSecure; + } + + /** + * Sets Three D Secure. + * DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in + * 'three_d_secure' object under 'authentication_result' object instead of the 'verification' field. + * + * @maps three_d_secure + * + * @param mixed $threeDSecure + */ + public function setThreeDSecure($threeDSecure): void + { + $this->threeDSecure = $threeDSecure; + } + /** * Encode this object to JSON * @@ -205,6 +236,9 @@ class CardVerificationDetails implements \JsonSerializable if (isset($this->processorResponse)) { $json['processor_response'] = $this->processorResponse; } + if (isset($this->threeDSecure)) { + $json['three_d_secure'] = $this->threeDSecure; + } return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } diff --git a/src/Models/ConfirmOrderRequest.php b/src/Models/ConfirmOrderRequest.php index 8db5733..2eec226 100644 --- a/src/Models/ConfirmOrderRequest.php +++ b/src/Models/ConfirmOrderRequest.php @@ -23,9 +23,9 @@ class ConfirmOrderRequest implements \JsonSerializable private $paymentSource; /** - * @var string|null + * @var mixed */ - private $processingInstruction = ProcessingInstruction::NO_INSTRUCTION; + private $processingInstruction; /** * @var OrderConfirmApplicationContext|null @@ -63,20 +63,22 @@ class ConfirmOrderRequest implements \JsonSerializable /** * Returns Processing Instruction. - * The instruction to process an order. + * + * @return mixed */ - public function getProcessingInstruction(): ?string + public function getProcessingInstruction() { return $this->processingInstruction; } /** * Sets Processing Instruction. - * The instruction to process an order. * * @maps processing_instruction + * + * @param mixed $processingInstruction */ - public function setProcessingInstruction(?string $processingInstruction): void + public function setProcessingInstruction($processingInstruction): void { $this->processingInstruction = $processingInstruction; } @@ -115,7 +117,7 @@ class ConfirmOrderRequest implements \JsonSerializable $json = []; $json['payment_source'] = $this->paymentSource; if (isset($this->processingInstruction)) { - $json['processing_instruction'] = ProcessingInstruction::checkValue($this->processingInstruction); + $json['processing_instruction'] = $this->processingInstruction; } if (isset($this->applicationContext)) { $json['application_context'] = $this->applicationContext; diff --git a/src/Models/FullfillmentType.php b/src/Models/FulfillmentType.php similarity index 93% rename from src/Models/FullfillmentType.php rename to src/Models/FulfillmentType.php index 14b151f..f2ec753 100644 --- a/src/Models/FullfillmentType.php +++ b/src/Models/FulfillmentType.php @@ -18,7 +18,7 @@ use stdClass; * A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either * `type` or `options` may be present, but not both. */ -class FullfillmentType +class FulfillmentType { public const SHIPPING = 'SHIPPING'; @@ -46,6 +46,6 @@ class FullfillmentType if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) { return $value; } - throw new Exception("$value is invalid for FullfillmentType."); + throw new Exception("$value is invalid for FulfillmentType."); } } diff --git a/src/Models/GooglePayCard.php b/src/Models/GooglePayCard.php new file mode 100644 index 0000000..0b33213 --- /dev/null +++ b/src/Models/GooglePayCard.php @@ -0,0 +1,239 @@ +name; + } + + /** + * Sets Name. + * The card holder's name as it appears on the card. + * + * @maps name + */ + public function setName(?string $name): void + { + $this->name = $name; + } + + /** + * Returns Number. + * The primary account number (PAN) for the payment card. + */ + public function getNumber(): ?string + { + return $this->number; + } + + /** + * Sets Number. + * The primary account number (PAN) for the payment card. + * + * @maps number + */ + public function setNumber(?string $number): void + { + $this->number = $number; + } + + /** + * Returns Expiry. + * The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https: + * //tools.ietf.org/html/rfc3339#section-5.6). + */ + public function getExpiry(): ?string + { + return $this->expiry; + } + + /** + * Sets Expiry. + * The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https: + * //tools.ietf.org/html/rfc3339#section-5.6). + * + * @maps expiry + */ + public function setExpiry(?string $expiry): void + { + $this->expiry = $expiry; + } + + /** + * Returns Last Digits. + * The last digits of the payment card. + */ + public function getLastDigits(): ?string + { + return $this->lastDigits; + } + + /** + * Sets Last Digits. + * The last digits of the payment card. + * + * @maps last_digits + */ + public function setLastDigits(?string $lastDigits): void + { + $this->lastDigits = $lastDigits; + } + + /** + * Returns Type. + * Type of card. i.e Credit, Debit and so on. + */ + public function getType(): ?string + { + return $this->type; + } + + /** + * Sets Type. + * Type of card. i.e Credit, Debit and so on. + * + * @maps type + */ + public function setType(?string $type): void + { + $this->type = $type; + } + + /** + * Returns Brand. + * The card network or brand. Applies to credit, debit, gift, and payment cards. + */ + public function getBrand(): ?string + { + return $this->brand; + } + + /** + * Sets Brand. + * The card network or brand. Applies to credit, debit, gift, and payment cards. + * + * @maps brand + */ + public function setBrand(?string $brand): void + { + $this->brand = $brand; + } + + /** + * Returns Billing Address. + * The portable international postal address. Maps to [AddressValidationMetadata](https://github. + * com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form + * controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form- + * controls-the-autocomplete-attribute). + */ + public function getBillingAddress(): ?PortablePostalAddressMediumGrained + { + return $this->billingAddress; + } + + /** + * Sets Billing Address. + * The portable international postal address. Maps to [AddressValidationMetadata](https://github. + * com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form + * controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form- + * controls-the-autocomplete-attribute). + * + * @maps billing_address + */ + public function setBillingAddress(?PortablePostalAddressMediumGrained $billingAddress): void + { + $this->billingAddress = $billingAddress; + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->name)) { + $json['name'] = $this->name; + } + if (isset($this->number)) { + $json['number'] = $this->number; + } + if (isset($this->expiry)) { + $json['expiry'] = $this->expiry; + } + if (isset($this->lastDigits)) { + $json['last_digits'] = $this->lastDigits; + } + if (isset($this->type)) { + $json['type'] = CardType::checkValue($this->type); + } + if (isset($this->brand)) { + $json['brand'] = CardBrand::checkValue($this->brand); + } + if (isset($this->billingAddress)) { + $json['billing_address'] = $this->billingAddress; + } + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/GooglePayDecryptedTokenData.php b/src/Models/GooglePayDecryptedTokenData.php index 719cf57..6e76815 100644 --- a/src/Models/GooglePayDecryptedTokenData.php +++ b/src/Models/GooglePayDecryptedTokenData.php @@ -33,6 +33,11 @@ class GooglePayDecryptedTokenData implements \JsonSerializable */ private $paymentMethod; + /** + * @var GooglePayCard + */ + private $card; + /** * @var string */ @@ -50,11 +55,13 @@ class GooglePayDecryptedTokenData implements \JsonSerializable /** * @param string $paymentMethod + * @param GooglePayCard $card * @param string $authenticationMethod */ - public function __construct(string $paymentMethod, string $authenticationMethod) + public function __construct(string $paymentMethod, GooglePayCard $card, string $authenticationMethod) { $this->paymentMethod = $paymentMethod; + $this->card = $card; $this->authenticationMethod = $authenticationMethod; } @@ -121,6 +128,27 @@ class GooglePayDecryptedTokenData implements \JsonSerializable $this->paymentMethod = $paymentMethod; } + /** + * Returns Card. + * The payment card used to fund a Google Pay payment. Can be a credit or debit card. + */ + public function getCard(): GooglePayCard + { + return $this->card; + } + + /** + * Sets Card. + * The payment card used to fund a Google Pay payment. Can be a credit or debit card. + * + * @required + * @maps card + */ + public function setCard(GooglePayCard $card): void + { + $this->card = $card; + } + /** * Returns Authentication Method. * Authentication Method which is used for the card transaction. @@ -205,6 +233,7 @@ class GooglePayDecryptedTokenData implements \JsonSerializable $json['message_expiration'] = $this->messageExpiration; } $json['payment_method'] = GooglePayPaymentMethod::checkValue($this->paymentMethod); + $json['card'] = $this->card; $json['authentication_method'] = GooglePayAuthenticationMethod::checkValue($this->authenticationMethod); if (isset($this->cryptogram)) { $json['cryptogram'] = $this->cryptogram; diff --git a/src/Models/Order.php b/src/Models/Order.php index a38ef4e..99b453d 100644 --- a/src/Models/Order.php +++ b/src/Models/Order.php @@ -43,9 +43,9 @@ class Order implements \JsonSerializable private $intent; /** - * @var string|null + * @var mixed */ - private $processingInstruction = ProcessingInstruction::NO_INSTRUCTION; + private $processingInstruction; /** * @var Payer|null @@ -179,20 +179,22 @@ class Order implements \JsonSerializable /** * Returns Processing Instruction. - * The instruction to process an order. + * + * @return mixed */ - public function getProcessingInstruction(): ?string + public function getProcessingInstruction() { return $this->processingInstruction; } /** * Sets Processing Instruction. - * The instruction to process an order. * * @maps processing_instruction + * + * @param mixed $processingInstruction */ - public function setProcessingInstruction(?string $processingInstruction): void + public function setProcessingInstruction($processingInstruction): void { $this->processingInstruction = $processingInstruction; } @@ -266,9 +268,9 @@ class Order implements \JsonSerializable /** * Returns Links. * An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to - * redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your + * redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your * account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, - * to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the + * to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the * order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to * initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is * specified or you will get "We're sorry, Things don't appear to be working at the moment" after the @@ -284,9 +286,9 @@ class Order implements \JsonSerializable /** * Sets Links. * An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to - * redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your + * redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your * account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, - * to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the + * to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the * order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to * initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is * specified or you will get "We're sorry, Things don't appear to be working at the moment" after the @@ -329,7 +331,7 @@ class Order implements \JsonSerializable $json['intent'] = CheckoutPaymentIntent::checkValue($this->intent); } if (isset($this->processingInstruction)) { - $json['processing_instruction'] = ProcessingInstruction::checkValue($this->processingInstruction); + $json['processing_instruction'] = $this->processingInstruction; } if (isset($this->payer)) { $json['payer'] = $this->payer; diff --git a/src/Models/OrderAuthorizeResponse.php b/src/Models/OrderAuthorizeResponse.php index 9db8410..5a79916 100644 --- a/src/Models/OrderAuthorizeResponse.php +++ b/src/Models/OrderAuthorizeResponse.php @@ -40,9 +40,9 @@ class OrderAuthorizeResponse implements \JsonSerializable private $intent; /** - * @var string|null + * @var mixed */ - private $processingInstruction = ProcessingInstruction::NO_INSTRUCTION; + private $processingInstruction; /** * @var Payer|null @@ -176,20 +176,22 @@ class OrderAuthorizeResponse implements \JsonSerializable /** * Returns Processing Instruction. - * The instruction to process an order. + * + * @return mixed */ - public function getProcessingInstruction(): ?string + public function getProcessingInstruction() { return $this->processingInstruction; } /** * Sets Processing Instruction. - * The instruction to process an order. * * @maps processing_instruction + * + * @param mixed $processingInstruction */ - public function setProcessingInstruction(?string $processingInstruction): void + public function setProcessingInstruction($processingInstruction): void { $this->processingInstruction = $processingInstruction; } @@ -314,7 +316,7 @@ class OrderAuthorizeResponse implements \JsonSerializable $json['intent'] = CheckoutPaymentIntent::checkValue($this->intent); } if (isset($this->processingInstruction)) { - $json['processing_instruction'] = ProcessingInstruction::checkValue($this->processingInstruction); + $json['processing_instruction'] = $this->processingInstruction; } if (isset($this->payer)) { $json['payer'] = $this->payer; diff --git a/src/Models/PortablePostalAddressMediumGrained.php b/src/Models/PortablePostalAddressMediumGrained.php new file mode 100644 index 0000000..a7e8d28 --- /dev/null +++ b/src/Models/PortablePostalAddressMediumGrained.php @@ -0,0 +1,231 @@ +countryCode = $countryCode; + } + + /** + * Returns Address Line 1. + * The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for + * data entry, and Compliance and Risk checks. This field needs to pass the full address. + */ + public function getAddressLine1(): ?string + { + return $this->addressLine1; + } + + /** + * Sets Address Line 1. + * The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for + * data entry, and Compliance and Risk checks. This field needs to pass the full address. + * + * @maps address_line_1 + */ + public function setAddressLine1(?string $addressLine1): void + { + $this->addressLine1 = $addressLine1; + } + + /** + * Returns Address Line 2. + * The second line of the address, for example, a suite or apartment number. + */ + public function getAddressLine2(): ?string + { + return $this->addressLine2; + } + + /** + * Sets Address Line 2. + * The second line of the address, for example, a suite or apartment number. + * + * @maps address_line_2 + */ + public function setAddressLine2(?string $addressLine2): void + { + $this->addressLine2 = $addressLine2; + } + + /** + * Returns Admin Area 2. + * A city, town, or village. Smaller than `admin_area_level_1`. + */ + public function getAdminArea2(): ?string + { + return $this->adminArea2; + } + + /** + * Sets Admin Area 2. + * A city, town, or village. Smaller than `admin_area_level_1`. + * + * @maps admin_area_2 + */ + public function setAdminArea2(?string $adminArea2): void + { + $this->adminArea2 = $adminArea2; + } + + /** + * Returns Admin Area 1. + * The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 + * subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. + * Value, by country, is:
Note: The country code for Great Britain is+ */ + public function getCountryCode(): string + { + return $this->countryCode; + } + + /** + * Sets Country Code. + * The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or + * region.GBand + * notUKas used in the top-level domain names for that country. Use the `C2` country + * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border + * transactions.
Note: The country code for Great Britain is+ * + * @required + * @maps country_code + */ + public function setCountryCode(string $countryCode): void + { + $this->countryCode = $countryCode; + } + + /** + * Encode this object to JSON + * + * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields + * are set. (default: false) + * + * @return array|stdClass + */ + #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) + public function jsonSerialize(bool $asArrayWhenEmpty = false) + { + $json = []; + if (isset($this->addressLine1)) { + $json['address_line_1'] = $this->addressLine1; + } + if (isset($this->addressLine2)) { + $json['address_line_2'] = $this->addressLine2; + } + if (isset($this->adminArea2)) { + $json['admin_area_2'] = $this->adminArea2; + } + if (isset($this->adminArea1)) { + $json['admin_area_1'] = $this->adminArea1; + } + if (isset($this->postalCode)) { + $json['postal_code'] = $this->postalCode; + } + $json['country_code'] = $this->countryCode; + + return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; + } +} diff --git a/src/Models/ProcessingInstruction.php b/src/Models/ProcessingInstruction.php deleted file mode 100644 index 3131b5d..0000000 --- a/src/Models/ProcessingInstruction.php +++ /dev/null @@ -1,45 +0,0 @@ -phoneNumber; } if (isset($this->type)) { - $json['type'] = FullfillmentType::checkValue($this->type); + $json['type'] = FulfillmentType::checkValue($this->type); } if (isset($this->options)) { $json['options'] = $this->options; diff --git a/src/Models/ShippingWithTrackingDetails.php b/src/Models/ShippingWithTrackingDetails.php index d621c64..072d79a 100644 --- a/src/Models/ShippingWithTrackingDetails.php +++ b/src/Models/ShippingWithTrackingDetails.php @@ -206,7 +206,7 @@ class ShippingWithTrackingDetails implements \JsonSerializable $json['phone_number'] = $this->phoneNumber; } if (isset($this->type)) { - $json['type'] = FullfillmentType::checkValue($this->type); + $json['type'] = FulfillmentType::checkValue($this->type); } if (isset($this->options)) { $json['options'] = $this->options; diff --git a/src/Models/VaultedDigitalWalletShippingDetails.php b/src/Models/VaultedDigitalWalletShippingDetails.php index 5fe12a2..b8c5c4b 100644 --- a/src/Models/VaultedDigitalWalletShippingDetails.php +++ b/src/Models/VaultedDigitalWalletShippingDetails.php @@ -116,7 +116,7 @@ class VaultedDigitalWalletShippingDetails implements \JsonSerializable $json['name'] = $this->name; } if (isset($this->type)) { - $json['type'] = FullfillmentType::checkValue($this->type); + $json['type'] = FulfillmentType::checkValue($this->type); } if (isset($this->address)) { $json['address'] = $this->address; diff --git a/src/PaypalServerSdkClient.php b/src/PaypalServerSdkClient.php index 0b08c06..83a1df3 100644 --- a/src/PaypalServerSdkClient.php +++ b/src/PaypalServerSdkClient.php @@ -62,7 +62,7 @@ class PaypalServerSdkClient implements ConfigurationInterface ->converter(new CompatibilityConverter()) ->jsonHelper(ApiHelper::getJsonHelper()) ->apiCallback($this->config['httpCallback'] ?? null) - ->userAgent('PayPal REST API PHP SDK, Version: 0.6.0, on OS {os-info}') + ->userAgent('PayPal REST API PHP SDK, Version: 0.6.1, on OS {os-info}') ->serverUrls(self::ENVIRONMENT_MAP[$this->getEnvironment()], Server::DEFAULT_) ->authManagers(['Oauth2' => $this->clientCredentialsAuthManager]) ->loggingConfiguration($loggingConfiguration)GBand + * notUKas used in the top-level domain names for that country. Use the `C2` country + * code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border + * transactions.