PayPal orders
Orders API Version v2 An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders.
Create order post /v2/checkout/orders Try it Creates an order. 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.
Security
Oauth2
Request
header Parameters
PayPal-Request-Id
string [ 1 .. 108 ] characters
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).
PayPal-Partner-Attribution-Id
string [ 1 .. 36 ] characters
PayPal-Client-Metadata-Id
string [ 1 .. 36 ] characters
Prefer
string [ 1 .. 25 ] characters
Default: return=minimal
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.
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Request Body schema: application/json application/json required purchase_units required Array of objects [ 1 .. 10 ] items An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
intent required string The intent to either capture payment immediately or authorize a payment for an order after order creation.
Enum Value Description
CAPTURE The merchant intends to capture payment immediately after the customer makes a payment.
AUTHORIZE The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.
payer
object
DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the payment_source.paypal object. In order to make this design more clear, the details in the payer object are now available under payment_source.paypal. Please use payment_source.paypal.
payment_source
object
The payment source definition.
application_context object Customize the payer experience during the approval process for the payment with PayPal.
Responses 200A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows order details. 201A successful request returns the HTTP 201 Created status code and a JSON response body that includes by default a minimal response with the ID, status, and HATEOAS links. If you require the complete order resource representation, you must pass the Prefer: return=representation request header. This header value is not the default. 400Request is not well-formed, syntactically incorrect, or violates schema. 422The requested action could not be performed, semantically incorrect, or failed business validation. Request samples cURL
application/json application/json
Sample 1 - 200 - Create Order - PayPal Wallet as Payment Source, Resulting in PAYER_ACTION_REQUIRED Response Sample 1 - 200 - Create Order - PayPal Wallet as Payment Source, Resulting in PAYER_ACTION_REQUIRED Response Copy curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders \ -H 'Content-Type: application/json' \ -H 'PayPal-Request-Id: 7b92603e-77ed-4896-8e78-5dea2050476a' \ -H 'Authorization: Bearer 6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \ -d '{ "intent": "CAPTURE", "payment_source": { "paypal": { "experience_context": { "payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED", "landing_page": "LOGIN", "shipping_preference": "GET_FROM_FILE", "user_action": "PAY_NOW", "return_url": "https://example.com/returnUrl", "cancel_url": "https://example.com/cancelUrl" } } }, "purchase_units": [ { "invoice_id": "90210", "amount": { "currency_code": "USD", "value": "230.00", "breakdown": { "item_total": { "currency_code": "USD", "value": "220.00" }, "shipping": { "currency_code": "USD", "value": "10.00" } } }, "items": [ { "name": "T-Shirt", "description": "Super Fresh Shirt", "unit_amount": { "currency_code": "USD", "value": "20.00" }, "quantity": "1", "category": "PHYSICAL_GOODS", "sku": "sku01", "image_url": "https://example.com/static/images/items/1/tshirt_green.jpg", "url": "https://example.com/url-to-the-item-being-purchased-1", "upc": { "type": "UPC-A", "code": "123456789012" } }, { "name": "Shoes", "description": "Running, Size 10.5", "sku": "sku02", "unit_amount": { "currency_code": "USD", "value": "100.00" }, "quantity": "2", "category": "PHYSICAL_GOODS", "image_url": "https://example.com/static/images/items/1/shoes_running.jpg", "url": "https://example.com/url-to-the-item-being-purchased-2", "upc": { "type": "UPC-A", "code": "987654321012" } } ] } ] }' Response samples 200 201 400 422 application/json
Sample 1 - 200 - Create Order - PayPal Wallet as Payment Source, Resulting in PAYER_ACTION_REQUIRED Response Sample 1 - 200 - Create Order - PayPal Wallet as Payment Source, Resulting in PAYER_ACTION_REQUIRED Response CopyExpand allCollapse all { "id": "5O190127TN364715T", "status": "PAYER_ACTION_REQUIRED", "payment_source": { "paypal": { } }, "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" }, { "href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T", "rel": "payer-action", "method": "GET" } ] } Show order details get /v2/checkout/orders/{id} Try it Shows details for an order, by ID.
Note: For error handling and troubleshooting, see Orders v2 errors. Security Oauth2 Request path Parameters id required string [ 1 .. 36 ] characters The ID of the order for which to show details.
query Parameters
fields
string
A comma-separated list of fields that should be returned for the order. Valid filter field is payment_source.
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Responses 200A successful request returns the HTTP 200 OK status code and a JSON response body that shows order details. 404The specified resource does not exist. Request samples cURL
Sample 1 - 200 - Get Order - Show Order Details After Customer Approval
Sample 1 - 200 - Get Order - Show Order Details After Customer Approval
Copy
curl -v -X GET https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T \
-H 'Authorization: Bearer 6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g'
Response samples
200
404
application/json
Sample 1 - 200 - Get Order - Show Order Details After Customer Approval Sample 1 - 200 - Get Order - Show Order Details After Customer Approval CopyExpand allCollapse all { "id": "5O190127TN364715T", "status": "APPROVED", "intent": "CAPTURE", "payment_source": { "paypal": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "account_id": "QYR5Z8XDVJNXQ" } }, "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "amount": { "currency_code": "USD", "value": "100.00" } } ], "payer": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "payer_id": "QYR5Z8XDVJNXQ" }, "create_time": "2018-04-01T21:18:49Z", "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" }, { "href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T", "rel": "approve", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "update", "method": "PATCH" }, { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/capture", "rel": "capture", "method": "POST" } ] } Update order patch /v2/checkout/orders/{id} Try it Updates an order with a CREATED or APPROVED status. You cannot update an order with the COMPLETED status.
To make an update, you must provide a reference_id. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to default which enables you to use the path: "/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
Security
Oauth2
Request
path Parameters
id
required
string [ 1 .. 36 ] characters
The ID of the order to update.
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Request Body schema: application/json Array ([ 0 .. 32767 ] items) op required string The operation.
Enum Value Description
add Depending on the target location reference, completes one of these functions:
The target location is an array index. Inserts a new value into the array at the specified index.
The target location is an object parameter that does not already exist. Adds a new parameter to the object.
The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.
remove Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.
replace Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.
move Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.
copy Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.
test Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
Type Considered equal if both values
strings Contain the same number of Unicode characters and their code points are byte-by-byte equal.
numbers Are numerically equal.
arrays Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objects Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null) Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.
path
string
The JSON Pointer to the target document location at which to complete the operation.
value
any
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.
Responses 204A successful request returns the HTTP 204 No Content status code with an empty object in the JSON response body. 400Request is not well-formed, syntactically incorrect, or violates schema. 422The requested action could not be performed, semantically incorrect, or failed business validation. Request samples cURL
Sample 1 - 204 - Patch Order - Add Shipping Address Sample 1 - 204 - Patch Order - Add Shipping Address Copy curl -v -X PATCH https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \ -d '[ { "op": "replace", "path": "/purchase_units/@reference_id=='PUHF'/shipping/address", "value": { "address_line_1": "2211 N First Street", "address_line_2": "Building 17", "admin_area_2": "San Jose", "admin_area_1": "CA", "postal_code": "95131", "country_code": "US" } } ]' Response samples 204 400 422 application/json
Sample 1 - 204 - Patch Order - Add Shipping Address Sample 1 - 204 - Patch Order - Add Shipping Address Copy { } Confirm the Order post /v2/checkout/orders/{id}/confirm-payment-source Try it Payer confirms their intent to pay for the the Order with the given payment source.
Security Oauth2 Request path Parameters id required string [ 1 .. 36 ] characters The ID of the order for which the payer confirms their intent to pay.
header Parameters
PayPal-Client-Metadata-Id
string [ 1 .. 36 ] characters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Prefer
string [ 1 .. 25 ] characters
Default: return=minimal
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. Request Body schema: application/json application/json application_context object Customizes the payer confirmation experience.
payment_source required object The payment source definition.
Responses 200A successful request indicates that the payment source was added to the Order. A successful request returns the HTTP 200 OK status code with a JSON response body that shows order details. 400Request is not well-formed, syntactically incorrect, or violates schema. 403Authorization failed due to insufficient permissions. 404Default description 422The requested action could not be performed, semantically incorrect, or failed business validation. 500An internal server error has occurred. Request samples cURL
application/json application/json
Sample 1 - 200 - Confirm Order - PayPal Wallet Resulting in Payer Action Required Sample 1 - 200 - Confirm Order - PayPal Wallet Resulting in Payer Action Required Copy curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/confirm-payment-source \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer 6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \ -d '{ "payment_source": { "paypal": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "experience_context": { "payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED", "brand_name": "EXAMPLE INC", "locale": "en-US", "landing_page": "LOGIN", "shipping_preference": "SET_PROVIDED_ADDRESS", "user_action": "PAY_NOW", "return_url": "https://example.com/returnUrl", "cancel_url": "https://example.com/cancelUrl" } } } }' Response samples 200 400 403 404 422
1 more 1 more application/json
Sample 1 - 200 - Confirm Order - PayPal Wallet Resulting in Payer Action Required Sample 1 - 200 - Confirm Order - PayPal Wallet Resulting in Payer Action Required CopyExpand allCollapse all { "id": "5O190127TN364715T", "status": "PAYER_ACTION_REQUIRED", "payment_source": { "paypal": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com" } }, "payer": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com" }, "links": [ { "href": "https://api.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" }, { "href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T", "rel": "payer-action", "method": "GET" } ] } Authorize payment for order post /v2/checkout/orders/{id}/authorize Try it Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.
Note: For error handling and troubleshooting, see Orders v2 errors. Security Oauth2 Request path Parameters id required string [ 1 .. 36 ] characters The ID of the order for which to authorize.
header Parameters
PayPal-Request-Id
string [ 1 .. 108 ] characters
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).
Prefer
string [ 1 .. 25 ] characters
Default: return=minimal
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.
PayPal-Client-Metadata-Id
string [ 1 .. 36 ] characters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Request Body schema:
application/json
application/json
payment_source
object
The source of payment for the order, which can be a token or a card. Use this object only if you have not redirected the user after order creation to approve the payment. In such cases, the user-selected payment method in the PayPal flow is implicitly used.
Responses 200A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows authorized payment details. 201A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows authorized payment details. If a duplicate response is retried, returns the HTTP 200 OK status code. By default, the response is minimal. If you need the complete resource representation, you must pass the Prefer: return=representation request header. 403The authorized payment failed due to insufficient permissions. 422The requested action could not be performed, semantically incorrect, or failed business validation. Request samples cURL
application/json application/json
Sample 1 - 201 - Authorize Order - PayPal Wallet as Payment Source Sample 1 - 201 - Authorize Order - PayPal Wallet as Payment Source Copy curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/authorize \ -H 'Content-Type: application/json' \ -H 'PayPal-Request-Id: 7b92603e-77ed-4896-8e78-5dea2050476a' \ -H 'Authorization: Bearer 6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \ -d '{}' Response samples 200 201 403 422 application/json
Sample 1 - 201 - Authorize Order - PayPal Wallet as Payment Source Sample 1 - 201 - Authorize Order - PayPal Wallet as Payment Source CopyExpand allCollapse all { "id": "5O190127TN364715T", "status": "COMPLETED", "payment_source": { "paypal": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "account_id": "QYR5Z8XDVJNXQ" } }, "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "payments": { "authorizations": [ { "id": "3C679366HH908993F", "status": "CREATED", "amount": { "currency_code": "USD", "value": "100.00" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "ITEM_NOT_RECEIVED", "UNAUTHORIZED_TRANSACTION" ] }, "expiration_time": "2021-10-08T23:37:39Z", "links": [ { "href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T", "rel": "self", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T/capture", "rel": "capture", "method": "POST" }, { "href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T/void", "rel": "void", "method": "POST" }, { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "up", "method": "GET" } ] } ] } } ], "payer": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "payer_id": "QYR5Z8XDVJNXQ" }, "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" } ] } Capture payment for order post /v2/checkout/orders/{id}/capture Try it Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.
Note: For error handling and troubleshooting, see Orders v2 errors. Security Oauth2 Request path Parameters id required string [ 1 .. 36 ] characters The ID of the order for which to capture a payment.
header Parameters
PayPal-Request-Id
string [ 1 .. 108 ] characters
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).
Prefer
string [ 1 .. 25 ] characters
Default: return=minimal
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.
PayPal-Client-Metadata-Id
string [ 1 .. 36 ] characters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Request Body schema:
application/json
application/json
payment_source
object
The payment source definition.
Responses 200A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows captured payment details. 201A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows captured payment details. If a duplicate response is retried, returns the HTTP 200 OK status code. By default, the response is minimal. If you need the complete resource representation, pass the Prefer: return=representation request header. 403The authorized payment failed due to insufficient permissions. 404The specified resource does not exist. 422The requested action could not be performed, semantically incorrect, or failed business validation. Request samples cURL
application/json application/json
Sample 1 - 201 - Capture Order - PayPal Wallet as Payment Source Sample 1 - 201 - Capture Order - PayPal Wallet as Payment Source Copy curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/capture \ -H 'Content-Type: application/json' \ -H 'PayPal-Request-Id: 7b92603e-77ed-4896-8e78-5dea2050476a' \ -H 'Authorization: Bearer 6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \ -d '{}' Response samples 200 201 403 404 422 application/json
Sample 1 - 201 - Capture Order - PayPal Wallet as Payment Source Sample 1 - 201 - Capture Order - PayPal Wallet as Payment Source CopyExpand allCollapse all { "id": "5O190127TN364715T", "status": "COMPLETED", "payment_source": { "paypal": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "account_id": "QYR5Z8XDVJNXQ" } }, "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "shipping": { "address": { "address_line_1": "2211 N First Street", "address_line_2": "Building 17", "admin_area_2": "San Jose", "admin_area_1": "CA", "postal_code": "95131", "country_code": "US" } }, "payments": { "captures": [ { "id": "3C679366HH908993F", "status": "COMPLETED", "amount": { "currency_code": "USD", "value": "100.00" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "ITEM_NOT_RECEIVED", "UNAUTHORIZED_TRANSACTION" ] }, "final_capture": true, "disbursement_mode": "INSTANT", "seller_receivable_breakdown": { "gross_amount": { "currency_code": "USD", "value": "100.00" }, "paypal_fee": { "currency_code": "USD", "value": "3.00" }, "net_amount": { "currency_code": "USD", "value": "97.00" } }, "create_time": "2018-04-01T21:20:49Z", "update_time": "2018-04-01T21:20:49Z", "links": [ { "href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F", "rel": "self", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F/refund", "rel": "refund", "method": "POST" } ] } ] } } ], "payer": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "payer_id": "QYR5Z8XDVJNXQ" }, "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" } ] } Add tracking information for an Order. post /v2/checkout/orders/{id}/track Try it Adds tracking information for an Order.
Security Oauth2 Request path Parameters id required string [ 1 .. 36 ] characters The ID of the order that the tracking information is associated with.
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Request Body schema: application/json application/json required tracking_number required string [ 1 .. 64 ] characters The tracking number for the shipment. This property supports Unicode.
carrier_name_other
string [ 1 .. 64 ] characters
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.
carrier required string [ 1 .. 64 ] characters ^[0-9A-Z_]+$ The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.
Enum Value Description DPD_RU DPD Russia. BG_BULGARIAN_POST Bulgarian Posts. KR_KOREA_POST Koreapost (www.koreapost.go.kr). ZA_COURIERIT Courier IT. FR_EXAPAQ DPD France (formerly exapaq). ARE_EMIRATES_POST Emirates Post. GAC GAC. GEIS Geis CZ. SF_EX SF Express. PAGO Pago Logistics. MYHERMES MyHermes UK. DIAMOND_EUROGISTICS Diamond Eurogistics Limited. CORPORATECOURIERS_WEBHOOK Corporate Couriers. BOND Bond courier. OMNIPARCEL Omni Parcel. SK_POSTA Slovenska pošta. PUROLATOR purolator. FETCHR_WEBHOOK Mena 360 (Fetchr). THEDELIVERYGROUP TDG – The Delivery Group. CELLO_SQUARE Cello Square. TARRIVE TONDA GLOBAL. COLLIVERY MDS Collivery Pty (Ltd). MAINFREIGHT Mainfreight. IND_FIRSTFLIGHT First Flight Couriers. ACSWORLDWIDE ACS Worldwide Express. AMSTAN Amstan Logistics. OKAYPARCEL OkayParcel. ENVIALIA_REFERENCE Envialia Reference. SEUR_ES Seur Spain. CONTINENTAL Continental. FDSEXPRESS FDSEXPRESS. AMAZON_FBA_SWISHIP Swiship UK. WYNGS Wyngs. DHL_ACTIVE_TRACING DHL Active Tracing. ZYLLEM Zyllem. RUSTON Ruston. XPOST Xpost.ph. CORREOS_ES correos Express (www.correos.es). DHL_FR DHL France (www.dhl.com). PAN_ASIA Pan-Asia International. BRT_IT BRT couriers Italy (www.brt.it). SRE_KOREA SRE Korea (www.srekorea.co.kr). SPEEDEE Spee-Dee Delivery. TNT_UK TNT UK Limited (www.tnt.com). VENIPAK Venipak. SHREENANDANCOURIER SHREE NANDAN COURIER. CROSHOT Croshot. NIPOST_NG NIpost (www.nipost.gov.ng). EPST_GLBL ePost Global. NEWGISTICS Newgistics. POST_SLOVENIA Post of Slovenia. JERSEY_POST Jersey Post. BOMBINOEXP Bombino Express Pvt. WMG WMG Delivery. XQ_EXPRESS XQ Express. FURDECO Furdeco. LHT_EXPRESS LHT Express. SOUTH_AFRICAN_POST_OFFICE South African Post Office. SPOTON SPOTON Logistics Pvt Ltd. DIMERCO Dimerco Express Group. CYPRUS_POST_CYP cyprus post. ABCUSTOM AB Custom Group. IND_DELIVREE deliverE. CN_BESTEXPRESS Best Express. DX_SFTP DX (SFTP). PICKUPP_MYS PICK UPP. FMX FMX. HELLMANN Hellmann Worldwide Logistics. SHIP_IT_ASIA Ship It Asia. KERRY_ECOMMERCE Kerry eCommerce. FRETERAPIDO Frete Rapido. PITNEY_BOWES Pitney Bowes. XPRESSEN_DK Xpressen courier. SEUR_SP_API Spanish Seur API. DELIVERYONTIME DELIVERYONTIME LOGISTICS PVT LTD. JINSUNG JINSUNG TRADING. TRANS_KARGO Trans Kargo Internasional. SWISHIP_DE Swiship DE. IVOY_WEBHOOK Ivoy courier. AIRMEE_WEBHOOK Airmee couriers. DHL_BENELUX dhl benelux. FIRSTMILE FirstMile. FASTWAY_IR Fastway Ireland. HH_EXP Hua Han Logistics. MYS_MYPOST_ONLINE Mypostonline. TNT_NL THT Netherland. TIPSA TIPSA courier. TAQBIN_MY TAQBIN Malaysia. KGMHUB KGM Hub. INTEXPRESS Internet Express. OVERSE_EXP Overseas Express. ONECLICK One click delivery services. ROADRUNNER_FREIGHT Roadbull Logistics. GLS_CROTIA GLS Croatia. MRW_FTP MRW courier. BLUEX Blue Express. DYLT Daylight Transport. DPD_IR DPD Ireland. SIN_GLBL Sin Global Express. TUFFNELLS_REFERENCE Tuffnells Parcels Express- Reference. CJPACKET CJ Packet. MILKMAN Milkman courier. ASIGNA ASIGNA courier. ONEWORLDEXPRESS One World Express. ROYAL_MAIL RoyalShipments. VIA_EXPRESS Viaxpress. TIGFREIGHT TIG Freight. ZTO_EXPRESS ZTO Express. TWO_GO 2GO Courier. IML IML courier. INTEL_VALLEY Intel-Valley Supply chain (ShenZhen) Co. Ltd. EFS EFS (E-commerce Fulfillment Service). UK_UK_MAIL UK mail (ukmail.com). RAM RAM courier. ALLIEDEXPRESS Allied Express. APC_OVERNIGHT APC overnight (apc-overnight.com). SHIPPIT Shippit. TFM TFM Xpress. M_XPRESS M Xpress Sdn Bhd. HDB_BOX Haidaibao (BOX). CLEVY_LINKS Clevy Links. IBEONE Beone Logistics. FIEGE_NL Fiege Netherlands. KWE_GLOBAL KWE Global. CTC_EXPRESS CTC Express. AMAZON Amazon Shipping. MORE_LINK Morelink. JX JX courier. EASY_MAIL Easy Mail. ADUIEPYLE A Duie Pyle. GB_PANTHER Panther. EXPRESSSALE Expresssale. SG_DETRACK Detrack. TRUNKRS_WEBHOOK Trunkrs courier. MATDESPATCH Matdespatch. DICOM GLS Logistic Systems Canada Ltd./Dicom. MBW MBW Courier Inc.. KHM_CAMBODIA_POST Cambodia Post. SINOTRANS Sinotrans. BRT_IT_PARCELID BRT Bartolini(Parcel ID). DHL_SUPPLY_CHAIN DHL Supply Chain APAC. DHL_PL DHL Poland. TOPYOU TopYou. PALEXPRESS PAL Express Limited. DHL_SG dhl Singapore. CN_WEDO WeDo Logistics. FULFILLME Fulfillme. DPD_DELISTRACK DPD delistrack. UPS_REFERENCE UPS Reference. CARIBOU Caribou. LOCUS_WEBHOOK Locus courier. DSV DSV courier. P2P_TRC P2P TrakPak. DIRECTPARCELS Direct Parcels. NOVA_POSHTA_INT Nova Poshta (International). FEDEX_POLAND FedEx® Poland Domestic. CN_JCEX JCEX courier. FAR_INTERNATIONAL FAR international. IDEXPRESS IDEX courier. GANGBAO GANGBAO Supplychain. NEWAY Neway Transport. POSTNL_INT_3_S PostNL International. RPX_ID RPX Indonesia. DESIGNERTRANSPORT_WEBHOOK Designer Transport. GLS_SLOVEN GLS Slovenia. PARCELLED_IN Parcelled.in. GSI_EXPRESS GSI EXPRESS. CON_WAY Con-way Freight. BROUWER_TRANSPORT Brouwer Transport en Logistiek. CPEX Captain Express International. ISRAEL_POST Israel Post. DTDC_IN DTDC India. PTT_POST PTT Post. XDE_WEBHOOK Ximex Delivery Express. TOLOS Tolos courier. GIAO_HANG Giao hàng nhanh. GEODIS_ESPACE Geodis E-space. MAGYAR_HU Magyar Post. DOORDASH_WEBHOOK DoorDash. TIKI_ID Tiki shipment. CJ_HK_INTERNATIONAL CJ Logistics International(Hong Kong). STAR_TRACK_EXPRESS Star Track Express. HELTHJEM Helthjem. SFB2C SF International. FREIGHTQUOTE Freightquote by C.H. Robinson. LANDMARK_GLOBAL_REFERENCE Landmark Global Reference. PARCEL2GO Parcel2Go. DELNEXT Delnext. RCL Red Carpet Logistics. CGS_EXPRESS CGS Express. HK_POST Hongkong Post (www.hongkongpost.hk). SAP_EXPRESS SAP EXPRESS. PARCELPOST_SG Parcel Post Singapore. HERMES HermesWorld UK. IND_SAFEEXPRESS Safexpress. TOPHATTEREXPRESS Tophatter Express. MGLOBAL PT MGLOBAL LOGISTICS INDONESIA. AVERITT Averitt Express. LEADER leader. _2EBOX 2ebox courier. SG_SPEEDPOST Singapore Speedpost. DBSCHENKER_SE DB Schenker (www.dbschenker.com). ISR_POST_DOMESTIC Israel Post Domestic. BESTWAYPARCEL Best Way Parcel. ASENDIA_DE asendia_de. NIGHTLINE_UK nightline_uk. TAQBIN_SG taqbin_sg. TCK_EXPRESS TCK Express. ENDEAVOUR_DELIVERY Endeavour Delivery. NANJINGWOYUAN Nanjing Woyuan. HEPPNER_FR Heppner France. EMPS_CN EMPS Express. FONSEN Fonsen Logistics. PICKRR Pickrr. APC_OVERNIGHT_CONNUM APC Overnight Consignment. STAR_TRACK_NEXT_FLIGHT Star Track Next Flight. DAJIN Shanghai Aqrum Chemical Logistics Co.Ltd. UPS_FREIGHT UPS Freight. POSTA_PLUS Posta Plus. CEVA CEVA LOGISTICS. ANSERX ANSERX courier. JS_EXPRESS JS EXPRESS. PADTF padtf.com. UPS_MAIL_INNOVATIONS UPS Mail Innovations. SYPOST Sunyou Post. AMAZON_SHIP_MCF Amazon Shipping + Amazon MCF. YUSEN Yusen Logistics. BRING Bring. SDA_IT SDA Italy. GBA GBA Services Ltd. NEWEGGEXPRESS Newegg Express. SPEEDCOURIERS_GR Speed Couriers. FORRUN forrun Pvt Ltd (Arpatech Venture). PICKUP Pickupp. ECMS ECMS International Logistics Co.. INTELIPOST Intelipost (TMS for LATAM). FLASHEXPRESS Flash Express. CN_STO STO Express. SEKO_SFTP SEKO Worldwide. HOME_DELIVERY_SOLUTIONS Home Delivery Solutions Ltd. DPD_HGRY DPD Hungary. KERRYTTC_VN Kerry Express (Vietnam) Co Ltd. JOYING_BOX Joying Box. TOTAL_EXPRESS Total Express. ZJS_EXPRESS ZJS International. STARKEN STARKEN couriers. DEMANDSHIP DemandShip. CN_DPEX DPEX. AUPOST_CN AuPost China. LOGISTERS Logisters. GOGLOBALPOST Global Post. GLS_CZ GLS Czech Republic. PAACK_WEBHOOK Paack courier. GRAB_WEBHOOK Grab courier. PARCELPOINT Parcelpoint. ICUMULUS iCumulus. DAIGLOBALTRACK DAI Post. GLOBAL_IPARCEL i-parcel. YURTICI_KARGO Yurtici Kargo. CN_PAYPAL_PACKAGE PayPal Package. PARCEL_2_POST Parcel To Post. GLS_IT GLS Italy. PIL_LOGISTICS PIL Logistics (China) Co.. HEPPNER Heppner Internationale Spedition GmbH & Co.. GENERAL_OVERNIGHT Go!Express and logistics. HAPPY2POINT Happy 2ThePoint. CHITCHATS Chit Chats. SMOOTH Smooth Couriers. CLE_LOGISTICS CL E-Logistics Solutions Limited. FIEGE Fiege Logistics. MX_CARGO M&X cargo. ZIINGFINALMILE Ziing Final Mile Inc. DAYTON_FREIGHT Dayton Freight. TCS TCS courier. AEX AEX Group. HERMES_DE Hermes Germany. ROUTIFIC_WEBHOOK Routific. GLOBAVEND Globavend. CJ_LOGISTICS CJ Logistics International. PALLET_NETWORK The Pallet Network. RAF_PH RAF Philippines. UK_XDP XDP Express. PAPER_EXPRESS Paper Express. LA_POSTE_SUIVI La Poste. PAQUETEXPRESS Paquetexpress. LIEFERY liefery. STRECK_TRANSPORT Streck Transport. PONY_EXPRESS Pony express. ALWAYS_EXPRESS Always Express. GBS_BROKER GBS-Broker. CITYLINK_MY City-Link Express. ALLJOY ALLJOY SUPPLY CHAIN. YODEL yodel. YODEL_DIR Yodel Direct. STONE3PL STONE3PL. PARCELPAL_WEBHOOK ParcelPal. DHL_ECOMERCE_ASA DHL eCommerce Asia (API). SIMPLYPOST J&T Express Singapore. KY_EXPRESS Kua Yue Express. SHENZHEN shenzhen 1st International Logistics(Group)Co. US_LASERSHIP LaserShip. UC_EXPRE ucexpress. DIDADI DIDADI Logistics tech. CJ_KR CJ Korea Express. DBSCHENKER_B2B DB Schenker B2B. MXE MXE Express. CAE_DELIVERS CAE Delivers. PFCEXPRESS PFC Express. WHISTL Whistl. WEPOST WePost Sdn Bhd. DHL_PARCEL_ES DHL parcel Spain(www.dhl.com). DDEXPRESS DD Express Courier. ARAMEX_AU Aramex Australia (formerly Fastway AU). BNEED Bneed courier. HK_TGX Kerry Express Hong Kong. LATVIJAS_PASTS Latvijas Pasts. VIAEUROPE ViaEurope. CORREO_UY Correo Uruguayo. CHRONOPOST_FR Chronopost france (www.chronopost.fr). J_NET J-Net. _6LS 6ls.com. BLR_BELPOST Belpost. BIRDSYSTEM BirdSystem. DOBROPOST DobroPost. WAHANA_ID Wahana express (www.wahana.com). WEASHIP Weaship. SONICTL Sonic Transportation & Logistics. KWT Shenzhen Jinghuada Logistics Co.. AFLLOG_FTP AFL LOGISTICS. SKYNET_WORLDWIDE SkyNet Worldwide Express. NOVA_POSHTA Nova Poshta (novaposhta.ua). SEINO Seino. SZENDEX SZENDEX. BPOST_INT Bpost international. DBSCHENKER_SV DB Schenker Sweden. AO_DEUTSCHLAND AO Deutschland. EU_FLEET_SOLUTIONS EU Fleet Solutions. PCFCORP PCF Final Mile. LINKBRIDGE Link Bridge(BeiJing)international logistics co.. PRIMAMULTICIPTA PT Prima Multi Cipta. COUREX Urbanfox. ZAJIL_EXPRESS Zajil Express Company. COLLECTCO CollectCo. JTEXPRESS J&T EXPRESS MALAYSIA. FEDEX_UK FedEx® UK. USHIP uShip courier. PIXSELL PIXSELL LOGISTICS. SHIPTOR Shiptor. CDEK CDEK courier. VNM_VIETTELPOST ViettelPost. CJ_CENTURY CJ Century. GSO GSO(GLS-USA). VIWO VIWO IoT. SKYBOX SKYBOX. KERRYTJ Kerry TJ Logistics. NTLOGISTICS_VN Nhat Tin Logistics. SDH_SCM lightning monkey. ZINC Zinc courier. DPE_SOUTH_AFRC DPE South Africa. CESKA_CZ Czech Post. ACS_GR ACS Courier. DEALERSEND DealerSend. JOCOM Jocom. CSE CSE courier. TFORCE_FINALMILE TForce Final Mile. SHIP_GATE ShipGate. SHIPTER SHIPTER. NATIONAL_SAMEDAY National Sameday. YUNEXPRESS YunExpress. CAINIAO AliExpress Standard Shipping. DMS_MATRIX DMSMatrix. DIRECTLOG Directlog (www.directlog.com.br). ASENDIA_US Asendia USA. _3JMSLOGISTICS 3JMS Logistics. LICCARDI_EXPRESS LICCARDI EXPRESS COURIER. SKY_POSTAL SkyPostal. CNWANGTONG cnwangtong. POSTNORD_LOGISTICS_DK ostnord denmark. LOGISTIKA Logistika. CELERITAS Celeritas Transporte. PRESSIODE Pressio. SHREE_MARUTI Shree Maruti Courier Services Pvt Ltd. LOGISTICSWORLDWIDE_HK Logistic Worldwide Express (LWE Honkong). EFEX eFEx (E-Commerce Fulfillment & Express). LOTTE Lotte Global Logistics. LONESTAR Lone Star Overnight. APRISAEXPRESS Aprisa Express. BEL_RS BEL North Russia. OSM_WORLDWIDE OSM Worldwide. WESTGATE_GL Westgate Global. FASTRACK Fasttrack. DTD_EXPR DTD Express. ALFATREX AlfaTrex. PROMEDDELIVERY ProMed Delivery. THABIT_LOGISTICS Thabit Logistics. HCT_LOGISTICS HCT LOGISTICS CO.LTD.. CARRY_FLAP Carry-Flap Co.. US_OLD_DOMINION Old Dominion Freight Line. ANICAM_BOX ANICAM BOX EXPRESS. WANBEXPRESS WanbExpress. AN_POST An Post. DPD_LOCAL DPD Local. STALLIONEXPRESS Stallion Express. RAIDEREX RaidereX. SHOPFANS ShopfansRU LLC. KYUNGDONG_PARCEL Kyungdong Parcel. CHAMPION_LOGISTICS Champion Logistics. PICKUPP_SGP PICK UPP (Singapore). MORNING_EXPRESS Morning Express. NACEX NACEX. THENILE_WEBHOOK SortHub courier. HOLISOL Holisol. LBCEXPRESS_FTP LBC EXPRESS INC.. KURASI KURASI. USF_REDDAWAY USF Reddaway. APG APG eCommerce Solutions. CN_BOXC BoxC courier. ECOSCOOTING ECOSCOOTING. MAINWAY Mainway. PAPERFLY Paperfly Private Limited. HOUNDEXPRESS Hound Express. BOX_BERRY Boxberry courier. EP_BOX EP-Box courier. PLUS_LOG_UK Plus UK Logistics. FULFILLA Fulfilla. ASE ASE KARGO. MAIL_PLUS MailPlus. XPO_LOGISTICS XPO logistics. WNDIRECT wnDirect. CLOUDWISH_ASIA Cloudwish Asia. ZELERIS Zeleris. GIO_EXPRESS Gio Express. OCS_WORLDWIDE OCS WORLDWIDE. ARK_LOGISTICS ARK Logistics. AQUILINE Aquiline. PILOT_FREIGHT Pilot Freight Services. QWINTRY Qwintry Logistics. DANSKE_FRAGT Danske Fragtaend. CARRIERS Carriers courier. AIR_CANADA_GLOBAL Rivo (Air canada). PRESIDENT_TRANS PRESIDENT TRANSNET CORP. STEPFORWARDFS STEP FORWARD FREIGHT SERVICE CO LTD. SKYNET_UK Skynet UK. PITTOHIO PITT OHIO. CORREOS_EXPRESS Correos Express. RL_US RL Carriers. DESTINY Destiny Transportation. UK_YODEL Yodel (www.yodel.co.uk). COMET_TECH CometTech. DHL_PARCEL_RU DHL Parcel Russia. TNT_REFR TNT Reference. SHREE_ANJANI_COURIER Shree Anjani Courier. MIKROPAKKET_BE Mikropakket Belgium. ETS_EXPRESS RETS express. COLIS_PRIVE Colis Privé. CN_YUNDA Yunda Express. AAA_COOPER AAA Cooper. ROCKET_PARCEL Rocket Parcel International. _360LION 360 Lion Express. PANDU PANDU. PROFESSIONAL_COURIERS PROFESSIONAL COURIERS. FLYTEXPRESS FLYTEXPRESS. LOGISTICSWORLDWIDE_MY LOGISTICSWORLDWIDE MY. CORREOS_DE_ESPANA CORREOS DE ESPANA. IMX IMX. FOUR_PX_EXPRESS FOUR PX EXPRESS. XPRESSBEES XPRESSBEES. PICKUPP_VNM pickupp_vnm. STARTRACK_EXPRESS startrack_express. FR_COLISSIMO fr_colissimo. NACEX_SPAIN_REFERENCE nacex_spain_reference. DHL_SUPPLY_CHAIN_AU dhl_supply_chain_au. ESHIPPING Eshipping. SHREETIRUPATI SHREE TIRUPATI COURIER SERVICES PVT. LTD.. HX_EXPRESS HX Express. INDOPAKET INDOPAKET. CN_17POST 17 Post Service. K1_EXPRESS K1 Express. CJ_GLS CJ GLS. MYS_GDEX GDEX courier. NATIONEX Nationex courier. ANJUN Anjun couriers. FARGOOD FarGood. SMG_EXPRESS SMG Direct. RZYEXPRESS RZY Express. SEFL Southeastern Freight Lines. TNT_CLICK_IT TNT-Click Italy. HDB Haidaibao. HIPSHIPPER Hipshipper. RPXLOGISTICS RPX Logistics. KUEHNE Kuehne + Nagel. IT_NEXIVE Nexive (TNT Post Italy). PTS PTS courier. SWISS_POST_FTP Swiss Post FTP. FASTRK_SERV Fastrak Services. _4_72 4-72 Entregando. US_YRC YRC courier. POSTNL_INTL_3S PostNL International 3S. ELIAN_POST Yilian (Elian) Supply Chain. CUBYN Cubyn. SAU_SAUDI_POST Saudi Post. ABXEXPRESS_MY ABX Express. HUAHAN_EXPRESS HUAHANG EXPRESS. ZES_EXPRESS Eshun international Logistic. ZEPTO_EXPRESS ZeptoExpress. SKYNET_ZA Skynet World Wide Express South Africa. ZEEK_2_DOOR Zeek2Door. BLINKLASTMILE Blink. POSTA_UKR UkrPoshta. CHROBINSON C.H. Robinson Worldwide. CN_POST56 Post56. COURANT_PLUS Courant Plus. SCUDEX_EXPRESS Scudex Express. SHIPENTEGRA ShipEntegra. B_TWO_C_EUROPE B2C courier Europe. COPE Cope Sensitive Freight. IND_GATI Gati-KWE. CN_WISHPOST WishPost. NACEX_ES NACEX Spain. TAQBIN_HK TAQBIN Hong Kong. GLOBALTRANZ GlobalTranz. HKD Qingdao HKD International Logistics. BJSHOMEDELIVERY BJS Distribution courier. OMNIVA Omniva. SUTTON Sutton Transport. PANTHER_REFERENCE Panther Reference. SFCSERVICE SFC Service. LTL LTL COURIER. PARKNPARCEL Park N Parcel. SPRING_GDS Spring GDS. ECEXPRESS ECexpress. INTERPARCEL_AU Interparcel Australia. AGILITY Agility. XL_EXPRESS XL Express. ADERONLINE Ader couriers. DIRECTCOURIERS Direct Couriers. PLANZER Planzer Group. SENDING Sending Transporte Urgente y Comunicacion. NINJAVAN_WB Ninjavan Webhook. NATIONWIDE_MY Nationwide Express Courier Services Bhd (www.nationwide.com.my). SENDIT Sendit. GB_ARROW Arrow XL. IND_GOJAVAS GoJavas. KPOST Korea Post. DHL_FREIGHT DHL Freight. BLUECARE Bluecare Express Ltd. JINDOUYUN jindouyun courier. TRACKON Trackon Couriers Pvt. Ltd. GB_TUFFNELLS Tuffnells Parcels Express. TRUMPCARD TRUMPCARD LLC. ETOTAL eTotal Solution Limited. SFPLUS_WEBHOOK Zeek courier. SEKOLOGISTICS SEKO Logistics. HERMES_2MANN_HANDLING Hermes Einrichtungs Service GmbH & Co. KG. DPD_LOCAL_REF DPD Local reference. UDS United Delivery Service. ZA_SPECIALISED_FREIGHT Specialised Freight. THA_KERRY Kerry Express Thailand. PRT_INT_SEUR SEUR International. BRA_CORREIOS Correios Brazil. NZ_NZ_POST New Zealand Post. CN_EQUICK Equick China. MYS_EMS Malaysia Post EMS / Pos Laju. GB_NORSK Norsk Global. ESP_MRW MRW spain. ESP_PACKLINK Packlink. KANGAROO_MY Kangaroo Worldwide Express. RPX RPX Online. XDP_UK_REFERENCE XDP Express Reference. NINJAVAN_MY ninja van (www.ninjavan.co). ADICIONAL Adicional Logistics. ROADBULL Red Carpet Logistics. YAKIT Yakit courier. MAILAMERICAS MailAmericas. MIKROPAKKET Mikropakket. DYNALOGIC Dynamic Logistics. DHL_ES DHL Spain(www.dhl.com). DHL_PARCEL_NL DHL Parcel NL. DHL_GLOBAL_MAIL_ASIA DHL Global Mail Asia (www.dhl.com). DAWN_WING Dawn Wing. GENIKI_GR Geniki Taxydromiki. HERMESWORLD_UK hermesworld_uk. ALPHAFAST Alphafast (www.alphafast.com). BUYLOGIC buylogic. EKART Ekart logistics (ekartlogistics.com). MEX_SENDA mexico senda express. SFC_LOGISTICS SFC. POST_SERBIA Posta Serbia. IND_DELHIVERY Delhivery India. DE_DPD_DELISTRACK DPD Germany. RPD2MAN RPD2man Deliveries. CN_SF_EXPRESS SF Express (www.sf-express.com). YANWEN Yanwen Logistics. MYS_SKYNET Skynet Malaysia. CORREOS_DE_MEXICO correos mexico. CBL_LOGISTICA CBL Logistica. MEX_ESTAFETA Estafeta (www.estafeta.com). AU_AUSTRIAN_POST Austrian Post (Registered). RINCOS Rincos. NLD_DHL DHL Netherland. RUSSIAN_POST Russian post. COURIERS_PLEASE CouriersPlease (couriersplease.com.au). POSTNORD_LOGISTICS PostNord Logistics. FEDEX Fedex. DPE_EXPRESS DPE Express. DPD DPD. ADSONE ADSone. IDN_JNE JNE Express (Jalur Nugraha Ekakurir). THECOURIERGUY The Courier Guy. CNEXPS CNE Express. PRT_CHRONOPOST Chronopost Portugal. LANDMARK_GLOBAL Landmark Global. IT_DHL_ECOMMERCE DHL International. ESP_NACEX NACEX Spain. PRT_CTT CTT Portugal. BE_KIALA Kiala. ASENDIA_UK Asendia UK. GLOBAL_TNT TNT global. POSTUR_IS Iceland Post. EPARCEL_KR eParcel Korea. INPOST_PACZKOMATY InPost Paczkomaty. IT_POSTE_ITALIA Poste italiane (www.poste.it). BE_BPOST Bpost (www.bpost.be). PL_POCZTA_POLSKA Poczta Polska (www.poczta-polska.pl). MYS_MYS_POST Malaysia Post. SG_SG_POST Singapore Post. THA_THAILAND_POST Thailand Post (www.thailandpost.co.th). LEXSHIP LexShip. FASTWAY_NZ Fastway New Zealand. DHL_AU DHL Supply Chain Australia. COSTMETICSNOW Cosmetics Now. PFLOGISTICS PFL. LOOMIS_EXPRESS Loomis Express. GLS_ITALY GLS Italy. LINE Line Clear Express & Logistics Sdn Bhd. GEL_EXPRESS Gel Express Logistik. HUODULL Huodull. NINJAVAN_SG Ninja van Singapore. JANIO Janio Asia. AO_COURIER AO Logistics. BRT_IT_SENDER_REF BRT Bartolini(Sender Reference). SAILPOST SAILPOST. LALAMOVE Lalamove. NEWZEALAND_COURIERS NEW ZEALAND COURIERS. ETOMARS Etomars. VIRTRANSPORT VIR Transport. WIZMO Wizmo. PALLETWAYS Palletways. I_DIKA i-dika. CFL_LOGISTICS CFL Logistics. GEMWORLDWIDE GEM Worldwide. GLOBAL_EXPRESS Tai Wan Global Business. LOGISTYX_TRANSGROUP Transgroup courier. WESTBANK_COURIER West Bank Courier. ARCO_SPEDIZIONI Arco Spedizioni SP. YDH_EXPRESS YDH express. PARCELINKLOGISTICS Parcelink Logistics. CNDEXPRESS CND Express. NOX_NIGHT_TIME_EXPRESS NOX NightTimeExpress. AERONET Aeronet couriers. LTIANEXP LTIAN EXP. INTEGRA2_FTP Integra2. PARCELONE PARCEL ONE. NOX_NACHTEXPRESS Innight Express Germany GmbH (nox NachtExpress). CN_CHINA_POST_EMS China Post. CHUKOU1 Chukou1. GLS_SLOV GLS General Logistics Systems Slovakia s.r.o.. ORANGE_DS OrangeDS (Orange Distribution Solutions Inc). JOOM_LOGIS Joom Logistics. AUS_STARTRACK StarTrack (startrack.com.au). DHL dhl Global. GB_APC APC postal logistics germany. BONDSCOURIERS Bonds Courier Service (bondscouriers.com.au). JPN_JAPAN_POST Japan Post. USPS United States Postal Service. WINIT WinIt. ARG_OCA OCA Argentina. TW_TAIWAN_POST Taiwan Post. DMM_NETWORK DMM Network. TNT TNT Express. BH_POSTA BH Posta (www.posta.ba). SWE_POSTNORD Postnord sweden. CA_CANADA_POST Canada Post. WISELOADS Wiseloads. ASENDIA_HK Asendia HonKong. NLD_GLS GLS Netherland. MEX_REDPACK Redpack. JET_SHIP Jet-Ship Worldwide. DE_DHL_EXPRESS DHL Express. NINJAVAN_THAI Ninja van Thai. RABEN_GROUP Raben Group. ESP_ASM ASM(GLS Spain). HRV_HRVATSKA Hrvatska posta. GLOBAL_ESTES Estes Express Lines. LTU_LIETUVOS Lietuvos pastas. BEL_DHL DHL Benelux. AU_AU_POST Australia Post. SPEEDEXCOURIER SPEEDEX couriers. FR_COLIS Colissimo. ARAMEX Aramex. DPEX DPEX (www.dpex.com). MYS_AIRPAK Airpak Express. CUCKOOEXPRESS Cuckoo Express. DPD_POLAND DPD Poland. NLD_POSTNL PostNL International. NIM_EXPRESS Nim Express. QUANTIUM Quantium. SENDLE Sendle. ESP_REDUR Redur Spain. MATKAHUOLTO Matkahuolto. CPACKET Cpacket couriers. POSTI Posti courier. HUNTER_EXPRESS Hunter Express. CHOIR_EXP Choir Express Indonesia. LEGION_EXPRESS Legion Express. AUSTRIAN_POST_EXPRESS austrian post. GRUPO Grupo ampm. POSTA_RO Post Roman (www.posta-romana.ro). INTERPARCEL_UK Interparcel UK. GLOBAL_ABF ABF Freight. POSTEN_NORGE Posten Norge (www.posten.no). XPERT_DELIVERY Xpert Delivery. DHL_REFR DHl (Reference number). DHL_HK DHL HonKong. SKYNET_UAE SKYNET UAE. GOJEK Gojek. YODEL_INTNL Yodel International. JANCO Janco Ecommerce. YTO YTO Express. WISE_EXPRESS Wise Express. JTEXPRESS_VN J&T Express Vietnam. FEDEX_INTL_MLSERV FedEx International MailService. VAMOX VAMOX. AMS_GRP AMS Group. DHL_JP DHL Japan. HRPARCEL HR Parcel. GESWL GESWL Express. BLUESTAR Blue Star. CDEK_TR CDEK TR. DESCARTES Innovel courier. DELTEC_UK Deltec Courier. DTDC_EXPRESS DTDC express. TOURLINE tourline. BH_WORLDWIDE B&H Worldwide. OCS OCS ANA Group. YINGNUO_LOGISTICS yingnuo logistics. UPS United Parcel Service. TOLL Toll IPEC. PRT_SEUR SEUR portugal. DTDC_AU DTDC Australia. THA_DYNAMIC_LOGISTICS Dynamic Logistics. UBI_LOGISTICS UBI Smart Parcel. FEDEX_CROSSBORDER FedEx Cross Border. A1POST A1Post. TAZMANIAN_FREIGHT Tazmanian Freight Systems. CJ_INT_MY CJ International malaysia. SAIA_FREIGHT Saia LTL Freight. SG_QXPRESS Qxpress. NHANS_SOLUTIONS Nhans Solutions. DPD_FR DPD France. COORDINADORA Coordinadora. ANDREANI Grupo logistico Andreani. DOORA Doora Logistics. INTERPARCEL_NZ Interparcel New Zealand. PHL_JAMEXPRESS Jam Express Philippines. BEL_BELGIUM_POST bel_belgium_post. US_APC us_apc. IDN_POS idn_pos. FR_MONDIAL fr_mondial. DE_DHL DE DHL. HK_RPX hk_rpx. DHL_PIECEID dhl_pieceid. VNPOST_EMS vnpost_ems. RRDONNELLEY rrdonnelley. DPD_DE dpd_de. DELCART_IN delcart_in. IMEXGLOBALSOLUTIONS imexglobalsolutions. ACOMMERCE ACOMMERCE. EURODIS eurodis. CANPAR CANPAR. GLS GLS. IND_ECOM Ecom Express. ESP_ENVIALIA Envialia. DHL_UK dhl UK. SMSA_EXPRESS SMSA Express. TNT_FR TNT France. DEX_I DEX-I courier. BUDBEE_WEBHOOK Budbee courier. COPA_COURIER Copa Airlines Courier. VNM_VIETNAM_POST Vietnam Post. DPD_HK DPD HongKong. TOLL_NZ Toll New Zealand. ECHO Echo courier. FEDEX_FR FedEx® Freight. BORDEREXPRESS Border Express. MAILPLUS_JPN MailPlus (Japan). TNT_UK_REFR TNT UK Reference. KEC KEC courier. DPD_RO DPD Romania. TNT_JP TNT_JP. TH_CJ TH_CJ. EC_CN EC_CN. FASTWAY_UK FASTWAY_UK. FASTWAY_US FASTWAY_US. GLS_DE GLS_DE. GLS_ES GLS_ES. GLS_FR GLS_FR. MONDIAL_BE MONDIAL_BE. SGT_IT SGT_IT. TNT_CN TNT_CN. TNT_DE TNT_DE. TNT_ES TNT_ES. TNT_PL TNT_PL. PARCELFORCE PARCELFORCE. SWISS_POST SWISS POST. TOLL_IPEC TOLL IPEC. AIR_21 AIR 21. AIRSPEED AIRSPEED. BERT BERT. BLUEDART BLUEDART. COLLECTPLUS COLLECTPLUS. COURIERPLUS COURIERPLUS. COURIER_POST COURIER POST. DHL_GLOBAL_MAIL dhl_global_mail. DPD_UK dpd_uk. DELTEC_DE DELTEC DE. DEUTSCHE_DE deutsche_de. DOTZOT DOTZOT. ELTA_GR elta_gr. EMS_CN ems_cn. ECARGO ECARGO. ENSENDA ENSENDA. FERCAM_IT fercam_it. FASTWAY_ZA fastway_za. FASTWAY_AU fastway_au. FIRST_LOGISITCS first_logisitcs. GEODIS GEODIS. GLOBEGISTICS GLOBEGISTICS. GREYHOUND GREYHOUND. JETSHIP_MY jetship_my. LION_PARCEL LION PARCEL. AEROFLASH AEROFLASH. ONTRAC ONTRAC. SAGAWA SAGAWA. SIODEMKA SIODEMKA. STARTRACK startrack. TNT_AU tnt_au. TNT_IT tnt_it. TRANSMISSION TRANSMISSION. YAMATO YAMATO. DHL_IT dhl_it. DHL_AT dhl_at. LOGISTICSWORLDWIDE_KR LOGISTICSWORLDWIDE KR. GLS_SPAIN gls_spain. AMAZON_UK_API amazon_uk_api. DPD_FR_REFERENCE dpd_fr_reference. DHLPARCEL_UK dhlparcel_uk. MEGASAVE megasave. QUALITYPOST qualitypost. IDS_LOGISTICS ids_logistics. JOYINGBOX joyingbox. PANTHER_ORDER_NUMBER panther_order_number. WATKINS_SHEPARD watkins_shepard. FASTTRACK fasttrack. UP_EXPRESS up_express. ELOGISTICA elogistica. ECOURIER ecourier. CJ_PHILIPPINES cj_philippines. SPEEDEX speedex. ORANGECONNEX orangeconnex. TECOR tecor. SAEE saee. GLS_ITALY_FTP gls_italy_ftp. DELIVERE delivere. YYCOM yycom. ADICIONAL_PT Adicional Logistics. DKSH DKSH. NIPPON_EXPRESS_FTP Nippon Express. GOLS GO Logistics & Storage. FUJEXP FUJIE EXPRESS. QTRACK QTrack. OMLOGISTICS_API OM LOGISTICS LTD. GDPHARM GDPharm Logistics. MISUMI_CN MISUMI Group Inc.. AIR_CANADA Rivo. CITY56_WEBHOOK City Express. SAGAWA_API Sagawa. KEDAEX KedaEX. PGEON_API Pgeon. WEWORLDEXPRESS We World Express. JT_LOGISTICS J&T International logistics. TRUSK Trusk France. VIAXPRESS ViaXpress. DHL_SUPPLYCHAIN_ID DHL Supply Chain Indonesia. ZUELLIGPHARMA_SFTP Zuellig Pharma Korea. MEEST Meest. TOLL_PRIORITY Toll Priority. MOTHERSHIP_API Mothership. CAPITAL Capital Transport. EUROPAKET_API Europacket+. HFD HFD. TOURLINE_REFERENCE Tourline Express. GIO_ECOURIER GIO Express Inc. CN_LOGISTICS CN Logistics. PANDION Pandion. BPOST_API Bpost API. PASSPORTSHIPPING Passport Shipping. PAKAJO Pakajo World. DACHSER DACHSER. YUSEN_SFTP Yusen Logistics. SHYPLITE Shypmax. XYY Xingyunyi Logistics. MWD Metropolitan Warehouse & Delivery. FAXECARGO Faxe Cargo. MAZET Groupe Mazet. FIRST_LOGISTICS_API First Logistics. SPRINT_PACK SPRINT PACK. HERMES_DE_FTP Hermes Germany. CONCISE Concise. KERRY_EXPRESS_TW_API Kerry Express TaiWan. EWE EWE Global Express. FASTDESPATCH Fast Despatch Logistics Limited. ABCUSTOM_SFTP AB Custom Group. CHAZKI Chazki. SHIPPIE Shippie. GEODIS_API GEODIS - Distribution & Express. NAQEL_EXPRESS Naqel Express. PAPA_WEBHOOK Papa. FORWARDAIR Forward Air. DIALOGO_LOGISTICA_API Dialogo Logistica. LALAMOVE_API Lalamove. TOMYDOOR Tomydoor. KRONOS_WEBHOOK Kronos Express. JTCARGO J&T CARGO. T_CAT T-cat. CONCISE_WEBHOOK Concise. TELEPORT_WEBHOOK Teleport. CUSTOMCO_API The Custom Companies. SPX_TH Shopee Xpress. BOLLORE_LOGISTICS Bollore Logistics. CLICKLINK_SFTP ClickLink. M3LOGISTICS M3 Logistics. VNPOST_API Vietnam Post. AXLEHIRE_FTP Axlehire. SHADOWFAX Shadowfax. MYHERMES_UK_API EVRi. DAIICHI Daiichi Freight System Inc. MENSAJEROSURBANOS_API Mensajeros Urbanos. POLARSPEED PolarSpeed Inc. IDEXPRESS_ID iDexpress Indonesia. PAYO Payo. WHISTL_SFTP Whistl. INTEX_DE INTEX Paketdienst GmbH. TRANS2U Trans2u. PRODUCTCAREGROUP_SFTP Product Care Services Limited. BIGSMART Big Smart. EXPEDITORS_API_REF Expeditors API Reference. AITWORLDWIDE_API AIT. WORLDCOURIER World Courier. QUIQUP Quiqup. AGEDISS_SFTP Agediss. ANDREANI_API Andreani. CRLEXPRESS CRL Express. SMARTCAT SMARTCAT. CROSSFLIGHT Crossflight Limited. PROCARRIER Pro Carrier. DHL_REFERENCE_API DHL (Reference number). SEINO_API Seino. WSPEXPRESS WSP Express. KRONOS Kronos Express. TOTAL_EXPRESS_API Total Express. PARCLL PARCLL. XPEDIGO Xpedigo. STAR_TRACK_WEBHOOK StarTrack. GPOST Georgian Post. UCS UCS. DMFGROUP DMF. COORDINADORA_API Coordinadora. MARKEN Marken. NTL NTL logistics. REDJEPAKKETJE Red je Pakketje. ALLIED_EXPRESS_FTP Allied Express (FTP). MONDIALRELAY_ES Mondial Relay Spain(Punto Pack). NAEKO_FTP Naeko Logistics. MHI Mhi. SHIPPIFY Shippify, Inc. MALCA_AMIT_API Malca Amit. JTEXPRESS_SG_API J&T Express Singapore. DACHSER_WEB DACHSER. FLIGHTLG Flight Logistics Group. CAGO Cago. COM1EXPRESS ComOne Express. TONAMI_FTP Tonami. PACKFLEET PACKFLEET. PUROLATOR_INTERNATIONAL Purolator International. WINESHIPPING_WEBHOOK Wineshipping. DHL_ES_SFTP DHL Spain Domestic. PCHOME_API 網家速配股份有限公司. CESKAPOSTA_API Czech Post. GORUSH Go Rush. HOMERUNNER HomeRunner. AMAZON_ORDER Amazon order. EFWNOW_API Estes Forwarding Worldwide. CBL_LOGISTICA_API CBL Logistica (API). NIMBUSPOST NimbusPost. LOGWIN_LOGISTICS Logwin Logistics. NOWLOG_API Sequoialog. DPD_NL DPD Netherlands. GODEPENDABLE Dependable Supply Chain Services. ESDEX Top Ideal Express. LOGISYSTEMS_SFTP Kiitäjät. EXPEDITORS Expeditors. SNTGLOBAL_API Snt Global Etrax. SHIPX ShipX. QINTL_API Quickstat Courier LLC. PACKS Packs. POSTNL_INTERNATIONAL PostNL International. AMAZON_EMAIL_PUSH Amazon. DHL_API DHL. SPX Shopee Express. AXLEHIRE AxleHire. ICSCOURIER ICS COURIER. DIALOGO_LOGISTICA Dialogo Logistica. SHUNBANG_EXPRESS ShunBang Express. TCS_API TCS. SF_EXPRESS_CN SF Express China. PACKETA Packeta. SIC_TELIWAY Teliway SIC Express. MONDIALRELAY_FR Mondial Relay France. INTIME_FTP InTime. JD_EXPRESS 京东物流. FASTBOX Fastbox. PATHEON Patheon Logistics. INDIA_POST India Post Domestic. TIPSA_REF Tipsa Reference. ECOFREIGHT Eco Freight. VOX VOX SOLUCION EMPRESARIAL SRL. DIRECTFREIGHT_AU_REF Direct Freight Express. BESTTRANSPORT_SFTP Best Transport. AUSTRALIA_POST_API Australia Post. FRAGILEPAK_SFTP FragilePAK. FLIPXP FlipXpress. VALUE_WEBHOOK Value Logistics. DAESHIN Daeshin. SHERPA Sherpa. MWD_API Metropolitan Warehouse & Delivery. SMARTKARGO SmartKargo. DNJ_EXPRESS DNJ Express. GOPEOPLE Go People. MYSENDLE_API mySendle. ARAMEX_API Aramex. PIDGE Pidge. THAIPARCELS TP Logistic. PANTHER_REFERENCE_API Panther Reference. POSTAPLUS Posta Plus. BUFFALO BUFFALO. U_ENVIOS U-ENVIOS. ELITE_CO Elite Express. ROCHE_INTERNAL_SFTP Roche Internal Courier. DBSCHENKER_ICELAND DB Schenker Iceland. TNT_FR_REFERENCE TNT France Reference. NEWGISTICSAPI Newgistics API. GLOVO Glovo. GWLOGIS_API G.I.G. SPREETAIL_API Spreetail. MOOVA Moova. PLYCONGROUP Plycon Transportation Group. USPS_WEBHOOK USPS Informed Visibility - Webhook. REIMAGINEDELIVERY maergo. EDF_FTP Eurodifarm. DAO365 DAO365. BIOCAIR_FTP BioCair. RANSA_WEBHOOK Ransa. SHIPXPRES SHIPXPRESS. COURANT_PLUS_API Courant Plus. SHIPA SHIPA. HOMELOGISTICS Home Logistics. DX DX. POSTE_ITALIANE_PACCOCELERE Poste Italiane Paccocelere. TOLL_WEBHOOK Toll Group. LCTBR_API LCT do Brasil. DX_FREIGHT DX Freight. DHL_SFTP DHL Express. SHIPROCKET Shiprocket X. UBER_WEBHOOK Uber. STATOVERNIGHT Stat Overnight. BURD Burd Delivery. FASTSHIP Fastship Express. IBVENTURE_WEBHOOK IB Venture. GATI_KWE_API Gati-KWE. CRYOPDP_FTP CryoPDP. HUBBED HUBBED. TIPSA_API Tipsa API. ARASKARGO Aras Cargo. THIJS_NL Thijs Logistiek. ATSHEALTHCARE_REFERENCE ATS Healthcare. 99MINUTOS 99minutos. HELLENIC_POST Hellenic (Greece) Post. HSM_GLOBAL HSM Global. MNX MNX. NMTRANSFER N&M Transfer Co., Inc.. LOGYSTO Logysto. INDIA_POST_INT India Post International. AMAZON_FBA_SWISHIP_IN Swiship IN. SRT_TRANSPORT SRT Transport. BOMI Bomi Group. DELIVERR_SFTP Deliverr. HSDEXPRESS HSDEXPRESS. SIMPLETIRE_WEBHOOK SimpleTire. HUNTER_EXPRESS_SFTP Hunter Express. UPS_API UPS. WOOYOUNG_LOGISTICS_SFTP WOO YOUNG LOGISTICS CO.,LTD.. PHSE_API PHSE. WISH_EMAIL_PUSH Wish. NORTHLINE Northline. MEDAFRICA Med Africa Logistics. DPD_AT_SFTP DPD Austria. ANTERAJA Anteraja. DHL_GLOBAL_FORWARDING_API DHL Global Forwarding API. LBCEXPRESS_API LBC EXPRESS INC.. SIMSGLOBAL Sims Global. CDLDELIVERS CDL Last Mile. TYP TYP. TESTING_COURIER_WEBHOOK Testing Courier. PANDAGO_API Pandago. ROYAL_MAIL_FTP Royal Mail. THUNDEREXPRESS Thunder Express Australia. SECRETLAB_WEBHOOK Secretlab. SETEL Setel Express. JD_WORLDWIDE JD Worldwide. DPD_RU_API DPD Russia. ARGENTS_WEBHOOK Argents Express Group. POSTONE Post ONE. TUSKLOGISTICS Tusk Logistics. RHENUS_UK_API Rhenus Logistics UK. TAQBIN_SG_API Yamato Singapore. INNTRALOG_SFTP Inntralog GmbH. DAYROSS Day & Ross. CORREOSEXPRESS_API Correos Express (API). INTERNATIONAL_SEUR_API International Seur API. YODEL_API Yodel API. HEROEXPRESS Hero Express. DHL_SUPPLYCHAIN_IN DHL supply chain India. URGENT_CARGUS Urgent Cargus. FRONTDOORCORP FRONTdoor Collective. JTEXPRESS_PH J&T Express Philippines. PARCELSTARS_WEBHOOK Parcelstars. DPD_SK_SFTP DPD Slovakia. MOVIANTO Movianto. OZEPARTS_SHIPPING Ozeparts Shipping. KARGOMKOLAY KargomKolay (CargoMini). TRUNKRS Trunkrs. OMNIRPS_WEBHOOK Omni Returns. CHILEXPRESS Chile Express. TESTING_COURIER Testing Courier. JNE_API JNE (API). BJSHOMEDELIVERY_FTP BJS Distribution, Storage & Couriers - FTP. DEXPRESS_WEBHOOK D Express. USPS_API USPS API. TRANSVIRTUAL TransVirtual. SOLISTICA_API solistica. CHIENVENTURE_WEBHOOK Chienventure. DPD_UK_SFTP DPD UK. INPOST_UK InPost. JAVIT Javit. ZTO_DOMESTIC ZTO Express China. DHL_GT_API DHL Global Forwarding Guatemala. CEVA_TRACKING CEVA Package. KOMON_EXPRESS Komon Express. EASTWESTCOURIER_FTP East West Courier Pte Ltd. DANNIAO Danniao. SPECTRAN Spectran. DELIVER_IT Deliver-iT. RELAISCOLIS Relais Colis. GLS_SPAIN_API GLS Spain. POSTPLUS PostPlus. AIRTERRA Airterra. GIO_ECOURIER_API GIO Express Ecourier. DPD_CH_SFTP DPD Switzerland. FEDEX_API FedEx®. INTERSMARTTRANS INTERSMARTTRANS & SOLUTIONS SL. HERMES_UK_SFTP Hermes UK. EXELOT_FTP Exelot Ltd.. DHL_PA_API DHL GLOBAL FORWARDING PANAMÁ. VIRTRANSPORT_SFTP Vir Transport. WORLDNET Worldnet Logistics. INSTABOX_WEBHOOK Instabox. KNG Keuhne + Nagel Global. FLASHEXPRESS_WEBHOOK Flash Express. MAGYAR_POSTA_API Magyar Posta. WESHIP_API WeShip. OHI_WEBHOOK Ohi. MUDITA MUDITA. BLUEDART_API Bluedart. T_CAT_API T-cat. ADS ADS Express. HERMES_IT HR Parcel. FITZMARK_API FitzMark. POSTI_API Posti API. SMSA_EXPRESS_WEBHOOK SMSA Express. TAMERGROUP_WEBHOOK Tamer Logistics. LIVRAPIDE Livrapide. NIPPON_EXPRESS Nippon Express. BETTERTRUCKS Better Trucks. FAN FAN COURIER EXPRESS. PB_USPSFLATS_FTP USPS Flats (Pitney Bowes). PARCELRIGHT Parcel Right. ITHINKLOGISTICS iThink Logistics. KERRY_EXPRESS_TH_WEBHOOK Kerry Logistics. ECOUTIER eCoutier. SHOWL SENHONG INTERNATIONAL LOGISTICS. BRT_IT_API BRT Bartolini API. RIXONHK_API Rixon Logistics. DBSCHENKER_API DB Schenker. ILYANGLOGIS Ilyang logistics. MAIL_BOX_ETC Mail Boxes Etc.. WESHIP WeShip. DHL_GLOBAL_MAIL_API DHL eCommerce Solutions. ACTIVOS24_API Activos24. ATSHEALTHCARE ATS Healthcare. LUWJISTIK Luwjistik. GW_WORLD Gebrüder Weiss. FAIRSENDEN_API fairsenden. SERVIP_WEBHOOK SerVIP. SWISHIP Swiship. TANET Transport Ambientales. HOTSIN_CARGO SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD. DIREX Direx. HUANTONG HuanTong. IMILE_API iMile. AUEXPRESS Au Express. NYTLOGISTICS NYT SUPPLY CHAIN LOGISTICS Co.,LTD. DSV_REFERENCE DSV Futurewave. NOVOFARMA_WEBHOOK Novofarma. AITWORLDWIDE_SFTP AIT. SHOPOLIVE Olive. FNF_ZA Fast & Furious. DHL_ECOMMERCE_GC DHL eCommerce Greater China. FETCHR Fetchr. STARLINKS_API Starlinks Global. YYEXPRESS YYEXPRESS. SERVIENTREGA Servientrega. HANJIN HanJin. SPANISH_SEUR_FTP Spanish Seur. DX_B2B_CONNUM DX (B2B). HELTHJEM_API Helthjem. INEXPOST Inexpost. A2B_BA A2B Express Logistics. RHENUS_GROUP Rhenus Logistics. SBERLOGISTICS_RU Sber Logistics. MALCA_AMIT Malca-Amit. PPL Professional Parcel Logistics. OSM_WORLDWIDE_SFTP OSM Worldwide. ACILOGISTIX ACI Logistix. OPTIMACOURIER Optima Courier. NOVA_POSHTA_API Nova Poshta API. LOGGI Loggi. YIFAN YiFan Express. MYDYNALOGIC My DynaLogic. MORNINGLOBAL Morning Global. CONCISE_API Concise. FXTRAN Falcon Express. DELIVERYOURPARCEL_ZA Deliver Your Parcel. UPARCEL uParcel. MOBI_BR Mobi Logistica. LOGINEXT_WEBHOOK T&W Delivery. EMS EMS. SPEEDY Speedy. ZOOM_RED Zoom. NAVLUNGO Navlungo. CASTLEPARCELS Castle Parcels. WEEE Weee. PACKALY Packaly. YUNHUIPOST Yunhuipost. YOUPARCEL YouParcel. LEMAN Leman. MOOVIN Moovin. URB_IT Urb-it. MULTIENTREGAPANAMA Multientrega. JUSDASR Jusdasr. DISCOUNTPOST Discount Post. RHENUS_UK Rhenus Logistics UK. SWISHIP_JP Swiship JP. GLS_US GLS USA. SMTL Southwestern Motor Transport. Inc. EMEGA Discount Post Emega. EXPRESSONE_SV EXPRESSONE Slovenia. HEPSIJET hepsiJET. WELIVERY Welivery. BRINGER Bringer Parcel Services. EASYROUTES EasyRoutes. MRW MRW. RPM RPM. DPD_PRT DPD Portugal. GLS_ROMANIA GLS Romania. LMPARCEL LM Parcel. GTAGSM GTA GSM. DOMINO DOMINO. ESHIPPER eShipper. TRANSPAK Transpak Inc.. XINDUS Xindus. AOYUE Aoyue. EASYPARCEL Easyparcel. EXPRESSONE EXPRESSONE. SENDEO_KARGO Sendeo Kargo. SPEEDAF Speedaf Express. ETOWER eTower. GCX GC Express. NINJAVAN_VN Ninjavan Vietnam. ALLEGRO Allegro. JUMPPOINT Jumppoint. SHIPGLOBAL_US ShipGlobal. KINISI Kinisi Transport Pty Ltd. OAKH Oakh Harbour Freight Lines. AWEST American West. BARSAN Barsan Global Lojistik. ENERGOLOGISTIC Energo Logistic. MADROOEX Madrooex. GOBOLT GoBolt. SWISS_UNIVERSAL_EXPRESS Swiss Universal Express. IORDIRECT IOR Direct Solutions. XMSZM xmszm. GLS_HUN GLS Hungary. SENDY Sendy Express. BRAUNSEXPRESS Brauns Express. GRANDSLAMEXPRESS Grand Slam Express. XGS XGS. OTSCHILE OTS. PACK_UP Pack-Up. PARCELSTARS Parcelstars. TEAMEXPRESSLLC Team Express Service LLC. ASYADEXPRESS Asyad Express. TDN TDN. EARLYBIRD Early Bird. CACESA Cacesa. PARCELJET Parceljet. MNG_KARGO MNG Kargo. SUPERPACKLINE Super Pac Line. SPEEDX SpeedX. VESYL Vesyl. SKYKING Sky King. DIRMENSAJERIA DIR. NETLOGIXGROUP Netlogix. ZYOU ZYEX. JAWAR Jawar. AGSYSTEMS Associate Global Systems. GPS GPS. PTT_KARGO PTT Kargo. MAERGO Maergo. ARIHANTCOURIER AICS. VTFE VicTas Freight Express. YUNANT Yunant. URBIFY Urbify. PACK_MAN pack-man. LIEFERGRUN LIEFERGRUN. OBIBOX Obibox. PAIKEDA Paikeda. SCOTTY Scotty. INTELCOM_CA Intelcom. SWE swe. ASENDIA Asendia Global. DPD_AT DPD Austria. RELAY Relay. ATA ATA. SKYEXPRESS_INTERNATIONAL SkyExpress Internationals. SURAT_KARGO Surat Kargo. SGLINK SG LINK. FLEETOPTICSINC FleetOptics. SHOPLINE shopline. PIGGYSHIP PIGGYSHIP. LOGOIX LogoiX. KOLAY_GELSIN Kolay Gelsin. ASSOCIATED_COURIERS Associated Couriers. UPS_CHECKER ups-checker. WINESHIPPING Wineshipping. SPEDISCI Spedisci online. FOURKITES Fourkites. ETONAS Etonas. FINMILE Fin Mile. UNIUNI Uniuni. RODONAVES Rodonaves. INPOST_IT Inpost Italy. TFORCE_FREIGHT Tforce Freight. RICHMOM Rich Mom. FRANCO Corriere Franco. ECPARCEL Ecparcel. FEDEX_CHINA Fedex China. GOFO_EXPRESS Gofo Express. SHIPBOB Shipbob. JERSEYPOST_ATLAS Jersey Post Group. CORETRAILS Coretrails. RHENUS_ITALY Rhenus Logistics Italy. JADLOG Jadlog. JITSU Jitsu. YANWEN_EXPRESS Yanwen Express. DASHLINK Dashlink. SEINO_SUPER_EXPRESS Seino Super Express. FLOSHIP Floship. METROSCG Metro Supply Chain. SENDPARCEL Sendparcel. P2P P2p. CN_EXPRESS Cn Express. CIRROTRACK Cirro Track. LAND_LOGISTICS Land Logistics. VEHO Veho. MEDLINE Medline. VDTRACK Vdtrack. SINO_SCM Sino Scm. 3PE_EXPRESS 3pe Express. SWIFTX Swiftx. SFYDEXPRESS Sfyd Express. TOPTRANS Toptrans. capture_id required string [ 1 .. 50 ] characters The PayPal capture ID.
notify_payer
boolean
Default: false
If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for notify_payer, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.
items
Array of objects
An array of details of items in the shipment.
Responses 200A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows tracker details. 201A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows tracker details. If a duplicate response is retried, returns the HTTP 200 OK status code. 400Request is not well-formed, syntactically incorrect, or violates schema. 403Authorization failed due to insufficient permissions. 422The requested action could not be performed, semantically incorrect, or failed business validation. 500An internal server error has occurred. Request samples cURL
application/json application/json
Sample 1 - 201 - Add Tracking to Order - Carrier Information and Items Breakdown Sample 1 - 201 - Add Tracking to Order - Carrier Information and Items Breakdown Copy curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/track \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer 6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \ -d '{ "capture_id": "8MC585209K746392H", "tracking_number": "443844607820", "carrier": "FEDEX", "notify_payer": false, "items": [ { "name": "T-Shirt", "sku": "sku02", "quantity": "1", "upc": { "type": "UPC-A", "code": "upc001" }, "image_url": "https://www.example.com/example.jpg", "url": "https://www.example.com/example" } ] }' Response samples 200 201 400 403 422
1 more 1 more application/json
Sample 1 - 201 - Add Tracking to Order - Carrier Information and Items Breakdown Sample 1 - 201 - Add Tracking to Order - Carrier Information and Items Breakdown CopyExpand allCollapse all { "id": "5O190127TN364715T", "status": "COMPLETED", "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "items": [ { "name": "Air Jordan Shoe", "sku": "sku01", "quantity": "1" }, { "name": "T-Shirt", "sku": "sku02", "quantity": "1" } ], "shipping": { "trackers": [ { "id": "8MC585209K746392H-443844607820", "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "up", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820", "rel": "update", "method": "PATCH" } ], "create_time": "2022-08-12T21:20:49Z", "update_time": "2022-08-12T21:20:49Z" } ] }, "payments": { "captures": [ { "id": "8MC585209K746392H", "status": "COMPLETED", "amount": { "currency_code": "USD", "value": "100.00" }, "seller_protection": { "status": "NOT_ELIGIBLE" }, "final_capture": true, "seller_receivable_breakdown": { "gross_amount": { "currency_code": "USD", "value": "100.00" }, "paypal_fee": { "currency_code": "USD", "value": "3.00" }, "net_amount": { "currency_code": "USD", "value": "97.00" } }, "create_time": "2018-04-01T21:20:49Z", "update_time": "2018-04-01T21:20:49Z", "links": [ { "href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H", "rel": "self", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund", "rel": "refund", "method": "POST" } ] } ] } } ], "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" } ] } Update or cancel tracking information for an order patch /v2/checkout/orders/{id}/trackers/{tracker_id} Try it Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:
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.
Security
Oauth2
Request
path Parameters
id
required
string [ 1 .. 36 ] characters
The ID of the order that the tracking information is associated with.
tracker_id required string [ 1 .. 36 ] characters The order tracking ID.
header Parameters
PayPal-Auth-Assertion
string
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Request Body schema: application/json Array ([ 0 .. 32767 ] items) op required string The operation.
Enum Value Description
add Depending on the target location reference, completes one of these functions:
The target location is an array index. Inserts a new value into the array at the specified index.
The target location is an object parameter that does not already exist. Adds a new parameter to the object.
The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.
remove Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.
replace Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.
move Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.
copy Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.
test Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
Type Considered equal if both values
strings Contain the same number of Unicode characters and their code points are byte-by-byte equal.
numbers Are numerically equal.
arrays Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objects Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null) Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.
path
string
The JSON Pointer to the target document location at which to complete the operation.
value
any
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.
Responses 204A successful request returns the HTTP 204 No Content status code with an empty object in the JSON response body. 400Request is not well-formed, syntactically incorrect, or violates schema. 403Authorization failed due to insufficient permissions. 404The specified resource does not exist. 422The requested action could not be performed, semantically incorrect, or failed business validation. 500An internal server error has occurred. Request samples cURL
Sample 1 - 204 - Patch Tracking Information - Replace the Status of the Tracker. Sample 1 - 204 - Patch Tracking Information - Replace the Status of the Tracker. Copy curl -v -X PATCH https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820 \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer 6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \ -d '[ { "op": "replace", "path": "/status", "value": "CANCELLED" } ]' Response samples 204 400 403 404 422
1 more 1 more application/json
Sample 1 - 204 - Patch Tracking Information - Replace the Status of the Tracker. Sample 1 - 204 - Patch Tracking Information - Replace the Status of the Tracker. Copy { } Receive updated order information via callback URL post /v2/checkout/orders/order-update-callback Try it The documentation for this 'endpoint' is different from the other endpoints under v2 Orders. For this endpoint the role of client and server is reversed. The client sending the request is PayPal, and the server sending the response is the merchant. In the request, PayPal will send the buyer's redacted shipping address and selected shipping option to the callback URL defined the create order request. The response from the merchant will update the Orders resource.
Request Request Body schema: application/json application/json purchase_units required Array of objects = 1 items An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
shipping_address
object
Redacted shipping address to be used for shipping options and tax calculations.
shipping_option object Buyer selected shipping option.
Responses 200The callback to merchant was successful. Request samples cURL
application/json application/json
Sample 1 - 200 - Discount Code Callback Request - Adding a Discount Code - No Address Sample 1 - 200 - Discount Code Callback Request - Adding a Discount Code - No Address Copy curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/order-update-callback \ -H 'Content-Type: application/json' \ -H 'Content-Language: en_US' \ -d '{ "id": "5O190127TN364715T", "discounts": [ { "operation": "ADD", "code": "SUMMER_SALE" } ], "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "amount": { "currency_code": "USD", "value": "100.00", "breakdown": { "item_total": { "currency_code": "USD", "value": "90.00" }, "tax_total": { "currency_code": "USD", "value": "10.00" }, "shipping": { "currency_code": "USD", "value": "0.00" } } }, "items": [ { "name": "E-book", "description": "Digital E-book", "sku": "sku01", "unit_amount": { "currency_code": "USD", "value": "90.00" }, "tax": { "currency_code": "USD", "value": "10.00" }, "quantity": "1", "category": "DIGITAL_GOODS" } ] } ] }' Response samples 200 application/json
Sample 1 - 200 - Discount Code Callback Request - Adding a Discount Code - No Address Sample 1 - 200 - Discount Code Callback Request - Adding a Discount Code - No Address CopyExpand allCollapse all { "id": "5O190127TN364715T", "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "amount": { "currency_code": "USD", "value": "90.00", "breakdown": { "item_total": { "currency_code": "USD", "value": "90.00" }, "tax_total": { "currency_code": "USD", "value": "10.00" }, "shipping": { "currency_code": "USD", "value": "0.00" }, "discount": { "currency_code": "USD", "value": "10.00", "breakdown": [ { "value": "10.00", "currency_code": "USD", "discount_code": "SUMMER_SALE", "description": "$10 off for summer sale" } ] } } }, "items": [ { "name": "E-book", "description": "Digital E-book", "sku": "sku01", "unit_amount": { "currency_code": "USD", "value": "90.00" }, "tax": { "currency_code": "USD", "value": "10.00" }, "quantity": "1", "category": "DIGITAL_GOODS" } ] } ] } Definitions account_id The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
string (account_id) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
Copy "stringstrings" activity_timestamps The date and time stamps that are common to authorized payment, captured payment, and refund transactions.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
Copy { "create_time": "string", "update_time": "string" } altpay_customer Alternative Payment Method (APM) customer information.
merchant_customer_id
string [ 1 .. 64 ] characters
Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to get the ID of the merchant's customer.
Copy { "merchant_customer_id": "string" } amount_breakdown The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
item_total
object
The subtotal for all items. Required if the request includes purchase_units[].items[].unit_amount. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.
shipping
object
The shipping fee for all items within a given purchase_unit. shipping.value can not be a negative number.
handling
object
The handling fee for all items within a given purchase_unit. handling.value can not be a negative number.
tax_total
object
The total tax for all items. Required if the request includes purchase_units.items.tax. Must equal the sum of (items[].tax * items[].quantity) for all items. tax_total.value can not be a negative number.
insurance
object
The insurance fee for all items within a given purchase_unit. insurance.value can not be a negative number.
shipping_discount
object
The shipping discount for all items within a given purchase_unit. shipping_discount.value can not be a negative number.
discount
object
The discount for all items within a given purchase_unit. discount.value can not be a negative number.
CopyExpand allCollapse all { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } amount_with_breakdown The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
currency_code required string = 3 characters The three-character ISO-4217 currency code that identifies the currency.
value required string <= 32 characters The value, which might be:
An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.
For the required number of decimal places for a currency code, see Currency Codes.
breakdown
object
The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
CopyExpand allCollapse all { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } } APM Authentication Method Enumeration of authentication methods for payment approval.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "REDIRECT" Enumeration of authentication methods for payment approval.
Enum Value Description REDIRECT Browser-based redirection flow where the payer is taken to a dedicated page. CODE_VERIFICATION Code is presented to the payer as a method of authentication. APP_NOTIFICATION Payer receives a push notification on their mobile device prompting them to authenticate the payment within their banking or payment app. Copy "REDIRECT" App Switch Preferences on Native App Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.
os_type string [ 1 .. 7 ] characters Operating System type of the device that the buyer is using.
Enum Value Description
ANDROID Google Android OS.
IOS Apple OS typically found in Apple mobile devices.
OTHER Any other OS type.
os_version
string [ 1 .. 64 ] characters
Operating System version of the device that the buyer is using.
Copy { "os_type": "ANDROID", "os_version": "string" } apple_pay Information needed to pay using ApplePay.
id
string [ 1 .. 250 ] characters
ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
token
string [ 1 .. 10000 ] characters
Encrypted ApplePay token, containing card information. This token would be base64encoded. The pattern is defined by an external party and supports Unicode.
stored_credential
object
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.
name
string [ 3 .. 300 ] characters
Name on the wallet.
email_address
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with this payment method.
phone_number
object
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.
card
object
The payment card information.
attributes
object
Additional attributes associated with apple pay.
CopyExpand allCollapse all { "id": "string", "token": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" }, "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "country_code": "string" }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "name": { "given_name": "string", "surname": "string" } } } } } apple_pay_attributes Additional attributes associated with apple pay.
customer
object
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
vault
object
Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.
CopyExpand allCollapse all { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } } apple_pay_attributes_response Additional attributes associated with the use of Apple Pay.
vault
object
The details about a saved payment source.
CopyExpand allCollapse all { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "name": { "given_name": "string", "surname": "string" } } } } apple_pay_card_response The Card from Apple Pay Wallet used to fund the payment.
name
string [ 2 .. 300 ] characters
The card holder's name as it appears on the card.
last_digits string The last digits of the payment card.
available_networks
Array of strings [ 1 .. 256 ] items
Array of brands or networks associated with the card.
Items Enum Value Description
VISA Visa card.
MASTERCARD Mastercard card.
DISCOVER Discover card.
AMEX American Express card.
SOLO Solo debit card.
JCB Japan Credit Bureau card.
STAR Military Star card.
DELTA Delta Airlines card.
SWITCH Switch credit card.
MAESTRO Maestro credit card.
CB_NATIONALE Carte Bancaire (CB) credit card.
CONFIGOGA Configoga credit card.
CONFIDIS Confidis credit card.
ELECTRON Visa Electron credit card.
CETELEM Cetelem credit card.
CHINA_UNION_PAY China union pay credit card.
DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO The Brazilian Elo card payment network.
HIPER The Hiper - Ingenico ePayment network.
HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY The RuPay payment network.
GE The GE Credit Union 3Point card payment network.
SYNCHRONY The Synchrony Financial (SYF) payment network.
EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
CARTE_BANCAIRE The Carte Bancaire payment network.
STAR_ACCESS The Star Access payment network.
PULSE The Pulse payment network.
NYCE The NYCE payment network.
ACCEL The Accel payment network.
UNKNOWN UNKNOWN payment network.
from_request
object
Representation of card details as received in the request.
stored_credential
object
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.
brand
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description
VISA Visa card.
MASTERCARD Mastercard card.
DISCOVER Discover card.
AMEX American Express card.
SOLO Solo debit card.
JCB Japan Credit Bureau card.
STAR Military Star card.
DELTA Delta Airlines card.
SWITCH Switch credit card.
MAESTRO Maestro credit card.
CB_NATIONALE Carte Bancaire (CB) credit card.
CONFIGOGA Configoga credit card.
CONFIDIS Confidis credit card.
ELECTRON Visa Electron credit card.
CETELEM Cetelem credit card.
CHINA_UNION_PAY China union pay credit card.
DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO The Brazilian Elo card payment network.
HIPER The Hiper - Ingenico ePayment network.
HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY The RuPay payment network.
GE The GE Credit Union 3Point card payment network.
SYNCHRONY The Synchrony Financial (SYF) payment network.
EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
CARTE_BANCAIRE The Carte Bancaire payment network.
STAR_ACCESS The Star Access payment network.
PULSE The Pulse payment network.
NYCE The NYCE payment network.
ACCEL The Accel payment network.
UNKNOWN UNKNOWN payment network.
type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.
Enum Value Description
CREDIT A credit card.
DEBIT A debit card.
PREPAID A Prepaid card.
STORE A store card.
UNKNOWN Card type cannot be determined.
authentication_result
object
Results of Authentication such as 3D Secure.
attributes
object
Additional attributes associated with the use of this card.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.
bin_details object Bank Identification Number (BIN) details used to fund a payment.
billing_address object The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. CopyExpand allCollapse all { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" }, "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "country_code": "string" } apple_pay_decrypted_token_data Information about the Payment data obtained by decrypting Apple Pay token.
device_manufacturer_id
string [ 1 .. 2000 ] characters
Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.
payment_data_type
string [ 1 .. 16 ] characters
Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.
Enum Value Description
3DSECURE The card was authenticated using 3D Secure (3DS) authentication scheme. While using this value make sure to populate cryptogram and eci_indicator as part of payment data..
EMV The card was authenticated using EMV method, which is applicable for China. While using this value make sure to pass emv_data and pin as part of payment data.
transaction_amount
object
The transaction amount for the payment that the payer has approved on apple platform.
tokenized_card required object Apple Pay tokenized credit card used to pay.
payment_data
object
Apple Pay payment data object which contains the cryptogram, eci_indicator and other data.
CopyExpand allCollapse all { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } } apple_pay_experience_context Customizes the payer experience during the approval process for the payment.
return_url required string The URL where the customer is redirected after the customer approves the payment.
cancel_url required string The URL where the customer is redirected after the customer cancels the payment.
Copy { "return_url": "string", "cancel_url": "string" } apple_pay_payment_data Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator.
cryptogram
string [ 1 .. 2000 ] characters
Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.
eci_indicator
string [ 1 .. 256 ] characters
ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.
emv_data
string [ 1 .. 2000 ] characters
Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.
pin string [ 1 .. 2000 ] characters Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.
Copy { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } apple_pay_request Information needed to pay using ApplePay.
id
string [ 1 .. 250 ] characters
ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
stored_credential
object
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.
attributes
object
Additional attributes associated with apple pay.
name
string [ 3 .. 300 ] characters
Name on the account holder associated with apple pay.
email_address
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with apple pay.
phone_number
object
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.
decrypted_token object The decrypted payload details for the apple pay token.
vault_id
string [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the saved apple pay payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } } application_context Customizes the payer experience during the approval process for the payment with PayPal.
Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.
brand_name
string [ 1 .. 127 ] characters
DEPRECATED. The label that overrides the business name in the PayPal account on the PayPal site. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.brand_name). Please specify this field in the experience_context object instead of the application_context object.
landing_page
string [ 1 .. 13 ] characters ^[0-9A-Z_]+$
Default: "NO_PREFERENCE"
DEPRECATED. DEPRECATED. The type of landing page to show on the PayPal site for customer checkout. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.landing_page). Please specify this field in the experience_context object instead of the application_context object.
Enum Value Description LOGIN When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment. BILLING When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. NO_PREFERENCE When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal. shipping_preference string [ 1 .. 20 ] characters ^[0-9A-Z_]+$ Default: "GET_FROM_FILE" DEPRECATED. DEPRECATED. The shipping preference:
Displays the shipping address to the customer. Enables the customer to choose an address on the PayPal site. Restricts the customer from changing the address during the payment-approval process. . The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.shipping_preference). Please specify this field in the experience_context object instead of the application_context object. Enum Value Description GET_FROM_FILE Use the customer-provided shipping address on the PayPal site. NO_SHIPPING Redact the shipping address from the PayPal site. Recommended for digital goods. SET_PROVIDED_ADDRESS Use the merchant-provided address. The customer cannot change this address on the PayPal site. user_action string [ 1 .. 8 ] characters Default: "CONTINUE" DEPRECATED. Configures a Continue or Pay Now checkout flow. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.user_action). Please specify this field in the experience_context object instead of the application_context object.
Enum Value Description
CONTINUE After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.
PAY_NOW After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.
return_url
string
DEPRECATED. The URL where the customer is redirected after the customer approves the payment. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.return_url). Please specify this field in the experience_context object instead of the application_context object.
cancel_url
string
DEPRECATED. The URL where the customer is redirected after the customer cancels the payment. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.cancel_url). Please specify this field in the experience_context object instead of the application_context object.
locale
string [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern
DEPRECATED. The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.locale). Please specify this field in the experience_context object instead of the application_context object.
payment_method
object
DEPRECATED. The customer and merchant payment preferences. The fields in application_context are now available in the experience_context object under the payment_source which supports them (eg. payment_source.paypal.experience_context.payment_method_selected). Please specify this field in the experience_context object instead of the application_context object..
stored_payment_source
object
DEPRECATED. Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER. usage=FIRST is compatible only with payment_initiator=CUSTOMER. previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request. . The fields in stored_payment_source are now available in the stored_credential object under the payment_source which supports them (eg. payment_source.card.stored_credential.payment_initiator). Please specify this field in the payment_source object instead of the application_context object. CopyExpand allCollapse all { "brand_name": "string", "landing_page": "LOGIN", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "return_url": "http://example.com", "cancel_url": "http://example.com", "locale": "string", "payment_method": { "standard_entry_class_code": "TEL", "payee_preferred": "UNRESTRICTED" }, "stored_payment_source": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } } } assurance_details Information about cardholder possession validation and cardholder identification and verifications (ID&V).
account_verified
boolean
Default: false
If true, indicates that Cardholder possession validation has been performed on returned payment credential.
card_holder_authenticated
boolean
Default: false
If true, indicates that identification and verifications (ID&V) was performed on the returned payment credential.If false, the same risk-based authentication can be performed as you would for card transactions. This risk-based authentication can include, but not limited to, step-up with 3D Secure protocol if applicable.
Copy { "account_verified": false, "card_holder_authenticated": false } authentication_response Results of Authentication such as 3D Secure.
liability_shift string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Liability shift indicator. The outcome of the issuer's authentication.
Enum Value Description
NO Liability is with the merchant.
POSSIBLE Liability may shift to the card issuer.
UNKNOWN The authentication system is not available.
three_d_secure
object
Results of 3D Secure Authentication.
CopyExpand allCollapse all { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } } authorization The authorized payment transaction.
status
string
The status for the authorized payment.
Enum Value Description
CREATED The authorized payment is created. No captured payments have been made for this authorized payment.
CAPTURED The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.
DENIED PayPal cannot authorize funds for this authorized payment.
PARTIALLY_CAPTURED A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.
VOIDED The authorized payment was voided. No more captured payments can be made against this authorized payment.
PENDING The created authorization is in pending state. For more information, see status.details.
status_details
object
The details of the authorized order pending status.
id
string
The PayPal-generated ID for the authorized payment.
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
custom_id
string <= 255 characters
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
links
Array of objects
An array of related HATEOAS links.
amount
object
The amount for this authorized payment.
network_transaction_reference
object
Reference values used by the card network to identify a transaction.
seller_protection
object
The level of protection offered as defined by PayPal Seller Protection for Merchants.
expiration_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the authorized payment expires, in Internet date and time format.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
CopyExpand allCollapse all { "status": "CREATED", "status_details": { "reason": "PENDING_REVIEW" }, "id": "string", "invoice_id": "string", "custom_id": "string", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "string" ] }, "expiration_time": "string", "create_time": "string", "update_time": "string" } authorization_status The status fields and status details for an authorized payment.
status
string
The status for the authorized payment.
Enum Value Description
CREATED The authorized payment is created. No captured payments have been made for this authorized payment.
CAPTURED The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.
DENIED PayPal cannot authorize funds for this authorized payment.
PARTIALLY_CAPTURED A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.
VOIDED The authorized payment was voided. No more captured payments can be made against this authorized payment.
PENDING The created authorization is in pending state. For more information, see status.details.
status_details
object
The details of the authorized order pending status.
CopyExpand allCollapse all { "status": "CREATED", "status_details": { "reason": "PENDING_REVIEW" } } authorization_status_details The details of the authorized payment status.
reason
string [ 1 .. 64 ] characters ^[A-Z_]+$
The reason why the authorized status is PENDING.
Enum Value Description PENDING_REVIEW Authorization is pending manual review. DECLINED_BY_RISK_FRAUD_FILTERS Risk Filter set by the payee failed for the transaction. Copy { "reason": "PENDING_REVIEW" } authorization_with_additional_data The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods.
status
string
The status for the authorized payment.
Enum Value Description
CREATED The authorized payment is created. No captured payments have been made for this authorized payment.
CAPTURED The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.
DENIED PayPal cannot authorize funds for this authorized payment.
PARTIALLY_CAPTURED A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.
VOIDED The authorized payment was voided. No more captured payments can be made against this authorized payment.
PENDING The created authorization is in pending state. For more information, see status.details.
status_details
object
The details of the authorized order pending status.
id
string
The PayPal-generated ID for the authorized payment.
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
custom_id
string <= 255 characters
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
links
Array of objects
An array of related HATEOAS links.
amount
object
The amount for this authorized payment.
network_transaction_reference
object
Reference values used by the card network to identify a transaction.
seller_protection
object
The level of protection offered as defined by PayPal Seller Protection for Merchants.
expiration_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the authorized payment expires, in Internet date and time format.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
processor_response
object
The processor response information for payment requests, such as direct credit card transactions.
CopyExpand allCollapse all { "status": "CREATED", "status_details": { "reason": "PENDING_REVIEW" }, "id": "string", "invoice_id": "string", "custom_id": "string", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "string" ] }, "expiration_time": "string", "create_time": "string", "update_time": "string", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } bancontact Information used to pay Bancontact.
card_last_digits
string = 4 characters
The last digits of the card used to fund the Bancontact payment.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
iban_last_chars string [ 4 .. 34 ] characters ^.[a-zA-Z0-9]{4}.$ The last characters of the IBAN used to pay.
Copy { "card_last_digits": "stri", "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" } bancontact_request Information needed to pay using Bancontact.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } BIC The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
Copy "stringst" Billing Cycle The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle.
id
string [ 1 .. 128 ] characters Show pattern
The unique identifier for this billing cycle or recurring series.
current_period
boolean
Indicates if this period, with its subscription terms, is currently active.
billing_interval_unit
string [ 1 .. 24 ] characters
The billing interval unit for the billing cycle.
Enum Value Description
YEAR The billing interval for the billing cycle is a year.
MONTH The billing interval for the billing cycle is a month.
SEMIMONTH The billing interval for the billing cycle is half a month.
WEEK The billing interval for the billing cycle is a week.
DAY The billing interval for the billing cycle is a day.
billing_frequency
integer [ 1 .. 365 ]
Default: 1
The frequency, i.e. the number of billing interval units, at which the user is charged. E.g. - if the billing_interval_unit is DAY, with a billing_frequency of 2, the user is billed once every two days.
total_billing_cycles
integer [ 0 .. 999 ]
Default: 1
The number of billing cycles in the period. This is effectively the number of times the user will be charged in the period.
current_billing_cycle
integer [ 0 .. 999 ]
Indicates the index of the current billing cycle for the period. E.g. - a value of 3 would mean that its the third billing cycle for the period.
regular_period
boolean
Indicates if the period is a regular period. A regular period would have standard billing cycle terms, as opposed to some special terms that might be applicable for a trial or promotional period.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The create date and time for this billing cycle or recurring series.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The update date and time for this billing cycle or recurring series.
billing_amount
object
The amount that the user will be charged in each billing cycle.
shipping_amount object The shipping charges applicable for each cycle.
tax_amount
object
The tax amount applicable for each cycle.
CopyExpand allCollapse all { "id": "string", "current_period": true, "billing_interval_unit": "YEAR", "billing_frequency": 1, "total_billing_cycles": 1, "current_billing_cycle": 999, "regular_period": true, "create_time": "string", "update_time": "string", "billing_amount": { "currency_code": "str", "value": "string" }, "shipping_amount": { "currency_code": "str", "value": "string" }, "tax_amount": { "currency_code": "str", "value": "string" } } billing_agreement_id The PayPal billing agreement ID. References an approved recurring payment for goods or services.
string [ 2 .. 128 ] characters ^[a-zA-Z0-9-]+$ The PayPal billing agreement ID. References an approved recurring payment for goods or services.
Copy "string" billing_cycle The billing cycle providing details of the billing frequency, amount, duration and if the billing cycle is a free, discounted or regular billing cycle. The sequence of the billing cycle will be in the following order - free trial billing cycle(s), discounted trial billing cycle(s), regular billing cycle(s).
tenure_type required string [ 1 .. 24 ] characters The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.
Enum Value Description
REGULAR A regular billing cycle to identify recurring charges for the billing agreement.
TRIAL A trial billing cycle to identify free or discounted charge for the billing agreement. Free trails will not have a price object in pricing scheme where as a discounted trial would have a discounted price compared to regular billing cycle.
total_cycles
integer [ 0 .. 999 ]
Default: 1
The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).
sequence
integer [ 1 .. 3 ]
Default: 1
The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a sequence of 1 while a regular billing cycle has a sequence of 2, so that trial cycle runs before the regular cycle.
pricing_scheme
object
The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.
start_date
string = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern
The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date.
CopyExpand allCollapse all { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": "str", "value": "string" }, "reload_threshold_amount": { "currency_code": "str", "value": "string" } }, "start_date": "string" } bin_details Bank Identification Number (BIN) details used to fund a payment.
bin string [ 1 .. 25 ] characters The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card.
issuing_bank
string [ 1 .. 64 ] characters
The issuer of the card instrument.
products
Array of strings [ 1 .. 256 ] items
The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE.
bin_country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO-3166-1 country code of the bank.
CopyExpand allCollapse all { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" } blik Information used to pay using BLIK.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
email
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with this payment method.
one_click
object
The one-click integration flow object.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "email": "string", "one_click": { "consumer_reference": "string" } } blik_experience_context Customizes the payer experience during the approval process for the BLIK payment.
brand_name
string [ 1 .. 127 ] characters
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.
shipping_preference string [ 1 .. 24 ] characters Default: "GET_FROM_FILE" The location from which the shipping address is derived.
Enum Value Description
GET_FROM_FILE Get the customer-provided shipping address on the PayPal site.
NO_SHIPPING Redacts the shipping address from the PayPal site. Recommended for digital goods.
SET_PROVIDED_ADDRESS Merchant sends the shipping address using purchase_units.shipping.address. The customer cannot change this address on the PayPal site.
locale
string [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.
return_url
string
The URL where the customer is redirected after the customer approves the payment.
cancel_url
string
The URL where the customer is redirected after the customer cancels the payment.
consumer_user_agent string [ 1 .. 256 ] characters The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0).
consumer_ip string [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...Show pattern The IP address of the consumer. It could be either IPv4 or IPv6.
Copy { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string", "consumer_user_agent": "string", "consumer_ip": "string" } blik_level_0 Information used to pay using BLIK level_0 flow.
auth_code required string = 6 characters The 6-digit code used to authenticate a consumer within BLIK.
Copy { "auth_code": "string" } blik_one_click Information used to pay using BLIK one-click flow.
auth_code
string = 6 characters
The 6-digit code used to authenticate a consumer within BLIK.
consumer_reference required string [ 3 .. 64 ] characters The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.
alias_label string [ 8 .. 35 ] characters A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts.
alias_key
string [ 1 .. 19 ] characters
A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference.
Copy { "auth_code": "string", "consumer_reference": "string", "alias_label": "stringst", "alias_key": "string" } blik_one_click_response Information used to pay using BLIK one-click flow.
consumer_reference
string [ 3 .. 64 ] characters
The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.
Copy { "consumer_reference": "string" } blik_request Information needed to pay using BLIK.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
email
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with this payment method.
experience_context
object
Customizes the payer experience during the approval process for the payment.
level_0 object The level_0 integration flow object.
one_click
object
The one-click integration flow object.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string", "consumer_user_agent": "string", "consumer_ip": "string" }, "level_0": { "auth_code": "string" }, "one_click": { "auth_code": "string", "consumer_reference": "string", "alias_label": "stringst", "alias_key": "string" } } callback_configuration CallBack Configuration that the merchant can provide to PayPal/Venmo.
callback_events required Array of strings [ 1 .. 5 ] items unique An array of callback events merchant can subscribe to for the corresponding callback url.
callback_url required string [ 10 .. 2040 ] characters Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the cart id or other params part of the url as query or path params.
CopyExpand allCollapse all { "callback_events": [ "string" ], "callback_url": "http://example.com" } capture A captured payment.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
id
string
The PayPal-generated ID for the captured payment.
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
custom_id
string <= 255 characters
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
final_capture
boolean
Default: false
Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.
links
Array of objects
An array of related HATEOAS links.
amount
object
The amount for this captured payment.
network_transaction_reference
object
Reference values used by the card network to identify a transaction.
seller_protection
object
The level of protection offered as defined by PayPal Seller Protection for Merchants.
seller_receivable_breakdown object The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
disbursement_mode
string [ 1 .. 16 ] characters ^[A-Z_]+$
Default: "INSTANT"
The funds that are held on behalf of the merchant.
Enum Value Description
INSTANT The funds are released to the merchant immediately.
DELAYED The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.
processor_response
object
An object that provides additional processor information for a direct credit card transaction.
CopyExpand allCollapse all { "create_time": "string", "update_time": "string", "id": "string", "invoice_id": "string", "custom_id": "string", "final_capture": false, "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "string" ] }, "seller_receivable_breakdown": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "gross_amount": { "currency_code": "str", "value": "string" }, "paypal_fee": { "currency_code": "str", "value": "string" }, "paypal_fee_in_receivable_currency": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" }, "receivable_amount": { "currency_code": "str", "value": "string" }, "exchange_rate": { "value": "string", "source_currency": "str", "target_currency": "str" } }, "disbursement_mode": "INSTANT", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } capture_status The status and status details of a captured payment.
status
string
The status of the captured payment.
Enum Value Description
COMPLETED The funds for this captured payment were credited to the payee's PayPal account.
DECLINED The funds could not be captured.
PARTIALLY_REFUNDED An amount less than this captured payment's amount was partially refunded to the payer.
PENDING The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.
REFUNDED An amount greater than or equal to this captured payment's amount was refunded to the payer.
FAILED There was an error while capturing payment.
status_details
object
The details of the captured payment status.
CopyExpand allCollapse all { "status": "COMPLETED", "status_details": { "reason": "BUYER_COMPLAINT" } } capture_status_details The details of the captured payment status.
reason
string [ 1 .. 64 ] characters ^[A-Z_]+$
The reason why the captured payment status is PENDING or DENIED.
Enum Value Description BUYER_COMPLAINT The payer initiated a dispute for this captured payment with PayPal. CHARGEBACK The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment. ECHECK The payer paid by an eCheck that has not yet cleared. INTERNATIONAL_WITHDRAWAL Visit your online account. In your Account Overview, accept and deny this payment. OTHER No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal. PENDING_REVIEW The captured payment is pending manual review. RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee. REFUNDED The captured funds were refunded. TRANSACTION_APPROVED_AWAITING_FUNDING The payer must send the funds for this captured payment. This code generally appears for manual EFTs. UNILATERAL The payee does not have a PayPal account. VERIFICATION_REQUIRED The payee's PayPal account is not verified. DECLINED_BY_RISK_FRAUD_FILTERS Risk Filter set by the payee failed for the transaction. Copy { "reason": "BUYER_COMPLAINT" } card The payment card to use to fund a payment. Can be a credit or debit card.
name
string [ 1 .. 300 ] characters
The card holder's name as it appears on the card.
number
string [ 13 .. 19 ] characters
The primary account number (PAN) for the payment card.
security_code
string [ 3 .. 4 ] characters
The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format For example: 2028-04
billing_address object The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
attributes
object
Additional attributes associated with the use of this card.
CopyExpand allCollapse all { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } } } card The payment card to use to fund a payment. Can be a credit or debit card.
name
string [ 1 .. 300 ] characters
The card holder's name as it appears on the card.
number
string [ 13 .. 19 ] characters
The primary account number (PAN) for the payment card.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format For example: 2028-04
card_type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description
VISA Visa card.
MASTERCARD Mastercard card.
DISCOVER Discover card.
AMEX American Express card.
SOLO Solo debit card.
JCB Japan Credit Bureau card.
STAR Military Star card.
DELTA Delta Airlines card.
SWITCH Switch credit card.
MAESTRO Maestro credit card.
CB_NATIONALE Carte Bancaire (CB) credit card.
CONFIGOGA Configoga credit card.
CONFIDIS Confidis credit card.
ELECTRON Visa Electron credit card.
CETELEM Cetelem credit card.
CHINA_UNION_PAY China union pay credit card.
DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO The Brazilian Elo card payment network.
HIPER The Hiper - Ingenico ePayment network.
HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY The RuPay payment network.
GE The GE Credit Union 3Point card payment network.
SYNCHRONY The Synchrony Financial (SYF) payment network.
EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
CARTE_BANCAIRE The Carte Bancaire payment network.
STAR_ACCESS The Star Access payment network.
PULSE The Pulse payment network.
NYCE The NYCE payment network.
ACCEL The Accel payment network.
UNKNOWN UNKNOWN payment network.
type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.
Enum Value Description
CREDIT A credit card.
DEBIT A debit card.
PREPAID A Prepaid card.
STORE A store card.
UNKNOWN Card type cannot be determined.
brand
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description VISA Visa card. MASTERCARD Mastercard card. DISCOVER Discover card. AMEX American Express card. SOLO Solo debit card. JCB Japan Credit Bureau card. STAR Military Star card. DELTA Delta Airlines card. SWITCH Switch credit card. MAESTRO Maestro credit card. CB_NATIONALE Carte Bancaire (CB) credit card. CONFIGOGA Configoga credit card. CONFIDIS Confidis credit card. ELECTRON Visa Electron credit card. CETELEM Cetelem credit card. CHINA_UNION_PAY China union pay credit card. DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. ELO The Brazilian Elo card payment network. HIPER The Hiper - Ingenico ePayment network. HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market. RUPAY The RuPay payment network. GE The GE Credit Union 3Point card payment network. SYNCHRONY The Synchrony Financial (SYF) payment network. EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. CARTE_BANCAIRE The Carte Bancaire payment network. STAR_ACCESS The Star Access payment network. PULSE The Pulse payment network. NYCE The NYCE payment network. ACCEL The Accel payment network. UNKNOWN UNKNOWN payment network. billing_address object The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
CopyExpand allCollapse all { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } Card Verification The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).
method
string [ 1 .. 255 ] characters
Default: "SCA_WHEN_REQUIRED"
The method used for card verification.
Enum Value Description SCA_ALWAYS Selecting this option will attempt to force a strong customer authentication for the authorization/transaction. In countries where SCA has been defined and implemented it will result in a contingency and HATEOAS link being returned. The API caller should redirect the payer to that link so that they can authenticate themselves against their issuing bank or other entity. As noted, the HATEOAS link is only available in all regions where strong authentication is supported, (e.g. in European countries where 3DS is live). Merchants can use this setting as an additional layer of security if they choose to. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. SCA_WHEN_REQUIRED This is the default. When an authorization or transaction is attempted this option will return a contingency and HATEOAS link only when local regulations require strong customer authentication, (e.g. 3DS in countries and use cases where it is mandated). The API caller should redirect the payer to the link so that they can authenticate themselves. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. 3D_SECURE The contingency surfaced as an additional security layer that helps prevent unauthorized card-not-present transactions and protects the merchant from exposure to fraud. AVS_CVV Places a temporary hold on the card to ensure its validity. This process protects the merchant from exposure to fraud. This verification method will confirm that the address information or CVV included matches what the issuing bank has on file for the associated card, ensuring that only authorized card users are able to make purchases from you. Copy { "method": "SCA_ALWAYS" } card_attributes Additional attributes associated with the use of this card.
customer
object
The details about a customer in PayPal's system of record.
vault
object
Instruction to vault the card based on the specified strategy.
verification
object
Instruction to optionally verify the card based on the specified strategy.
CopyExpand allCollapse all { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } } card_attributes_response Additional attributes associated with the use of this card.
vault
object
The details about a saved Card payment source.
CopyExpand allCollapse all { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } } card_brand The card network or brand. Applies to credit, debit, gift, and payment cards.
string [ 1 .. 255 ] characters ^[A-Z_]+$ The card network or brand. Applies to credit, debit, gift, and payment cards.
Enum Value Description VISA Visa card. MASTERCARD Mastercard card. DISCOVER Discover card. AMEX American Express card. SOLO Solo debit card. JCB Japan Credit Bureau card. STAR Military Star card. DELTA Delta Airlines card. SWITCH Switch credit card. MAESTRO Maestro credit card. CB_NATIONALE Carte Bancaire (CB) credit card. CONFIGOGA Configoga credit card. CONFIDIS Confidis credit card. ELECTRON Visa Electron credit card. CETELEM Cetelem credit card. CHINA_UNION_PAY China union pay credit card. DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. ELO The Brazilian Elo card payment network. HIPER The Hiper - Ingenico ePayment network. HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market. RUPAY The RuPay payment network. GE The GE Credit Union 3Point card payment network. SYNCHRONY The Synchrony Financial (SYF) payment network. EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. CARTE_BANCAIRE The Carte Bancaire payment network. STAR_ACCESS The Star Access payment network. PULSE The Pulse payment network. NYCE The NYCE payment network. ACCEL The Accel payment network. UNKNOWN UNKNOWN payment network. Copy "VISA" card_customer The details about a customer in PayPal's system of record.
id
string [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.
phone
object
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.
name
object
The full name of the customer as provided to the merchant or on file with the merchant.
merchant_customer_id
string [ 1 .. 64 ] characters
Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.
CopyExpand allCollapse all { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } card_experience_context Customizes the payer experience during the 3DS Approval for payment.
return_url
string [ 10 .. 4000 ] characters
The URL where the customer will be redirected upon successfully completing the 3DS challenge.
cancel_url
string [ 10 .. 4000 ] characters
The URL where the customer will be redirected upon cancelling the 3DS challenge.
Copy { "return_url": "string", "cancel_url": "string" } card_from_request Representation of card details as received in the request.
last_digits string [ 2 .. 4 ] characters The last digits of the payment card.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.
Copy { "last_digits": "stri", "expiry": "string" } card_request The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.
name
string [ 1 .. 300 ] characters
The card holder's name as it appears on the card.
number
string [ 13 .. 19 ] characters
The primary account number (PAN) for the payment card.
security_code
string [ 3 .. 4 ] characters
The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format For example: 2028-04
billing_address object The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
attributes
object
Additional attributes associated with the use of this card.
stored_credential
object
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.
vault_id
string [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server.
single_use_token
string [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.
network_token
object
A 3rd party network token refers to a network token that the merchant provisions from and vaults with an external TSP (Token Service Provider) other than PayPal.
experience_context
object
Customizes the payer experience during the 3DS Approval for payment.
CopyExpand allCollapse all { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } } card_response The payment card to use to fund a payment. Card can be a credit or debit card.
name
string [ 2 .. 300 ] characters
The card holder's name as it appears on the card.
last_digits string The last digits of the payment card.
available_networks
Array of strings [ 1 .. 256 ] items
Array of brands or networks associated with the card.
Items Enum Value Description
VISA Visa card.
MASTERCARD Mastercard card.
DISCOVER Discover card.
AMEX American Express card.
SOLO Solo debit card.
JCB Japan Credit Bureau card.
STAR Military Star card.
DELTA Delta Airlines card.
SWITCH Switch credit card.
MAESTRO Maestro credit card.
CB_NATIONALE Carte Bancaire (CB) credit card.
CONFIGOGA Configoga credit card.
CONFIDIS Confidis credit card.
ELECTRON Visa Electron credit card.
CETELEM Cetelem credit card.
CHINA_UNION_PAY China union pay credit card.
DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO The Brazilian Elo card payment network.
HIPER The Hiper - Ingenico ePayment network.
HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY The RuPay payment network.
GE The GE Credit Union 3Point card payment network.
SYNCHRONY The Synchrony Financial (SYF) payment network.
EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
CARTE_BANCAIRE The Carte Bancaire payment network.
STAR_ACCESS The Star Access payment network.
PULSE The Pulse payment network.
NYCE The NYCE payment network.
ACCEL The Accel payment network.
UNKNOWN UNKNOWN payment network.
from_request
object
Representation of card details as received in the request.
stored_credential
object
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.
brand
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description
VISA Visa card.
MASTERCARD Mastercard card.
DISCOVER Discover card.
AMEX American Express card.
SOLO Solo debit card.
JCB Japan Credit Bureau card.
STAR Military Star card.
DELTA Delta Airlines card.
SWITCH Switch credit card.
MAESTRO Maestro credit card.
CB_NATIONALE Carte Bancaire (CB) credit card.
CONFIGOGA Configoga credit card.
CONFIDIS Confidis credit card.
ELECTRON Visa Electron credit card.
CETELEM Cetelem credit card.
CHINA_UNION_PAY China union pay credit card.
DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO The Brazilian Elo card payment network.
HIPER The Hiper - Ingenico ePayment network.
HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY The RuPay payment network.
GE The GE Credit Union 3Point card payment network.
SYNCHRONY The Synchrony Financial (SYF) payment network.
EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
CARTE_BANCAIRE The Carte Bancaire payment network.
STAR_ACCESS The Star Access payment network.
PULSE The Pulse payment network.
NYCE The NYCE payment network.
ACCEL The Accel payment network.
UNKNOWN UNKNOWN payment network.
type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.
Enum Value Description
CREDIT A credit card.
DEBIT A debit card.
PREPAID A Prepaid card.
STORE A store card.
UNKNOWN Card type cannot be determined.
authentication_result
object
Results of Authentication such as 3D Secure.
attributes
object
Additional attributes associated with the use of this card.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.
bin_details object Bank Identification Number (BIN) details used to fund a payment.
CopyExpand allCollapse all { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" } } card_response The payment card to use to fund a payment. Card can be a credit or debit card.
name
string [ 2 .. 300 ] characters
The card holder's name as it appears on the card.
last_digits string The last digits of the payment card.
available_networks
Array of strings [ 1 .. 256 ] items
Array of brands or networks associated with the card.
Items Enum Value Description
VISA Visa card.
MASTERCARD Mastercard card.
DISCOVER Discover card.
AMEX American Express card.
SOLO Solo debit card.
JCB Japan Credit Bureau card.
STAR Military Star card.
DELTA Delta Airlines card.
SWITCH Switch credit card.
MAESTRO Maestro credit card.
CB_NATIONALE Carte Bancaire (CB) credit card.
CONFIGOGA Configoga credit card.
CONFIDIS Confidis credit card.
ELECTRON Visa Electron credit card.
CETELEM Cetelem credit card.
CHINA_UNION_PAY China union pay credit card.
DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO The Brazilian Elo card payment network.
HIPER The Hiper - Ingenico ePayment network.
HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY The RuPay payment network.
GE The GE Credit Union 3Point card payment network.
SYNCHRONY The Synchrony Financial (SYF) payment network.
EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
CARTE_BANCAIRE The Carte Bancaire payment network.
STAR_ACCESS The Star Access payment network.
PULSE The Pulse payment network.
NYCE The NYCE payment network.
ACCEL The Accel payment network.
UNKNOWN UNKNOWN payment network.
from_request
object
Representation of card details as received in the request.
stored_credential
object
Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.
brand
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description
VISA Visa card.
MASTERCARD Mastercard card.
DISCOVER Discover card.
AMEX American Express card.
SOLO Solo debit card.
JCB Japan Credit Bureau card.
STAR Military Star card.
DELTA Delta Airlines card.
SWITCH Switch credit card.
MAESTRO Maestro credit card.
CB_NATIONALE Carte Bancaire (CB) credit card.
CONFIGOGA Configoga credit card.
CONFIDIS Confidis credit card.
ELECTRON Visa Electron credit card.
CETELEM Cetelem credit card.
CHINA_UNION_PAY China union pay credit card.
DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services.
ELO The Brazilian Elo card payment network.
HIPER The Hiper - Ingenico ePayment network.
HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market.
RUPAY The RuPay payment network.
GE The GE Credit Union 3Point card payment network.
SYNCHRONY The Synchrony Financial (SYF) payment network.
EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network.
CARTE_BANCAIRE The Carte Bancaire payment network.
STAR_ACCESS The Star Access payment network.
PULSE The Pulse payment network.
NYCE The NYCE payment network.
ACCEL The Accel payment network.
UNKNOWN UNKNOWN payment network.
type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.
Enum Value Description
CREDIT A credit card.
DEBIT A debit card.
PREPAID A Prepaid card.
STORE A store card.
UNKNOWN Card type cannot be determined.
authentication_result
object
Results of Authentication such as 3D Secure.
attributes
object
Additional attributes associated with the use of this card.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.
bin_details object Bank Identification Number (BIN) details used to fund a payment.
CopyExpand allCollapse all { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" } } card_stored_credential Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER. usage=FIRST is compatible only with payment_initiator=CUSTOMER. previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request. payment_initiator required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The person or party who initiated or triggered the payment.
Enum Value Description CUSTOMER Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website. MERCHANT Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer. payment_type required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Indicates the type of the stored payment_source payment.
Enum Value Description
ONE_TIME One Time payment such as online purchase or donation. (e.g. Checkout with one-click).
RECURRING Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).
UNSCHEDULED Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).
usage
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Default: "DERIVED"
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
Enum Value Description
FIRST Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.
SUBSEQUENT Indicates a payment using a stored payment_source which has been successfully used previously for a payment.
DERIVED Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal.
previous_network_transaction_reference
object
Reference values used by the card network to identify a transaction.
CopyExpand allCollapse all { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } } card_supplementary_data 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.
level_2 object The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business.
level_3 object The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business.
CopyExpand allCollapse all { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": null, "price": null, "reload_threshold_amount": null }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } }, "commodity_code": "string", "unit_of_measure": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "total_amount": { "currency_code": "str", "value": "string" } } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } } card_type Type of card. i.e Credit, Debit and so on.
string [ 1 .. 255 ] characters ^[A-Z_]+$ Type of card. i.e Credit, Debit and so on.
Enum Value Description CREDIT A credit card. DEBIT A debit card. PREPAID A Prepaid card. STORE A store card. UNKNOWN Card type cannot be determined. Copy "CREDIT" card_vault_response The details about a saved Card payment source.
id
string [ 1 .. 255 ] characters
The PayPal-generated ID for the saved payment source.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.
Enum Value Description
VAULTED The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.
CREATED DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.
APPROVED Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault
links
Array of objects [ 1 .. 10 ] items
An array of request-related HATEOAS links.
customer
object
The details about a customer in PayPal's system of record.
CopyExpand allCollapse all { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } carrier The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.
string [ 1 .. 64 ] characters ^[0-9A-Z_]+$ The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.
Enum Value Description DPD_RU DPD Russia. BG_BULGARIAN_POST Bulgarian Posts. KR_KOREA_POST Koreapost (www.koreapost.go.kr). ZA_COURIERIT Courier IT. FR_EXAPAQ DPD France (formerly exapaq). ARE_EMIRATES_POST Emirates Post. GAC GAC. GEIS Geis CZ. SF_EX SF Express. PAGO Pago Logistics. MYHERMES MyHermes UK. DIAMOND_EUROGISTICS Diamond Eurogistics Limited. CORPORATECOURIERS_WEBHOOK Corporate Couriers. BOND Bond courier. OMNIPARCEL Omni Parcel. SK_POSTA Slovenska pošta. PUROLATOR purolator. FETCHR_WEBHOOK Mena 360 (Fetchr). THEDELIVERYGROUP TDG – The Delivery Group. CELLO_SQUARE Cello Square. TARRIVE TONDA GLOBAL. COLLIVERY MDS Collivery Pty (Ltd). MAINFREIGHT Mainfreight. IND_FIRSTFLIGHT First Flight Couriers. ACSWORLDWIDE ACS Worldwide Express. AMSTAN Amstan Logistics. OKAYPARCEL OkayParcel. ENVIALIA_REFERENCE Envialia Reference. SEUR_ES Seur Spain. CONTINENTAL Continental. FDSEXPRESS FDSEXPRESS. AMAZON_FBA_SWISHIP Swiship UK. WYNGS Wyngs. DHL_ACTIVE_TRACING DHL Active Tracing. ZYLLEM Zyllem. RUSTON Ruston. XPOST Xpost.ph. CORREOS_ES correos Express (www.correos.es). DHL_FR DHL France (www.dhl.com). PAN_ASIA Pan-Asia International. BRT_IT BRT couriers Italy (www.brt.it). SRE_KOREA SRE Korea (www.srekorea.co.kr). SPEEDEE Spee-Dee Delivery. TNT_UK TNT UK Limited (www.tnt.com). VENIPAK Venipak. SHREENANDANCOURIER SHREE NANDAN COURIER. CROSHOT Croshot. NIPOST_NG NIpost (www.nipost.gov.ng). EPST_GLBL ePost Global. NEWGISTICS Newgistics. POST_SLOVENIA Post of Slovenia. JERSEY_POST Jersey Post. BOMBINOEXP Bombino Express Pvt. WMG WMG Delivery. XQ_EXPRESS XQ Express. FURDECO Furdeco. LHT_EXPRESS LHT Express. SOUTH_AFRICAN_POST_OFFICE South African Post Office. SPOTON SPOTON Logistics Pvt Ltd. DIMERCO Dimerco Express Group. CYPRUS_POST_CYP cyprus post. ABCUSTOM AB Custom Group. IND_DELIVREE deliverE. CN_BESTEXPRESS Best Express. DX_SFTP DX (SFTP). PICKUPP_MYS PICK UPP. FMX FMX. HELLMANN Hellmann Worldwide Logistics. SHIP_IT_ASIA Ship It Asia. KERRY_ECOMMERCE Kerry eCommerce. FRETERAPIDO Frete Rapido. PITNEY_BOWES Pitney Bowes. XPRESSEN_DK Xpressen courier. SEUR_SP_API Spanish Seur API. DELIVERYONTIME DELIVERYONTIME LOGISTICS PVT LTD. JINSUNG JINSUNG TRADING. TRANS_KARGO Trans Kargo Internasional. SWISHIP_DE Swiship DE. IVOY_WEBHOOK Ivoy courier. AIRMEE_WEBHOOK Airmee couriers. DHL_BENELUX dhl benelux. FIRSTMILE FirstMile. FASTWAY_IR Fastway Ireland. HH_EXP Hua Han Logistics. MYS_MYPOST_ONLINE Mypostonline. TNT_NL THT Netherland. TIPSA TIPSA courier. TAQBIN_MY TAQBIN Malaysia. KGMHUB KGM Hub. INTEXPRESS Internet Express. OVERSE_EXP Overseas Express. ONECLICK One click delivery services. ROADRUNNER_FREIGHT Roadbull Logistics. GLS_CROTIA GLS Croatia. MRW_FTP MRW courier. BLUEX Blue Express. DYLT Daylight Transport. DPD_IR DPD Ireland. SIN_GLBL Sin Global Express. TUFFNELLS_REFERENCE Tuffnells Parcels Express- Reference. CJPACKET CJ Packet. MILKMAN Milkman courier. ASIGNA ASIGNA courier. ONEWORLDEXPRESS One World Express. ROYAL_MAIL RoyalShipments. VIA_EXPRESS Viaxpress. TIGFREIGHT TIG Freight. ZTO_EXPRESS ZTO Express. TWO_GO 2GO Courier. IML IML courier. INTEL_VALLEY Intel-Valley Supply chain (ShenZhen) Co. Ltd. EFS EFS (E-commerce Fulfillment Service). UK_UK_MAIL UK mail (ukmail.com). RAM RAM courier. ALLIEDEXPRESS Allied Express. APC_OVERNIGHT APC overnight (apc-overnight.com). SHIPPIT Shippit. TFM TFM Xpress. M_XPRESS M Xpress Sdn Bhd. HDB_BOX Haidaibao (BOX). CLEVY_LINKS Clevy Links. IBEONE Beone Logistics. FIEGE_NL Fiege Netherlands. KWE_GLOBAL KWE Global. CTC_EXPRESS CTC Express. AMAZON Amazon Shipping. MORE_LINK Morelink. JX JX courier. EASY_MAIL Easy Mail. ADUIEPYLE A Duie Pyle. GB_PANTHER Panther. EXPRESSSALE Expresssale. SG_DETRACK Detrack. TRUNKRS_WEBHOOK Trunkrs courier. MATDESPATCH Matdespatch. DICOM GLS Logistic Systems Canada Ltd./Dicom. MBW MBW Courier Inc.. KHM_CAMBODIA_POST Cambodia Post. SINOTRANS Sinotrans. BRT_IT_PARCELID BRT Bartolini(Parcel ID). DHL_SUPPLY_CHAIN DHL Supply Chain APAC. DHL_PL DHL Poland. TOPYOU TopYou. PALEXPRESS PAL Express Limited. DHL_SG dhl Singapore. CN_WEDO WeDo Logistics. FULFILLME Fulfillme. DPD_DELISTRACK DPD delistrack. UPS_REFERENCE UPS Reference. CARIBOU Caribou. LOCUS_WEBHOOK Locus courier. DSV DSV courier. P2P_TRC P2P TrakPak. DIRECTPARCELS Direct Parcels. NOVA_POSHTA_INT Nova Poshta (International). FEDEX_POLAND FedEx® Poland Domestic. CN_JCEX JCEX courier. FAR_INTERNATIONAL FAR international. IDEXPRESS IDEX courier. GANGBAO GANGBAO Supplychain. NEWAY Neway Transport. POSTNL_INT_3_S PostNL International. RPX_ID RPX Indonesia. DESIGNERTRANSPORT_WEBHOOK Designer Transport. GLS_SLOVEN GLS Slovenia. PARCELLED_IN Parcelled.in. GSI_EXPRESS GSI EXPRESS. CON_WAY Con-way Freight. BROUWER_TRANSPORT Brouwer Transport en Logistiek. CPEX Captain Express International. ISRAEL_POST Israel Post. DTDC_IN DTDC India. PTT_POST PTT Post. XDE_WEBHOOK Ximex Delivery Express. TOLOS Tolos courier. GIAO_HANG Giao hàng nhanh. GEODIS_ESPACE Geodis E-space. MAGYAR_HU Magyar Post. DOORDASH_WEBHOOK DoorDash. TIKI_ID Tiki shipment. CJ_HK_INTERNATIONAL CJ Logistics International(Hong Kong). STAR_TRACK_EXPRESS Star Track Express. HELTHJEM Helthjem. SFB2C SF International. FREIGHTQUOTE Freightquote by C.H. Robinson. LANDMARK_GLOBAL_REFERENCE Landmark Global Reference. PARCEL2GO Parcel2Go. DELNEXT Delnext. RCL Red Carpet Logistics. CGS_EXPRESS CGS Express. HK_POST Hongkong Post (www.hongkongpost.hk). SAP_EXPRESS SAP EXPRESS. PARCELPOST_SG Parcel Post Singapore. HERMES HermesWorld UK. IND_SAFEEXPRESS Safexpress. TOPHATTEREXPRESS Tophatter Express. MGLOBAL PT MGLOBAL LOGISTICS INDONESIA. AVERITT Averitt Express. LEADER leader. _2EBOX 2ebox courier. SG_SPEEDPOST Singapore Speedpost. DBSCHENKER_SE DB Schenker (www.dbschenker.com). ISR_POST_DOMESTIC Israel Post Domestic. BESTWAYPARCEL Best Way Parcel. ASENDIA_DE asendia_de. NIGHTLINE_UK nightline_uk. TAQBIN_SG taqbin_sg. TCK_EXPRESS TCK Express. ENDEAVOUR_DELIVERY Endeavour Delivery. NANJINGWOYUAN Nanjing Woyuan. HEPPNER_FR Heppner France. EMPS_CN EMPS Express. FONSEN Fonsen Logistics. PICKRR Pickrr. APC_OVERNIGHT_CONNUM APC Overnight Consignment. STAR_TRACK_NEXT_FLIGHT Star Track Next Flight. DAJIN Shanghai Aqrum Chemical Logistics Co.Ltd. UPS_FREIGHT UPS Freight. POSTA_PLUS Posta Plus. CEVA CEVA LOGISTICS. ANSERX ANSERX courier. JS_EXPRESS JS EXPRESS. PADTF padtf.com. UPS_MAIL_INNOVATIONS UPS Mail Innovations. SYPOST Sunyou Post. AMAZON_SHIP_MCF Amazon Shipping + Amazon MCF. YUSEN Yusen Logistics. BRING Bring. SDA_IT SDA Italy. GBA GBA Services Ltd. NEWEGGEXPRESS Newegg Express. SPEEDCOURIERS_GR Speed Couriers. FORRUN forrun Pvt Ltd (Arpatech Venture). PICKUP Pickupp. ECMS ECMS International Logistics Co.. INTELIPOST Intelipost (TMS for LATAM). FLASHEXPRESS Flash Express. CN_STO STO Express. SEKO_SFTP SEKO Worldwide. HOME_DELIVERY_SOLUTIONS Home Delivery Solutions Ltd. DPD_HGRY DPD Hungary. KERRYTTC_VN Kerry Express (Vietnam) Co Ltd. JOYING_BOX Joying Box. TOTAL_EXPRESS Total Express. ZJS_EXPRESS ZJS International. STARKEN STARKEN couriers. DEMANDSHIP DemandShip. CN_DPEX DPEX. AUPOST_CN AuPost China. LOGISTERS Logisters. GOGLOBALPOST Global Post. GLS_CZ GLS Czech Republic. PAACK_WEBHOOK Paack courier. GRAB_WEBHOOK Grab courier. PARCELPOINT Parcelpoint. ICUMULUS iCumulus. DAIGLOBALTRACK DAI Post. GLOBAL_IPARCEL i-parcel. YURTICI_KARGO Yurtici Kargo. CN_PAYPAL_PACKAGE PayPal Package. PARCEL_2_POST Parcel To Post. GLS_IT GLS Italy. PIL_LOGISTICS PIL Logistics (China) Co.. HEPPNER Heppner Internationale Spedition GmbH & Co.. GENERAL_OVERNIGHT Go!Express and logistics. HAPPY2POINT Happy 2ThePoint. CHITCHATS Chit Chats. SMOOTH Smooth Couriers. CLE_LOGISTICS CL E-Logistics Solutions Limited. FIEGE Fiege Logistics. MX_CARGO M&X cargo. ZIINGFINALMILE Ziing Final Mile Inc. DAYTON_FREIGHT Dayton Freight. TCS TCS courier. AEX AEX Group. HERMES_DE Hermes Germany. ROUTIFIC_WEBHOOK Routific. GLOBAVEND Globavend. CJ_LOGISTICS CJ Logistics International. PALLET_NETWORK The Pallet Network. RAF_PH RAF Philippines. UK_XDP XDP Express. PAPER_EXPRESS Paper Express. LA_POSTE_SUIVI La Poste. PAQUETEXPRESS Paquetexpress. LIEFERY liefery. STRECK_TRANSPORT Streck Transport. PONY_EXPRESS Pony express. ALWAYS_EXPRESS Always Express. GBS_BROKER GBS-Broker. CITYLINK_MY City-Link Express. ALLJOY ALLJOY SUPPLY CHAIN. YODEL yodel. YODEL_DIR Yodel Direct. STONE3PL STONE3PL. PARCELPAL_WEBHOOK ParcelPal. DHL_ECOMERCE_ASA DHL eCommerce Asia (API). SIMPLYPOST J&T Express Singapore. KY_EXPRESS Kua Yue Express. SHENZHEN shenzhen 1st International Logistics(Group)Co. US_LASERSHIP LaserShip. UC_EXPRE ucexpress. DIDADI DIDADI Logistics tech. CJ_KR CJ Korea Express. DBSCHENKER_B2B DB Schenker B2B. MXE MXE Express. CAE_DELIVERS CAE Delivers. PFCEXPRESS PFC Express. WHISTL Whistl. WEPOST WePost Sdn Bhd. DHL_PARCEL_ES DHL parcel Spain(www.dhl.com). DDEXPRESS DD Express Courier. ARAMEX_AU Aramex Australia (formerly Fastway AU). BNEED Bneed courier. HK_TGX Kerry Express Hong Kong. LATVIJAS_PASTS Latvijas Pasts. VIAEUROPE ViaEurope. CORREO_UY Correo Uruguayo. CHRONOPOST_FR Chronopost france (www.chronopost.fr). J_NET J-Net. _6LS 6ls.com. BLR_BELPOST Belpost. BIRDSYSTEM BirdSystem. DOBROPOST DobroPost. WAHANA_ID Wahana express (www.wahana.com). WEASHIP Weaship. SONICTL Sonic Transportation & Logistics. KWT Shenzhen Jinghuada Logistics Co.. AFLLOG_FTP AFL LOGISTICS. SKYNET_WORLDWIDE SkyNet Worldwide Express. NOVA_POSHTA Nova Poshta (novaposhta.ua). SEINO Seino. SZENDEX SZENDEX. BPOST_INT Bpost international. DBSCHENKER_SV DB Schenker Sweden. AO_DEUTSCHLAND AO Deutschland. EU_FLEET_SOLUTIONS EU Fleet Solutions. PCFCORP PCF Final Mile. LINKBRIDGE Link Bridge(BeiJing)international logistics co.. PRIMAMULTICIPTA PT Prima Multi Cipta. COUREX Urbanfox. ZAJIL_EXPRESS Zajil Express Company. COLLECTCO CollectCo. JTEXPRESS J&T EXPRESS MALAYSIA. FEDEX_UK FedEx® UK. USHIP uShip courier. PIXSELL PIXSELL LOGISTICS. SHIPTOR Shiptor. CDEK CDEK courier. VNM_VIETTELPOST ViettelPost. CJ_CENTURY CJ Century. GSO GSO(GLS-USA). VIWO VIWO IoT. SKYBOX SKYBOX. KERRYTJ Kerry TJ Logistics. NTLOGISTICS_VN Nhat Tin Logistics. SDH_SCM lightning monkey. ZINC Zinc courier. DPE_SOUTH_AFRC DPE South Africa. CESKA_CZ Czech Post. ACS_GR ACS Courier. DEALERSEND DealerSend. JOCOM Jocom. CSE CSE courier. TFORCE_FINALMILE TForce Final Mile. SHIP_GATE ShipGate. SHIPTER SHIPTER. NATIONAL_SAMEDAY National Sameday. YUNEXPRESS YunExpress. CAINIAO AliExpress Standard Shipping. DMS_MATRIX DMSMatrix. DIRECTLOG Directlog (www.directlog.com.br). ASENDIA_US Asendia USA. _3JMSLOGISTICS 3JMS Logistics. LICCARDI_EXPRESS LICCARDI EXPRESS COURIER. SKY_POSTAL SkyPostal. CNWANGTONG cnwangtong. POSTNORD_LOGISTICS_DK ostnord denmark. LOGISTIKA Logistika. CELERITAS Celeritas Transporte. PRESSIODE Pressio. SHREE_MARUTI Shree Maruti Courier Services Pvt Ltd. LOGISTICSWORLDWIDE_HK Logistic Worldwide Express (LWE Honkong). EFEX eFEx (E-Commerce Fulfillment & Express). LOTTE Lotte Global Logistics. LONESTAR Lone Star Overnight. APRISAEXPRESS Aprisa Express. BEL_RS BEL North Russia. OSM_WORLDWIDE OSM Worldwide. WESTGATE_GL Westgate Global. FASTRACK Fasttrack. DTD_EXPR DTD Express. ALFATREX AlfaTrex. PROMEDDELIVERY ProMed Delivery. THABIT_LOGISTICS Thabit Logistics. HCT_LOGISTICS HCT LOGISTICS CO.LTD.. CARRY_FLAP Carry-Flap Co.. US_OLD_DOMINION Old Dominion Freight Line. ANICAM_BOX ANICAM BOX EXPRESS. WANBEXPRESS WanbExpress. AN_POST An Post. DPD_LOCAL DPD Local. STALLIONEXPRESS Stallion Express. RAIDEREX RaidereX. SHOPFANS ShopfansRU LLC. KYUNGDONG_PARCEL Kyungdong Parcel. CHAMPION_LOGISTICS Champion Logistics. PICKUPP_SGP PICK UPP (Singapore). MORNING_EXPRESS Morning Express. NACEX NACEX. THENILE_WEBHOOK SortHub courier. HOLISOL Holisol. LBCEXPRESS_FTP LBC EXPRESS INC.. KURASI KURASI. USF_REDDAWAY USF Reddaway. APG APG eCommerce Solutions. CN_BOXC BoxC courier. ECOSCOOTING ECOSCOOTING. MAINWAY Mainway. PAPERFLY Paperfly Private Limited. HOUNDEXPRESS Hound Express. BOX_BERRY Boxberry courier. EP_BOX EP-Box courier. PLUS_LOG_UK Plus UK Logistics. FULFILLA Fulfilla. ASE ASE KARGO. MAIL_PLUS MailPlus. XPO_LOGISTICS XPO logistics. WNDIRECT wnDirect. CLOUDWISH_ASIA Cloudwish Asia. ZELERIS Zeleris. GIO_EXPRESS Gio Express. OCS_WORLDWIDE OCS WORLDWIDE. ARK_LOGISTICS ARK Logistics. AQUILINE Aquiline. PILOT_FREIGHT Pilot Freight Services. QWINTRY Qwintry Logistics. DANSKE_FRAGT Danske Fragtaend. CARRIERS Carriers courier. AIR_CANADA_GLOBAL Rivo (Air canada). PRESIDENT_TRANS PRESIDENT TRANSNET CORP. STEPFORWARDFS STEP FORWARD FREIGHT SERVICE CO LTD. SKYNET_UK Skynet UK. PITTOHIO PITT OHIO. CORREOS_EXPRESS Correos Express. RL_US RL Carriers. DESTINY Destiny Transportation. UK_YODEL Yodel (www.yodel.co.uk). COMET_TECH CometTech. DHL_PARCEL_RU DHL Parcel Russia. TNT_REFR TNT Reference. SHREE_ANJANI_COURIER Shree Anjani Courier. MIKROPAKKET_BE Mikropakket Belgium. ETS_EXPRESS RETS express. COLIS_PRIVE Colis Privé. CN_YUNDA Yunda Express. AAA_COOPER AAA Cooper. ROCKET_PARCEL Rocket Parcel International. _360LION 360 Lion Express. PANDU PANDU. PROFESSIONAL_COURIERS PROFESSIONAL COURIERS. FLYTEXPRESS FLYTEXPRESS. LOGISTICSWORLDWIDE_MY LOGISTICSWORLDWIDE MY. CORREOS_DE_ESPANA CORREOS DE ESPANA. IMX IMX. FOUR_PX_EXPRESS FOUR PX EXPRESS. XPRESSBEES XPRESSBEES. PICKUPP_VNM pickupp_vnm. STARTRACK_EXPRESS startrack_express. FR_COLISSIMO fr_colissimo. NACEX_SPAIN_REFERENCE nacex_spain_reference. DHL_SUPPLY_CHAIN_AU dhl_supply_chain_au. ESHIPPING Eshipping. SHREETIRUPATI SHREE TIRUPATI COURIER SERVICES PVT. LTD.. HX_EXPRESS HX Express. INDOPAKET INDOPAKET. CN_17POST 17 Post Service. K1_EXPRESS K1 Express. CJ_GLS CJ GLS. MYS_GDEX GDEX courier. NATIONEX Nationex courier. ANJUN Anjun couriers. FARGOOD FarGood. SMG_EXPRESS SMG Direct. RZYEXPRESS RZY Express. SEFL Southeastern Freight Lines. TNT_CLICK_IT TNT-Click Italy. HDB Haidaibao. HIPSHIPPER Hipshipper. RPXLOGISTICS RPX Logistics. KUEHNE Kuehne + Nagel. IT_NEXIVE Nexive (TNT Post Italy). PTS PTS courier. SWISS_POST_FTP Swiss Post FTP. FASTRK_SERV Fastrak Services. _4_72 4-72 Entregando. US_YRC YRC courier. POSTNL_INTL_3S PostNL International 3S. ELIAN_POST Yilian (Elian) Supply Chain. CUBYN Cubyn. SAU_SAUDI_POST Saudi Post. ABXEXPRESS_MY ABX Express. HUAHAN_EXPRESS HUAHANG EXPRESS. ZES_EXPRESS Eshun international Logistic. ZEPTO_EXPRESS ZeptoExpress. SKYNET_ZA Skynet World Wide Express South Africa. ZEEK_2_DOOR Zeek2Door. BLINKLASTMILE Blink. POSTA_UKR UkrPoshta. CHROBINSON C.H. Robinson Worldwide. CN_POST56 Post56. COURANT_PLUS Courant Plus. SCUDEX_EXPRESS Scudex Express. SHIPENTEGRA ShipEntegra. B_TWO_C_EUROPE B2C courier Europe. COPE Cope Sensitive Freight. IND_GATI Gati-KWE. CN_WISHPOST WishPost. NACEX_ES NACEX Spain. TAQBIN_HK TAQBIN Hong Kong. GLOBALTRANZ GlobalTranz. HKD Qingdao HKD International Logistics. BJSHOMEDELIVERY BJS Distribution courier. OMNIVA Omniva. SUTTON Sutton Transport. PANTHER_REFERENCE Panther Reference. SFCSERVICE SFC Service. LTL LTL COURIER. PARKNPARCEL Park N Parcel. SPRING_GDS Spring GDS. ECEXPRESS ECexpress. INTERPARCEL_AU Interparcel Australia. AGILITY Agility. XL_EXPRESS XL Express. ADERONLINE Ader couriers. DIRECTCOURIERS Direct Couriers. PLANZER Planzer Group. SENDING Sending Transporte Urgente y Comunicacion. NINJAVAN_WB Ninjavan Webhook. NATIONWIDE_MY Nationwide Express Courier Services Bhd (www.nationwide.com.my). SENDIT Sendit. GB_ARROW Arrow XL. IND_GOJAVAS GoJavas. KPOST Korea Post. DHL_FREIGHT DHL Freight. BLUECARE Bluecare Express Ltd. JINDOUYUN jindouyun courier. TRACKON Trackon Couriers Pvt. Ltd. GB_TUFFNELLS Tuffnells Parcels Express. TRUMPCARD TRUMPCARD LLC. ETOTAL eTotal Solution Limited. SFPLUS_WEBHOOK Zeek courier. SEKOLOGISTICS SEKO Logistics. HERMES_2MANN_HANDLING Hermes Einrichtungs Service GmbH & Co. KG. DPD_LOCAL_REF DPD Local reference. UDS United Delivery Service. ZA_SPECIALISED_FREIGHT Specialised Freight. THA_KERRY Kerry Express Thailand. PRT_INT_SEUR SEUR International. BRA_CORREIOS Correios Brazil. NZ_NZ_POST New Zealand Post. CN_EQUICK Equick China. MYS_EMS Malaysia Post EMS / Pos Laju. GB_NORSK Norsk Global. ESP_MRW MRW spain. ESP_PACKLINK Packlink. KANGAROO_MY Kangaroo Worldwide Express. RPX RPX Online. XDP_UK_REFERENCE XDP Express Reference. NINJAVAN_MY ninja van (www.ninjavan.co). ADICIONAL Adicional Logistics. ROADBULL Red Carpet Logistics. YAKIT Yakit courier. MAILAMERICAS MailAmericas. MIKROPAKKET Mikropakket. DYNALOGIC Dynamic Logistics. DHL_ES DHL Spain(www.dhl.com). DHL_PARCEL_NL DHL Parcel NL. DHL_GLOBAL_MAIL_ASIA DHL Global Mail Asia (www.dhl.com). DAWN_WING Dawn Wing. GENIKI_GR Geniki Taxydromiki. HERMESWORLD_UK hermesworld_uk. ALPHAFAST Alphafast (www.alphafast.com). BUYLOGIC buylogic. EKART Ekart logistics (ekartlogistics.com). MEX_SENDA mexico senda express. SFC_LOGISTICS SFC. POST_SERBIA Posta Serbia. IND_DELHIVERY Delhivery India. DE_DPD_DELISTRACK DPD Germany. RPD2MAN RPD2man Deliveries. CN_SF_EXPRESS SF Express (www.sf-express.com). YANWEN Yanwen Logistics. MYS_SKYNET Skynet Malaysia. CORREOS_DE_MEXICO correos mexico. CBL_LOGISTICA CBL Logistica. MEX_ESTAFETA Estafeta (www.estafeta.com). AU_AUSTRIAN_POST Austrian Post (Registered). RINCOS Rincos. NLD_DHL DHL Netherland. RUSSIAN_POST Russian post. COURIERS_PLEASE CouriersPlease (couriersplease.com.au). POSTNORD_LOGISTICS PostNord Logistics. FEDEX Fedex. DPE_EXPRESS DPE Express. DPD DPD. ADSONE ADSone. IDN_JNE JNE Express (Jalur Nugraha Ekakurir). THECOURIERGUY The Courier Guy. CNEXPS CNE Express. PRT_CHRONOPOST Chronopost Portugal. LANDMARK_GLOBAL Landmark Global. IT_DHL_ECOMMERCE DHL International. ESP_NACEX NACEX Spain. PRT_CTT CTT Portugal. BE_KIALA Kiala. ASENDIA_UK Asendia UK. GLOBAL_TNT TNT global. POSTUR_IS Iceland Post. EPARCEL_KR eParcel Korea. INPOST_PACZKOMATY InPost Paczkomaty. IT_POSTE_ITALIA Poste italiane (www.poste.it). BE_BPOST Bpost (www.bpost.be). PL_POCZTA_POLSKA Poczta Polska (www.poczta-polska.pl). MYS_MYS_POST Malaysia Post. SG_SG_POST Singapore Post. THA_THAILAND_POST Thailand Post (www.thailandpost.co.th). LEXSHIP LexShip. FASTWAY_NZ Fastway New Zealand. DHL_AU DHL Supply Chain Australia. COSTMETICSNOW Cosmetics Now. PFLOGISTICS PFL. LOOMIS_EXPRESS Loomis Express. GLS_ITALY GLS Italy. LINE Line Clear Express & Logistics Sdn Bhd. GEL_EXPRESS Gel Express Logistik. HUODULL Huodull. NINJAVAN_SG Ninja van Singapore. JANIO Janio Asia. AO_COURIER AO Logistics. BRT_IT_SENDER_REF BRT Bartolini(Sender Reference). SAILPOST SAILPOST. LALAMOVE Lalamove. NEWZEALAND_COURIERS NEW ZEALAND COURIERS. ETOMARS Etomars. VIRTRANSPORT VIR Transport. WIZMO Wizmo. PALLETWAYS Palletways. I_DIKA i-dika. CFL_LOGISTICS CFL Logistics. GEMWORLDWIDE GEM Worldwide. GLOBAL_EXPRESS Tai Wan Global Business. LOGISTYX_TRANSGROUP Transgroup courier. WESTBANK_COURIER West Bank Courier. ARCO_SPEDIZIONI Arco Spedizioni SP. YDH_EXPRESS YDH express. PARCELINKLOGISTICS Parcelink Logistics. CNDEXPRESS CND Express. NOX_NIGHT_TIME_EXPRESS NOX NightTimeExpress. AERONET Aeronet couriers. LTIANEXP LTIAN EXP. INTEGRA2_FTP Integra2. PARCELONE PARCEL ONE. NOX_NACHTEXPRESS Innight Express Germany GmbH (nox NachtExpress). CN_CHINA_POST_EMS China Post. CHUKOU1 Chukou1. GLS_SLOV GLS General Logistics Systems Slovakia s.r.o.. ORANGE_DS OrangeDS (Orange Distribution Solutions Inc). JOOM_LOGIS Joom Logistics. AUS_STARTRACK StarTrack (startrack.com.au). DHL dhl Global. GB_APC APC postal logistics germany. BONDSCOURIERS Bonds Courier Service (bondscouriers.com.au). JPN_JAPAN_POST Japan Post. USPS United States Postal Service. WINIT WinIt. ARG_OCA OCA Argentina. TW_TAIWAN_POST Taiwan Post. DMM_NETWORK DMM Network. TNT TNT Express. BH_POSTA BH Posta (www.posta.ba). SWE_POSTNORD Postnord sweden. CA_CANADA_POST Canada Post. WISELOADS Wiseloads. ASENDIA_HK Asendia HonKong. NLD_GLS GLS Netherland. MEX_REDPACK Redpack. JET_SHIP Jet-Ship Worldwide. DE_DHL_EXPRESS DHL Express. NINJAVAN_THAI Ninja van Thai. RABEN_GROUP Raben Group. ESP_ASM ASM(GLS Spain). HRV_HRVATSKA Hrvatska posta. GLOBAL_ESTES Estes Express Lines. LTU_LIETUVOS Lietuvos pastas. BEL_DHL DHL Benelux. AU_AU_POST Australia Post. SPEEDEXCOURIER SPEEDEX couriers. FR_COLIS Colissimo. ARAMEX Aramex. DPEX DPEX (www.dpex.com). MYS_AIRPAK Airpak Express. CUCKOOEXPRESS Cuckoo Express. DPD_POLAND DPD Poland. NLD_POSTNL PostNL International. NIM_EXPRESS Nim Express. QUANTIUM Quantium. SENDLE Sendle. ESP_REDUR Redur Spain. MATKAHUOLTO Matkahuolto. CPACKET Cpacket couriers. POSTI Posti courier. HUNTER_EXPRESS Hunter Express. CHOIR_EXP Choir Express Indonesia. LEGION_EXPRESS Legion Express. AUSTRIAN_POST_EXPRESS austrian post. GRUPO Grupo ampm. POSTA_RO Post Roman (www.posta-romana.ro). INTERPARCEL_UK Interparcel UK. GLOBAL_ABF ABF Freight. POSTEN_NORGE Posten Norge (www.posten.no). XPERT_DELIVERY Xpert Delivery. DHL_REFR DHl (Reference number). DHL_HK DHL HonKong. SKYNET_UAE SKYNET UAE. GOJEK Gojek. YODEL_INTNL Yodel International. JANCO Janco Ecommerce. YTO YTO Express. WISE_EXPRESS Wise Express. JTEXPRESS_VN J&T Express Vietnam. FEDEX_INTL_MLSERV FedEx International MailService. VAMOX VAMOX. AMS_GRP AMS Group. DHL_JP DHL Japan. HRPARCEL HR Parcel. GESWL GESWL Express. BLUESTAR Blue Star. CDEK_TR CDEK TR. DESCARTES Innovel courier. DELTEC_UK Deltec Courier. DTDC_EXPRESS DTDC express. TOURLINE tourline. BH_WORLDWIDE B&H Worldwide. OCS OCS ANA Group. YINGNUO_LOGISTICS yingnuo logistics. UPS United Parcel Service. TOLL Toll IPEC. PRT_SEUR SEUR portugal. DTDC_AU DTDC Australia. THA_DYNAMIC_LOGISTICS Dynamic Logistics. UBI_LOGISTICS UBI Smart Parcel. FEDEX_CROSSBORDER FedEx Cross Border. A1POST A1Post. TAZMANIAN_FREIGHT Tazmanian Freight Systems. CJ_INT_MY CJ International malaysia. SAIA_FREIGHT Saia LTL Freight. SG_QXPRESS Qxpress. NHANS_SOLUTIONS Nhans Solutions. DPD_FR DPD France. COORDINADORA Coordinadora. ANDREANI Grupo logistico Andreani. DOORA Doora Logistics. INTERPARCEL_NZ Interparcel New Zealand. PHL_JAMEXPRESS Jam Express Philippines. BEL_BELGIUM_POST bel_belgium_post. US_APC us_apc. IDN_POS idn_pos. FR_MONDIAL fr_mondial. DE_DHL DE DHL. HK_RPX hk_rpx. DHL_PIECEID dhl_pieceid. VNPOST_EMS vnpost_ems. RRDONNELLEY rrdonnelley. DPD_DE dpd_de. DELCART_IN delcart_in. IMEXGLOBALSOLUTIONS imexglobalsolutions. ACOMMERCE ACOMMERCE. EURODIS eurodis. CANPAR CANPAR. GLS GLS. IND_ECOM Ecom Express. ESP_ENVIALIA Envialia. DHL_UK dhl UK. SMSA_EXPRESS SMSA Express. TNT_FR TNT France. DEX_I DEX-I courier. BUDBEE_WEBHOOK Budbee courier. COPA_COURIER Copa Airlines Courier. VNM_VIETNAM_POST Vietnam Post. DPD_HK DPD HongKong. TOLL_NZ Toll New Zealand. ECHO Echo courier. FEDEX_FR FedEx® Freight. BORDEREXPRESS Border Express. MAILPLUS_JPN MailPlus (Japan). TNT_UK_REFR TNT UK Reference. KEC KEC courier. DPD_RO DPD Romania. TNT_JP TNT_JP. TH_CJ TH_CJ. EC_CN EC_CN. FASTWAY_UK FASTWAY_UK. FASTWAY_US FASTWAY_US. GLS_DE GLS_DE. GLS_ES GLS_ES. GLS_FR GLS_FR. MONDIAL_BE MONDIAL_BE. SGT_IT SGT_IT. TNT_CN TNT_CN. TNT_DE TNT_DE. TNT_ES TNT_ES. TNT_PL TNT_PL. PARCELFORCE PARCELFORCE. SWISS_POST SWISS POST. TOLL_IPEC TOLL IPEC. AIR_21 AIR 21. AIRSPEED AIRSPEED. BERT BERT. BLUEDART BLUEDART. COLLECTPLUS COLLECTPLUS. COURIERPLUS COURIERPLUS. COURIER_POST COURIER POST. DHL_GLOBAL_MAIL dhl_global_mail. DPD_UK dpd_uk. DELTEC_DE DELTEC DE. DEUTSCHE_DE deutsche_de. DOTZOT DOTZOT. ELTA_GR elta_gr. EMS_CN ems_cn. ECARGO ECARGO. ENSENDA ENSENDA. FERCAM_IT fercam_it. FASTWAY_ZA fastway_za. FASTWAY_AU fastway_au. FIRST_LOGISITCS first_logisitcs. GEODIS GEODIS. GLOBEGISTICS GLOBEGISTICS. GREYHOUND GREYHOUND. JETSHIP_MY jetship_my. LION_PARCEL LION PARCEL. AEROFLASH AEROFLASH. ONTRAC ONTRAC. SAGAWA SAGAWA. SIODEMKA SIODEMKA. STARTRACK startrack. TNT_AU tnt_au. TNT_IT tnt_it. TRANSMISSION TRANSMISSION. YAMATO YAMATO. DHL_IT dhl_it. DHL_AT dhl_at. LOGISTICSWORLDWIDE_KR LOGISTICSWORLDWIDE KR. GLS_SPAIN gls_spain. AMAZON_UK_API amazon_uk_api. DPD_FR_REFERENCE dpd_fr_reference. DHLPARCEL_UK dhlparcel_uk. MEGASAVE megasave. QUALITYPOST qualitypost. IDS_LOGISTICS ids_logistics. JOYINGBOX joyingbox. PANTHER_ORDER_NUMBER panther_order_number. WATKINS_SHEPARD watkins_shepard. FASTTRACK fasttrack. UP_EXPRESS up_express. ELOGISTICA elogistica. ECOURIER ecourier. CJ_PHILIPPINES cj_philippines. SPEEDEX speedex. ORANGECONNEX orangeconnex. TECOR tecor. SAEE saee. GLS_ITALY_FTP gls_italy_ftp. DELIVERE delivere. YYCOM yycom. ADICIONAL_PT Adicional Logistics. DKSH DKSH. NIPPON_EXPRESS_FTP Nippon Express. GOLS GO Logistics & Storage. FUJEXP FUJIE EXPRESS. QTRACK QTrack. OMLOGISTICS_API OM LOGISTICS LTD. GDPHARM GDPharm Logistics. MISUMI_CN MISUMI Group Inc.. AIR_CANADA Rivo. CITY56_WEBHOOK City Express. SAGAWA_API Sagawa. KEDAEX KedaEX. PGEON_API Pgeon. WEWORLDEXPRESS We World Express. JT_LOGISTICS J&T International logistics. TRUSK Trusk France. VIAXPRESS ViaXpress. DHL_SUPPLYCHAIN_ID DHL Supply Chain Indonesia. ZUELLIGPHARMA_SFTP Zuellig Pharma Korea. MEEST Meest. TOLL_PRIORITY Toll Priority. MOTHERSHIP_API Mothership. CAPITAL Capital Transport. EUROPAKET_API Europacket+. HFD HFD. TOURLINE_REFERENCE Tourline Express. GIO_ECOURIER GIO Express Inc. CN_LOGISTICS CN Logistics. PANDION Pandion. BPOST_API Bpost API. PASSPORTSHIPPING Passport Shipping. PAKAJO Pakajo World. DACHSER DACHSER. YUSEN_SFTP Yusen Logistics. SHYPLITE Shypmax. XYY Xingyunyi Logistics. MWD Metropolitan Warehouse & Delivery. FAXECARGO Faxe Cargo. MAZET Groupe Mazet. FIRST_LOGISTICS_API First Logistics. SPRINT_PACK SPRINT PACK. HERMES_DE_FTP Hermes Germany. CONCISE Concise. KERRY_EXPRESS_TW_API Kerry Express TaiWan. EWE EWE Global Express. FASTDESPATCH Fast Despatch Logistics Limited. ABCUSTOM_SFTP AB Custom Group. CHAZKI Chazki. SHIPPIE Shippie. GEODIS_API GEODIS - Distribution & Express. NAQEL_EXPRESS Naqel Express. PAPA_WEBHOOK Papa. FORWARDAIR Forward Air. DIALOGO_LOGISTICA_API Dialogo Logistica. LALAMOVE_API Lalamove. TOMYDOOR Tomydoor. KRONOS_WEBHOOK Kronos Express. JTCARGO J&T CARGO. T_CAT T-cat. CONCISE_WEBHOOK Concise. TELEPORT_WEBHOOK Teleport. CUSTOMCO_API The Custom Companies. SPX_TH Shopee Xpress. BOLLORE_LOGISTICS Bollore Logistics. CLICKLINK_SFTP ClickLink. M3LOGISTICS M3 Logistics. VNPOST_API Vietnam Post. AXLEHIRE_FTP Axlehire. SHADOWFAX Shadowfax. MYHERMES_UK_API EVRi. DAIICHI Daiichi Freight System Inc. MENSAJEROSURBANOS_API Mensajeros Urbanos. POLARSPEED PolarSpeed Inc. IDEXPRESS_ID iDexpress Indonesia. PAYO Payo. WHISTL_SFTP Whistl. INTEX_DE INTEX Paketdienst GmbH. TRANS2U Trans2u. PRODUCTCAREGROUP_SFTP Product Care Services Limited. BIGSMART Big Smart. EXPEDITORS_API_REF Expeditors API Reference. AITWORLDWIDE_API AIT. WORLDCOURIER World Courier. QUIQUP Quiqup. AGEDISS_SFTP Agediss. ANDREANI_API Andreani. CRLEXPRESS CRL Express. SMARTCAT SMARTCAT. CROSSFLIGHT Crossflight Limited. PROCARRIER Pro Carrier. DHL_REFERENCE_API DHL (Reference number). SEINO_API Seino. WSPEXPRESS WSP Express. KRONOS Kronos Express. TOTAL_EXPRESS_API Total Express. PARCLL PARCLL. XPEDIGO Xpedigo. STAR_TRACK_WEBHOOK StarTrack. GPOST Georgian Post. UCS UCS. DMFGROUP DMF. COORDINADORA_API Coordinadora. MARKEN Marken. NTL NTL logistics. REDJEPAKKETJE Red je Pakketje. ALLIED_EXPRESS_FTP Allied Express (FTP). MONDIALRELAY_ES Mondial Relay Spain(Punto Pack). NAEKO_FTP Naeko Logistics. MHI Mhi. SHIPPIFY Shippify, Inc. MALCA_AMIT_API Malca Amit. JTEXPRESS_SG_API J&T Express Singapore. DACHSER_WEB DACHSER. FLIGHTLG Flight Logistics Group. CAGO Cago. COM1EXPRESS ComOne Express. TONAMI_FTP Tonami. PACKFLEET PACKFLEET. PUROLATOR_INTERNATIONAL Purolator International. WINESHIPPING_WEBHOOK Wineshipping. DHL_ES_SFTP DHL Spain Domestic. PCHOME_API 網家速配股份有限公司. CESKAPOSTA_API Czech Post. GORUSH Go Rush. HOMERUNNER HomeRunner. AMAZON_ORDER Amazon order. EFWNOW_API Estes Forwarding Worldwide. CBL_LOGISTICA_API CBL Logistica (API). NIMBUSPOST NimbusPost. LOGWIN_LOGISTICS Logwin Logistics. NOWLOG_API Sequoialog. DPD_NL DPD Netherlands. GODEPENDABLE Dependable Supply Chain Services. ESDEX Top Ideal Express. LOGISYSTEMS_SFTP Kiitäjät. EXPEDITORS Expeditors. SNTGLOBAL_API Snt Global Etrax. SHIPX ShipX. QINTL_API Quickstat Courier LLC. PACKS Packs. POSTNL_INTERNATIONAL PostNL International. AMAZON_EMAIL_PUSH Amazon. DHL_API DHL. SPX Shopee Express. AXLEHIRE AxleHire. ICSCOURIER ICS COURIER. DIALOGO_LOGISTICA Dialogo Logistica. SHUNBANG_EXPRESS ShunBang Express. TCS_API TCS. SF_EXPRESS_CN SF Express China. PACKETA Packeta. SIC_TELIWAY Teliway SIC Express. MONDIALRELAY_FR Mondial Relay France. INTIME_FTP InTime. JD_EXPRESS 京东物流. FASTBOX Fastbox. PATHEON Patheon Logistics. INDIA_POST India Post Domestic. TIPSA_REF Tipsa Reference. ECOFREIGHT Eco Freight. VOX VOX SOLUCION EMPRESARIAL SRL. DIRECTFREIGHT_AU_REF Direct Freight Express. BESTTRANSPORT_SFTP Best Transport. AUSTRALIA_POST_API Australia Post. FRAGILEPAK_SFTP FragilePAK. FLIPXP FlipXpress. VALUE_WEBHOOK Value Logistics. DAESHIN Daeshin. SHERPA Sherpa. MWD_API Metropolitan Warehouse & Delivery. SMARTKARGO SmartKargo. DNJ_EXPRESS DNJ Express. GOPEOPLE Go People. MYSENDLE_API mySendle. ARAMEX_API Aramex. PIDGE Pidge. THAIPARCELS TP Logistic. PANTHER_REFERENCE_API Panther Reference. POSTAPLUS Posta Plus. BUFFALO BUFFALO. U_ENVIOS U-ENVIOS. ELITE_CO Elite Express. ROCHE_INTERNAL_SFTP Roche Internal Courier. DBSCHENKER_ICELAND DB Schenker Iceland. TNT_FR_REFERENCE TNT France Reference. NEWGISTICSAPI Newgistics API. GLOVO Glovo. GWLOGIS_API G.I.G. SPREETAIL_API Spreetail. MOOVA Moova. PLYCONGROUP Plycon Transportation Group. USPS_WEBHOOK USPS Informed Visibility - Webhook. REIMAGINEDELIVERY maergo. EDF_FTP Eurodifarm. DAO365 DAO365. BIOCAIR_FTP BioCair. RANSA_WEBHOOK Ransa. SHIPXPRES SHIPXPRESS. COURANT_PLUS_API Courant Plus. SHIPA SHIPA. HOMELOGISTICS Home Logistics. DX DX. POSTE_ITALIANE_PACCOCELERE Poste Italiane Paccocelere. TOLL_WEBHOOK Toll Group. LCTBR_API LCT do Brasil. DX_FREIGHT DX Freight. DHL_SFTP DHL Express. SHIPROCKET Shiprocket X. UBER_WEBHOOK Uber. STATOVERNIGHT Stat Overnight. BURD Burd Delivery. FASTSHIP Fastship Express. IBVENTURE_WEBHOOK IB Venture. GATI_KWE_API Gati-KWE. CRYOPDP_FTP CryoPDP. HUBBED HUBBED. TIPSA_API Tipsa API. ARASKARGO Aras Cargo. THIJS_NL Thijs Logistiek. ATSHEALTHCARE_REFERENCE ATS Healthcare. 99MINUTOS 99minutos. HELLENIC_POST Hellenic (Greece) Post. HSM_GLOBAL HSM Global. MNX MNX. NMTRANSFER N&M Transfer Co., Inc.. LOGYSTO Logysto. INDIA_POST_INT India Post International. AMAZON_FBA_SWISHIP_IN Swiship IN. SRT_TRANSPORT SRT Transport. BOMI Bomi Group. DELIVERR_SFTP Deliverr. HSDEXPRESS HSDEXPRESS. SIMPLETIRE_WEBHOOK SimpleTire. HUNTER_EXPRESS_SFTP Hunter Express. UPS_API UPS. WOOYOUNG_LOGISTICS_SFTP WOO YOUNG LOGISTICS CO.,LTD.. PHSE_API PHSE. WISH_EMAIL_PUSH Wish. NORTHLINE Northline. MEDAFRICA Med Africa Logistics. DPD_AT_SFTP DPD Austria. ANTERAJA Anteraja. DHL_GLOBAL_FORWARDING_API DHL Global Forwarding API. LBCEXPRESS_API LBC EXPRESS INC.. SIMSGLOBAL Sims Global. CDLDELIVERS CDL Last Mile. TYP TYP. TESTING_COURIER_WEBHOOK Testing Courier. PANDAGO_API Pandago. ROYAL_MAIL_FTP Royal Mail. THUNDEREXPRESS Thunder Express Australia. SECRETLAB_WEBHOOK Secretlab. SETEL Setel Express. JD_WORLDWIDE JD Worldwide. DPD_RU_API DPD Russia. ARGENTS_WEBHOOK Argents Express Group. POSTONE Post ONE. TUSKLOGISTICS Tusk Logistics. RHENUS_UK_API Rhenus Logistics UK. TAQBIN_SG_API Yamato Singapore. INNTRALOG_SFTP Inntralog GmbH. DAYROSS Day & Ross. CORREOSEXPRESS_API Correos Express (API). INTERNATIONAL_SEUR_API International Seur API. YODEL_API Yodel API. HEROEXPRESS Hero Express. DHL_SUPPLYCHAIN_IN DHL supply chain India. URGENT_CARGUS Urgent Cargus. FRONTDOORCORP FRONTdoor Collective. JTEXPRESS_PH J&T Express Philippines. PARCELSTARS_WEBHOOK Parcelstars. DPD_SK_SFTP DPD Slovakia. MOVIANTO Movianto. OZEPARTS_SHIPPING Ozeparts Shipping. KARGOMKOLAY KargomKolay (CargoMini). TRUNKRS Trunkrs. OMNIRPS_WEBHOOK Omni Returns. CHILEXPRESS Chile Express. TESTING_COURIER Testing Courier. JNE_API JNE (API). BJSHOMEDELIVERY_FTP BJS Distribution, Storage & Couriers - FTP. DEXPRESS_WEBHOOK D Express. USPS_API USPS API. TRANSVIRTUAL TransVirtual. SOLISTICA_API solistica. CHIENVENTURE_WEBHOOK Chienventure. DPD_UK_SFTP DPD UK. INPOST_UK InPost. JAVIT Javit. ZTO_DOMESTIC ZTO Express China. DHL_GT_API DHL Global Forwarding Guatemala. CEVA_TRACKING CEVA Package. KOMON_EXPRESS Komon Express. EASTWESTCOURIER_FTP East West Courier Pte Ltd. DANNIAO Danniao. SPECTRAN Spectran. DELIVER_IT Deliver-iT. RELAISCOLIS Relais Colis. GLS_SPAIN_API GLS Spain. POSTPLUS PostPlus. AIRTERRA Airterra. GIO_ECOURIER_API GIO Express Ecourier. DPD_CH_SFTP DPD Switzerland. FEDEX_API FedEx®. INTERSMARTTRANS INTERSMARTTRANS & SOLUTIONS SL. HERMES_UK_SFTP Hermes UK. EXELOT_FTP Exelot Ltd.. DHL_PA_API DHL GLOBAL FORWARDING PANAMÁ. VIRTRANSPORT_SFTP Vir Transport. WORLDNET Worldnet Logistics. INSTABOX_WEBHOOK Instabox. KNG Keuhne + Nagel Global. FLASHEXPRESS_WEBHOOK Flash Express. MAGYAR_POSTA_API Magyar Posta. WESHIP_API WeShip. OHI_WEBHOOK Ohi. MUDITA MUDITA. BLUEDART_API Bluedart. T_CAT_API T-cat. ADS ADS Express. HERMES_IT HR Parcel. FITZMARK_API FitzMark. POSTI_API Posti API. SMSA_EXPRESS_WEBHOOK SMSA Express. TAMERGROUP_WEBHOOK Tamer Logistics. LIVRAPIDE Livrapide. NIPPON_EXPRESS Nippon Express. BETTERTRUCKS Better Trucks. FAN FAN COURIER EXPRESS. PB_USPSFLATS_FTP USPS Flats (Pitney Bowes). PARCELRIGHT Parcel Right. ITHINKLOGISTICS iThink Logistics. KERRY_EXPRESS_TH_WEBHOOK Kerry Logistics. ECOUTIER eCoutier. SHOWL SENHONG INTERNATIONAL LOGISTICS. BRT_IT_API BRT Bartolini API. RIXONHK_API Rixon Logistics. DBSCHENKER_API DB Schenker. ILYANGLOGIS Ilyang logistics. MAIL_BOX_ETC Mail Boxes Etc.. WESHIP WeShip. DHL_GLOBAL_MAIL_API DHL eCommerce Solutions. ACTIVOS24_API Activos24. ATSHEALTHCARE ATS Healthcare. LUWJISTIK Luwjistik. GW_WORLD Gebrüder Weiss. FAIRSENDEN_API fairsenden. SERVIP_WEBHOOK SerVIP. SWISHIP Swiship. TANET Transport Ambientales. HOTSIN_CARGO SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD. DIREX Direx. HUANTONG HuanTong. IMILE_API iMile. AUEXPRESS Au Express. NYTLOGISTICS NYT SUPPLY CHAIN LOGISTICS Co.,LTD. DSV_REFERENCE DSV Futurewave. NOVOFARMA_WEBHOOK Novofarma. AITWORLDWIDE_SFTP AIT. SHOPOLIVE Olive. FNF_ZA Fast & Furious. DHL_ECOMMERCE_GC DHL eCommerce Greater China. FETCHR Fetchr. STARLINKS_API Starlinks Global. YYEXPRESS YYEXPRESS. SERVIENTREGA Servientrega. HANJIN HanJin. SPANISH_SEUR_FTP Spanish Seur. DX_B2B_CONNUM DX (B2B). HELTHJEM_API Helthjem. INEXPOST Inexpost. A2B_BA A2B Express Logistics. RHENUS_GROUP Rhenus Logistics. SBERLOGISTICS_RU Sber Logistics. MALCA_AMIT Malca-Amit. PPL Professional Parcel Logistics. OSM_WORLDWIDE_SFTP OSM Worldwide. ACILOGISTIX ACI Logistix. OPTIMACOURIER Optima Courier. NOVA_POSHTA_API Nova Poshta API. LOGGI Loggi. YIFAN YiFan Express. MYDYNALOGIC My DynaLogic. MORNINGLOBAL Morning Global. CONCISE_API Concise. FXTRAN Falcon Express. DELIVERYOURPARCEL_ZA Deliver Your Parcel. UPARCEL uParcel. MOBI_BR Mobi Logistica. LOGINEXT_WEBHOOK T&W Delivery. EMS EMS. SPEEDY Speedy. ZOOM_RED Zoom. NAVLUNGO Navlungo. CASTLEPARCELS Castle Parcels. WEEE Weee. PACKALY Packaly. YUNHUIPOST Yunhuipost. YOUPARCEL YouParcel. LEMAN Leman. MOOVIN Moovin. URB_IT Urb-it. MULTIENTREGAPANAMA Multientrega. JUSDASR Jusdasr. DISCOUNTPOST Discount Post. RHENUS_UK Rhenus Logistics UK. SWISHIP_JP Swiship JP. GLS_US GLS USA. SMTL Southwestern Motor Transport. Inc. EMEGA Discount Post Emega. EXPRESSONE_SV EXPRESSONE Slovenia. HEPSIJET hepsiJET. WELIVERY Welivery. BRINGER Bringer Parcel Services. EASYROUTES EasyRoutes. MRW MRW. RPM RPM. DPD_PRT DPD Portugal. GLS_ROMANIA GLS Romania. LMPARCEL LM Parcel. GTAGSM GTA GSM. DOMINO DOMINO. ESHIPPER eShipper. TRANSPAK Transpak Inc.. XINDUS Xindus. AOYUE Aoyue. EASYPARCEL Easyparcel. EXPRESSONE EXPRESSONE. SENDEO_KARGO Sendeo Kargo. SPEEDAF Speedaf Express. ETOWER eTower. GCX GC Express. NINJAVAN_VN Ninjavan Vietnam. ALLEGRO Allegro. JUMPPOINT Jumppoint. SHIPGLOBAL_US ShipGlobal. KINISI Kinisi Transport Pty Ltd. OAKH Oakh Harbour Freight Lines. AWEST American West. BARSAN Barsan Global Lojistik. ENERGOLOGISTIC Energo Logistic. MADROOEX Madrooex. GOBOLT GoBolt. SWISS_UNIVERSAL_EXPRESS Swiss Universal Express. IORDIRECT IOR Direct Solutions. XMSZM xmszm. GLS_HUN GLS Hungary. SENDY Sendy Express. BRAUNSEXPRESS Brauns Express. GRANDSLAMEXPRESS Grand Slam Express. XGS XGS. OTSCHILE OTS. PACK_UP Pack-Up. PARCELSTARS Parcelstars. TEAMEXPRESSLLC Team Express Service LLC. ASYADEXPRESS Asyad Express. TDN TDN. EARLYBIRD Early Bird. CACESA Cacesa. PARCELJET Parceljet. MNG_KARGO MNG Kargo. SUPERPACKLINE Super Pac Line. SPEEDX SpeedX. VESYL Vesyl. SKYKING Sky King. DIRMENSAJERIA DIR. NETLOGIXGROUP Netlogix. ZYOU ZYEX. JAWAR Jawar. AGSYSTEMS Associate Global Systems. GPS GPS. PTT_KARGO PTT Kargo. MAERGO Maergo. ARIHANTCOURIER AICS. VTFE VicTas Freight Express. YUNANT Yunant. URBIFY Urbify. PACK_MAN pack-man. LIEFERGRUN LIEFERGRUN. OBIBOX Obibox. PAIKEDA Paikeda. SCOTTY Scotty. INTELCOM_CA Intelcom. SWE swe. ASENDIA Asendia Global. DPD_AT DPD Austria. RELAY Relay. ATA ATA. SKYEXPRESS_INTERNATIONAL SkyExpress Internationals. SURAT_KARGO Surat Kargo. SGLINK SG LINK. FLEETOPTICSINC FleetOptics. SHOPLINE shopline. PIGGYSHIP PIGGYSHIP. LOGOIX LogoiX. KOLAY_GELSIN Kolay Gelsin. ASSOCIATED_COURIERS Associated Couriers. UPS_CHECKER ups-checker. WINESHIPPING Wineshipping. SPEDISCI Spedisci online. FOURKITES Fourkites. ETONAS Etonas. FINMILE Fin Mile. UNIUNI Uniuni. RODONAVES Rodonaves. INPOST_IT Inpost Italy. TFORCE_FREIGHT Tforce Freight. RICHMOM Rich Mom. FRANCO Corriere Franco. ECPARCEL Ecparcel. FEDEX_CHINA Fedex China. GOFO_EXPRESS Gofo Express. SHIPBOB Shipbob. JERSEYPOST_ATLAS Jersey Post Group. CORETRAILS Coretrails. RHENUS_ITALY Rhenus Logistics Italy. JADLOG Jadlog. JITSU Jitsu. YANWEN_EXPRESS Yanwen Express. DASHLINK Dashlink. SEINO_SUPER_EXPRESS Seino Super Express. FLOSHIP Floship. METROSCG Metro Supply Chain. SENDPARCEL Sendparcel. P2P P2p. CN_EXPRESS Cn Express. CIRROTRACK Cirro Track. LAND_LOGISTICS Land Logistics. VEHO Veho. MEDLINE Medline. VDTRACK Vdtrack. SINO_SCM Sino Scm. 3PE_EXPRESS 3pe Express. SWIFTX Swiftx. SFYDEXPRESS Sfyd Express. TOPTRANS Toptrans. Copy "DPD_RU" charge_pattern Expected business/pricing model for the billing agreement.
string [ 1 .. 30 ] characters ^[A-Z0-9_]+$ Expected business/pricing model for the billing agreement.
Enum Value Description IMMEDIATE On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency. DEFERRED Pay after use, non-recurring post-paid, variable amount, irregular frequency. RECURRING_PREPAID Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. RECURRING_POSTPAID Pay on a fixed date based on usage or consumption after the goods/service is delivered. THRESHOLD_PREPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. THRESHOLD_POSTPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. SUBSCRIPTION_PREPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered. SUBSCRIPTION_POSTPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered. UNSCHEDULED_PREPAID Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans. UNSCHEDULED_POSTPAID Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans. INSTALLMENT_PREPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered. INSTALLMENT_POSTPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. Copy "IMMEDIATE" checkout_payment_intent The intent to either capture payment immediately or authorize a payment for an order after order creation.
string The intent to either capture payment immediately or authorize a payment for an order after order creation.
Enum Value Description CAPTURE The merchant intends to capture payment immediately after the customer makes a payment. AUTHORIZE The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order. Copy "CAPTURE" cobranded_card Details about the merchant cobranded card used for order purchase.
labels
Array of strings [ 1 .. 25 ] items
Array of labels for the cobranded card.
payee
object
Merchant associated with the purchase.
amount
object
Amount that was charged to the cobranded card.
CopyExpand allCollapse all { "labels": [ "string" ], "payee": { "email_address": "string", "merchant_id": "string" }, "amount": { "currency_code": "str", "value": "string" } } confirm_order_request Payer confirms the intent to pay for the Order using the provided payment source.
application_context object Customizes the payer confirmation experience.
payment_source required object The payment source definition.
CopyExpand allCollapse all { "application_context": { "brand_name": "string", "return_url": "http://example.com", "cancel_url": "http://example.com", "locale": "string", "stored_payment_source": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } } }, "payment_source": { "card": { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "token": { "id": "string", "type": "BILLING_AGREEMENT" }, "paypal": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } }, "bancontact": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "blik": { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string", "consumer_user_agent": "string", "consumer_ip": "string" }, "level_0": { "auth_code": "string" }, "one_click": { "auth_code": "string", "consumer_reference": "string", "alias_label": "stringst", "alias_key": "string" } }, "eps": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "giropay": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "ideal": { "name": "string", "country_code": "string", "bic": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "mybank": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "p24": { "name": "string", "email": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "sofort": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "trustly": { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "apple_pay": { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "venmo": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } } } country_code The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. string (country_code) = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy "st" country_code The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. string (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy "st" country_code The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. string (country_code) = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy "st" currency_code The three-character ISO-4217 currency code that identifies the currency.
string (currency_code) = 3 characters The three-character ISO-4217 currency code that identifies the currency.
Copy "str" currency_code The 3-character ISO-4217 currency code that identifies the currency.
string (currency_code) = 3 characters The 3-character ISO-4217 currency code that identifies the currency.
Copy "str" customer This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
id
string [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.
name
object
The full name of the customer as provided to the merchant or on file with the merchant.
CopyExpand allCollapse all { "id": "string", "name": { "given_name": "string", "surname": "string" } } customer This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
id
string [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.
phone
object
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.
name
object
The full name of the customer as provided to the merchant or on file with the merchant.
CopyExpand allCollapse all { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } } date_no_time The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
string (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
Copy "stringstri" date_no_time The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
string (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
Copy "stringstri" date_no_time The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
string (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
Copy "stringstri" date_time The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates. string (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates. Copy "stringstringstringst" date_time The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates. string (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates. Copy "stringstringstringst" date_year_month The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
Copy "strings" date_year_month The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
Copy "strings" disbursement_mode The funds that are held on behalf of the merchant.
string [ 1 .. 16 ] characters ^[A-Z_]+$ Default: "INSTANT" The funds that are held on behalf of the merchant.
Enum Value Description INSTANT The funds are released to the merchant immediately. DELAYED The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration. Copy "INSTANT" discount_with_breakdown The discount amount and currency code. For list of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
currency_code required string = 3 characters The three-character ISO-4217 currency code that identifies the currency.
value required string <= 32 characters The value, which might be:
An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes. Copy { "currency_code": "str", "value": "string" } eci_flag Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.
Enum Value Description MASTERCARD_NON_3D_SECURE_TRANSACTION Mastercard non-3-D Secure transaction. MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION Mastercard attempted authentication transaction. MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION Mastercard fully authenticated transaction. FULLY_AUTHENTICATED_TRANSACTION VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction. ATTEMPTED_AUTHENTICATION_TRANSACTION VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction. NON_3D_SECURE_TRANSACTION VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction. Copy "MASTERCARD_NON_3D_SECURE_TRANSACTION" email The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists. string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists. Copy "string" email_address The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists. string (email_address) [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists. Copy "string" email_address The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists. string (email_address) [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists. Copy "string" enrolled Status of Authentication eligibility.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Status of Authentication eligibility.
Enum Value Description Y Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl. N No. The bank is not participating in 3-D Secure protocol. U Unavailable. The DS or ACS is not available for authentication at the time of the request. B Bypass. The merchant authentication rule is triggered to bypass authentication. Copy "Y" eps Information used to pay using eps.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
Copy { "name": "string", "country_code": "string", "bic": "string" } eps_request Information needed to pay using eps.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } Error The error details.
name required string The human-readable, unique name of the error.
message required string The message that describes the error.
debug_id required string The PayPal internal ID. Used for correlation purposes.
details Array of objects An array of additional details about the error.
links
Array of objects
An array of request-related HATEOAS links.
CopyExpand allCollapse all { "name": "string", "message": "string", "debug_id": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "description": "string" } ], "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ] } Error Details The error details. Required for client-side 4XX errors.
field
string
The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.
value
string
The value of the field that caused the error.
location
string
Default: "body"
The location of the field that caused the error. Value is body, path, or query.
issue required string The unique, fine-grained application-level error code.
links
Array of objects [ 1 .. 4 ] items
An array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions.
description string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.
CopyExpand allCollapse all { "field": "string", "value": "string", "location": "body", "issue": "string", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "description": "string" } exchange_rate The exchange rate that determines the amount to convert from one currency to another currency.
value
string
The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point.
source_currency string = 3 characters The source currency from which to convert an amount.
target_currency string = 3 characters The target currency to which to convert an amount.
Copy { "value": "string", "source_currency": "str", "target_currency": "str" } experience_context_base Customizes the payer experience during the approval process for the payment.
brand_name
string [ 1 .. 127 ] characters
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.
shipping_preference string [ 1 .. 24 ] characters Default: "GET_FROM_FILE" The location from which the shipping address is derived.
Enum Value Description
GET_FROM_FILE Get the customer-provided shipping address on the PayPal site.
NO_SHIPPING Redacts the shipping address from the PayPal site. Recommended for digital goods.
SET_PROVIDED_ADDRESS Merchant sends the shipping address using purchase_units.shipping.address. The customer cannot change this address on the PayPal site.
locale
string [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.
return_url
string
The URL where the customer is redirected after the customer approves the payment.
cancel_url
string
The URL where the customer is redirected after the customer cancels the payment.
Copy { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } experience_context_base Customizes the payer experience during the approval process for the payment.
locale
string [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.
return_url
string
The URL where the customer is redirected after the customer approves the payment.
cancel_url
string
The URL where the customer is redirected after the customer cancels the payment.
Copy { "locale": "string", "return_url": "string", "cancel_url": "string" } giropay Information needed to pay using giropay.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
Copy { "name": "string", "country_code": "string", "bic": "string" } giropay_request Information needed to pay using giropay.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } google_pay Google Pay Wallet payment data.
name
string [ 3 .. 300 ] characters
Name on the account holder associated with Google Pay.
email_address
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with Google Pay.
phone_number
object
The phone number of account holder, in its canonical international E.164 numbering plan format. Supports only the national_number property.
card
object
The Card from Google Pay Wallet used to fund the payment.
CopyExpand allCollapse all { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "last_digits": "stri", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } } } } google_pay_card The payment card used to fund a Google Pay payment. Can be a credit or debit card.
name
string [ 1 .. 300 ] characters
The card holder's name as it appears on the card.
type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.
Enum Value Description
CREDIT A credit card.
DEBIT A debit card.
PREPAID A Prepaid card.
STORE A store card.
UNKNOWN Card type cannot be determined.
brand
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description VISA Visa card. MASTERCARD Mastercard card. DISCOVER Discover card. AMEX American Express card. SOLO Solo debit card. JCB Japan Credit Bureau card. STAR Military Star card. DELTA Delta Airlines card. SWITCH Switch credit card. MAESTRO Maestro credit card. CB_NATIONALE Carte Bancaire (CB) credit card. CONFIGOGA Configoga credit card. CONFIDIS Confidis credit card. ELECTRON Visa Electron credit card. CETELEM Cetelem credit card. CHINA_UNION_PAY China union pay credit card. DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. ELO The Brazilian Elo card payment network. HIPER The Hiper - Ingenico ePayment network. HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market. RUPAY The RuPay payment network. GE The GE Credit Union 3Point card payment network. SYNCHRONY The Synchrony Financial (SYF) payment network. EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. CARTE_BANCAIRE The Carte Bancaire payment network. STAR_ACCESS The Star Access payment network. PULSE The Pulse payment network. NYCE The NYCE payment network. ACCEL The Accel payment network. UNKNOWN UNKNOWN payment network. billing_address object The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
CopyExpand allCollapse all { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } google_pay_card The payment card used to fund a Google Pay payment. Can be a credit or debit card.
name
string [ 1 .. 300 ] characters
The card holder's name as it appears on the card.
number
string [ 13 .. 19 ] characters
The primary account number (PAN) for the payment card.
last_digits string [ 2 .. 4 ] characters The last digits of the payment card.
expiry
string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format.
type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.
Enum Value Description
CREDIT A credit card.
DEBIT A debit card.
PREPAID A Prepaid card.
STORE A store card.
UNKNOWN Card type cannot be determined.
brand
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description VISA Visa card. MASTERCARD Mastercard card. DISCOVER Discover card. AMEX American Express card. SOLO Solo debit card. JCB Japan Credit Bureau card. STAR Military Star card. DELTA Delta Airlines card. SWITCH Switch credit card. MAESTRO Maestro credit card. CB_NATIONALE Carte Bancaire (CB) credit card. CONFIGOGA Configoga credit card. CONFIDIS Confidis credit card. ELECTRON Visa Electron credit card. CETELEM Cetelem credit card. CHINA_UNION_PAY China union pay credit card. DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. ELO The Brazilian Elo card payment network. HIPER The Hiper - Ingenico ePayment network. HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market. RUPAY The RuPay payment network. GE The GE Credit Union 3Point card payment network. SYNCHRONY The Synchrony Financial (SYF) payment network. EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. CARTE_BANCAIRE The Carte Bancaire payment network. STAR_ACCESS The Star Access payment network. PULSE The Pulse payment network. NYCE The NYCE payment network. ACCEL The Accel payment network. UNKNOWN UNKNOWN payment network. billing_address object The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
CopyExpand allCollapse all { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } google_pay_card_response The payment card to use to fund a Google Pay payment response. Can be a credit or debit card.
name
string [ 1 .. 300 ] characters
The card holder's name as it appears on the card.
last_digits string [ 2 .. 4 ] characters The last digits of the payment card.
type
string [ 1 .. 255 ] characters ^[A-Z_]+$
The payment card type.
Enum Value Description
CREDIT A credit card.
DEBIT A debit card.
PREPAID A Prepaid card.
STORE A store card.
UNKNOWN Card type cannot be determined.
brand
string [ 1 .. 255 ] characters ^[A-Z_]+$
The card brand or network. Typically used in the response.
Enum Value Description VISA Visa card. MASTERCARD Mastercard card. DISCOVER Discover card. AMEX American Express card. SOLO Solo debit card. JCB Japan Credit Bureau card. STAR Military Star card. DELTA Delta Airlines card. SWITCH Switch credit card. MAESTRO Maestro credit card. CB_NATIONALE Carte Bancaire (CB) credit card. CONFIGOGA Configoga credit card. CONFIDIS Confidis credit card. ELECTRON Visa Electron credit card. CETELEM Cetelem credit card. CHINA_UNION_PAY China union pay credit card. DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. ELO The Brazilian Elo card payment network. HIPER The Hiper - Ingenico ePayment network. HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market. RUPAY The RuPay payment network. GE The GE Credit Union 3Point card payment network. SYNCHRONY The Synchrony Financial (SYF) payment network. EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. CARTE_BANCAIRE The Carte Bancaire payment network. STAR_ACCESS The Star Access payment network. PULSE The Pulse payment network. NYCE The NYCE payment network. ACCEL The Accel payment network. UNKNOWN UNKNOWN payment network. billing_address object The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
authentication_result
object
Results of Authentication such as 3D Secure.
CopyExpand allCollapse all { "name": "string", "last_digits": "stri", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } } } google_pay_decrypted_token_data Details shared by Google for the merchant to be shared with PayPal. This is required to process the transaction using the Google Pay payment method.
message_id
string [ 1 .. 250 ] characters
A unique ID that identifies the message in case it needs to be revoked or located at a later time.
message_expiration
string = 13 characters
Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired.
payment_method required string = 4 characters The type of the payment credential. Currently, only CARD is supported.
Value Description CARD CARD is the only value that Google Pay accepts. card required object Google Pay tokenized credit card used to pay.
authentication_method required string [ 1 .. 50 ] characters Authentication Method which is used for the card transaction.
Enum Value Description
PAN_ONLY This authentication method is associated with payment cards stored on file with the user's Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year.
CRYPTOGRAM_3DS Returned payment data includes a 3-D Secure (3DS) cryptogram generated on the device. -> If authentication_method=CRYPTOGRAM, it is required that 'cryptogram' parameter in the request has a valid 3-D Secure (3DS) cryptogram generated on the device.
cryptogram
string [ 1 .. 2000 ] characters
Base-64 cryptographic identifier used by card schemes to validate the token verification result. This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS.
eci_indicator
string [ 1 .. 256 ] characters
Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa card network. This value is passed through in the payment authorization request.
CopyExpand allCollapse all { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" } google_pay_experience_context Customizes the payer experience during the approval process for the payment.
return_url required string The URL where the customer is redirected after the customer approves the payment.
cancel_url required string The URL where the customer is redirected after the customer cancels the payment.
Copy { "return_url": "string", "cancel_url": "string" } google_pay_request Information needed to pay using Google Pay.
name
string [ 3 .. 300 ] characters
Name on the account holder associated with Google Pay.
email_address
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with Google Pay.
phone_number
object
The phone number of account holder, in its canonical international E.164 numbering plan format. Supports only the national_number property.
card
object
The payment card information.
decrypted_token object The decrypted payload details for the Google Pay token.
assurance_details
object
Information about what validation has been performed on the returned payment credentials.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } } iban_last_chars The last characters of the IBAN used to pay.
string [ 4 .. 34 ] characters ^.[a-zA-Z0-9]{4}.$ The last characters of the IBAN used to pay.
Copy "string" ideal Information used to pay using iDEAL.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
iban_last_chars string [ 4 .. 34 ] characters ^.[a-zA-Z0-9]{4}.$ The last characters of the IBAN used to pay.
Copy { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" } ideal_request Information needed to pay using iDEAL.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "bic": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } instrument_id The identifier of the instrument.
string [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+=]+$ The identifier of the instrument.
Copy "string" IP Address An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.
string (IP Address) [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...Show pattern An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.
Copy "strings" item The details for the items to be purchased.
name required string [ 1 .. 127 ] characters The item name or title.
quantity required string <= 10 characters The item quantity. Must be a whole number.
description string <= 2048 characters The detailed item description.
sku string <= 127 characters The stock keeping unit (SKU) for the item.
url string [ 1 .. 2048 ] characters The URL to the item being purchased. Visible to buyer and used in buyer experiences.
category
string [ 1 .. 20 ] characters
The item category type.
Enum Value Description
DIGITAL_GOODS Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
PHYSICAL_GOODS A tangible item that can be shipped with proof of delivery.
DONATION A contribution or gift for which no good or service is exchanged, usually to a not for profit organization.
image_url
string [ 1 .. 2048 ] characters
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
unit_amount required object The item price or rate per unit. If you specify unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.
tax object The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number.
upc object The Universal Product Code of the item.
billing_plan
object
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.
CopyExpand allCollapse all { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": "str", "value": "string" }, "reload_threshold_amount": { "currency_code": "str", "value": "string" } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } item The details for the items to be purchased.
name required string [ 1 .. 127 ] characters The item name or title.
quantity required string <= 10 characters The item quantity. Must be a whole number.
description string <= 2048 characters The detailed item description.
sku string <= 127 characters The stock keeping unit (SKU) for the item.
url string [ 1 .. 2048 ] characters The URL to the item being purchased. Visible to buyer and used in buyer experiences.
image_url
string [ 1 .. 2048 ] characters
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
upc object The Universal Product Code of the item.
billing_plan
object
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.
CopyExpand allCollapse all { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": "str", "value": "string" }, "reload_threshold_amount": { "currency_code": "str", "value": "string" } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } item_request The details for the items to be purchased.
name required string [ 1 .. 3000 ] characters The item name or title.
This field supports up to 3000 characters, but any content beyond 127 characters (including spaces) will be truncated. The 3000 character limit is reflected in the response representation of this field . quantity required string <= 10 characters The item quantity. Must be a whole number.
description string <= 4000 characters This field supports up to 4000 characters, but any content beyond 2048 characters (including spaces) will be truncated. The 2048 character limit is reflected in the response representation of this field . sku string <= 127 characters The stock keeping unit (SKU) for the item.
url string [ 1 .. 2048 ] characters The URL to the item being purchased. Visible to buyer and used in buyer experiences.
category
string [ 1 .. 20 ] characters
The item category type.
Enum Value Description
DIGITAL_GOODS Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
PHYSICAL_GOODS A tangible item that can be shipped with proof of delivery.
DONATION A contribution or gift for which no good or service is exchanged, usually to a not for profit organization.
image_url
string [ 1 .. 2048 ] characters
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
unit_amount required object The item price or rate per unit. If you specify unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.
tax object The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number.
upc object The Universal Product Code of the item.
billing_plan
object
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.
CopyExpand allCollapse all { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": "str", "value": "string" }, "reload_threshold_amount": { "currency_code": "str", "value": "string" } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } language The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
string (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
Copy "string" language The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
string (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
Copy "string" level_2 The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business.
invoice_id
string [ 1 .. 127 ] characters
Use this field to pass a purchase identification value of up to 127 ASCII characters. The length of this field will be adjusted to meet network specifications (25chars for Visa and Mastercard, 17chars for Amex), and the original invoice ID will still be displayed in your existing reports.
tax_total
object
Use this field to break down the amount of tax included in the total purchase amount. The value provided here will not add to the total purchase amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates. Value, by country, is:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. CopyExpand allCollapse all { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } } level_3 The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business.
ships_from_postal_code
string [ 1 .. 60 ] characters
Use this field to specify the postal code of the shipping location.
line_items
Array of objects [ 1 .. 100 ] items
A list of the items that were purchased with this payment. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.
shipping_amount object Use this field to break down the shipping cost included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.
duty_amount object Use this field to break down the duty amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.
discount_amount object Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.
shipping_address
object
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.
CopyExpand allCollapse all { "ships_from_postal_code": "string", "line_items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": null, "value": null }, "reload_threshold_amount": { "currency_code": null, "value": null } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } }, "commodity_code": "string", "unit_of_measure": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "total_amount": { "currency_code": "str", "value": "string" } } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } liability_shift Liability shift indicator. The outcome of the issuer's authentication.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Liability shift indicator. The outcome of the issuer's authentication.
Enum Value Description NO Liability is with the merchant. POSSIBLE Liability may shift to the card issuer. UNKNOWN The authentication system is not available. Copy "NO" line_item The line items for this purchase. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf.
name required string [ 1 .. 127 ] characters The item name or title.
quantity required string <= 10 characters The item quantity. Must be a whole number.
description string <= 2048 characters The detailed item description.
sku string <= 127 characters The stock keeping unit (SKU) for the item.
url string [ 1 .. 2048 ] characters The URL to the item being purchased. Visible to buyer and used in buyer experiences.
image_url
string [ 1 .. 2048 ] characters
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
upc object The Universal Product Code of the item.
billing_plan
object
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.
commodity_code
string [ 1 .. 12 ] characters
Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used.
unit_of_measure string [ 1 .. 12 ] characters Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK).
unit_amount required object The item price or rate per unit. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.
tax object The item tax for each unit. Must equal tax * quantity for all items. tax.value can not be a negative number.
discount_amount object Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.
total_amount
object
The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.
CopyExpand allCollapse all { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": "str", "value": "string" }, "reload_threshold_amount": { "currency_code": "str", "value": "string" } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } }, "commodity_code": "string", "unit_of_measure": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "total_amount": { "currency_code": "str", "value": "string" } } Link Description The request-related HATEOAS link information.
href required string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
rel required string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
string
The HTTP method required to make the related call.
Enum Value Description
GET The HTTP GET method.
POST The HTTP POST method.
PUT The HTTP PUT method.
DELETE The HTTP DELETE method.
HEAD The HTTP HEAD method.
CONNECT The HTTP CONNECT method.
OPTIONS The HTTP OPTIONS method.
PATCH The HTTP PATCH method.
title
string
The link title.
mediaType
string
The media type, as defined by RFC 2046. Describes the link target.
encType string Default: "application/json" The media type in which to submit the request data.
schema
object
The schema that describes the request data.
targetSchema
object
The schema that describes the link target.
CopyExpand allCollapse all { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } Link Description The request-related HATEOAS link information.
href required string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
rel required string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
string
The HTTP method required to make the related call.
Enum Value Description
GET The HTTP GET method.
POST The HTTP POST method.
PUT The HTTP PUT method.
DELETE The HTTP DELETE method.
HEAD The HTTP HEAD method.
CONNECT The HTTP CONNECT method.
OPTIONS The HTTP OPTIONS method.
PATCH The HTTP PATCH method.
title
string
The link title.
mediaType
string
The media type, as defined by RFC 2046. Describes the link target.
encType string Default: "application/json" The media type in which to submit the request data.
schema
object
The schema that describes the request data.
targetSchema
object
The schema that describes the link target.
CopyExpand allCollapse all { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } Link Description The request-related HATEOAS link information.
href required string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
rel required string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
string
The HTTP method required to make the related call.
Enum Value Description
GET The HTTP GET method.
POST The HTTP POST method.
PUT The HTTP PUT method.
DELETE The HTTP DELETE method.
HEAD The HTTP HEAD method.
CONNECT The HTTP CONNECT method.
OPTIONS The HTTP OPTIONS method.
PATCH The HTTP PATCH method.
title
string
The link title.
mediaType
string
The media type, as defined by RFC 2046. Describes the link target.
encType string Default: "application/json" The media type in which to submit the request data.
schema
object
The schema that describes the request data.
targetSchema
object
The schema that describes the link target.
CopyExpand allCollapse all { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } Link Schema The request data or link target.
additionalItems object Any additional items.
dependencies
object
The dependencies.
items
object
An item.
definitions object Definitions.
patternProperties
object
The pattern properties.
properties
object
The properties.
allOf
Array of objects
An array of sub-schemas. The data must validate against all sub-schemas.
anyOf
Array of objects
An array of sub-schemas. The data must validate against one or more sub-schemas.
oneOf
Array of objects
An array of sub-schemas. The data must validate against one sub-schema.
not object Not.
links
Array of objects
An array of links.
fragmentResolution
string
The fragment resolution.
media
object
The media type and context-encoding scheme.
pathStart
string
To apply this schema to the instances' URIs, start the URIs with this value.
CopyExpand allCollapse all { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } Link Schema The request data or link target.
additionalItems object Any additional items.
dependencies
object
Any Dependencies.
items
object
An item.
definitions object Definitions.
patternProperties
object
The pattern properties.
properties
object
Properties.
allOf
Array of objects
An array of sub-schemas. The data must validate against all sub-schemas.
anyOf
Array of objects
An array of sub-schemas. The data must validate against one or more sub-schemas.
oneOf
Array of objects
An array of sub-schemas. The data must validate against one sub-schema.
not object Not.
links
Array of objects
An array of links.
fragmentResolution
string
The fragment resolution.
media
object
The media type and context-encoding scheme.
pathStart
string
To apply this schema to the instances' URIs, start the URIs with this value.
CopyExpand allCollapse all { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } Link Schema The request data or link target.
additionalItems object Any additional items.
dependencies
object
The dependencies.
items
object
An item.
definitions object Definitions.
patternProperties
object
The pattern properties.
properties
object
The properties.
allOf
Array of objects
An array of sub-schemas. The data must validate against all sub-schemas.
anyOf
Array of objects
An array of sub-schemas. The data must validate against one or more sub-schemas.
oneOf
Array of objects
An array of sub-schemas. The data must validate against one sub-schema.
not object Not.
links
Array of objects
An array of links.
fragmentResolution
string
The fragment resolution.
media
object
The media type and context-encoding scheme.
pathStart
string
To apply this schema to the instances' URIs, start the URIs with this value.
CopyExpand allCollapse all { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } Merchant App Switch Details & Preferences Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app.
native_app
object
Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.
mobile_web
object
Buyer's mobile web browser context to app switch to the PayPal consumer app.
CopyExpand allCollapse all { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } } merchant_partner_customer_id The unique ID for a customer generated by PayPal.
string [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$ The unique ID for a customer generated by PayPal.
Copy "string" Mobile Web App Switch Context Buyer's mobile web browser context to app switch to the PayPal consumer app.
return_flow string [ 1 .. 6 ] characters Default: "AUTO" Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the PayPal App.
Enum Value Description
AUTO After payment approval in the PayPal App, buyer will automatically be redirected to the merchant website.
MANUAL After payment approval in the PayPal App, buyer will be asked to manually navigate back to the merchant website where they started the transaction from. The buyer is shown a message like 'Return to Merchant' to return to the source where the transaction actually started.
buyer_user_agent
string [ 1 .. 512 ] characters
User agent from the request originating from the buyer's device. This will be used to identify the buyer's operating system and browser versions. NOTE: Merchants must not alter or modify the buyer's device user agent.
Copy { "return_flow": "AUTO", "buyer_user_agent": "string" } Money The currency and amount for a financial transaction, such as a balance or payment due.
currency_code required string = 3 characters The three-character ISO-4217 currency code that identifies the currency.
value required string <= 32 characters The value, which might be:
An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes. Copy { "currency_code": "str", "value": "string" } Money The currency and amount for a financial transaction, such as a balance or payment due.
currency_code required string = 3 characters The 3-character ISO-4217 currency code that identifies the currency.
value required string <= 32 characters The value, which might be:
An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes. Copy { "currency_code": "str", "value": "string" } mybank Information used to pay using MyBank.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
iban_last_chars string [ 4 .. 34 ] characters ^.[a-zA-Z0-9]{4}.$ The last characters of the IBAN used to pay.
Copy { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" } mybank_request Information needed to pay using MyBank.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } name The full name representation like Mr J Smith.
string [ 3 .. 300 ] characters The full name representation like Mr J Smith.
Copy "string" Name The name of the party.
given_name
string <= 140 characters
When the party is a person, the party's given, or first, name.
surname string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
Copy { "given_name": "string", "surname": "string" } Name The name of the party.
given_name
string <= 140 characters
When the party is a person, the party's given, or first, name.
surname string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
Copy { "given_name": "string", "surname": "string" } Name The name of the party.
given_name
string <= 140 characters
When the party is a person, the party's given, or first, name.
surname string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
Copy { "given_name": "string", "surname": "string" } Name The name of the party.
given_name
string <= 140 characters
When the party is a person, the party's given, or first, name.
surname string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
Copy { "given_name": "string", "surname": "string" } Name The name of the party.
full_name
string <= 300 characters
When the party is a person, the party's full name.
Copy { "full_name": "string" } Name The name of the party.
given_name
string <= 140 characters
When the party is a person, the party's given, or first, name.
surname string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
Copy { "given_name": "string", "surname": "string" } Name The name of the party.
given_name
string <= 140 characters
When the party is a person, the party's given, or first, name.
surname string <= 140 characters When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
Copy { "given_name": "string", "surname": "string" } net_amount_breakdown The net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the merchant holds their funds.
payable_amount
object
The net amount debited from the merchant's PayPal account.
converted_amount
object
The converted payable amount.
exchange_rate
object
The exchange rate that determines the amount that was debited from the merchant's PayPal account.
CopyExpand allCollapse all { "payable_amount": { "currency_code": "str", "value": "string" }, "converted_amount": { "currency_code": "str", "value": "string" }, "exchange_rate": { "value": "string", "source_currency": "str", "target_currency": "str" } } network_token The Third Party Network token used to fund a payment.
number required string [ 13 .. 19 ] characters Third party network token number.
cryptogram
string [ 28 .. 32 ] characters
An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.
token_requestor_id
string [ 1 .. 11 ] characters
A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.
expiry required string = 7 characters ^[0-9]{4}-(0[1-9]|1[0-2])$ The card expiration year and month, in Internet date format.
eci_flag
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.
Enum Value Description MASTERCARD_NON_3D_SECURE_TRANSACTION Mastercard non-3-D Secure transaction. MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION Mastercard attempted authentication transaction. MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION Mastercard fully authenticated transaction. FULLY_AUTHENTICATED_TRANSACTION VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction. ATTEMPTED_AUTHENTICATION_TRANSACTION VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction. NON_3D_SECURE_TRANSACTION VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction. Copy { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" } network_transaction Reference values used by the card network to identify a transaction.
id
string [ 9 .. 36 ] characters
Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.
date
string = 4 characters
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date". For some specific networks, such as MasterCard and Discover, this date field is mandatory when the previous_network_transaction_reference_id is passed.
acquirer_reference_number
string [ 1 .. 36 ] characters
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
network string [ 1 .. 255 ] characters ^[A-Z_]+$ Name of the card network through which the transaction was routed.
Enum Value Description VISA Visa card. MASTERCARD Mastercard card. DISCOVER Discover card. AMEX American Express card. SOLO Solo debit card. JCB Japan Credit Bureau card. STAR Military Star card. DELTA Delta Airlines card. SWITCH Switch credit card. MAESTRO Maestro credit card. CB_NATIONALE Carte Bancaire (CB) credit card. CONFIGOGA Configoga credit card. CONFIDIS Confidis credit card. ELECTRON Visa Electron credit card. CETELEM Cetelem credit card. CHINA_UNION_PAY China union pay credit card. DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. ELO The Brazilian Elo card payment network. HIPER The Hiper - Ingenico ePayment network. HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market. RUPAY The RuPay payment network. GE The GE Credit Union 3Point card payment network. SYNCHRONY The Synchrony Financial (SYF) payment network. EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. CARTE_BANCAIRE The Carte Bancaire payment network. STAR_ACCESS The Star Access payment network. PULSE The Pulse payment network. NYCE The NYCE payment network. ACCEL The Accel payment network. UNKNOWN UNKNOWN payment network. Copy { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } network_transaction_reference Reference values used by the card network to identify a transaction.
id required string [ 9 .. 36 ] characters Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.
date
string = 4 characters
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date". For some specific networks, such as MasterCard and Discover, this date field is mandatory when the previous_network_transaction_reference_id is passed.
acquirer_reference_number
string [ 1 .. 36 ] characters
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
network string [ 1 .. 255 ] characters ^[A-Z_]+$ Name of the card network through which the transaction was routed.
Enum Value Description VISA Visa card. MASTERCARD Mastercard card. DISCOVER Discover card. AMEX American Express card. SOLO Solo debit card. JCB Japan Credit Bureau card. STAR Military Star card. DELTA Delta Airlines card. SWITCH Switch credit card. MAESTRO Maestro credit card. CB_NATIONALE Carte Bancaire (CB) credit card. CONFIGOGA Configoga credit card. CONFIDIS Confidis credit card. ELECTRON Visa Electron credit card. CETELEM Cetelem credit card. CHINA_UNION_PAY China union pay credit card. DINERS The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. ELO The Brazilian Elo card payment network. HIPER The Hiper - Ingenico ePayment network. HIPERCARD The Brazilian Hipercard payment network that's widely accepted in the retail market. RUPAY The RuPay payment network. GE The GE Credit Union 3Point card payment network. SYNCHRONY The Synchrony Financial (SYF) payment network. EFTPOS The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. CARTE_BANCAIRE The Carte Bancaire payment network. STAR_ACCESS The Star Access payment network. PULSE The Pulse payment network. NYCE The NYCE payment network. ACCEL The Accel payment network. UNKNOWN UNKNOWN payment network. Copy { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } Order The order details.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
id
string
The ID of the order.
purchase_units
Array of objects [ 1 .. 10 ] items
An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.
links
Array of objects
An array of request-related HATEOAS links. To complete payer approval, use the approve link to 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 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 payer approves the payment.
payment_source
object
The payment source used to fund the payment.
intent
string
The intent to either capture payment immediately or authorize a payment for an order after order creation.
Enum Value Description
CAPTURE The merchant intends to capture payment immediately after the customer makes a payment.
AUTHORIZE The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The order status.
Enum Value Description CREATED The order was created with the specified context. SAVED The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order. APPROVED The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on. VOIDED All purchase units in the order are voided. COMPLETED The intent of the order was completed and a payments resource was created. Important: Check the payment status in purchase_units[].payments.captures[].status before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined. PAYER_ACTION_REQUIRED The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc). CopyExpand allCollapse all { "create_time": "string", "update_time": "string", "id": "string", "purchase_units": [ { "reference_id": "string", "description": "string", "custom_id": "string", "invoice_id": "string", "id": "string", "soft_descriptor": "string", "items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": null, "total_cycles": null, "sequence": null, "pricing_scheme": null, "start_date": null } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } ], "most_recent_errors": [ null ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "payee": { "email_address": "string", "merchant_id": "string" }, "payment_instruction": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "payee_pricing_tier_id": "string", "payee_receivable_fx_rate_id": "string", "disbursement_mode": "INSTANT" }, "shipping": { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "trackers": [ { "id": "string", "status": "CANCELLED", "items": [ { "name": null, "quantity": null, "sku": null, "url": null, "image_url": null, "upc": null } ], "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "create_time": "string", "update_time": "string" } ] }, "supplementary_data": { "card": { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": null, "quantity": null, "description": null, "sku": null, "url": null, "image_url": null, "upc": null, "billing_plan": null, "commodity_code": null, "unit_of_measure": null, "unit_amount": null, "tax": null, "discount_amount": null, "total_amount": null } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } }, "risk": { "customer": { "ip_address": "string" } } }, "payments": { "authorizations": [ { "status": "CREATED", "status_details": { "reason": "PENDING_REVIEW" }, "id": "string", "invoice_id": "string", "custom_id": "string", "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": null, "shipping": null, "handling": null, "tax_total": null, "insurance": null, "shipping_discount": null, "discount": null } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ null ] }, "expiration_time": "string", "create_time": "string", "update_time": "string", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "captures": [ { "create_time": "string", "update_time": "string", "id": "string", "invoice_id": "string", "custom_id": "string", "final_capture": false, "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": null, "shipping": null, "handling": null, "tax_total": null, "insurance": null, "shipping_discount": null, "discount": null } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ null ] }, "seller_receivable_breakdown": { "platform_fees": [ null ], "gross_amount": { "currency_code": null, "value": null }, "paypal_fee": { "currency_code": null, "value": null }, "paypal_fee_in_receivable_currency": { "currency_code": null, "value": null }, "net_amount": { "currency_code": null, "value": null }, "receivable_amount": { "currency_code": null, "value": null }, "exchange_rate": { "value": null, "source_currency": null, "target_currency": null } }, "disbursement_mode": "INSTANT", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "refunds": [ { "status": "CANCELLED", "status_details": { "reason": "ECHECK" }, "id": "string", "invoice_id": "string", "custom_id": "string", "acquirer_reference_number": "string", "note_to_payer": "string", "seller_payable_breakdown": { "platform_fees": [ null ], "net_amount_breakdown": [ null ], "gross_amount": { "currency_code": null, "value": null }, "paypal_fee": { "currency_code": null, "value": null }, "paypal_fee_in_receivable_currency": { "currency_code": null, "value": null }, "net_amount": { "currency_code": null, "value": null }, "net_amount_in_receivable_currency": { "currency_code": null, "value": null }, "total_refunded_amount": { "currency_code": null, "value": null } }, "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "amount": { "currency_code": "str", "value": "string" }, "payer": { "email_address": "string", "merchant_id": "string" }, "create_time": "string", "update_time": "string" } ] } } ], "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "payment_source": { "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" } }, "bancontact": { "card_last_digits": "stri", "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "blik": { "name": "string", "country_code": "string", "email": "string", "one_click": { "consumer_reference": "string" } }, "eps": { "name": "string", "country_code": "string", "bic": "string" }, "giropay": { "name": "string", "country_code": "string", "bic": "string" }, "ideal": { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "mybank": { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "p24": { "payment_descriptor": "string", "method_id": "string", "method_description": "string", "name": "string", "email": "string", "country_code": "string" }, "sofort": { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "trustly": { "name": "string", "country_code": "string", "email": "string", "bic": "string", "iban_last_chars": "string" }, "venmo": { "user_name": "string", "return_flow": "AUTO", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" } } } }, "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "paypal": { "account_status": "VERIFIED", "phone_type": "FAX", "business_name": "string", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } }, "cobranded_cards": [ { "labels": [ "string" ], "payee": { "email_address": "string", "merchant_id": "string" }, "amount": { "currency_code": "str", "value": "string" } } ] }, "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "experience_status": "NOT_STARTED", "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "apple_pay": { "id": "string", "token": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": null, "phone_number": null }, "name": { "given_name": null, "surname": null }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" }, "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "country_code": "string" }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "name": { "given_name": "string", "surname": "string" } } } } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "last_digits": "stri", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } } } } }, "intent": "CAPTURE", "payer": { "email_address": "string", "payer_id": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "status": "CREATED" } Order Authorize Request The authorization of an order request.
payment_source
object
The source of payment for the order, which can be a token or a card. Use this object only if you have not redirected the user after order creation to approve the payment. In such cases, the user-selected payment method in the PayPal flow is implicitly used.
CopyExpand allCollapse all { "payment_source": { "card": { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "token": { "id": "string", "type": "BILLING_AGREEMENT" }, "paypal": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } }, "apple_pay": { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "venmo": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } } } Order Authorize Response The order authorize response.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
id
string
The ID of the order.
purchase_units
Array of objects [ 1 .. 10 ] items
An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.
links
Array of objects
An array of request-related HATEOAS links. To complete payer approval, use the approve link to 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 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 payer approves the payment.
payment_source
object
The payment source used to fund the payment.
intent
string
The intent to either capture payment immediately or authorize a payment for an order after order creation.
Enum Value Description
CAPTURE The merchant intends to capture payment immediately after the customer makes a payment.
AUTHORIZE The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The order status.
Enum Value Description CREATED The order was created with the specified context. SAVED The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order. APPROVED The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on. VOIDED All purchase units in the order are voided. COMPLETED The intent of the order was completed and a payments resource was created. Important: Check the payment status in purchase_units[].payments.captures[].status before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined. PAYER_ACTION_REQUIRED The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc). CopyExpand allCollapse all { "create_time": "string", "update_time": "string", "id": "string", "purchase_units": [ { "reference_id": "string", "description": "string", "custom_id": "string", "invoice_id": "string", "id": "string", "soft_descriptor": "string", "items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": null, "total_cycles": null, "sequence": null, "pricing_scheme": null, "start_date": null } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } ], "most_recent_errors": [ null ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "payee": { "email_address": "string", "merchant_id": "string" }, "payment_instruction": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "payee_pricing_tier_id": "string", "payee_receivable_fx_rate_id": "string", "disbursement_mode": "INSTANT" }, "shipping": { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "trackers": [ { "id": "string", "status": "CANCELLED", "items": [ { "name": null, "quantity": null, "sku": null, "url": null, "image_url": null, "upc": null } ], "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "create_time": "string", "update_time": "string" } ] }, "supplementary_data": { "card": { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": null, "quantity": null, "description": null, "sku": null, "url": null, "image_url": null, "upc": null, "billing_plan": null, "commodity_code": null, "unit_of_measure": null, "unit_amount": null, "tax": null, "discount_amount": null, "total_amount": null } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } }, "risk": { "customer": { "ip_address": "string" } } }, "payments": { "authorizations": [ { "status": "CREATED", "status_details": { "reason": "PENDING_REVIEW" }, "id": "string", "invoice_id": "string", "custom_id": "string", "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": null, "shipping": null, "handling": null, "tax_total": null, "insurance": null, "shipping_discount": null, "discount": null } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ null ] }, "expiration_time": "string", "create_time": "string", "update_time": "string", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "captures": [ { "create_time": "string", "update_time": "string", "id": "string", "invoice_id": "string", "custom_id": "string", "final_capture": false, "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": null, "shipping": null, "handling": null, "tax_total": null, "insurance": null, "shipping_discount": null, "discount": null } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ null ] }, "seller_receivable_breakdown": { "platform_fees": [ null ], "gross_amount": { "currency_code": null, "value": null }, "paypal_fee": { "currency_code": null, "value": null }, "paypal_fee_in_receivable_currency": { "currency_code": null, "value": null }, "net_amount": { "currency_code": null, "value": null }, "receivable_amount": { "currency_code": null, "value": null }, "exchange_rate": { "value": null, "source_currency": null, "target_currency": null } }, "disbursement_mode": "INSTANT", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "refunds": [ { "status": "CANCELLED", "status_details": { "reason": "ECHECK" }, "id": "string", "invoice_id": "string", "custom_id": "string", "acquirer_reference_number": "string", "note_to_payer": "string", "seller_payable_breakdown": { "platform_fees": [ null ], "net_amount_breakdown": [ null ], "gross_amount": { "currency_code": null, "value": null }, "paypal_fee": { "currency_code": null, "value": null }, "paypal_fee_in_receivable_currency": { "currency_code": null, "value": null }, "net_amount": { "currency_code": null, "value": null }, "net_amount_in_receivable_currency": { "currency_code": null, "value": null }, "total_refunded_amount": { "currency_code": null, "value": null } }, "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "amount": { "currency_code": "str", "value": "string" }, "payer": { "email_address": "string", "merchant_id": "string" }, "create_time": "string", "update_time": "string" } ] } } ], "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "payment_source": { "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" } }, "venmo": { "user_name": "string", "return_flow": "AUTO", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" } } } }, "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "paypal": { "account_status": "VERIFIED", "phone_type": "FAX", "business_name": "string", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } }, "cobranded_cards": [ { "labels": [ "string" ], "payee": { "email_address": "string", "merchant_id": "string" }, "amount": { "currency_code": "str", "value": "string" } } ] }, "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "experience_status": "NOT_STARTED", "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "apple_pay": { "id": "string", "token": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": null, "rel": null, "method": null, "title": null, "mediaType": null, "encType": null, "schema": null, "targetSchema": null } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": null, "phone_number": null }, "name": { "given_name": null, "surname": null }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" }, "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "country_code": "string" }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "name": { "given_name": "string", "surname": "string" } } } } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "last_digits": "stri", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } } } } }, "intent": "CAPTURE", "payer": { "email_address": "string", "payer_id": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "status": "CREATED" } Order Capture Request Completes an capture payment for an order.
payment_source
object
The payment source definition.
CopyExpand allCollapse all { "payment_source": { "card": { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "token": { "id": "string", "type": "BILLING_AGREEMENT" }, "paypal": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } }, "apple_pay": { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "venmo": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } } } Order Confirm Application Context Customizes the payer confirmation experience.
brand_name
string [ 1 .. 127 ] characters
Label to present to your payer as part of the PayPal hosted web experience.
return_url
string [ 10 .. 4000 ] characters
The URL where the customer is redirected after the customer approves the payment.
cancel_url
string [ 10 .. 4000 ] characters
The URL where the customer is redirected after the customer cancels the payment.
locale
string [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.
stored_payment_source
object
Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER. usage=FIRST is compatible only with payment_initiator=CUSTOMER. previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request. CopyExpand allCollapse all { "brand_name": "string", "return_url": "http://example.com", "cancel_url": "http://example.com", "locale": "string", "stored_payment_source": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } } } Order Request The order request details.
purchase_units required Array of objects [ 1 .. 10 ] items An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
intent required string The intent to either capture payment immediately or authorize a payment for an order after order creation.
Enum Value Description
CAPTURE The merchant intends to capture payment immediately after the customer makes a payment.
AUTHORIZE The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one purchase_unit within your order.
payer
object
DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the payment_source.paypal object. In order to make this design more clear, the details in the payer object are now available under payment_source.paypal. Please use payment_source.paypal.
payment_source
object
The payment source definition.
application_context object Customize the payer experience during the approval process for the payment with PayPal.
CopyExpand allCollapse all { "purchase_units": [ { "reference_id": "string", "description": "string", "custom_id": "string", "invoice_id": "string", "soft_descriptor": "string", "items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": null, "total_cycles": null, "sequence": null, "pricing_scheme": null, "start_date": null } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "payee": { "email_address": "string", "merchant_id": "string" }, "payment_instruction": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "payee_pricing_tier_id": "string", "payee_receivable_fx_rate_id": "string", "disbursement_mode": "INSTANT" }, "shipping": { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "supplementary_data": { "card": { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": null, "quantity": null, "description": null, "sku": null, "url": null, "image_url": null, "upc": null, "billing_plan": null, "commodity_code": null, "unit_of_measure": null, "unit_amount": null, "tax": null, "discount_amount": null, "total_amount": null } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } }, "risk": { "customer": { "ip_address": "string" } } } } ], "intent": "CAPTURE", "payer": { "email_address": "string", "payer_id": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_source": { "card": { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "token": { "id": "string", "type": "BILLING_AGREEMENT" }, "paypal": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } }, "bancontact": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "blik": { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string", "consumer_user_agent": "string", "consumer_ip": "string" }, "level_0": { "auth_code": "string" }, "one_click": { "auth_code": "string", "consumer_reference": "string", "alias_label": "stringst", "alias_key": "string" } }, "eps": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "giropay": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "ideal": { "name": "string", "country_code": "string", "bic": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "mybank": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "p24": { "name": "string", "email": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "sofort": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "trustly": { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "apple_pay": { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "venmo": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } }, "application_context": { "brand_name": "string", "landing_page": "LOGIN", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "return_url": "http://example.com", "cancel_url": "http://example.com", "locale": "string", "payment_method": { "standard_entry_class_code": "TEL", "payee_preferred": "UNRESTRICTED" }, "stored_payment_source": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } } } } Order Status The order status.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The order status.
Enum Value Description CREATED The order was created with the specified context. SAVED The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order. APPROVED The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on. VOIDED All purchase units in the order are voided. COMPLETED The intent of the order was completed and a payments resource was created. Important: Check the payment status in purchase_units[].payments.captures[].status before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined. PAYER_ACTION_REQUIRED The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc). Copy "CREATED" order_billing_plan Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.
billing_cycles required Array of objects [ 1 .. 3 ] items An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.
name
string [ 1 .. 127 ] characters
Name of the recurring plan.
setup_fee
object
The setup fee for the recurring plan. Ensure its part of the item amount.
CopyExpand allCollapse all { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": "str", "value": "string" }, "reload_threshold_amount": { "currency_code": "str", "value": "string" } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } OrderUpdateCallbackErrorResponse The error details.
name required string [ 1 .. 256 ] characters The human-readable, unique name of the error.
message string [ 1 .. 2048 ] characters The message that describes the error.
details Array of objects [ 1 .. 100 ] items An array of additional details about the error.
CopyExpand allCollapse all { "name": "string", "message": "string", "details": [ { "field": "string", "value": "string", "issue": "string" } ] } OrderUpdateCallbackErrorResponseDetails The error details. Required for client-side 4XX errors.
field
string [ 0 .. 256 ] characters
The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.
value
string [ 0 .. 1024 ] characters
The value of the field that caused the error.
issue required string [ 0 .. 256 ] characters The unique, fine-grained application-level error code.
Copy { "field": "string", "value": "string", "issue": "string" } OrderUpdateCallbackRequest Shipping Options Callback request. This will be implemented by the merchants.
id
string [ 1 .. 36 ] characters
The ID of the order.
purchase_units required Array of objects = 1 items An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
shipping_address
object
Redacted shipping address to be used for shipping options and tax calculations.
shipping_option object Buyer selected shipping option.
CopyExpand allCollapse all { "id": "string", "purchase_units": [ { "reference_id": "string", "description": "string", "custom_id": "string", "invoice_id": "string", "soft_descriptor": "string", "items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": null, "total_cycles": null, "sequence": null, "pricing_scheme": null, "start_date": null } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "payee": { "email_address": "string", "merchant_id": "string" }, "payment_instruction": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "payee_pricing_tier_id": "string", "payee_receivable_fx_rate_id": "string", "disbursement_mode": "INSTANT" }, "shipping": { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "supplementary_data": { "card": { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": null, "quantity": null, "description": null, "sku": null, "url": null, "image_url": null, "upc": null, "billing_plan": null, "commodity_code": null, "unit_of_measure": null, "unit_amount": null, "tax": null, "discount_amount": null, "total_amount": null } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } }, "risk": { "customer": { "ip_address": "string" } } } } ], "shipping_address": { "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "shipping_option": { "id": "string", "label": "string", "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } } OrderUpdateCallbackResponse Returns the updated shipping options for an order.
id
string [ 1 .. 36 ] characters
The ID of the order.
purchase_units
object
This would contain shipping option and amount data at purchase unit level.
CopyExpand allCollapse all { "id": "string", "purchase_units": { "reference_id": "string", "shipping_options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } } } } Orthography Type The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on most widely used writing systems.
string = 4 characters ^[A-Z][a-z]{3}$ The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on most widely used writing systems.
Enum Value Description Zyyy The orthography cannot be determined. Zzzz The orthography is unknown. Kana An angular form of Japanese writing for words of foreign origin. Cyrl The Slavic languages alphabet. Used in eastern Europe. Arab The Arabic language alphabet. Armn The Armenian alphabet. Beng The Bengali alphabet. Used in eastern India. Cans The Unified Canadian Aboriginal Syllabics alphabet. Deva The Devanagari (Nagari) alphabet. Ethi The Ethiopic alphabet. Geor The Georgian (Mkhedruli and Mtavruli) alphabet. Grek The Greek alphabet. Gujr The Gujurati language alphabet. Used in western India. Guru The Gurmukhi alphabet. Used in the northern Indian state of Punjab. Hani The Han (Hanzi, Kanji, Hanja) alphabet. Hebr The Hebrew alphabet. Java The Javanese alphabet. Jpan The Japanese (alias for Han + Hiragana + Katakana) alphabet. Khmr The Khmer alphabet. Knda The Kannada alphabet. Used in the southern Indian state of Karnataka. Kore Korean (alias for Hangul + Han). Laoo The Lao alphabet. Latn The Latin alphabet. Mlym The Malayalam alphabet. Used in the southern Indian state of Kerala. Mong The Mongolian alphabet. Mymr The Myanmar (Burmese) alphabet. Orya The Oriya (Odia) alphabet. Used in the eastern Indian state of Odisha. Sinh The Sinhala alphabet. Sund The Sundanese alphabet. Syrc The Syriac alphabet. Taml The Tamil alphabet. Used in the southern Indian state of Tamilnadu. Telu The Telugu language alphabet. Used in the southern Indian state of Andhra pradesh. Thaa The Thaana (Maldivian) alphabet. Thai The Thai alphabet. Used in Thailand. Tibt The Tibetan alphabet. Yiii The Yi alphabet. Copy "Zyyy" p24 Information used to pay using P24(Przelewy24).
payment_descriptor
string [ 1 .. 2000 ] characters
P24 generated payment description.
method_id
string [ 1 .. 300 ] characters
Numeric identifier of the payment scheme or bank used for the payment.
method_description
string [ 1 .. 2000 ] characters
Friendly name of the payment scheme or bank used for the payment.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
email
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
Copy { "payment_descriptor": "string", "method_id": "string", "method_description": "string", "name": "string", "email": "string", "country_code": "string" } p24_request Information needed to pay using P24 (Przelewy24).
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
email required string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern The email address of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "email": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } pares_status Transactions status result identifier. The outcome of the issuer's authentication.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Transactions status result identifier. The outcome of the issuer's authentication.
Enum Value Description Y Successful authentication. N Failed authentication / account not verified / transaction denied. U Unable to complete authentication. A Successful attempts transaction. C Challenge required for authentication. R Authentication rejected (merchant must not submit for authorization). D Challenge required; decoupled authentication confirmed. I Informational only; 3DS requestor challenge preference acknowledged. Copy "Y" participant_metadata Profile information of the sender or receiver.
ip_address
string [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...Show pattern
The consumer's IP address, which can be represented in either IPv4 or IPv6 format.
Copy { "ip_address": "string" } Patch The JSON patch object to apply partial updates to resources.
op required string The operation.
Enum Value Description
add Depending on the target location reference, completes one of these functions:
The target location is an array index. Inserts a new value into the array at the specified index.
The target location is an object parameter that does not already exist. Adds a new parameter to the object.
The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.
remove Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.
replace Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.
move Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.
copy Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.
test Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
Type Considered equal if both values
strings Contain the same number of Unicode characters and their code points are byte-by-byte equal.
numbers Are numerically equal.
arrays Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objects Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null) Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.
path
string
The JSON Pointer to the target document location at which to complete the operation.
value
any
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.
Copy { "op": "add", "path": "string", "value": null, "from": "string" } Patch Request An array of JSON patch objects to apply partial updates to resources.
Array ([ 0 .. 32767 ] items) op required string The operation.
Enum Value Description
add Depending on the target location reference, completes one of these functions:
The target location is an array index. Inserts a new value into the array at the specified index.
The target location is an object parameter that does not already exist. Adds a new parameter to the object.
The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.
remove Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.
replace Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.
move Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.
copy Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.
test Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
Type Considered equal if both values
strings Contain the same number of Unicode characters and their code points are byte-by-byte equal.
numbers Are numerically equal.
arrays Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objects Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null) Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.
path
string
The JSON Pointer to the target document location at which to complete the operation.
value
any
The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.
CopyExpand allCollapse all [ { "op": "add", "path": "string", "value": null, "from": "string" } ] payee The merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of merchant.
merchant_id string = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The encrypted PayPal account ID of the merchant.
Copy { "email_address": "string", "merchant_id": "string" } payee_base The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of merchant.
merchant_id string = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The encrypted PayPal account ID of the merchant.
Copy { "email_address": "string", "merchant_id": "string" } payee_base The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of merchant.
merchant_id string = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The encrypted PayPal account ID of the merchant.
Copy { "email_address": "string", "merchant_id": "string" } payee_payment_method_preference The merchant-preferred payment methods.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "UNRESTRICTED" The merchant-preferred payment methods.
Enum Value Description UNRESTRICTED Accepts any type of payment from the customer. IMMEDIATE_PAYMENT_REQUIRED Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the pending status. Copy "UNRESTRICTED" payer The customer who approves and pays for the order. The customer is also known as the payer.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of the payer.
payer_id
string = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The PayPal-assigned ID for the payer.
name
object
The name of the payer. Supports only the given_name and surname properties.
phone
object
The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.
birth_date
string = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern
The birth date of the payer in YYYY-MM-DD format.
tax_info
object
The tax information of the payer. Required only for Brazilian payer's. Both tax_id and tax_id_type are required.
address object The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.
CopyExpand allCollapse all { "email_address": "string", "payer_id": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } payer_base The customer who approves and pays for the order. The customer is also known as the payer.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of the payer.
payer_id
string = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The PayPal-assigned ID for the payer.
Copy { "email_address": "string", "payer_id": "string" } Payment Collection The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.
authorizations
Array of objects
An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.
captures
Array of objects
An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.
refunds Array of objects An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.
CopyExpand allCollapse all { "authorizations": [ { "status": "CREATED", "status_details": { "reason": "PENDING_REVIEW" }, "id": "string", "invoice_id": "string", "custom_id": "string", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "string" ] }, "expiration_time": "string", "create_time": "string", "update_time": "string", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "captures": [ { "create_time": "string", "update_time": "string", "id": "string", "invoice_id": "string", "custom_id": "string", "final_capture": false, "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "string" ] }, "seller_receivable_breakdown": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "gross_amount": { "currency_code": "str", "value": "string" }, "paypal_fee": { "currency_code": "str", "value": "string" }, "paypal_fee_in_receivable_currency": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" }, "receivable_amount": { "currency_code": "str", "value": "string" }, "exchange_rate": { "value": "string", "source_currency": "str", "target_currency": "str" } }, "disbursement_mode": "INSTANT", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "refunds": [ { "status": "CANCELLED", "status_details": { "reason": "ECHECK" }, "id": "string", "invoice_id": "string", "custom_id": "string", "acquirer_reference_number": "string", "note_to_payer": "string", "seller_payable_breakdown": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "net_amount_breakdown": [ { "payable_amount": { "currency_code": "str", "value": "string" }, "converted_amount": { "currency_code": "str", "value": "string" }, "exchange_rate": { "value": "string", "source_currency": "str", "target_currency": "str" } } ], "gross_amount": { "currency_code": "str", "value": "string" }, "paypal_fee": { "currency_code": "str", "value": "string" }, "paypal_fee_in_receivable_currency": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" }, "net_amount_in_receivable_currency": { "currency_code": "str", "value": "string" }, "total_refunded_amount": { "currency_code": "str", "value": "string" } }, "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string" }, "payer": { "email_address": "string", "merchant_id": "string" }, "create_time": "string", "update_time": "string" } ] } payment_initiator The person or party who initiated or triggered the payment.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The person or party who initiated or triggered the payment.
Enum Value Description CUSTOMER Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website. MERCHANT Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer. Copy "CUSTOMER" payment_instruction Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
platform_fees
Array of objects [ 0 .. 1 ] items
An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.
payee_pricing_tier_id
string [ 1 .. 20 ] characters
This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.
payee_receivable_fx_rate_id string [ 1 .. 4000 ] characters FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.
disbursement_mode
string [ 1 .. 16 ] characters ^[A-Z_]+$
Default: "INSTANT"
The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.
Enum Value Description INSTANT The funds are released to the merchant immediately. DELAYED The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration. CopyExpand allCollapse all { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "payee_pricing_tier_id": "string", "payee_receivable_fx_rate_id": "string", "disbursement_mode": "INSTANT" } payment_method The customer and merchant payment preferences.
standard_entry_class_code
string [ 3 .. 255 ] characters
Default: "WEB"
NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.
Enum Value Description TEL The API caller (merchant/partner) accepts authorization and payment information from a consumer over the telephone. WEB The API caller (merchant/partner) accepts Debit transactions from a consumer on their website. CCD Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company transfers or invoice payments to suppliers). PPD Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account holder, and usually initiated by a company. These are usually recurring debits (such as insurance premiums). payee_preferred string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "UNRESTRICTED" The merchant-preferred payment methods.
Enum Value Description UNRESTRICTED Accepts any type of payment from the customer. IMMEDIATE_PAYMENT_REQUIRED Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the pending status. Copy { "standard_entry_class_code": "TEL", "payee_preferred": "UNRESTRICTED" } payment_source The payment source definition.
card
object
The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.
token
object
The tokenized payment source to fund a payment.
paypal
object
Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.
bancontact
object
Bancontact is the most popular online payment in Belgium. More Details.
blik
object
BLIK is a mobile payment system, created by Polish Payment Standard in order to allow millions of users to pay in shops, payout cash in ATMs and make online purchases and payments. More Details.
eps object The eps transfer is an online payment method developed by many Austrian banks. More Details.
giropay object Giropay is an Internet payment System in Germany, based on online banking. More Details.
ideal
object
The Dutch payment method iDEAL is an online payment method that enables consumers to pay online through their own bank. More Details.
mybank
object
MyBank is an e-authorisation solution which enables safe digital payments and identity authentication through a consumer’s own online banking portal or mobile application. More Details.
p24 object P24 (Przelewy24) is a secure and fast online bank transfer service linked to all the major banks in Poland. More Details.
sofort
object
SOFORT Banking is a real-time bank transfer payment method that buyers use to transfer funds directly to merchants from their bank accounts. More Details.
trustly object Trustly is a payment method that allows customers to shop and pay from their bank account. More Details.
apple_pay
object
ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.
google_pay
object
Google Pay payment source, allows buyer to pay using Google Pay.
venmo
object
Information needed to indicate that Venmo is being used to fund the payment.
CopyExpand allCollapse all { "card": { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "token": { "id": "string", "type": "BILLING_AGREEMENT" }, "paypal": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } }, "bancontact": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "blik": { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string", "consumer_user_agent": "string", "consumer_ip": "string" }, "level_0": { "auth_code": "string" }, "one_click": { "auth_code": "string", "consumer_reference": "string", "alias_label": "stringst", "alias_key": "string" } }, "eps": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "giropay": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "ideal": { "name": "string", "country_code": "string", "bic": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "mybank": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "p24": { "name": "string", "email": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "sofort": { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "trustly": { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } }, "apple_pay": { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "venmo": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } } payment_source The payment source definition.
card
object
The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.
token
object
The tokenized payment source to fund a payment.
paypal
object
Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.
apple_pay
object
ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.
google_pay
object
Google Pay payment source, allows buyer to pay using Google Pay.
venmo
object
Information needed to indicate that Venmo is being used to fund the payment.
CopyExpand allCollapse all { "card": { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "token": { "id": "string", "type": "BILLING_AGREEMENT" }, "paypal": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } }, "apple_pay": { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "venmo": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } } payment_source The payment source definition.
card
object
The payment card to use to fund a payment. Can be a credit or debit card.
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.
PayPal offers a mechanism by which you do not have to take on the PCI SAQ D burden by using hosted fields - refer to this Integration Guide.
token
object
The tokenized payment source to fund a payment.
paypal
object
Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.
apple_pay
object
ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.
google_pay
object
Google Pay payment source, allows buyer to pay using Google Pay.
venmo
object
Information needed to indicate that Venmo is being used to fund the payment.
CopyExpand allCollapse all { "card": { "name": "string", "number": "stringstrings", "security_code": "stri", "expiry": "string", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS" }, "verification": { "method": "SCA_ALWAYS" } }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "vault_id": "string", "single_use_token": "string", "network_token": { "number": "stringstrings", "cryptogram": "stringstringstringstringstri", "token_requestor_id": "string", "expiry": "string", "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION" }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "token": { "id": "string", "type": "BILLING_AGREEMENT" }, "paypal": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } }, "apple_pay": { "id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "decrypted_token": { "device_manufacturer_id": "string", "payment_data_type": "3DSECURE", "transaction_amount": { "currency_code": "str", "value": "string" }, "tokenized_card": { "name": "string", "number": "stringstrings", "expiry": "string", "card_type": "VISA", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "payment_data": { "cryptogram": "string", "eci_indicator": "string", "emv_data": "string", "pin": "string" } }, "vault_id": "string", "experience_context": { "return_url": "string", "cancel_url": "string" } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "decrypted_token": { "message_id": "string", "message_expiration": "stringstrings", "payment_method": "CARD", "card": { "name": "string", "number": "stringstrings", "last_digits": "stri", "expiry": "string", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "authentication_method": "PAN_ONLY", "cryptogram": "string", "eci_indicator": "string" }, "assurance_details": { "account_verified": false, "card_holder_authenticated": false }, "experience_context": { "return_url": "string", "cancel_url": "string" } }, "venmo": { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } } payment_source_response The payment source used to fund the payment.
card
object
The payment card to use to fund a payment. Card can be a credit or debit card.
bancontact
object
Information used to pay Bancontact.
blik
object
Information used to pay using BLIK.
eps object Information used to pay using eps.
giropay object Information needed to pay using giropay.
ideal
object
Information used to pay using iDEAL.
mybank
object
Information used to pay using MyBank.
p24 object Information used to pay using P24(Przelewy24).
sofort
object
Information used to pay using Sofort.
trustly object Information needed to pay using Trustly.
venmo
object
Venmo wallet response.
paypal
object
The PayPal Wallet response.
apple_pay
object
Information needed to pay using ApplePay.
google_pay
object
Google Pay Wallet payment data.
CopyExpand allCollapse all { "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" } }, "bancontact": { "card_last_digits": "stri", "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "blik": { "name": "string", "country_code": "string", "email": "string", "one_click": { "consumer_reference": "string" } }, "eps": { "name": "string", "country_code": "string", "bic": "string" }, "giropay": { "name": "string", "country_code": "string", "bic": "string" }, "ideal": { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "mybank": { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "p24": { "payment_descriptor": "string", "method_id": "string", "method_description": "string", "name": "string", "email": "string", "country_code": "string" }, "sofort": { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" }, "trustly": { "name": "string", "country_code": "string", "email": "string", "bic": "string", "iban_last_chars": "string" }, "venmo": { "user_name": "string", "return_flow": "AUTO", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } } } }, "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "paypal": { "account_status": "VERIFIED", "phone_type": "FAX", "business_name": "string", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } }, "cobranded_cards": [ { "labels": [ "string" ], "payee": { "email_address": "string", "merchant_id": "string" }, "amount": { "currency_code": "str", "value": "string" } } ] }, "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "experience_status": "NOT_STARTED", "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "apple_pay": { "id": "string", "token": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" }, "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "country_code": "string" }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "name": { "given_name": "string", "surname": "string" } } } } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "last_digits": "stri", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } } } } } payment_source_response The payment source used to fund the payment.
card
object
The payment card to use to fund a payment. Card can be a credit or debit card.
venmo
object
Venmo wallet response.
paypal
object
The PayPal Wallet response.
apple_pay
object
Information needed to pay using ApplePay.
google_pay
object
Google Pay Wallet payment data.
CopyExpand allCollapse all { "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" } }, "venmo": { "user_name": "string", "return_flow": "AUTO", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } } } }, "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "paypal": { "account_status": "VERIFIED", "phone_type": "FAX", "business_name": "string", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } }, "cobranded_cards": [ { "labels": [ "string" ], "payee": { "email_address": "string", "merchant_id": "string" }, "amount": { "currency_code": "str", "value": "string" } } ] }, "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "experience_status": "NOT_STARTED", "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "apple_pay": { "id": "string", "token": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "name": "string", "email_address": "string", "phone_number": { "national_number": "string" }, "card": { "name": "string", "last_digits": "string", "available_networks": [ "VISA" ], "from_request": { "last_digits": "stri", "expiry": "string" }, "stored_credential": { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } }, "brand": "VISA", "type": "CREDIT", "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ ], "anyOf": [ ], "oneOf": [ ], "not": { }, "links": [ ], "fragmentResolution": null, "media": { }, "pathStart": null } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": null } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } }, "expiry": "string", "bin_details": { "bin": "string", "issuing_bank": "string", "products": [ "string" ], "bin_country_code": "string" }, "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "country_code": "string" }, "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "name": { "given_name": "string", "surname": "string" } } } } }, "google_pay": { "name": "string", "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "card": { "name": "string", "last_digits": "stri", "type": "CREDIT", "brand": "VISA", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "authentication_result": { "liability_shift": "NO", "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y" } } } } } PayPal Account Identifier The account identifier for a PayPal account.
string (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The account identifier for a PayPal account.
Copy "stringstrings" paypal_wallet A resource that identifies a PayPal Wallet is used for payment.
experience_context
object
Customizes the payer experience during the approval process for payment with PayPal.
Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.
billing_agreement_id
string [ 2 .. 128 ] characters ^[a-zA-Z0-9-]+$
The PayPal billing agreement ID. References an approved recurring payment for goods or services.
stored_credential
object
Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.
vault_id
string [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the payment_source stored within the Vault.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of the PayPal account holder.
name
object
The name of the PayPal account holder. Supports only the given_name and surname properties.
phone
object
The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number.
birth_date
string = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern
The birth date of the PayPal account holder in YYYY-MM-DD format.
tax_info
object
The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both tax_id and tax_id_type are required.
address object The address of the PayPal account holder. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.
attributes
object
Additional attributes associated with the use of this wallet.
CopyExpand allCollapse all { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "billing_agreement_id": "string", "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "vault_id": "string", "email_address": "string", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } paypal_wallet_attributes Additional attributes associated with the use of this PayPal Wallet.
customer
object
The details about a customer in PayPal's system of record.
vault
object
Attributes used to provide the instructions during vaulting of the PayPal Wallet.
CopyExpand allCollapse all { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } paypal_wallet_attributes_response Additional attributes associated with the use of a PayPal Wallet.
vault
object
The details about a saved PayPal Wallet payment source.
cobranded_cards Array of objects [ 0 .. 25 ] items An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).
CopyExpand allCollapse all { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } }, "cobranded_cards": [ { "labels": [ "string" ], "payee": { "email_address": "string", "merchant_id": "string" }, "amount": { "currency_code": "str", "value": "string" } } ] } paypal_wallet_customer The details about a customer in PayPal's system of record.
id
string [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.
phone
object
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.
name
object
The full name of the customer as provided to the merchant or on file with the merchant.
merchant_customer_id
string [ 1 .. 64 ] characters
Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.
CopyExpand allCollapse all { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } paypal_wallet_experience_context Customizes the payer experience during the approval process for payment with PayPal.
Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.
brand_name
string [ 1 .. 127 ] characters
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.
shipping_preference string [ 1 .. 24 ] characters Default: "GET_FROM_FILE" The location from which the shipping address is derived.
Enum Value Description
GET_FROM_FILE Get the customer-provided shipping address on the PayPal site.
NO_SHIPPING Removes the shipping address information from the API response and the Paypal site. However, the shipping.phone_number and shipping.email_address fields will still be returned to allow for digital goods delivery.
SET_PROVIDED_ADDRESS Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.
contact_preference
string [ 1 .. 24 ] characters
Default: "NO_CONTACT_INFO"
The preference to display the contact information (buyer’s shipping email & phone number) on PayPal's checkout for easy merchant-buyer communication.
Enum Value Description
NO_CONTACT_INFO The merchant can opt out of showing buyer's contact information on PayPal checkout.
UPDATE_CONTACT_INFO The merchant allows buyer to add or update shipping contact information on the PayPal checkout. Please ensure to use this updated information returned in shipping.email_address and shipping.phone_number to contact your buyers.
RETAIN_CONTACT_INFO The buyer can only see but can not override merchant passed contact information (shipping.email_address and shipping.phone_number) on PayPal checkout. NOTE: If you don't pass the contact information, the behavior is the same as NO_CONTACT_INFO preference.
landing_page
string [ 1 .. 13 ] characters
Default: "NO_PREFERENCE"
The type of landing page to show on the PayPal site for customer checkout.
Enum Value Description LOGIN When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment. GUEST_CHECKOUT When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. This option has previously been also called as 'BILLING' NO_PREFERENCE When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal. BILLING DEPRECATED - please use GUEST_CHECKOUT. All implementations of 'BILLING' will be routed to 'GUEST_CHECKOUT'. When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. user_action string [ 1 .. 8 ] characters Default: "CONTINUE" Configures a Continue or Pay Now checkout flow.
Enum Value Description
CONTINUE After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.
PAY_NOW After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.
payment_method_preference
string [ 1 .. 255 ] characters
Default: "UNRESTRICTED"
The merchant-preferred payment methods.
Enum Value Description
UNRESTRICTED Accepts any type of payment from the customer.
IMMEDIATE_PAYMENT_REQUIRED Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the pending status.
locale
string [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.
return_url
string
The URL where the customer will be redirected upon approving a payment.
cancel_url
string
The URL where the customer will be redirected upon cancelling the payment approval.
app_switch_context
object
Merchants can use this to switch buyers from their website/application to the PayPal consumer app to review and approve the transaction.
order_update_callback_config
object
Merchant provided Order Update callback configuration for PayPal Wallet.PayPal will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
CopyExpand allCollapse all { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "contact_preference": "NO_CONTACT_INFO", "landing_page": "LOGIN", "user_action": "CONTINUE", "payment_method_preference": "UNRESTRICTED", "locale": "string", "return_url": "string", "cancel_url": "string", "app_switch_context": { "native_app": { "os_type": "ANDROID", "os_version": "string" }, "mobile_web": { "return_flow": "AUTO", "buyer_user_agent": "string" } }, "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } } paypal_wallet_response The PayPal Wallet response.
account_status
string [ 1 .. 255 ] characters
The account status indicates whether the buyer has verified the financial details associated with their PayPal account.
Enum Value Description
VERIFIED The buyer has completed the verification of the financial details associated with this PayPal account. For example: confirming their bank account.
UNVERIFIED The buyer has not completed the verification of the financial details associated with this PayPal account. For example: confirming their bank account.
phone_type
string
The phone type.
Enum Value Description
FAX Fax number.
HOME Home phone number.
MOBILE Mobile phone number.
OTHER Other phone number.
PAGER Pager number.
business_name
string [ 0 .. 300 ] characters
The business name of the PayPal account holder (populated for business accounts only)
attributes
object
Additional attributes associated with the use of a PayPal Wallet.
stored_credential
object
Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.
experience_status
string [ 1 .. 255 ] characters
This field indicates the status of PayPal's Checkout experience throughout the order lifecycle. The values reflect the current stage of the checkout process.
Enum Value Description
NOT_STARTED PayPal checkout process has not yet begun.
IN_PROGRESS PayPal checkout initiated. User is on the checkout page for order review before approval.
CANCELED PayPal checkout is canceled (by closing the checkout window or clicking cancel) before the order approval.
APPROVED Order is approved. User has completed the checkout process.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of the PayPal account holder.
account_id
string = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The PayPal-assigned ID for the PayPal account holder.
name
object
The name of the PayPal account holder. Supports only the given_name and surname properties.
phone_number
object
The phone number, in its canonical international E.164 numbering plan format. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account. Supports only the national_number property.
birth_date
string = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern
The birth date of the PayPal account holder in YYYY-MM-DD format.
tax_info
object
The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both tax_id and tax_id_type are required.
address object The address of the PayPal account holder. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.
CopyExpand allCollapse all { "account_status": "VERIFIED", "phone_type": "FAX", "business_name": "string", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } }, "cobranded_cards": [ { "labels": [ "string" ], "payee": { "email_address": "string", "merchant_id": "string" }, "amount": { "currency_code": "str", "value": "string" } } ] }, "stored_credential": { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" }, "experience_status": "NOT_STARTED", "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "birth_date": "stringstri", "tax_info": { "tax_id": "string", "tax_id_type": "BR_CPF" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } paypal_wallet_stored_credential Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.
payment_initiator required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The person or party who initiated or triggered the payment.
Enum Value Description
CUSTOMER Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.
MERCHANT Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.
charge_pattern
string [ 1 .. 30 ] characters ^[A-Z0-9_]+$
DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern instead.
Enum Value Description
IMMEDIATE On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency.
DEFERRED Pay after use, non-recurring post-paid, variable amount, irregular frequency.
RECURRING_PREPAID Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered.
RECURRING_POSTPAID Pay on a fixed date based on usage or consumption after the goods/service is delivered.
THRESHOLD_PREPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered.
THRESHOLD_POSTPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered.
SUBSCRIPTION_PREPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered.
SUBSCRIPTION_POSTPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered.
UNSCHEDULED_PREPAID Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.
UNSCHEDULED_POSTPAID Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.
INSTALLMENT_PREPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered.
INSTALLMENT_POSTPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered.
usage_pattern
string [ 1 .. 30 ] characters ^[A-Z0-9_]+$
Expected business/pricing model for the billing agreement.
Enum Value Description
IMMEDIATE On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency.
DEFERRED Pay after use, non-recurring post-paid, variable amount, irregular frequency.
RECURRING_PREPAID Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered.
RECURRING_POSTPAID Pay on a fixed date based on usage or consumption after the goods/service is delivered.
THRESHOLD_PREPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered.
THRESHOLD_POSTPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered.
SUBSCRIPTION_PREPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered.
SUBSCRIPTION_POSTPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered.
UNSCHEDULED_PREPAID Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.
UNSCHEDULED_POSTPAID Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.
INSTALLMENT_PREPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered.
INSTALLMENT_POSTPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered.
usage
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Default: "DERIVED"
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
Enum Value Description FIRST Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment. SUBSEQUENT Indicates a payment using a stored payment_source which has been successfully used previously for a payment. DERIVED Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal. Copy { "payment_initiator": "CUSTOMER", "charge_pattern": "IMMEDIATE", "usage_pattern": "IMMEDIATE", "usage": "FIRST" } paypal_wallet_vault_response The details about a saved PayPal Wallet payment source.
id
string [ 1 .. 255 ] characters
The PayPal-generated ID for the saved payment source.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.
Enum Value Description
VAULTED The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.
CREATED DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.
APPROVED Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault
links
Array of objects [ 1 .. 10 ] items
An array of request-related HATEOAS links.
customer
object
The details about a customer in PayPal's system of record.
CopyExpand allCollapse all { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" }, "merchant_customer_id": "string" } } Phone The phone number, in its canonical international E.164 numbering plan format.
national_number required string [ 1 .. 14 ] characters The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
Copy { "national_number": "string" } Phone The phone number in its canonical international E.164 numbering plan format.
country_code
string [ 1 .. 3 ] characters
The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_number required string [ 1 .. 14 ] characters The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
Copy { "country_code": "str", "national_number": "string" } Phone The phone number, in its canonical international E.164 numbering plan format.
country_code required string [ 1 .. 3 ] characters The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_number required string [ 1 .. 14 ] characters The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
Copy { "country_code": "str", "national_number": "string" } Phone Number The phone number in its canonical international E.164 numbering plan format.
national_number required string [ 1 .. 14 ] characters The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
Copy { "national_number": "string" } Phone Number Format Requiring National Number Excluding Country Code A structured representation of a phone number conforming to the international E.164 numbering plan format,requiring only the national_number field.
national_number required string [ 1 .. 14 ] characters The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
Copy { "national_number": "string" } Phone Number Schema with Required National Number and Optional Country Code A structured representation of a phone number conforming to the international E.164 numbering plan format,requiring the national_number field and optionally supporting the country_code.
country_code
string [ 1 .. 3 ] characters
The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_number required string [ 1 .. 14 ] characters The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
Copy { "country_code": "str", "national_number": "string" } Phone Type The phone type.
string The phone type.
Enum Value Description FAX Fax number. HOME Home phone number. MOBILE Mobile phone number. OTHER Other phone number. PAGER Pager number. Copy "FAX" phone_with_type The phone information.
phone_type
string
The phone type.
Enum Value Description FAX Fax number. HOME Home phone number. MOBILE Mobile phone number. OTHER Other phone number. PAGER Pager number. phone_number required object The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.
CopyExpand allCollapse all { "phone_type": "FAX", "phone_number": { "national_number": "string" } } platform_fee The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external perspective. The platform fee is limited in scope and is always associated with the original payment for the purchase unit.
amount required object The fee for this transaction.
payee
object
The recipient of the fee for this transaction. If you omit this value, the default is the API caller.
CopyExpand allCollapse all { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } Portable Postal Address (Medium-Grained) The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.
address_line_1
string <= 300 characters
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.
address_line_2
string <= 300 characters
The second line of the address, for example, a suite or apartment number.
admin_area_2
string <= 120 characters
A city, town, or village. Smaller than admin_area_level_1.
admin_area_1
string <= 300 characters
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:
UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton. postal_code string <= 60 characters The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as 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. Copy { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } pricing_scheme The pricing scheme details.
pricing_model required string [ 1 .. 24 ] characters The pricing model for the billing cycle.
Enum Value Description
FIXED A fixed pricing scheme where the customer is charged a fixed amount.
VARIABLE A variable pricing scheme where the customer is charged a variable amount.
AUTO_RELOAD A auto-reload pricing scheme where the customer is charged a fixed amount for reload.
price
object
The price the customer will be charged based on the pricing model
reload_threshold_amount object The threshold amount on which the reload charge would be triggered. This will be associated with the account-balance where if the account-balance goes below this amount then customer would incur reload charge.
CopyExpand allCollapse all { "pricing_model": "FIXED", "price": { "currency_code": "str", "value": "string" }, "reload_threshold_amount": { "currency_code": "str", "value": "string" } } processor_response The processor response information for payment requests, such as direct credit card transactions.
avs_code
string
The address verification code for Visa, Discover, Mastercard, or American Express transactions.
Enum Value Description
0 For Maestro, all address information matches.
1 For Maestro, none of the address information matches.
2 For Maestro, part of the address information matches.
3 For Maestro, the merchant did not provide AVS information. It was not processed.
4 For Maestro, the address was not checked or the acquirer had no response. The service is not available.
A For Visa, Mastercard, or Discover transactions, the address matches but the zip code does not match. For American Express transactions, the card holder address is correct.
B For Visa, Mastercard, or Discover transactions, the address matches. International A.
C For Visa, Mastercard, or Discover transactions, no values match. International N.
D For Visa, Mastercard, or Discover transactions, the address and postal code match. International X.
E For Visa, Mastercard, or Discover transactions, not allowed for Internet or phone transactions. For American Express card holder, the name is incorrect but the address and postal code match.
F For Visa, Mastercard, or Discover transactions, the address and postal code match. UK-specific X. For American Express card holder, the name is incorrect but the address matches.
G For Visa, Mastercard, or Discover transactions, global is unavailable. Nothing matches.
I For Visa, Mastercard, or Discover transactions, international is unavailable. Not applicable.
M For Visa, Mastercard, or Discover transactions, the address and postal code match. For American Express card holder, the name, address, and postal code match.
N For Visa, Mastercard, or Discover transactions, nothing matches. For American Express card holder, the address and postal code are both incorrect.
P For Visa, Mastercard, or Discover transactions, postal international Z. Postal code only.
R For Visa, Mastercard, or Discover transactions, re-try the request. For American Express, the system is unavailable.
S For Visa, Mastercard, Discover, or American Express, the service is not supported.
U For Visa, Mastercard, or Discover transactions, the service is unavailable. For American Express, information is not available. For Maestro, the address is not checked or the acquirer had no response. The service is not available.
W For Visa, Mastercard, or Discover transactions, whole ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.
X For Visa, Mastercard, or Discover transactions, exact match of the address and the nine-digit ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.
Y For Visa, Mastercard, or Discover transactions, the address and five-digit ZIP code match. For American Express, the card holder address and postal code are both correct.
Z For Visa, Mastercard, or Discover transactions, the five-digit ZIP code matches but no address. For American Express, only the card holder postal code is correct.
Null For Maestro, no AVS response was obtained.
cvv_code
string
The card verification value code for for Visa, Discover, Mastercard, or American Express.
Enum Value Description
0 For Maestro, the CVV2 matched.
1 For Maestro, the CVV2 did not match.
2 For Maestro, the merchant has not implemented CVV2 code handling.
3 For Maestro, the merchant has indicated that CVV2 is not present on card.
4 For Maestro, the service is not available.
E For Visa, Mastercard, Discover, or American Express, error - unrecognized or unknown response.
I For Visa, Mastercard, Discover, or American Express, invalid or null.
M For Visa, Mastercard, Discover, or American Express, the CVV2/CSC matches.
N For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does not match.
P For Visa, Mastercard, Discover, or American Express, it was not processed.
S For Visa, Mastercard, Discover, or American Express, the service is not supported.
U For Visa, Mastercard, Discover, or American Express, unknown - the issuer is not certified.
X For Visa, Mastercard, Discover, or American Express, no response. For Maestro, the service is not available.
All others For Visa, Mastercard, Discover, or American Express, error.
response_code
string
Processor response code for the non-PayPal payment processor errors.
Enum Value Description 1000 PARTIAL_AUTHORIZATION. 1300 INVALID_DATA_FORMAT. 1310 INVALID_AMOUNT. 1312 INVALID_TRANSACTION_CARD_ISSUER_ACQUIRER. 1317 INVALID_CAPTURE_DATE. 1320 INVALID_CURRENCY_CODE. 1330 INVALID_ACCOUNT. 1335 INVALID_ACCOUNT_RECURRING. 1340 INVALID_TERMINAL. 1350 INVALID_MERCHANT. 1352 RESTRICTED_OR_INACTIVE_ACCOUNT. 1360 BAD_PROCESSING_CODE. 1370 INVALID_MCC. 1380 INVALID_EXPIRATION. 1382 INVALID_CARD_VERIFICATION_VALUE. 1384 INVALID_LIFE_CYCLE_OF_TRANSACTION. 1390 INVALID_ORDER. 1393 TRANSACTION_CANNOT_BE_COMPLETED. 5100 GENERIC_DECLINE. 5110 CVV2_FAILURE. 5120 INSUFFICIENT_FUNDS. 5130 INVALID_PIN. 5135 DECLINED_PIN_TRY_EXCEEDED. 5140 CARD_CLOSED. 5150 PICKUP_CARD_SPECIAL_CONDITIONS. Try using another card. Do not retry the same card. 5160 UNAUTHORIZED_USER. 5170 AVS_FAILURE. 5180 INVALID_OR_RESTRICTED_CARD. Try using another card. Do not retry the same card. 5190 SOFT_AVS. 5200 DUPLICATE_TRANSACTION. 5210 INVALID_TRANSACTION. 5400 EXPIRED_CARD. 5500 INCORRECT_PIN_REENTER. 5650 DECLINED_SCA_REQUIRED. 5700 TRANSACTION_NOT_PERMITTED. Outside of scope of accepted business. 5710 TX_ATTEMPTS_EXCEED_LIMIT. 5800 REVERSAL_REJECTED. 5900 INVALID_ISSUE. 5910 ISSUER_NOT_AVAILABLE_NOT_RETRIABLE. 5920 ISSUER_NOT_AVAILABLE_RETRIABLE. 5930 CARD_NOT_ACTIVATED. 5950 DECLINED_DUE_TO_UPDATED_ACCOUNT. External decline as an updated card has been issued. 6300 ACCOUNT_NOT_ON_FILE. 7600 APPROVED_NON_CAPTURE. 7700 ERROR_3DS. 7710 AUTHENTICATION_FAILED. 7800 BIN_ERROR. 7900 PIN_ERROR. 8000 PROCESSOR_SYSTEM_ERROR. 8010 HOST_KEY_ERROR. 8020 CONFIGURATION_ERROR. 8030 UNSUPPORTED_OPERATION. 8100 FATAL_COMMUNICATION_ERROR. 8110 RETRIABLE_COMMUNICATION_ERROR. 8220 SYSTEM_UNAVAILABLE. 9100 DECLINED_PLEASE_RETRY. Retry. 9500 SUSPECTED_FRAUD. Try using another card. Do not retry the same card. 9510 SECURITY_VIOLATION. 9520 LOST_OR_STOLEN. Try using another card. Do not retry the same card. 9530 HOLD_CALL_CENTER. The merchant must call the number on the back of the card. POS scenario. 9540 REFUSED_CARD. 9600 UNRECOGNIZED_RESPONSE_CODE. 0000 APPROVED. 00N7 CVV2_FAILURE_POSSIBLE_RETRY_WITH_CVV. 0100 REFERRAL. 0390 ACCOUNT_NOT_FOUND. 0500 DO_NOT_HONOR. 0580 UNAUTHORIZED_TRANSACTION. 0800 BAD_RESPONSE_REVERSAL_REQUIRED. 0880 CRYPTOGRAPHIC_FAILURE. 0890 UNACCEPTABLE_PIN. 0960 SYSTEM_MALFUNCTION. 0R00 CANCELLED_PAYMENT. 10BR ISSUER_REJECTED. PCNR CONTINGENCIES_NOT_RESOLVED. PCVV CVV_FAILURE. PP06 ACCOUNT_CLOSED. A previously open account is now closed PPRN REATTEMPT_NOT_PERMITTED. PPAD BILLING_ADDRESS. PPAB ACCOUNT_BLOCKED_BY_ISSUER. PPAE AMEX_DISABLED. PPAG ADULT_GAMING_UNSUPPORTED. PPAI AMOUNT_INCOMPATIBLE. PPAR AUTH_RESULT. PPAU MCC_CODE. PPAV ARC_AVS. PPAX AMOUNT_EXCEEDED. PPBG BAD_GAMING. PPC2 ARC_CVV. PPCE CE_REGISTRATION_INCOMPLETE. PPCO COUNTRY. PPCR CREDIT_ERROR. PPCT CARD_TYPE_UNSUPPORTED. PPCU CURRENCY_USED_INVALID. PPD3 SECURE_ERROR_3DS. PPDC DCC_UNSUPPORTED. PPDI DINERS_REJECT. PPDV AUTH_MESSAGE. PPDT DECLINE_THRESHOLD_BREACH. PPEF EXPIRED_FUNDING_INSTRUMENT. PPEL EXCEEDS_FREQUENCY_LIMIT. PPER INTERNAL_SYSTEM_ERROR. PPEX EXPIRY_DATE. PPFE FUNDING_SOURCE_ALREADY_EXISTS. PPFI INVALID_FUNDING_INSTRUMENT. PPFR RESTRICTED_FUNDING_INSTRUMENT. PPFV FIELD_VALIDATION_FAILED. PPGR GAMING_REFUND_ERROR. PPH1 H1_ERROR. PPIF IDEMPOTENCY_FAILURE. PPII INVALID_INPUT_FAILURE. PPIM ID_MISMATCH. PPIT INVALID_TRACE_ID. PPLR LATE_REVERSAL. PPLS LARGE_STATUS_CODE. PPMB MISSING_BUSINESS_RULE_OR_DATA. PPMC BLOCKED_Mastercard. PPMD DEPRECATED The PPMD value has been deprecated. PPNC NOT_SUPPORTED_NRC. PPNL EXCEEDS_NETWORK_FREQUENCY_LIMIT. PPNM NO_MID_FOUND. PPNT NETWORK_ERROR. PPPH NO_PHONE_FOR_DCC_TRANSACTION. PPPI INVALID_PRODUCT. PPPM INVALID_PAYMENT_METHOD. PPQC QUASI_CASH_UNSUPPORTED. PPRE UNSUPPORT_REFUND_ON_PENDING_BC. PPRF INVALID_PARENT_TRANSACTION_STATUS. PPRR MERCHANT_NOT_REGISTERED. PPS0 BANKAUTH_ROW_MISMATCH. PPS1 BANKAUTH_ROW_SETTLED. PPS2 BANKAUTH_ROW_VOIDED. PPS3 BANKAUTH_EXPIRED. PPS4 CURRENCY_MISMATCH. PPS5 CREDITCARD_MISMATCH. PPS6 AMOUNT_MISMATCH. PPSC ARC_SCORE. PPSD STATUS_DESCRIPTION. PPSE AMEX_DENIED. PPTE VERIFICATION_TOKEN_EXPIRED. PPTF INVALID_TRACE_REFERENCE. PPTI INVALID_TRANSACTION_ID. PPTR VERIFICATION_TOKEN_REVOKED. PPTT TRANSACTION_TYPE_UNSUPPORTED. PPTV INVALID_VERIFICATION_TOKEN. PPUA USER_NOT_AUTHORIZED. PPUC CURRENCY_CODE_UNSUPPORTED. PPUE UNSUPPORT_ENTITY. PPUI UNSUPPORT_INSTALLMENT. PPUP UNSUPPORT_POS_FLAG. PPUR UNSUPPORTED_REVERSAL. PPVC VALIDATE_CURRENCY. PPVE VALIDATION_ERROR. PPVT VIRTUAL_TERMINAL_UNSUPPORTED. payment_advice_code string The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.
Enum Value Description 21 For Mastercard, the card holder has been unsuccessful at canceling recurring payment through merchant. Stop recurring payment requests. For Visa, all recurring payments were canceled for the card number requested. Stop recurring payment requests. 22 For Mastercard, merchant does not qualify for product code. 24 For Mastercard, retry after 1 hour. 25 For Mastercard, retry after 24 hours. 26 For Mastercard, retry after 2 days. 27 For Mastercard, retry after 4 days. 28 For Mastercard, retry after 6 days. 29 For Mastercard, retry after 8 days. 30 For Mastercard, retry after 10 days . 40 For Mastercard, consumer non-reloadable prepaid card. 43 For Mastercard, consumer multi-use virtual card number. 01 For Mastercard, expired card account upgrade or portfolio sale conversion. Obtain new account information before next billing cycle. 02 For Mastercard, over credit limit or insufficient funds. Retry the transaction 72 hours later. For Visa, the card holder wants to stop only one specific payment in the recurring payment relationship. The merchant must NOT resubmit the same transaction. The merchant can continue the billing process in the subsequent billing period. 03 For Mastercard, account closed as fraudulent. Obtain another type of payment from customer due to account being closed or fraud. Possible reason: Account closed as fraudulent. For Visa, the card holder wants to stop all recurring payment transactions for a specific merchant. Stop recurring payment requests. 04 For Mastercard, token requirements not fulfilled for this token type. Copy { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } Purchase Unit The purchase unit details. Used to capture required information for the payment contract.
reference_id
string [ 1 .. 256 ] characters
The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH. If you omit this value and the order contains only one purchase unit, PayPal sets this value to default.
Note: If there are multiple purchase units, reference_id is required for each purchase unit. description string [ 1 .. 127 ] characters The purchase description.
custom_id
string [ 1 .. 255 ] characters
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
invoice_id
string [ 1 .. 127 ] characters
The API caller-provided external invoice ID for this order.
id
string [ 1 .. 19 ] characters
The PayPal-generated ID for the purchase unit. This ID appears in both the payer's transaction history and the emails that the payer receives. In addition, this ID is available in transaction and settlement reports that merchants and API callers can use to reconcile transactions. This ID is only available when an order is saved by calling v2/checkout/orders/id/save.
soft_descriptor string [ 1 .. 22 ] characters The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters.
The soft descriptor supports the following ASCII characters:
Alphanumeric characters Dashes Asterisks Periods (.) Spaces For Wallet payments marketplace integrations: The merchant descriptor in the Payment Receiving Preferences must be the marketplace name. You can't use the remaining space to show the customer service number. The remaining spaces can be a combination of seller name and country.
For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.
items
Array of objects
An array of items that the customer purchases from the merchant.
most_recent_errors
Array of any [ 1 .. 10 ] items
The error reason code and description that are the reason for the most recent order decline.
amount
object
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
payee
object
The merchant who receives payment for this transaction.
payment_instruction object Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
shipping
object
The shipping address and method.
supplementary_data
object
Supplementary data about this payment. 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.
payments
object
The comprehensive history of payments for the purchase unit.
CopyExpand allCollapse all { "reference_id": "string", "description": "string", "custom_id": "string", "invoice_id": "string", "id": "string", "soft_descriptor": "string", "items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": null, "value": null }, "reload_threshold_amount": { "currency_code": null, "value": null } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } ], "most_recent_errors": [ null ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "payee": { "email_address": "string", "merchant_id": "string" }, "payment_instruction": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "payee_pricing_tier_id": "string", "payee_receivable_fx_rate_id": "string", "disbursement_mode": "INSTANT" }, "shipping": { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "trackers": [ { "id": "string", "status": "CANCELLED", "items": [ { "name": "string", "quantity": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" } } ], "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "create_time": "string", "update_time": "string" } ] }, "supplementary_data": { "card": { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ null ], "name": "string", "setup_fee": { "currency_code": null, "value": null } }, "commodity_code": "string", "unit_of_measure": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "total_amount": { "currency_code": "str", "value": "string" } } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } }, "risk": { "customer": { "ip_address": "string" } } }, "payments": { "authorizations": [ { "status": "CREATED", "status_details": { "reason": "PENDING_REVIEW" }, "id": "string", "invoice_id": "string", "custom_id": "string", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "string" ] }, "expiration_time": "string", "create_time": "string", "update_time": "string", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "captures": [ { "create_time": "string", "update_time": "string", "id": "string", "invoice_id": "string", "custom_id": "string", "final_capture": false, "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" }, "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "string" ] }, "seller_receivable_breakdown": { "platform_fees": [ { "amount": { "currency_code": null, "value": null }, "payee": { "email_address": null, "merchant_id": null } } ], "gross_amount": { "currency_code": "str", "value": "string" }, "paypal_fee": { "currency_code": "str", "value": "string" }, "paypal_fee_in_receivable_currency": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" }, "receivable_amount": { "currency_code": "str", "value": "string" }, "exchange_rate": { "value": "string", "source_currency": "str", "target_currency": "str" } }, "disbursement_mode": "INSTANT", "processor_response": { "avs_code": "A", "cvv_code": "E", "response_code": "0000", "payment_advice_code": "01" } } ], "refunds": [ { "status": "CANCELLED", "status_details": { "reason": "ECHECK" }, "id": "string", "invoice_id": "string", "custom_id": "string", "acquirer_reference_number": "string", "note_to_payer": "string", "seller_payable_breakdown": { "platform_fees": [ { "amount": { "currency_code": null, "value": null }, "payee": { "email_address": null, "merchant_id": null } } ], "net_amount_breakdown": [ { "payable_amount": { "currency_code": null, "value": null }, "converted_amount": { "currency_code": null, "value": null }, "exchange_rate": { "value": null, "source_currency": null, "target_currency": null } } ], "gross_amount": { "currency_code": "str", "value": "string" }, "paypal_fee": { "currency_code": "str", "value": "string" }, "paypal_fee_in_receivable_currency": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" }, "net_amount_in_receivable_currency": { "currency_code": "str", "value": "string" }, "total_refunded_amount": { "currency_code": "str", "value": "string" } }, "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": null, "binaryEncoding": null }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string" }, "payer": { "email_address": "string", "merchant_id": "string" }, "create_time": "string", "update_time": "string" } ] } } Purchase Unit Request The purchase unit request. Includes required information for the payment contract.
reference_id
string [ 1 .. 256 ] characters
The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH. If you omit this value and the order contains only one purchase unit, PayPal sets this value to default.
description
string [ 1 .. 3000 ] characters
This field supports up to 3,000 characters, but any content beyond 127 characters (including spaces) will be truncated. The 127 character limit is reflected in the response representation of this field.
The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.
custom_id
string [ 1 .. 255 ] characters
The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.
invoice_id
string [ 1 .. 127 ] characters
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. invoice_id values are required to be unique within each merchant account by default. Although the uniqueness validation is configurable, disabling this behavior will remove the account's ability to use invoice_id in other APIs as an identifier. It is highly recommended to keep a unique invoice_id for each Order.
soft_descriptor string [ 1 .. 1000 ] characters This field supports up to 127 characters, but any content beyond 22 characters (including spaces) will be truncated. The 22 character limit is reflected in the response representation of this field. The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement.
If an Order is paid using the "PayPal Wallet", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor
Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit
The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement.
For example, if:
The PayPal prefix toggle is PAYPAL *.
The merchant descriptor in the profile is Janes Gift.
The soft descriptor is 800-123-1234.
Then, the statement descriptor on the card is PAYPAL * Janes Gift 80.
items
Array of objects
An array of items that the customer purchases from the merchant.
amount required object The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount. The amount must be a positive number. The amount.value field supports up to 15 digits preceding the decimal. For a list of supported currencies, decimal precision, and maximum charge amount, see the PayPal REST APIs Currency Codes.
payee
object
The merchant who receives payment for this transaction.
payment_instruction object Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
shipping
object
The name and address of the person to whom to ship the items.
supplementary_data
object
Contains Supplementary Data.
CopyExpand allCollapse all { "reference_id": "string", "description": "string", "custom_id": "string", "invoice_id": "string", "soft_descriptor": "string", "items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "category": "DIGITAL_GOODS", "image_url": "http://example.com", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": "REGULAR", "total_cycles": 1, "sequence": 1, "pricing_scheme": { "pricing_model": "FIXED", "price": { "currency_code": null, "value": null }, "reload_threshold_amount": { "currency_code": null, "value": null } }, "start_date": "string" } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } }, "payee": { "email_address": "string", "merchant_id": "string" }, "payment_instruction": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "payee_pricing_tier_id": "string", "payee_receivable_fx_rate_id": "string", "disbursement_mode": "INSTANT" }, "shipping": { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "supplementary_data": { "card": { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ null ], "name": "string", "setup_fee": { "currency_code": null, "value": null } }, "commodity_code": "string", "unit_of_measure": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "total_amount": { "currency_code": "str", "value": "string" } } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } }, "risk": { "customer": { "ip_address": "string" } } } } refund The refund information.
status
string
The status of the refund.
Enum Value Description
CANCELLED The refund was cancelled.
FAILED The refund could not be processed.
PENDING The refund is pending. For more information, see status_details.reason.
COMPLETED The funds for this transaction were debited to the customer's account.
status_details
object
The details of the refund status.
id
string
The PayPal-generated ID for the refund.
invoice_id
string
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
custom_id
string [ 1 .. 255 ] characters
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
acquirer_reference_number
string [ 1 .. 36 ] characters
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
note_to_payer
string
The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.
seller_payable_breakdown
object
The breakdown of the refund.
links
Array of objects
An array of related HATEOAS links.
amount
object
The amount that the payee refunded to the payer.
payer
object
The details associated with the merchant for this transaction.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
CopyExpand allCollapse all { "status": "CANCELLED", "status_details": { "reason": "ECHECK" }, "id": "string", "invoice_id": "string", "custom_id": "string", "acquirer_reference_number": "string", "note_to_payer": "string", "seller_payable_breakdown": { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "net_amount_breakdown": [ { "payable_amount": { "currency_code": "str", "value": "string" }, "converted_amount": { "currency_code": "str", "value": "string" }, "exchange_rate": { "value": "string", "source_currency": "str", "target_currency": "str" } } ], "gross_amount": { "currency_code": "str", "value": "string" }, "paypal_fee": { "currency_code": "str", "value": "string" }, "paypal_fee_in_receivable_currency": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" }, "net_amount_in_receivable_currency": { "currency_code": "str", "value": "string" }, "total_refunded_amount": { "currency_code": "str", "value": "string" } }, "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "amount": { "currency_code": "str", "value": "string" }, "payer": { "email_address": "string", "merchant_id": "string" }, "create_time": "string", "update_time": "string" } refund_status The refund status with details.
status
string
The status of the refund.
Enum Value Description
CANCELLED The refund was cancelled.
FAILED The refund could not be processed.
PENDING The refund is pending. For more information, see status_details.reason.
COMPLETED The funds for this transaction were debited to the customer's account.
status_details
object
The details of the refund status.
CopyExpand allCollapse all { "status": "CANCELLED", "status_details": { "reason": "ECHECK" } } refund_status_details The details of the refund status.
reason
string
The reason why the refund has the PENDING or FAILED status.
Value Description ECHECK The customer's account is funded through an eCheck, which has not yet cleared. Copy { "reason": "ECHECK" } Risk Assessment Status The risk assessment status.
string [ 1 .. 255 ] characters ^[A-Z_]+$ The risk assessment status.
Enum Value Description ALLOW Fraud Protection allowed this payment. DENY Fraud Protection denied this payment. PENDING Payment is in Fraud Protection Review Queue. Copy "ALLOW" risk_supplementary_data Additional information necessary to evaluate the risk profile of a transaction.
customer
object
Profile information of the sender or receiver.
CopyExpand allCollapse all { "customer": { "ip_address": "string" } } Seller Receivable Breakdown The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
platform_fees
Array of objects [ 0 .. 1 ] items
An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.
gross_amount required object The amount for this captured payment in the currency of the transaction.
paypal_fee
object
The applicable fee for this captured payment in the currency of the transaction.
paypal_fee_in_receivable_currency
object
The applicable fee for this captured payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example 'CNY'.
net_amount
object
The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee minus the platform_fees.
receivable_amount
object
The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. The amount is computed as net_amount times exchange_rate.
exchange_rate
object
The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds.
CopyExpand allCollapse all { "platform_fees": [ { "amount": { "currency_code": "str", "value": "string" }, "payee": { "email_address": "string", "merchant_id": "string" } } ], "gross_amount": { "currency_code": "str", "value": "string" }, "paypal_fee": { "currency_code": "str", "value": "string" }, "paypal_fee_in_receivable_currency": { "currency_code": "str", "value": "string" }, "net_amount": { "currency_code": "str", "value": "string" }, "receivable_amount": { "currency_code": "str", "value": "string" }, "exchange_rate": { "value": "string", "source_currency": "str", "target_currency": "str" } } seller_protection The level of protection offered as defined by PayPal Seller Protection for Merchants.
status
string
Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.
Enum Value Description
ELIGIBLE Your PayPal balance remains intact if the customer claims that they did not receive an item or the account holder claims that they did not authorize the payment.
PARTIALLY_ELIGIBLE Your PayPal balance remains intact if the customer claims that they did not receive an item.
NOT_ELIGIBLE This transaction is not eligible for seller protection.
dispute_categories
Array of strings
An array of conditions that are covered for the transaction.
CopyExpand allCollapse all { "status": "ELIGIBLE", "dispute_categories": [ "string" ] } Shipping Option and Amount data at Purchase Unit This would contain shipping option and amount data at purchase unit level.
reference_id
string [ 1 .. 256 ] characters
The API caller-provided external ID for the purchase unit. Required for multiple purchase units when you must update the order through PATCH. If you omit this value and the order contains only one purchase unit, PayPal sets this value to default.
Note: If there are multiple purchase units, reference_id is required for each purchase unit.
shipping_options
Array of objects [ 1 .. 10 ] items
An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.
amount
object
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
CopyExpand allCollapse all { "reference_id": "string", "shipping_options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "shipping": { "currency_code": "str", "value": "string" }, "handling": { "currency_code": "str", "value": "string" }, "tax_total": { "currency_code": "str", "value": "string" }, "insurance": { "currency_code": "str", "value": "string" }, "shipping_discount": { "currency_code": "str", "value": "string" }, "discount": { "currency_code": "str", "value": "string" } } } } shipping_detail The shipping details.
type
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
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.
Enum Value Description SHIPPING The payer intends to receive the items at a specified address. PICKUP_IN_PERSON DEPRECATED. Please use "PICKUP_FROM_PERSON" instead. PICKUP_IN_STORE The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. PICKUP_FROM_PERSON The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. options Array of objects [ 0 .. 10 ] items An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.
name
object
The name of the person to whom to ship the items. Supports only the full_name property.
email_address
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.
phone_number
object
The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan]
address object The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. admin_area_1 is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.
CopyExpand allCollapse all { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } shipping_detail The shipping details.
type
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
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.
Enum Value Description
SHIPPING The payer intends to receive the items at a specified address.
PICKUP_IN_PERSON DEPRECATED. Please use "PICKUP_FROM_PERSON" instead.
PICKUP_IN_STORE The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.
PICKUP_FROM_PERSON The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.
name
object
The name of the person to whom to ship the items. Supports only the full_name property.
email_address
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.
phone_number
object
The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan]
address object The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. admin_area_1 is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.
CopyExpand allCollapse all { "type": "SHIPPING", "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } shipping_option The options that the payee or merchant offers to the payer to ship or pick up their items.
id required string <= 127 characters A unique ID that identifies a payer-selected shipping option.
label required string <= 127 characters A description that the payer sees, which helps them choose an appropriate shipping option. For example, Free Shipping, USPS Priority Shipping, Expédition prioritaire USPS, or USPS yōuxiān fā huò. Localize this description to the payer's locale.
selected required boolean If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. As part of the response if a shipping.option contains selected=true, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one shipping.option can be set to selected=true.
type
string
A classification for the method of purchase fulfillment.
Enum Value Description
SHIPPING The payer intends to receive the items at a specified address.
PICKUP DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address).
PICKUP_IN_STORE The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.
PICKUP_FROM_PERSON The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.
amount
object
The shipping cost for the selected option.
CopyExpand allCollapse all { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } shipping_option The options that the payee or merchant offers to the payer to ship or pick up their items.
id required string <= 127 characters A unique ID that identifies a payer-selected shipping option.
label required string <= 127 characters A description that the payer sees, which helps them choose an appropriate shipping option. For example, Free Shipping, USPS Priority Shipping, Expédition prioritaire USPS, or USPS yōuxiān fā huò. Localize this description to the payer's locale.
type
string
A classification for the method of purchase fulfillment.
Enum Value Description
SHIPPING The payer intends to receive the items at a specified address.
PICKUP DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address).
PICKUP_IN_STORE The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option.
PICKUP_FROM_PERSON The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment.
amount
object
The shipping cost for the selected option.
CopyExpand allCollapse all { "id": "string", "label": "string", "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } shipping_type A classification for the method of purchase fulfillment.
string A classification for the method of purchase fulfillment.
Enum Value Description SHIPPING The payer intends to receive the items at a specified address. PICKUP DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). PICKUP_IN_STORE The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. PICKUP_FROM_PERSON The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. Copy "SHIPPING" shipping_with_tracking_details The order shipping details.
type
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
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.
Enum Value Description SHIPPING The payer intends to receive the items at a specified address. PICKUP_IN_PERSON DEPRECATED. Please use "PICKUP_FROM_PERSON" instead. PICKUP_IN_STORE The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. PICKUP_FROM_PERSON The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. options Array of objects [ 0 .. 10 ] items An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.
name
object
The name of the person to whom to ship the items. Supports only the full_name property.
email_address
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.
phone_number
object
The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan]
address object The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. admin_area_1 is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.
trackers
Array of objects
An array of trackers for a transaction.
CopyExpand allCollapse all { "type": "SHIPPING", "options": [ { "id": "string", "label": "string", "selected": true, "type": "SHIPPING", "amount": { "currency_code": "str", "value": "string" } } ], "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "trackers": [ { "id": "string", "status": "CANCELLED", "items": [ { "name": "string", "quantity": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" } } ], "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "create_time": "string", "update_time": "string" } ] } single_use_token The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.
string [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$ The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.
Copy "string" sofort Information used to pay using Sofort.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
iban_last_chars string [ 4 .. 34 ] characters ^.[a-zA-Z0-9]{4}.$ The last characters of the IBAN used to pay.
Copy { "name": "string", "country_code": "string", "bic": "string", "iban_last_chars": "string" } sofort_request Information needed to pay using Sofort.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } store_in_vault_instruction Defines how and when the payment source gets vaulted.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Defines how and when the payment source gets vaulted.
Value Description ON_SUCCESS Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. Copy "ON_SUCCESS" stored_payment_source Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility:
payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER. usage=FIRST is compatible only with payment_initiator=CUSTOMER. previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request. payment_initiator required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The person or party who initiated or triggered the payment.
Enum Value Description CUSTOMER Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website. MERCHANT Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer. payment_type required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Indicates the type of the stored payment_source payment.
Enum Value Description
ONE_TIME One Time payment such as online purchase or donation. (e.g. Checkout with one-click).
RECURRING Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).
UNSCHEDULED Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).
usage
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Default: "DERIVED"
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
Enum Value Description
FIRST Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.
SUBSEQUENT Indicates a payment using a stored payment_source which has been successfully used previously for a payment.
DERIVED Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal.
previous_network_transaction_reference
object
Reference values used by the card network to identify a transaction.
CopyExpand allCollapse all { "payment_initiator": "CUSTOMER", "payment_type": "ONE_TIME", "usage": "FIRST", "previous_network_transaction_reference": { "id": "stringstr", "date": "stri", "acquirer_reference_number": "string", "network": "VISA" } } stored_payment_source_payment_type Indicates the type of the stored payment_source payment.
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Indicates the type of the stored payment_source payment.
Enum Value Description ONE_TIME One Time payment such as online purchase or donation. (e.g. Checkout with one-click). RECURRING Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments). UNSCHEDULED Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments). Copy "ONE_TIME" stored_payment_source_usage_type Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "DERIVED" Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
Enum Value Description FIRST Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment. SUBSEQUENT Indicates a payment using a stored payment_source which has been successfully used previously for a payment. DERIVED Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal. Copy "FIRST" Subscription period Describes a period in a subscription. A period is a chunk of time for which a set of subscription terms are applicable.
current_period
boolean
Indicates if this period, with its subscription terms, is currently active.
billing_interval_unit
string [ 1 .. 24 ] characters
The billing interval unit for the subscription period.
Enum Value Description
YEAR The billing interval for the subscription period is a year.
MONTH The billing interval for the subscription period is a month.
SEMIMONTH The billing interval for the subscription period is half a month.
WEEK The billing interval for the subscription period is a week.
DAY The billing interval for the subscription period is a day.
billing_frequency
integer [ 1 .. 365 ]
Default: 1
The frequency, i.e. the number of billing interval units, at which the subscriber is charged. E.g. - if the billing_interval_unit is DAY, with a billing_frequency of 2, the subscriber is billed once every two days.
total_billing_cycles
integer [ 0 .. 999 ]
Default: 1
The number of billing cycles in the period. This is effectively the number of times the subscriber will be charged in the period.
current_billing_cycle
integer [ 0 .. 999 ]
Indicates the index of the current billing cycle for the period. E.g. - a value of 3 would mean that its the third billing cycle for the period.
regular_period
boolean
Indicates if the period is a regular period. A regular period would have standard subscription terms, as opposed to some special terms that might be applicable for a trial or promotional period.
billing_amount
object
The amount that the subscriber will be charged in each billing cycle.
shipping_amount object The shipping charges applicable for each cycle.
tax_amount
object
The tax amount applicable for each cycle.
CopyExpand allCollapse all { "current_period": true, "billing_interval_unit": "YEAR", "billing_frequency": 1, "total_billing_cycles": 1, "current_billing_cycle": 999, "regular_period": true, "billing_amount": { "currency_code": "str", "value": "string" }, "shipping_amount": { "currency_code": "str", "value": "string" }, "tax_amount": { "currency_code": "str", "value": "string" } } supplementary_data Supplementary data about a payment. This object passes information that can be used to improve risk assessments and processing costs, for example, by providing Level 2 and Level 3 payment data.
card
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.
risk
object
Merchants and partners can add additional customer parameters that can help with better fraud protection and reduced risk for unbranded card payments.
CopyExpand allCollapse all { "card": { "level_2": { "invoice_id": "string", "tax_total": { "currency_code": "str", "value": "string" } }, "level_3": { "ships_from_postal_code": "string", "line_items": [ { "name": "string", "quantity": "string", "description": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" }, "billing_plan": { "billing_cycles": [ { "tenure_type": null, "total_cycles": null, "sequence": null, "pricing_scheme": null, "start_date": null } ], "name": "string", "setup_fee": { "currency_code": "str", "value": "string" } }, "commodity_code": "string", "unit_of_measure": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "total_amount": { "currency_code": "str", "value": "string" } } ], "shipping_amount": { "currency_code": "str", "value": "string" }, "duty_amount": { "currency_code": "str", "value": "string" }, "discount_amount": { "currency_code": "str", "value": "string" }, "shipping_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } } }, "risk": { "customer": { "ip_address": "string" } } } tax_info The tax ID of the customer. The customer is also known as the payer. Both tax_id and tax_id_type are required.
tax_id required string [ 1 .. 14 ] characters The customer's tax ID value.
tax_id_type required string [ 1 .. 14 ] characters The customer's tax ID type.
Enum Value Description BR_CPF The individual tax ID type, typically is 11 characters long. BR_CNPJ The business tax ID type, typically is 14 characters long. Copy { "tax_id": "string", "tax_id_type": "BR_CPF" } three_d_secure_authentication_response Results of 3D Secure Authentication.
authentication_status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The outcome of the issuer's authentication.
Enum Value Description
Y Successful authentication.
N Failed authentication / account not verified / transaction denied.
U Unable to complete authentication.
A Successful attempts transaction.
C Challenge required for authentication.
R Authentication rejected (merchant must not submit for authorization).
D Challenge required; decoupled authentication confirmed.
I Informational only; 3DS requestor challenge preference acknowledged.
enrollment_status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Status of authentication eligibility.
Enum Value Description Y Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl. N No. The bank is not participating in 3-D Secure protocol. U Unavailable. The DS or ACS is not available for authentication at the time of the request. B Bypass. The merchant authentication rule is triggered to bypass authentication. Copy { "authentication_status": "Y", "enrollment_status": "Y" } token The tokenized payment source to fund a payment.
id required string [ 1 .. 255 ] characters The PayPal-generated ID for the token.
type required string [ 1 .. 255 ] characters The tokenization method that generated the ID.
Value Description BILLING_AGREEMENT The PayPal billing agreement ID. References an approved recurring payment for goods or services. Copy { "id": "string", "type": "BILLING_AGREEMENT" } tracker The tracking response on creation of tracker.
id
string
The tracker id.
status
string [ 1 .. 64 ] characters ^[0-9A-Z_]+$
The status of the item shipment.
Enum Value Description
CANCELLED The shipment was cancelled and the tracking number no longer applies.
SHIPPED The merchant has assigned a tracking number to the items being shipped from the Order. This does not correspond to the carrier's actual status for the shipment. The latest status of the parcel must be retrieved from the carrier.
items
Array of objects
An array of details of items in the shipment.
links
Array of objects
An array of request-related HATEOAS links.
create_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction occurred, in Internet date and time format.
update_time string [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern The date and time when the transaction was last updated, in Internet date and time format.
CopyExpand allCollapse all { "id": "string", "status": "CANCELLED", "items": [ { "name": "string", "quantity": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" } } ], "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "create_time": "string", "update_time": "string" } tracker The tracking information for a shipment.
tracking_number required string [ 1 .. 64 ] characters The tracking number for the shipment. This property supports Unicode.
carrier_name_other
string [ 1 .. 64 ] characters
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.
carrier required string [ 1 .. 64 ] characters ^[0-9A-Z_]+$ The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.
Enum Value Description DPD_RU DPD Russia. BG_BULGARIAN_POST Bulgarian Posts. KR_KOREA_POST Koreapost (www.koreapost.go.kr). ZA_COURIERIT Courier IT. FR_EXAPAQ DPD France (formerly exapaq). ARE_EMIRATES_POST Emirates Post. GAC GAC. GEIS Geis CZ. SF_EX SF Express. PAGO Pago Logistics. MYHERMES MyHermes UK. DIAMOND_EUROGISTICS Diamond Eurogistics Limited. CORPORATECOURIERS_WEBHOOK Corporate Couriers. BOND Bond courier. OMNIPARCEL Omni Parcel. SK_POSTA Slovenska pošta. PUROLATOR purolator. FETCHR_WEBHOOK Mena 360 (Fetchr). THEDELIVERYGROUP TDG – The Delivery Group. CELLO_SQUARE Cello Square. TARRIVE TONDA GLOBAL. COLLIVERY MDS Collivery Pty (Ltd). MAINFREIGHT Mainfreight. IND_FIRSTFLIGHT First Flight Couriers. ACSWORLDWIDE ACS Worldwide Express. AMSTAN Amstan Logistics. OKAYPARCEL OkayParcel. ENVIALIA_REFERENCE Envialia Reference. SEUR_ES Seur Spain. CONTINENTAL Continental. FDSEXPRESS FDSEXPRESS. AMAZON_FBA_SWISHIP Swiship UK. WYNGS Wyngs. DHL_ACTIVE_TRACING DHL Active Tracing. ZYLLEM Zyllem. RUSTON Ruston. XPOST Xpost.ph. CORREOS_ES correos Express (www.correos.es). DHL_FR DHL France (www.dhl.com). PAN_ASIA Pan-Asia International. BRT_IT BRT couriers Italy (www.brt.it). SRE_KOREA SRE Korea (www.srekorea.co.kr). SPEEDEE Spee-Dee Delivery. TNT_UK TNT UK Limited (www.tnt.com). VENIPAK Venipak. SHREENANDANCOURIER SHREE NANDAN COURIER. CROSHOT Croshot. NIPOST_NG NIpost (www.nipost.gov.ng). EPST_GLBL ePost Global. NEWGISTICS Newgistics. POST_SLOVENIA Post of Slovenia. JERSEY_POST Jersey Post. BOMBINOEXP Bombino Express Pvt. WMG WMG Delivery. XQ_EXPRESS XQ Express. FURDECO Furdeco. LHT_EXPRESS LHT Express. SOUTH_AFRICAN_POST_OFFICE South African Post Office. SPOTON SPOTON Logistics Pvt Ltd. DIMERCO Dimerco Express Group. CYPRUS_POST_CYP cyprus post. ABCUSTOM AB Custom Group. IND_DELIVREE deliverE. CN_BESTEXPRESS Best Express. DX_SFTP DX (SFTP). PICKUPP_MYS PICK UPP. FMX FMX. HELLMANN Hellmann Worldwide Logistics. SHIP_IT_ASIA Ship It Asia. KERRY_ECOMMERCE Kerry eCommerce. FRETERAPIDO Frete Rapido. PITNEY_BOWES Pitney Bowes. XPRESSEN_DK Xpressen courier. SEUR_SP_API Spanish Seur API. DELIVERYONTIME DELIVERYONTIME LOGISTICS PVT LTD. JINSUNG JINSUNG TRADING. TRANS_KARGO Trans Kargo Internasional. SWISHIP_DE Swiship DE. IVOY_WEBHOOK Ivoy courier. AIRMEE_WEBHOOK Airmee couriers. DHL_BENELUX dhl benelux. FIRSTMILE FirstMile. FASTWAY_IR Fastway Ireland. HH_EXP Hua Han Logistics. MYS_MYPOST_ONLINE Mypostonline. TNT_NL THT Netherland. TIPSA TIPSA courier. TAQBIN_MY TAQBIN Malaysia. KGMHUB KGM Hub. INTEXPRESS Internet Express. OVERSE_EXP Overseas Express. ONECLICK One click delivery services. ROADRUNNER_FREIGHT Roadbull Logistics. GLS_CROTIA GLS Croatia. MRW_FTP MRW courier. BLUEX Blue Express. DYLT Daylight Transport. DPD_IR DPD Ireland. SIN_GLBL Sin Global Express. TUFFNELLS_REFERENCE Tuffnells Parcels Express- Reference. CJPACKET CJ Packet. MILKMAN Milkman courier. ASIGNA ASIGNA courier. ONEWORLDEXPRESS One World Express. ROYAL_MAIL RoyalShipments. VIA_EXPRESS Viaxpress. TIGFREIGHT TIG Freight. ZTO_EXPRESS ZTO Express. TWO_GO 2GO Courier. IML IML courier. INTEL_VALLEY Intel-Valley Supply chain (ShenZhen) Co. Ltd. EFS EFS (E-commerce Fulfillment Service). UK_UK_MAIL UK mail (ukmail.com). RAM RAM courier. ALLIEDEXPRESS Allied Express. APC_OVERNIGHT APC overnight (apc-overnight.com). SHIPPIT Shippit. TFM TFM Xpress. M_XPRESS M Xpress Sdn Bhd. HDB_BOX Haidaibao (BOX). CLEVY_LINKS Clevy Links. IBEONE Beone Logistics. FIEGE_NL Fiege Netherlands. KWE_GLOBAL KWE Global. CTC_EXPRESS CTC Express. AMAZON Amazon Shipping. MORE_LINK Morelink. JX JX courier. EASY_MAIL Easy Mail. ADUIEPYLE A Duie Pyle. GB_PANTHER Panther. EXPRESSSALE Expresssale. SG_DETRACK Detrack. TRUNKRS_WEBHOOK Trunkrs courier. MATDESPATCH Matdespatch. DICOM GLS Logistic Systems Canada Ltd./Dicom. MBW MBW Courier Inc.. KHM_CAMBODIA_POST Cambodia Post. SINOTRANS Sinotrans. BRT_IT_PARCELID BRT Bartolini(Parcel ID). DHL_SUPPLY_CHAIN DHL Supply Chain APAC. DHL_PL DHL Poland. TOPYOU TopYou. PALEXPRESS PAL Express Limited. DHL_SG dhl Singapore. CN_WEDO WeDo Logistics. FULFILLME Fulfillme. DPD_DELISTRACK DPD delistrack. UPS_REFERENCE UPS Reference. CARIBOU Caribou. LOCUS_WEBHOOK Locus courier. DSV DSV courier. P2P_TRC P2P TrakPak. DIRECTPARCELS Direct Parcels. NOVA_POSHTA_INT Nova Poshta (International). FEDEX_POLAND FedEx® Poland Domestic. CN_JCEX JCEX courier. FAR_INTERNATIONAL FAR international. IDEXPRESS IDEX courier. GANGBAO GANGBAO Supplychain. NEWAY Neway Transport. POSTNL_INT_3_S PostNL International. RPX_ID RPX Indonesia. DESIGNERTRANSPORT_WEBHOOK Designer Transport. GLS_SLOVEN GLS Slovenia. PARCELLED_IN Parcelled.in. GSI_EXPRESS GSI EXPRESS. CON_WAY Con-way Freight. BROUWER_TRANSPORT Brouwer Transport en Logistiek. CPEX Captain Express International. ISRAEL_POST Israel Post. DTDC_IN DTDC India. PTT_POST PTT Post. XDE_WEBHOOK Ximex Delivery Express. TOLOS Tolos courier. GIAO_HANG Giao hàng nhanh. GEODIS_ESPACE Geodis E-space. MAGYAR_HU Magyar Post. DOORDASH_WEBHOOK DoorDash. TIKI_ID Tiki shipment. CJ_HK_INTERNATIONAL CJ Logistics International(Hong Kong). STAR_TRACK_EXPRESS Star Track Express. HELTHJEM Helthjem. SFB2C SF International. FREIGHTQUOTE Freightquote by C.H. Robinson. LANDMARK_GLOBAL_REFERENCE Landmark Global Reference. PARCEL2GO Parcel2Go. DELNEXT Delnext. RCL Red Carpet Logistics. CGS_EXPRESS CGS Express. HK_POST Hongkong Post (www.hongkongpost.hk). SAP_EXPRESS SAP EXPRESS. PARCELPOST_SG Parcel Post Singapore. HERMES HermesWorld UK. IND_SAFEEXPRESS Safexpress. TOPHATTEREXPRESS Tophatter Express. MGLOBAL PT MGLOBAL LOGISTICS INDONESIA. AVERITT Averitt Express. LEADER leader. _2EBOX 2ebox courier. SG_SPEEDPOST Singapore Speedpost. DBSCHENKER_SE DB Schenker (www.dbschenker.com). ISR_POST_DOMESTIC Israel Post Domestic. BESTWAYPARCEL Best Way Parcel. ASENDIA_DE asendia_de. NIGHTLINE_UK nightline_uk. TAQBIN_SG taqbin_sg. TCK_EXPRESS TCK Express. ENDEAVOUR_DELIVERY Endeavour Delivery. NANJINGWOYUAN Nanjing Woyuan. HEPPNER_FR Heppner France. EMPS_CN EMPS Express. FONSEN Fonsen Logistics. PICKRR Pickrr. APC_OVERNIGHT_CONNUM APC Overnight Consignment. STAR_TRACK_NEXT_FLIGHT Star Track Next Flight. DAJIN Shanghai Aqrum Chemical Logistics Co.Ltd. UPS_FREIGHT UPS Freight. POSTA_PLUS Posta Plus. CEVA CEVA LOGISTICS. ANSERX ANSERX courier. JS_EXPRESS JS EXPRESS. PADTF padtf.com. UPS_MAIL_INNOVATIONS UPS Mail Innovations. SYPOST Sunyou Post. AMAZON_SHIP_MCF Amazon Shipping + Amazon MCF. YUSEN Yusen Logistics. BRING Bring. SDA_IT SDA Italy. GBA GBA Services Ltd. NEWEGGEXPRESS Newegg Express. SPEEDCOURIERS_GR Speed Couriers. FORRUN forrun Pvt Ltd (Arpatech Venture). PICKUP Pickupp. ECMS ECMS International Logistics Co.. INTELIPOST Intelipost (TMS for LATAM). FLASHEXPRESS Flash Express. CN_STO STO Express. SEKO_SFTP SEKO Worldwide. HOME_DELIVERY_SOLUTIONS Home Delivery Solutions Ltd. DPD_HGRY DPD Hungary. KERRYTTC_VN Kerry Express (Vietnam) Co Ltd. JOYING_BOX Joying Box. TOTAL_EXPRESS Total Express. ZJS_EXPRESS ZJS International. STARKEN STARKEN couriers. DEMANDSHIP DemandShip. CN_DPEX DPEX. AUPOST_CN AuPost China. LOGISTERS Logisters. GOGLOBALPOST Global Post. GLS_CZ GLS Czech Republic. PAACK_WEBHOOK Paack courier. GRAB_WEBHOOK Grab courier. PARCELPOINT Parcelpoint. ICUMULUS iCumulus. DAIGLOBALTRACK DAI Post. GLOBAL_IPARCEL i-parcel. YURTICI_KARGO Yurtici Kargo. CN_PAYPAL_PACKAGE PayPal Package. PARCEL_2_POST Parcel To Post. GLS_IT GLS Italy. PIL_LOGISTICS PIL Logistics (China) Co.. HEPPNER Heppner Internationale Spedition GmbH & Co.. GENERAL_OVERNIGHT Go!Express and logistics. HAPPY2POINT Happy 2ThePoint. CHITCHATS Chit Chats. SMOOTH Smooth Couriers. CLE_LOGISTICS CL E-Logistics Solutions Limited. FIEGE Fiege Logistics. MX_CARGO M&X cargo. ZIINGFINALMILE Ziing Final Mile Inc. DAYTON_FREIGHT Dayton Freight. TCS TCS courier. AEX AEX Group. HERMES_DE Hermes Germany. ROUTIFIC_WEBHOOK Routific. GLOBAVEND Globavend. CJ_LOGISTICS CJ Logistics International. PALLET_NETWORK The Pallet Network. RAF_PH RAF Philippines. UK_XDP XDP Express. PAPER_EXPRESS Paper Express. LA_POSTE_SUIVI La Poste. PAQUETEXPRESS Paquetexpress. LIEFERY liefery. STRECK_TRANSPORT Streck Transport. PONY_EXPRESS Pony express. ALWAYS_EXPRESS Always Express. GBS_BROKER GBS-Broker. CITYLINK_MY City-Link Express. ALLJOY ALLJOY SUPPLY CHAIN. YODEL yodel. YODEL_DIR Yodel Direct. STONE3PL STONE3PL. PARCELPAL_WEBHOOK ParcelPal. DHL_ECOMERCE_ASA DHL eCommerce Asia (API). SIMPLYPOST J&T Express Singapore. KY_EXPRESS Kua Yue Express. SHENZHEN shenzhen 1st International Logistics(Group)Co. US_LASERSHIP LaserShip. UC_EXPRE ucexpress. DIDADI DIDADI Logistics tech. CJ_KR CJ Korea Express. DBSCHENKER_B2B DB Schenker B2B. MXE MXE Express. CAE_DELIVERS CAE Delivers. PFCEXPRESS PFC Express. WHISTL Whistl. WEPOST WePost Sdn Bhd. DHL_PARCEL_ES DHL parcel Spain(www.dhl.com). DDEXPRESS DD Express Courier. ARAMEX_AU Aramex Australia (formerly Fastway AU). BNEED Bneed courier. HK_TGX Kerry Express Hong Kong. LATVIJAS_PASTS Latvijas Pasts. VIAEUROPE ViaEurope. CORREO_UY Correo Uruguayo. CHRONOPOST_FR Chronopost france (www.chronopost.fr). J_NET J-Net. _6LS 6ls.com. BLR_BELPOST Belpost. BIRDSYSTEM BirdSystem. DOBROPOST DobroPost. WAHANA_ID Wahana express (www.wahana.com). WEASHIP Weaship. SONICTL Sonic Transportation & Logistics. KWT Shenzhen Jinghuada Logistics Co.. AFLLOG_FTP AFL LOGISTICS. SKYNET_WORLDWIDE SkyNet Worldwide Express. NOVA_POSHTA Nova Poshta (novaposhta.ua). SEINO Seino. SZENDEX SZENDEX. BPOST_INT Bpost international. DBSCHENKER_SV DB Schenker Sweden. AO_DEUTSCHLAND AO Deutschland. EU_FLEET_SOLUTIONS EU Fleet Solutions. PCFCORP PCF Final Mile. LINKBRIDGE Link Bridge(BeiJing)international logistics co.. PRIMAMULTICIPTA PT Prima Multi Cipta. COUREX Urbanfox. ZAJIL_EXPRESS Zajil Express Company. COLLECTCO CollectCo. JTEXPRESS J&T EXPRESS MALAYSIA. FEDEX_UK FedEx® UK. USHIP uShip courier. PIXSELL PIXSELL LOGISTICS. SHIPTOR Shiptor. CDEK CDEK courier. VNM_VIETTELPOST ViettelPost. CJ_CENTURY CJ Century. GSO GSO(GLS-USA). VIWO VIWO IoT. SKYBOX SKYBOX. KERRYTJ Kerry TJ Logistics. NTLOGISTICS_VN Nhat Tin Logistics. SDH_SCM lightning monkey. ZINC Zinc courier. DPE_SOUTH_AFRC DPE South Africa. CESKA_CZ Czech Post. ACS_GR ACS Courier. DEALERSEND DealerSend. JOCOM Jocom. CSE CSE courier. TFORCE_FINALMILE TForce Final Mile. SHIP_GATE ShipGate. SHIPTER SHIPTER. NATIONAL_SAMEDAY National Sameday. YUNEXPRESS YunExpress. CAINIAO AliExpress Standard Shipping. DMS_MATRIX DMSMatrix. DIRECTLOG Directlog (www.directlog.com.br). ASENDIA_US Asendia USA. _3JMSLOGISTICS 3JMS Logistics. LICCARDI_EXPRESS LICCARDI EXPRESS COURIER. SKY_POSTAL SkyPostal. CNWANGTONG cnwangtong. POSTNORD_LOGISTICS_DK ostnord denmark. LOGISTIKA Logistika. CELERITAS Celeritas Transporte. PRESSIODE Pressio. SHREE_MARUTI Shree Maruti Courier Services Pvt Ltd. LOGISTICSWORLDWIDE_HK Logistic Worldwide Express (LWE Honkong). EFEX eFEx (E-Commerce Fulfillment & Express). LOTTE Lotte Global Logistics. LONESTAR Lone Star Overnight. APRISAEXPRESS Aprisa Express. BEL_RS BEL North Russia. OSM_WORLDWIDE OSM Worldwide. WESTGATE_GL Westgate Global. FASTRACK Fasttrack. DTD_EXPR DTD Express. ALFATREX AlfaTrex. PROMEDDELIVERY ProMed Delivery. THABIT_LOGISTICS Thabit Logistics. HCT_LOGISTICS HCT LOGISTICS CO.LTD.. CARRY_FLAP Carry-Flap Co.. US_OLD_DOMINION Old Dominion Freight Line. ANICAM_BOX ANICAM BOX EXPRESS. WANBEXPRESS WanbExpress. AN_POST An Post. DPD_LOCAL DPD Local. STALLIONEXPRESS Stallion Express. RAIDEREX RaidereX. SHOPFANS ShopfansRU LLC. KYUNGDONG_PARCEL Kyungdong Parcel. CHAMPION_LOGISTICS Champion Logistics. PICKUPP_SGP PICK UPP (Singapore). MORNING_EXPRESS Morning Express. NACEX NACEX. THENILE_WEBHOOK SortHub courier. HOLISOL Holisol. LBCEXPRESS_FTP LBC EXPRESS INC.. KURASI KURASI. USF_REDDAWAY USF Reddaway. APG APG eCommerce Solutions. CN_BOXC BoxC courier. ECOSCOOTING ECOSCOOTING. MAINWAY Mainway. PAPERFLY Paperfly Private Limited. HOUNDEXPRESS Hound Express. BOX_BERRY Boxberry courier. EP_BOX EP-Box courier. PLUS_LOG_UK Plus UK Logistics. FULFILLA Fulfilla. ASE ASE KARGO. MAIL_PLUS MailPlus. XPO_LOGISTICS XPO logistics. WNDIRECT wnDirect. CLOUDWISH_ASIA Cloudwish Asia. ZELERIS Zeleris. GIO_EXPRESS Gio Express. OCS_WORLDWIDE OCS WORLDWIDE. ARK_LOGISTICS ARK Logistics. AQUILINE Aquiline. PILOT_FREIGHT Pilot Freight Services. QWINTRY Qwintry Logistics. DANSKE_FRAGT Danske Fragtaend. CARRIERS Carriers courier. AIR_CANADA_GLOBAL Rivo (Air canada). PRESIDENT_TRANS PRESIDENT TRANSNET CORP. STEPFORWARDFS STEP FORWARD FREIGHT SERVICE CO LTD. SKYNET_UK Skynet UK. PITTOHIO PITT OHIO. CORREOS_EXPRESS Correos Express. RL_US RL Carriers. DESTINY Destiny Transportation. UK_YODEL Yodel (www.yodel.co.uk). COMET_TECH CometTech. DHL_PARCEL_RU DHL Parcel Russia. TNT_REFR TNT Reference. SHREE_ANJANI_COURIER Shree Anjani Courier. MIKROPAKKET_BE Mikropakket Belgium. ETS_EXPRESS RETS express. COLIS_PRIVE Colis Privé. CN_YUNDA Yunda Express. AAA_COOPER AAA Cooper. ROCKET_PARCEL Rocket Parcel International. _360LION 360 Lion Express. PANDU PANDU. PROFESSIONAL_COURIERS PROFESSIONAL COURIERS. FLYTEXPRESS FLYTEXPRESS. LOGISTICSWORLDWIDE_MY LOGISTICSWORLDWIDE MY. CORREOS_DE_ESPANA CORREOS DE ESPANA. IMX IMX. FOUR_PX_EXPRESS FOUR PX EXPRESS. XPRESSBEES XPRESSBEES. PICKUPP_VNM pickupp_vnm. STARTRACK_EXPRESS startrack_express. FR_COLISSIMO fr_colissimo. NACEX_SPAIN_REFERENCE nacex_spain_reference. DHL_SUPPLY_CHAIN_AU dhl_supply_chain_au. ESHIPPING Eshipping. SHREETIRUPATI SHREE TIRUPATI COURIER SERVICES PVT. LTD.. HX_EXPRESS HX Express. INDOPAKET INDOPAKET. CN_17POST 17 Post Service. K1_EXPRESS K1 Express. CJ_GLS CJ GLS. MYS_GDEX GDEX courier. NATIONEX Nationex courier. ANJUN Anjun couriers. FARGOOD FarGood. SMG_EXPRESS SMG Direct. RZYEXPRESS RZY Express. SEFL Southeastern Freight Lines. TNT_CLICK_IT TNT-Click Italy. HDB Haidaibao. HIPSHIPPER Hipshipper. RPXLOGISTICS RPX Logistics. KUEHNE Kuehne + Nagel. IT_NEXIVE Nexive (TNT Post Italy). PTS PTS courier. SWISS_POST_FTP Swiss Post FTP. FASTRK_SERV Fastrak Services. _4_72 4-72 Entregando. US_YRC YRC courier. POSTNL_INTL_3S PostNL International 3S. ELIAN_POST Yilian (Elian) Supply Chain. CUBYN Cubyn. SAU_SAUDI_POST Saudi Post. ABXEXPRESS_MY ABX Express. HUAHAN_EXPRESS HUAHANG EXPRESS. ZES_EXPRESS Eshun international Logistic. ZEPTO_EXPRESS ZeptoExpress. SKYNET_ZA Skynet World Wide Express South Africa. ZEEK_2_DOOR Zeek2Door. BLINKLASTMILE Blink. POSTA_UKR UkrPoshta. CHROBINSON C.H. Robinson Worldwide. CN_POST56 Post56. COURANT_PLUS Courant Plus. SCUDEX_EXPRESS Scudex Express. SHIPENTEGRA ShipEntegra. B_TWO_C_EUROPE B2C courier Europe. COPE Cope Sensitive Freight. IND_GATI Gati-KWE. CN_WISHPOST WishPost. NACEX_ES NACEX Spain. TAQBIN_HK TAQBIN Hong Kong. GLOBALTRANZ GlobalTranz. HKD Qingdao HKD International Logistics. BJSHOMEDELIVERY BJS Distribution courier. OMNIVA Omniva. SUTTON Sutton Transport. PANTHER_REFERENCE Panther Reference. SFCSERVICE SFC Service. LTL LTL COURIER. PARKNPARCEL Park N Parcel. SPRING_GDS Spring GDS. ECEXPRESS ECexpress. INTERPARCEL_AU Interparcel Australia. AGILITY Agility. XL_EXPRESS XL Express. ADERONLINE Ader couriers. DIRECTCOURIERS Direct Couriers. PLANZER Planzer Group. SENDING Sending Transporte Urgente y Comunicacion. NINJAVAN_WB Ninjavan Webhook. NATIONWIDE_MY Nationwide Express Courier Services Bhd (www.nationwide.com.my). SENDIT Sendit. GB_ARROW Arrow XL. IND_GOJAVAS GoJavas. KPOST Korea Post. DHL_FREIGHT DHL Freight. BLUECARE Bluecare Express Ltd. JINDOUYUN jindouyun courier. TRACKON Trackon Couriers Pvt. Ltd. GB_TUFFNELLS Tuffnells Parcels Express. TRUMPCARD TRUMPCARD LLC. ETOTAL eTotal Solution Limited. SFPLUS_WEBHOOK Zeek courier. SEKOLOGISTICS SEKO Logistics. HERMES_2MANN_HANDLING Hermes Einrichtungs Service GmbH & Co. KG. DPD_LOCAL_REF DPD Local reference. UDS United Delivery Service. ZA_SPECIALISED_FREIGHT Specialised Freight. THA_KERRY Kerry Express Thailand. PRT_INT_SEUR SEUR International. BRA_CORREIOS Correios Brazil. NZ_NZ_POST New Zealand Post. CN_EQUICK Equick China. MYS_EMS Malaysia Post EMS / Pos Laju. GB_NORSK Norsk Global. ESP_MRW MRW spain. ESP_PACKLINK Packlink. KANGAROO_MY Kangaroo Worldwide Express. RPX RPX Online. XDP_UK_REFERENCE XDP Express Reference. NINJAVAN_MY ninja van (www.ninjavan.co). ADICIONAL Adicional Logistics. ROADBULL Red Carpet Logistics. YAKIT Yakit courier. MAILAMERICAS MailAmericas. MIKROPAKKET Mikropakket. DYNALOGIC Dynamic Logistics. DHL_ES DHL Spain(www.dhl.com). DHL_PARCEL_NL DHL Parcel NL. DHL_GLOBAL_MAIL_ASIA DHL Global Mail Asia (www.dhl.com). DAWN_WING Dawn Wing. GENIKI_GR Geniki Taxydromiki. HERMESWORLD_UK hermesworld_uk. ALPHAFAST Alphafast (www.alphafast.com). BUYLOGIC buylogic. EKART Ekart logistics (ekartlogistics.com). MEX_SENDA mexico senda express. SFC_LOGISTICS SFC. POST_SERBIA Posta Serbia. IND_DELHIVERY Delhivery India. DE_DPD_DELISTRACK DPD Germany. RPD2MAN RPD2man Deliveries. CN_SF_EXPRESS SF Express (www.sf-express.com). YANWEN Yanwen Logistics. MYS_SKYNET Skynet Malaysia. CORREOS_DE_MEXICO correos mexico. CBL_LOGISTICA CBL Logistica. MEX_ESTAFETA Estafeta (www.estafeta.com). AU_AUSTRIAN_POST Austrian Post (Registered). RINCOS Rincos. NLD_DHL DHL Netherland. RUSSIAN_POST Russian post. COURIERS_PLEASE CouriersPlease (couriersplease.com.au). POSTNORD_LOGISTICS PostNord Logistics. FEDEX Fedex. DPE_EXPRESS DPE Express. DPD DPD. ADSONE ADSone. IDN_JNE JNE Express (Jalur Nugraha Ekakurir). THECOURIERGUY The Courier Guy. CNEXPS CNE Express. PRT_CHRONOPOST Chronopost Portugal. LANDMARK_GLOBAL Landmark Global. IT_DHL_ECOMMERCE DHL International. ESP_NACEX NACEX Spain. PRT_CTT CTT Portugal. BE_KIALA Kiala. ASENDIA_UK Asendia UK. GLOBAL_TNT TNT global. POSTUR_IS Iceland Post. EPARCEL_KR eParcel Korea. INPOST_PACZKOMATY InPost Paczkomaty. IT_POSTE_ITALIA Poste italiane (www.poste.it). BE_BPOST Bpost (www.bpost.be). PL_POCZTA_POLSKA Poczta Polska (www.poczta-polska.pl). MYS_MYS_POST Malaysia Post. SG_SG_POST Singapore Post. THA_THAILAND_POST Thailand Post (www.thailandpost.co.th). LEXSHIP LexShip. FASTWAY_NZ Fastway New Zealand. DHL_AU DHL Supply Chain Australia. COSTMETICSNOW Cosmetics Now. PFLOGISTICS PFL. LOOMIS_EXPRESS Loomis Express. GLS_ITALY GLS Italy. LINE Line Clear Express & Logistics Sdn Bhd. GEL_EXPRESS Gel Express Logistik. HUODULL Huodull. NINJAVAN_SG Ninja van Singapore. JANIO Janio Asia. AO_COURIER AO Logistics. BRT_IT_SENDER_REF BRT Bartolini(Sender Reference). SAILPOST SAILPOST. LALAMOVE Lalamove. NEWZEALAND_COURIERS NEW ZEALAND COURIERS. ETOMARS Etomars. VIRTRANSPORT VIR Transport. WIZMO Wizmo. PALLETWAYS Palletways. I_DIKA i-dika. CFL_LOGISTICS CFL Logistics. GEMWORLDWIDE GEM Worldwide. GLOBAL_EXPRESS Tai Wan Global Business. LOGISTYX_TRANSGROUP Transgroup courier. WESTBANK_COURIER West Bank Courier. ARCO_SPEDIZIONI Arco Spedizioni SP. YDH_EXPRESS YDH express. PARCELINKLOGISTICS Parcelink Logistics. CNDEXPRESS CND Express. NOX_NIGHT_TIME_EXPRESS NOX NightTimeExpress. AERONET Aeronet couriers. LTIANEXP LTIAN EXP. INTEGRA2_FTP Integra2. PARCELONE PARCEL ONE. NOX_NACHTEXPRESS Innight Express Germany GmbH (nox NachtExpress). CN_CHINA_POST_EMS China Post. CHUKOU1 Chukou1. GLS_SLOV GLS General Logistics Systems Slovakia s.r.o.. ORANGE_DS OrangeDS (Orange Distribution Solutions Inc). JOOM_LOGIS Joom Logistics. AUS_STARTRACK StarTrack (startrack.com.au). DHL dhl Global. GB_APC APC postal logistics germany. BONDSCOURIERS Bonds Courier Service (bondscouriers.com.au). JPN_JAPAN_POST Japan Post. USPS United States Postal Service. WINIT WinIt. ARG_OCA OCA Argentina. TW_TAIWAN_POST Taiwan Post. DMM_NETWORK DMM Network. TNT TNT Express. BH_POSTA BH Posta (www.posta.ba). SWE_POSTNORD Postnord sweden. CA_CANADA_POST Canada Post. WISELOADS Wiseloads. ASENDIA_HK Asendia HonKong. NLD_GLS GLS Netherland. MEX_REDPACK Redpack. JET_SHIP Jet-Ship Worldwide. DE_DHL_EXPRESS DHL Express. NINJAVAN_THAI Ninja van Thai. RABEN_GROUP Raben Group. ESP_ASM ASM(GLS Spain). HRV_HRVATSKA Hrvatska posta. GLOBAL_ESTES Estes Express Lines. LTU_LIETUVOS Lietuvos pastas. BEL_DHL DHL Benelux. AU_AU_POST Australia Post. SPEEDEXCOURIER SPEEDEX couriers. FR_COLIS Colissimo. ARAMEX Aramex. DPEX DPEX (www.dpex.com). MYS_AIRPAK Airpak Express. CUCKOOEXPRESS Cuckoo Express. DPD_POLAND DPD Poland. NLD_POSTNL PostNL International. NIM_EXPRESS Nim Express. QUANTIUM Quantium. SENDLE Sendle. ESP_REDUR Redur Spain. MATKAHUOLTO Matkahuolto. CPACKET Cpacket couriers. POSTI Posti courier. HUNTER_EXPRESS Hunter Express. CHOIR_EXP Choir Express Indonesia. LEGION_EXPRESS Legion Express. AUSTRIAN_POST_EXPRESS austrian post. GRUPO Grupo ampm. POSTA_RO Post Roman (www.posta-romana.ro). INTERPARCEL_UK Interparcel UK. GLOBAL_ABF ABF Freight. POSTEN_NORGE Posten Norge (www.posten.no). XPERT_DELIVERY Xpert Delivery. DHL_REFR DHl (Reference number). DHL_HK DHL HonKong. SKYNET_UAE SKYNET UAE. GOJEK Gojek. YODEL_INTNL Yodel International. JANCO Janco Ecommerce. YTO YTO Express. WISE_EXPRESS Wise Express. JTEXPRESS_VN J&T Express Vietnam. FEDEX_INTL_MLSERV FedEx International MailService. VAMOX VAMOX. AMS_GRP AMS Group. DHL_JP DHL Japan. HRPARCEL HR Parcel. GESWL GESWL Express. BLUESTAR Blue Star. CDEK_TR CDEK TR. DESCARTES Innovel courier. DELTEC_UK Deltec Courier. DTDC_EXPRESS DTDC express. TOURLINE tourline. BH_WORLDWIDE B&H Worldwide. OCS OCS ANA Group. YINGNUO_LOGISTICS yingnuo logistics. UPS United Parcel Service. TOLL Toll IPEC. PRT_SEUR SEUR portugal. DTDC_AU DTDC Australia. THA_DYNAMIC_LOGISTICS Dynamic Logistics. UBI_LOGISTICS UBI Smart Parcel. FEDEX_CROSSBORDER FedEx Cross Border. A1POST A1Post. TAZMANIAN_FREIGHT Tazmanian Freight Systems. CJ_INT_MY CJ International malaysia. SAIA_FREIGHT Saia LTL Freight. SG_QXPRESS Qxpress. NHANS_SOLUTIONS Nhans Solutions. DPD_FR DPD France. COORDINADORA Coordinadora. ANDREANI Grupo logistico Andreani. DOORA Doora Logistics. INTERPARCEL_NZ Interparcel New Zealand. PHL_JAMEXPRESS Jam Express Philippines. BEL_BELGIUM_POST bel_belgium_post. US_APC us_apc. IDN_POS idn_pos. FR_MONDIAL fr_mondial. DE_DHL DE DHL. HK_RPX hk_rpx. DHL_PIECEID dhl_pieceid. VNPOST_EMS vnpost_ems. RRDONNELLEY rrdonnelley. DPD_DE dpd_de. DELCART_IN delcart_in. IMEXGLOBALSOLUTIONS imexglobalsolutions. ACOMMERCE ACOMMERCE. EURODIS eurodis. CANPAR CANPAR. GLS GLS. IND_ECOM Ecom Express. ESP_ENVIALIA Envialia. DHL_UK dhl UK. SMSA_EXPRESS SMSA Express. TNT_FR TNT France. DEX_I DEX-I courier. BUDBEE_WEBHOOK Budbee courier. COPA_COURIER Copa Airlines Courier. VNM_VIETNAM_POST Vietnam Post. DPD_HK DPD HongKong. TOLL_NZ Toll New Zealand. ECHO Echo courier. FEDEX_FR FedEx® Freight. BORDEREXPRESS Border Express. MAILPLUS_JPN MailPlus (Japan). TNT_UK_REFR TNT UK Reference. KEC KEC courier. DPD_RO DPD Romania. TNT_JP TNT_JP. TH_CJ TH_CJ. EC_CN EC_CN. FASTWAY_UK FASTWAY_UK. FASTWAY_US FASTWAY_US. GLS_DE GLS_DE. GLS_ES GLS_ES. GLS_FR GLS_FR. MONDIAL_BE MONDIAL_BE. SGT_IT SGT_IT. TNT_CN TNT_CN. TNT_DE TNT_DE. TNT_ES TNT_ES. TNT_PL TNT_PL. PARCELFORCE PARCELFORCE. SWISS_POST SWISS POST. TOLL_IPEC TOLL IPEC. AIR_21 AIR 21. AIRSPEED AIRSPEED. BERT BERT. BLUEDART BLUEDART. COLLECTPLUS COLLECTPLUS. COURIERPLUS COURIERPLUS. COURIER_POST COURIER POST. DHL_GLOBAL_MAIL dhl_global_mail. DPD_UK dpd_uk. DELTEC_DE DELTEC DE. DEUTSCHE_DE deutsche_de. DOTZOT DOTZOT. ELTA_GR elta_gr. EMS_CN ems_cn. ECARGO ECARGO. ENSENDA ENSENDA. FERCAM_IT fercam_it. FASTWAY_ZA fastway_za. FASTWAY_AU fastway_au. FIRST_LOGISITCS first_logisitcs. GEODIS GEODIS. GLOBEGISTICS GLOBEGISTICS. GREYHOUND GREYHOUND. JETSHIP_MY jetship_my. LION_PARCEL LION PARCEL. AEROFLASH AEROFLASH. ONTRAC ONTRAC. SAGAWA SAGAWA. SIODEMKA SIODEMKA. STARTRACK startrack. TNT_AU tnt_au. TNT_IT tnt_it. TRANSMISSION TRANSMISSION. YAMATO YAMATO. DHL_IT dhl_it. DHL_AT dhl_at. LOGISTICSWORLDWIDE_KR LOGISTICSWORLDWIDE KR. GLS_SPAIN gls_spain. AMAZON_UK_API amazon_uk_api. DPD_FR_REFERENCE dpd_fr_reference. DHLPARCEL_UK dhlparcel_uk. MEGASAVE megasave. QUALITYPOST qualitypost. IDS_LOGISTICS ids_logistics. JOYINGBOX joyingbox. PANTHER_ORDER_NUMBER panther_order_number. WATKINS_SHEPARD watkins_shepard. FASTTRACK fasttrack. UP_EXPRESS up_express. ELOGISTICA elogistica. ECOURIER ecourier. CJ_PHILIPPINES cj_philippines. SPEEDEX speedex. ORANGECONNEX orangeconnex. TECOR tecor. SAEE saee. GLS_ITALY_FTP gls_italy_ftp. DELIVERE delivere. YYCOM yycom. ADICIONAL_PT Adicional Logistics. DKSH DKSH. NIPPON_EXPRESS_FTP Nippon Express. GOLS GO Logistics & Storage. FUJEXP FUJIE EXPRESS. QTRACK QTrack. OMLOGISTICS_API OM LOGISTICS LTD. GDPHARM GDPharm Logistics. MISUMI_CN MISUMI Group Inc.. AIR_CANADA Rivo. CITY56_WEBHOOK City Express. SAGAWA_API Sagawa. KEDAEX KedaEX. PGEON_API Pgeon. WEWORLDEXPRESS We World Express. JT_LOGISTICS J&T International logistics. TRUSK Trusk France. VIAXPRESS ViaXpress. DHL_SUPPLYCHAIN_ID DHL Supply Chain Indonesia. ZUELLIGPHARMA_SFTP Zuellig Pharma Korea. MEEST Meest. TOLL_PRIORITY Toll Priority. MOTHERSHIP_API Mothership. CAPITAL Capital Transport. EUROPAKET_API Europacket+. HFD HFD. TOURLINE_REFERENCE Tourline Express. GIO_ECOURIER GIO Express Inc. CN_LOGISTICS CN Logistics. PANDION Pandion. BPOST_API Bpost API. PASSPORTSHIPPING Passport Shipping. PAKAJO Pakajo World. DACHSER DACHSER. YUSEN_SFTP Yusen Logistics. SHYPLITE Shypmax. XYY Xingyunyi Logistics. MWD Metropolitan Warehouse & Delivery. FAXECARGO Faxe Cargo. MAZET Groupe Mazet. FIRST_LOGISTICS_API First Logistics. SPRINT_PACK SPRINT PACK. HERMES_DE_FTP Hermes Germany. CONCISE Concise. KERRY_EXPRESS_TW_API Kerry Express TaiWan. EWE EWE Global Express. FASTDESPATCH Fast Despatch Logistics Limited. ABCUSTOM_SFTP AB Custom Group. CHAZKI Chazki. SHIPPIE Shippie. GEODIS_API GEODIS - Distribution & Express. NAQEL_EXPRESS Naqel Express. PAPA_WEBHOOK Papa. FORWARDAIR Forward Air. DIALOGO_LOGISTICA_API Dialogo Logistica. LALAMOVE_API Lalamove. TOMYDOOR Tomydoor. KRONOS_WEBHOOK Kronos Express. JTCARGO J&T CARGO. T_CAT T-cat. CONCISE_WEBHOOK Concise. TELEPORT_WEBHOOK Teleport. CUSTOMCO_API The Custom Companies. SPX_TH Shopee Xpress. BOLLORE_LOGISTICS Bollore Logistics. CLICKLINK_SFTP ClickLink. M3LOGISTICS M3 Logistics. VNPOST_API Vietnam Post. AXLEHIRE_FTP Axlehire. SHADOWFAX Shadowfax. MYHERMES_UK_API EVRi. DAIICHI Daiichi Freight System Inc. MENSAJEROSURBANOS_API Mensajeros Urbanos. POLARSPEED PolarSpeed Inc. IDEXPRESS_ID iDexpress Indonesia. PAYO Payo. WHISTL_SFTP Whistl. INTEX_DE INTEX Paketdienst GmbH. TRANS2U Trans2u. PRODUCTCAREGROUP_SFTP Product Care Services Limited. BIGSMART Big Smart. EXPEDITORS_API_REF Expeditors API Reference. AITWORLDWIDE_API AIT. WORLDCOURIER World Courier. QUIQUP Quiqup. AGEDISS_SFTP Agediss. ANDREANI_API Andreani. CRLEXPRESS CRL Express. SMARTCAT SMARTCAT. CROSSFLIGHT Crossflight Limited. PROCARRIER Pro Carrier. DHL_REFERENCE_API DHL (Reference number). SEINO_API Seino. WSPEXPRESS WSP Express. KRONOS Kronos Express. TOTAL_EXPRESS_API Total Express. PARCLL PARCLL. XPEDIGO Xpedigo. STAR_TRACK_WEBHOOK StarTrack. GPOST Georgian Post. UCS UCS. DMFGROUP DMF. COORDINADORA_API Coordinadora. MARKEN Marken. NTL NTL logistics. REDJEPAKKETJE Red je Pakketje. ALLIED_EXPRESS_FTP Allied Express (FTP). MONDIALRELAY_ES Mondial Relay Spain(Punto Pack). NAEKO_FTP Naeko Logistics. MHI Mhi. SHIPPIFY Shippify, Inc. MALCA_AMIT_API Malca Amit. JTEXPRESS_SG_API J&T Express Singapore. DACHSER_WEB DACHSER. FLIGHTLG Flight Logistics Group. CAGO Cago. COM1EXPRESS ComOne Express. TONAMI_FTP Tonami. PACKFLEET PACKFLEET. PUROLATOR_INTERNATIONAL Purolator International. WINESHIPPING_WEBHOOK Wineshipping. DHL_ES_SFTP DHL Spain Domestic. PCHOME_API 網家速配股份有限公司. CESKAPOSTA_API Czech Post. GORUSH Go Rush. HOMERUNNER HomeRunner. AMAZON_ORDER Amazon order. EFWNOW_API Estes Forwarding Worldwide. CBL_LOGISTICA_API CBL Logistica (API). NIMBUSPOST NimbusPost. LOGWIN_LOGISTICS Logwin Logistics. NOWLOG_API Sequoialog. DPD_NL DPD Netherlands. GODEPENDABLE Dependable Supply Chain Services. ESDEX Top Ideal Express. LOGISYSTEMS_SFTP Kiitäjät. EXPEDITORS Expeditors. SNTGLOBAL_API Snt Global Etrax. SHIPX ShipX. QINTL_API Quickstat Courier LLC. PACKS Packs. POSTNL_INTERNATIONAL PostNL International. AMAZON_EMAIL_PUSH Amazon. DHL_API DHL. SPX Shopee Express. AXLEHIRE AxleHire. ICSCOURIER ICS COURIER. DIALOGO_LOGISTICA Dialogo Logistica. SHUNBANG_EXPRESS ShunBang Express. TCS_API TCS. SF_EXPRESS_CN SF Express China. PACKETA Packeta. SIC_TELIWAY Teliway SIC Express. MONDIALRELAY_FR Mondial Relay France. INTIME_FTP InTime. JD_EXPRESS 京东物流. FASTBOX Fastbox. PATHEON Patheon Logistics. INDIA_POST India Post Domestic. TIPSA_REF Tipsa Reference. ECOFREIGHT Eco Freight. VOX VOX SOLUCION EMPRESARIAL SRL. DIRECTFREIGHT_AU_REF Direct Freight Express. BESTTRANSPORT_SFTP Best Transport. AUSTRALIA_POST_API Australia Post. FRAGILEPAK_SFTP FragilePAK. FLIPXP FlipXpress. VALUE_WEBHOOK Value Logistics. DAESHIN Daeshin. SHERPA Sherpa. MWD_API Metropolitan Warehouse & Delivery. SMARTKARGO SmartKargo. DNJ_EXPRESS DNJ Express. GOPEOPLE Go People. MYSENDLE_API mySendle. ARAMEX_API Aramex. PIDGE Pidge. THAIPARCELS TP Logistic. PANTHER_REFERENCE_API Panther Reference. POSTAPLUS Posta Plus. BUFFALO BUFFALO. U_ENVIOS U-ENVIOS. ELITE_CO Elite Express. ROCHE_INTERNAL_SFTP Roche Internal Courier. DBSCHENKER_ICELAND DB Schenker Iceland. TNT_FR_REFERENCE TNT France Reference. NEWGISTICSAPI Newgistics API. GLOVO Glovo. GWLOGIS_API G.I.G. SPREETAIL_API Spreetail. MOOVA Moova. PLYCONGROUP Plycon Transportation Group. USPS_WEBHOOK USPS Informed Visibility - Webhook. REIMAGINEDELIVERY maergo. EDF_FTP Eurodifarm. DAO365 DAO365. BIOCAIR_FTP BioCair. RANSA_WEBHOOK Ransa. SHIPXPRES SHIPXPRESS. COURANT_PLUS_API Courant Plus. SHIPA SHIPA. HOMELOGISTICS Home Logistics. DX DX. POSTE_ITALIANE_PACCOCELERE Poste Italiane Paccocelere. TOLL_WEBHOOK Toll Group. LCTBR_API LCT do Brasil. DX_FREIGHT DX Freight. DHL_SFTP DHL Express. SHIPROCKET Shiprocket X. UBER_WEBHOOK Uber. STATOVERNIGHT Stat Overnight. BURD Burd Delivery. FASTSHIP Fastship Express. IBVENTURE_WEBHOOK IB Venture. GATI_KWE_API Gati-KWE. CRYOPDP_FTP CryoPDP. HUBBED HUBBED. TIPSA_API Tipsa API. ARASKARGO Aras Cargo. THIJS_NL Thijs Logistiek. ATSHEALTHCARE_REFERENCE ATS Healthcare. 99MINUTOS 99minutos. HELLENIC_POST Hellenic (Greece) Post. HSM_GLOBAL HSM Global. MNX MNX. NMTRANSFER N&M Transfer Co., Inc.. LOGYSTO Logysto. INDIA_POST_INT India Post International. AMAZON_FBA_SWISHIP_IN Swiship IN. SRT_TRANSPORT SRT Transport. BOMI Bomi Group. DELIVERR_SFTP Deliverr. HSDEXPRESS HSDEXPRESS. SIMPLETIRE_WEBHOOK SimpleTire. HUNTER_EXPRESS_SFTP Hunter Express. UPS_API UPS. WOOYOUNG_LOGISTICS_SFTP WOO YOUNG LOGISTICS CO.,LTD.. PHSE_API PHSE. WISH_EMAIL_PUSH Wish. NORTHLINE Northline. MEDAFRICA Med Africa Logistics. DPD_AT_SFTP DPD Austria. ANTERAJA Anteraja. DHL_GLOBAL_FORWARDING_API DHL Global Forwarding API. LBCEXPRESS_API LBC EXPRESS INC.. SIMSGLOBAL Sims Global. CDLDELIVERS CDL Last Mile. TYP TYP. TESTING_COURIER_WEBHOOK Testing Courier. PANDAGO_API Pandago. ROYAL_MAIL_FTP Royal Mail. THUNDEREXPRESS Thunder Express Australia. SECRETLAB_WEBHOOK Secretlab. SETEL Setel Express. JD_WORLDWIDE JD Worldwide. DPD_RU_API DPD Russia. ARGENTS_WEBHOOK Argents Express Group. POSTONE Post ONE. TUSKLOGISTICS Tusk Logistics. RHENUS_UK_API Rhenus Logistics UK. TAQBIN_SG_API Yamato Singapore. INNTRALOG_SFTP Inntralog GmbH. DAYROSS Day & Ross. CORREOSEXPRESS_API Correos Express (API). INTERNATIONAL_SEUR_API International Seur API. YODEL_API Yodel API. HEROEXPRESS Hero Express. DHL_SUPPLYCHAIN_IN DHL supply chain India. URGENT_CARGUS Urgent Cargus. FRONTDOORCORP FRONTdoor Collective. JTEXPRESS_PH J&T Express Philippines. PARCELSTARS_WEBHOOK Parcelstars. DPD_SK_SFTP DPD Slovakia. MOVIANTO Movianto. OZEPARTS_SHIPPING Ozeparts Shipping. KARGOMKOLAY KargomKolay (CargoMini). TRUNKRS Trunkrs. OMNIRPS_WEBHOOK Omni Returns. CHILEXPRESS Chile Express. TESTING_COURIER Testing Courier. JNE_API JNE (API). BJSHOMEDELIVERY_FTP BJS Distribution, Storage & Couriers - FTP. DEXPRESS_WEBHOOK D Express. USPS_API USPS API. TRANSVIRTUAL TransVirtual. SOLISTICA_API solistica. CHIENVENTURE_WEBHOOK Chienventure. DPD_UK_SFTP DPD UK. INPOST_UK InPost. JAVIT Javit. ZTO_DOMESTIC ZTO Express China. DHL_GT_API DHL Global Forwarding Guatemala. CEVA_TRACKING CEVA Package. KOMON_EXPRESS Komon Express. EASTWESTCOURIER_FTP East West Courier Pte Ltd. DANNIAO Danniao. SPECTRAN Spectran. DELIVER_IT Deliver-iT. RELAISCOLIS Relais Colis. GLS_SPAIN_API GLS Spain. POSTPLUS PostPlus. AIRTERRA Airterra. GIO_ECOURIER_API GIO Express Ecourier. DPD_CH_SFTP DPD Switzerland. FEDEX_API FedEx®. INTERSMARTTRANS INTERSMARTTRANS & SOLUTIONS SL. HERMES_UK_SFTP Hermes UK. EXELOT_FTP Exelot Ltd.. DHL_PA_API DHL GLOBAL FORWARDING PANAMÁ. VIRTRANSPORT_SFTP Vir Transport. WORLDNET Worldnet Logistics. INSTABOX_WEBHOOK Instabox. KNG Keuhne + Nagel Global. FLASHEXPRESS_WEBHOOK Flash Express. MAGYAR_POSTA_API Magyar Posta. WESHIP_API WeShip. OHI_WEBHOOK Ohi. MUDITA MUDITA. BLUEDART_API Bluedart. T_CAT_API T-cat. ADS ADS Express. HERMES_IT HR Parcel. FITZMARK_API FitzMark. POSTI_API Posti API. SMSA_EXPRESS_WEBHOOK SMSA Express. TAMERGROUP_WEBHOOK Tamer Logistics. LIVRAPIDE Livrapide. NIPPON_EXPRESS Nippon Express. BETTERTRUCKS Better Trucks. FAN FAN COURIER EXPRESS. PB_USPSFLATS_FTP USPS Flats (Pitney Bowes). PARCELRIGHT Parcel Right. ITHINKLOGISTICS iThink Logistics. KERRY_EXPRESS_TH_WEBHOOK Kerry Logistics. ECOUTIER eCoutier. SHOWL SENHONG INTERNATIONAL LOGISTICS. BRT_IT_API BRT Bartolini API. RIXONHK_API Rixon Logistics. DBSCHENKER_API DB Schenker. ILYANGLOGIS Ilyang logistics. MAIL_BOX_ETC Mail Boxes Etc.. WESHIP WeShip. DHL_GLOBAL_MAIL_API DHL eCommerce Solutions. ACTIVOS24_API Activos24. ATSHEALTHCARE ATS Healthcare. LUWJISTIK Luwjistik. GW_WORLD Gebrüder Weiss. FAIRSENDEN_API fairsenden. SERVIP_WEBHOOK SerVIP. SWISHIP Swiship. TANET Transport Ambientales. HOTSIN_CARGO SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD. DIREX Direx. HUANTONG HuanTong. IMILE_API iMile. AUEXPRESS Au Express. NYTLOGISTICS NYT SUPPLY CHAIN LOGISTICS Co.,LTD. DSV_REFERENCE DSV Futurewave. NOVOFARMA_WEBHOOK Novofarma. AITWORLDWIDE_SFTP AIT. SHOPOLIVE Olive. FNF_ZA Fast & Furious. DHL_ECOMMERCE_GC DHL eCommerce Greater China. FETCHR Fetchr. STARLINKS_API Starlinks Global. YYEXPRESS YYEXPRESS. SERVIENTREGA Servientrega. HANJIN HanJin. SPANISH_SEUR_FTP Spanish Seur. DX_B2B_CONNUM DX (B2B). HELTHJEM_API Helthjem. INEXPOST Inexpost. A2B_BA A2B Express Logistics. RHENUS_GROUP Rhenus Logistics. SBERLOGISTICS_RU Sber Logistics. MALCA_AMIT Malca-Amit. PPL Professional Parcel Logistics. OSM_WORLDWIDE_SFTP OSM Worldwide. ACILOGISTIX ACI Logistix. OPTIMACOURIER Optima Courier. NOVA_POSHTA_API Nova Poshta API. LOGGI Loggi. YIFAN YiFan Express. MYDYNALOGIC My DynaLogic. MORNINGLOBAL Morning Global. CONCISE_API Concise. FXTRAN Falcon Express. DELIVERYOURPARCEL_ZA Deliver Your Parcel. UPARCEL uParcel. MOBI_BR Mobi Logistica. LOGINEXT_WEBHOOK T&W Delivery. EMS EMS. SPEEDY Speedy. ZOOM_RED Zoom. NAVLUNGO Navlungo. CASTLEPARCELS Castle Parcels. WEEE Weee. PACKALY Packaly. YUNHUIPOST Yunhuipost. YOUPARCEL YouParcel. LEMAN Leman. MOOVIN Moovin. URB_IT Urb-it. MULTIENTREGAPANAMA Multientrega. JUSDASR Jusdasr. DISCOUNTPOST Discount Post. RHENUS_UK Rhenus Logistics UK. SWISHIP_JP Swiship JP. GLS_US GLS USA. SMTL Southwestern Motor Transport. Inc. EMEGA Discount Post Emega. EXPRESSONE_SV EXPRESSONE Slovenia. HEPSIJET hepsiJET. WELIVERY Welivery. BRINGER Bringer Parcel Services. EASYROUTES EasyRoutes. MRW MRW. RPM RPM. DPD_PRT DPD Portugal. GLS_ROMANIA GLS Romania. LMPARCEL LM Parcel. GTAGSM GTA GSM. DOMINO DOMINO. ESHIPPER eShipper. TRANSPAK Transpak Inc.. XINDUS Xindus. AOYUE Aoyue. EASYPARCEL Easyparcel. EXPRESSONE EXPRESSONE. SENDEO_KARGO Sendeo Kargo. SPEEDAF Speedaf Express. ETOWER eTower. GCX GC Express. NINJAVAN_VN Ninjavan Vietnam. ALLEGRO Allegro. JUMPPOINT Jumppoint. SHIPGLOBAL_US ShipGlobal. KINISI Kinisi Transport Pty Ltd. OAKH Oakh Harbour Freight Lines. AWEST American West. BARSAN Barsan Global Lojistik. ENERGOLOGISTIC Energo Logistic. MADROOEX Madrooex. GOBOLT GoBolt. SWISS_UNIVERSAL_EXPRESS Swiss Universal Express. IORDIRECT IOR Direct Solutions. XMSZM xmszm. GLS_HUN GLS Hungary. SENDY Sendy Express. BRAUNSEXPRESS Brauns Express. GRANDSLAMEXPRESS Grand Slam Express. XGS XGS. OTSCHILE OTS. PACK_UP Pack-Up. PARCELSTARS Parcelstars. TEAMEXPRESSLLC Team Express Service LLC. ASYADEXPRESS Asyad Express. TDN TDN. EARLYBIRD Early Bird. CACESA Cacesa. PARCELJET Parceljet. MNG_KARGO MNG Kargo. SUPERPACKLINE Super Pac Line. SPEEDX SpeedX. VESYL Vesyl. SKYKING Sky King. DIRMENSAJERIA DIR. NETLOGIXGROUP Netlogix. ZYOU ZYEX. JAWAR Jawar. AGSYSTEMS Associate Global Systems. GPS GPS. PTT_KARGO PTT Kargo. MAERGO Maergo. ARIHANTCOURIER AICS. VTFE VicTas Freight Express. YUNANT Yunant. URBIFY Urbify. PACK_MAN pack-man. LIEFERGRUN LIEFERGRUN. OBIBOX Obibox. PAIKEDA Paikeda. SCOTTY Scotty. INTELCOM_CA Intelcom. SWE swe. ASENDIA Asendia Global. DPD_AT DPD Austria. RELAY Relay. ATA ATA. SKYEXPRESS_INTERNATIONAL SkyExpress Internationals. SURAT_KARGO Surat Kargo. SGLINK SG LINK. FLEETOPTICSINC FleetOptics. SHOPLINE shopline. PIGGYSHIP PIGGYSHIP. LOGOIX LogoiX. KOLAY_GELSIN Kolay Gelsin. ASSOCIATED_COURIERS Associated Couriers. UPS_CHECKER ups-checker. WINESHIPPING Wineshipping. SPEDISCI Spedisci online. FOURKITES Fourkites. ETONAS Etonas. FINMILE Fin Mile. UNIUNI Uniuni. RODONAVES Rodonaves. INPOST_IT Inpost Italy. TFORCE_FREIGHT Tforce Freight. RICHMOM Rich Mom. FRANCO Corriere Franco. ECPARCEL Ecparcel. FEDEX_CHINA Fedex China. GOFO_EXPRESS Gofo Express. SHIPBOB Shipbob. JERSEYPOST_ATLAS Jersey Post Group. CORETRAILS Coretrails. RHENUS_ITALY Rhenus Logistics Italy. JADLOG Jadlog. JITSU Jitsu. YANWEN_EXPRESS Yanwen Express. DASHLINK Dashlink. SEINO_SUPER_EXPRESS Seino Super Express. FLOSHIP Floship. METROSCG Metro Supply Chain. SENDPARCEL Sendparcel. P2P P2p. CN_EXPRESS Cn Express. CIRROTRACK Cirro Track. LAND_LOGISTICS Land Logistics. VEHO Veho. MEDLINE Medline. VDTRACK Vdtrack. SINO_SCM Sino Scm. 3PE_EXPRESS 3pe Express. SWIFTX Swiftx. SFYDEXPRESS Sfyd Express. TOPTRANS Toptrans. Copy { "tracking_number": "string", "carrier_name_other": "string", "carrier": "DPD_RU" } Tracker Status The status of the item shipment.
string [ 1 .. 64 ] characters ^[0-9A-Z_]+$ The status of the item shipment.
Enum Value Description CANCELLED The shipment was cancelled and the tracking number no longer applies. SHIPPED The merchant has assigned a tracking number to the items being shipped from the Order. This does not correspond to the carrier's actual status for the shipment. The latest status of the parcel must be retrieved from the carrier. Copy "CANCELLED" tracker_item The details of the items in the shipment.
name
string [ 1 .. 127 ] characters
The item name or title.
quantity
string [ 1 .. 10 ] characters
The item quantity. Must be a whole number.
sku string [ 1 .. 127 ] characters The stock keeping unit (SKU) for the item. This can contain unicode characters.
url string [ 1 .. 2048 ] characters The URL to the item being purchased. Visible to buyer and used in buyer experiences.
image_url
string [ 1 .. 2048 ] characters ^(https:)([/|.|\w|\s|-])*.(?:jpg|gif|png|jpe...Show pattern
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.
upc object The Universal Product Code of the item.
CopyExpand allCollapse all { "name": "string", "quantity": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" } } tracker_request The tracking details of an order.
tracking_number required string [ 1 .. 64 ] characters The tracking number for the shipment. This property supports Unicode.
carrier_name_other
string [ 1 .. 64 ] characters
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.
carrier required string [ 1 .. 64 ] characters ^[0-9A-Z_]+$ The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.
Enum Value Description DPD_RU DPD Russia. BG_BULGARIAN_POST Bulgarian Posts. KR_KOREA_POST Koreapost (www.koreapost.go.kr). ZA_COURIERIT Courier IT. FR_EXAPAQ DPD France (formerly exapaq). ARE_EMIRATES_POST Emirates Post. GAC GAC. GEIS Geis CZ. SF_EX SF Express. PAGO Pago Logistics. MYHERMES MyHermes UK. DIAMOND_EUROGISTICS Diamond Eurogistics Limited. CORPORATECOURIERS_WEBHOOK Corporate Couriers. BOND Bond courier. OMNIPARCEL Omni Parcel. SK_POSTA Slovenska pošta. PUROLATOR purolator. FETCHR_WEBHOOK Mena 360 (Fetchr). THEDELIVERYGROUP TDG – The Delivery Group. CELLO_SQUARE Cello Square. TARRIVE TONDA GLOBAL. COLLIVERY MDS Collivery Pty (Ltd). MAINFREIGHT Mainfreight. IND_FIRSTFLIGHT First Flight Couriers. ACSWORLDWIDE ACS Worldwide Express. AMSTAN Amstan Logistics. OKAYPARCEL OkayParcel. ENVIALIA_REFERENCE Envialia Reference. SEUR_ES Seur Spain. CONTINENTAL Continental. FDSEXPRESS FDSEXPRESS. AMAZON_FBA_SWISHIP Swiship UK. WYNGS Wyngs. DHL_ACTIVE_TRACING DHL Active Tracing. ZYLLEM Zyllem. RUSTON Ruston. XPOST Xpost.ph. CORREOS_ES correos Express (www.correos.es). DHL_FR DHL France (www.dhl.com). PAN_ASIA Pan-Asia International. BRT_IT BRT couriers Italy (www.brt.it). SRE_KOREA SRE Korea (www.srekorea.co.kr). SPEEDEE Spee-Dee Delivery. TNT_UK TNT UK Limited (www.tnt.com). VENIPAK Venipak. SHREENANDANCOURIER SHREE NANDAN COURIER. CROSHOT Croshot. NIPOST_NG NIpost (www.nipost.gov.ng). EPST_GLBL ePost Global. NEWGISTICS Newgistics. POST_SLOVENIA Post of Slovenia. JERSEY_POST Jersey Post. BOMBINOEXP Bombino Express Pvt. WMG WMG Delivery. XQ_EXPRESS XQ Express. FURDECO Furdeco. LHT_EXPRESS LHT Express. SOUTH_AFRICAN_POST_OFFICE South African Post Office. SPOTON SPOTON Logistics Pvt Ltd. DIMERCO Dimerco Express Group. CYPRUS_POST_CYP cyprus post. ABCUSTOM AB Custom Group. IND_DELIVREE deliverE. CN_BESTEXPRESS Best Express. DX_SFTP DX (SFTP). PICKUPP_MYS PICK UPP. FMX FMX. HELLMANN Hellmann Worldwide Logistics. SHIP_IT_ASIA Ship It Asia. KERRY_ECOMMERCE Kerry eCommerce. FRETERAPIDO Frete Rapido. PITNEY_BOWES Pitney Bowes. XPRESSEN_DK Xpressen courier. SEUR_SP_API Spanish Seur API. DELIVERYONTIME DELIVERYONTIME LOGISTICS PVT LTD. JINSUNG JINSUNG TRADING. TRANS_KARGO Trans Kargo Internasional. SWISHIP_DE Swiship DE. IVOY_WEBHOOK Ivoy courier. AIRMEE_WEBHOOK Airmee couriers. DHL_BENELUX dhl benelux. FIRSTMILE FirstMile. FASTWAY_IR Fastway Ireland. HH_EXP Hua Han Logistics. MYS_MYPOST_ONLINE Mypostonline. TNT_NL THT Netherland. TIPSA TIPSA courier. TAQBIN_MY TAQBIN Malaysia. KGMHUB KGM Hub. INTEXPRESS Internet Express. OVERSE_EXP Overseas Express. ONECLICK One click delivery services. ROADRUNNER_FREIGHT Roadbull Logistics. GLS_CROTIA GLS Croatia. MRW_FTP MRW courier. BLUEX Blue Express. DYLT Daylight Transport. DPD_IR DPD Ireland. SIN_GLBL Sin Global Express. TUFFNELLS_REFERENCE Tuffnells Parcels Express- Reference. CJPACKET CJ Packet. MILKMAN Milkman courier. ASIGNA ASIGNA courier. ONEWORLDEXPRESS One World Express. ROYAL_MAIL RoyalShipments. VIA_EXPRESS Viaxpress. TIGFREIGHT TIG Freight. ZTO_EXPRESS ZTO Express. TWO_GO 2GO Courier. IML IML courier. INTEL_VALLEY Intel-Valley Supply chain (ShenZhen) Co. Ltd. EFS EFS (E-commerce Fulfillment Service). UK_UK_MAIL UK mail (ukmail.com). RAM RAM courier. ALLIEDEXPRESS Allied Express. APC_OVERNIGHT APC overnight (apc-overnight.com). SHIPPIT Shippit. TFM TFM Xpress. M_XPRESS M Xpress Sdn Bhd. HDB_BOX Haidaibao (BOX). CLEVY_LINKS Clevy Links. IBEONE Beone Logistics. FIEGE_NL Fiege Netherlands. KWE_GLOBAL KWE Global. CTC_EXPRESS CTC Express. AMAZON Amazon Shipping. MORE_LINK Morelink. JX JX courier. EASY_MAIL Easy Mail. ADUIEPYLE A Duie Pyle. GB_PANTHER Panther. EXPRESSSALE Expresssale. SG_DETRACK Detrack. TRUNKRS_WEBHOOK Trunkrs courier. MATDESPATCH Matdespatch. DICOM GLS Logistic Systems Canada Ltd./Dicom. MBW MBW Courier Inc.. KHM_CAMBODIA_POST Cambodia Post. SINOTRANS Sinotrans. BRT_IT_PARCELID BRT Bartolini(Parcel ID). DHL_SUPPLY_CHAIN DHL Supply Chain APAC. DHL_PL DHL Poland. TOPYOU TopYou. PALEXPRESS PAL Express Limited. DHL_SG dhl Singapore. CN_WEDO WeDo Logistics. FULFILLME Fulfillme. DPD_DELISTRACK DPD delistrack. UPS_REFERENCE UPS Reference. CARIBOU Caribou. LOCUS_WEBHOOK Locus courier. DSV DSV courier. P2P_TRC P2P TrakPak. DIRECTPARCELS Direct Parcels. NOVA_POSHTA_INT Nova Poshta (International). FEDEX_POLAND FedEx® Poland Domestic. CN_JCEX JCEX courier. FAR_INTERNATIONAL FAR international. IDEXPRESS IDEX courier. GANGBAO GANGBAO Supplychain. NEWAY Neway Transport. POSTNL_INT_3_S PostNL International. RPX_ID RPX Indonesia. DESIGNERTRANSPORT_WEBHOOK Designer Transport. GLS_SLOVEN GLS Slovenia. PARCELLED_IN Parcelled.in. GSI_EXPRESS GSI EXPRESS. CON_WAY Con-way Freight. BROUWER_TRANSPORT Brouwer Transport en Logistiek. CPEX Captain Express International. ISRAEL_POST Israel Post. DTDC_IN DTDC India. PTT_POST PTT Post. XDE_WEBHOOK Ximex Delivery Express. TOLOS Tolos courier. GIAO_HANG Giao hàng nhanh. GEODIS_ESPACE Geodis E-space. MAGYAR_HU Magyar Post. DOORDASH_WEBHOOK DoorDash. TIKI_ID Tiki shipment. CJ_HK_INTERNATIONAL CJ Logistics International(Hong Kong). STAR_TRACK_EXPRESS Star Track Express. HELTHJEM Helthjem. SFB2C SF International. FREIGHTQUOTE Freightquote by C.H. Robinson. LANDMARK_GLOBAL_REFERENCE Landmark Global Reference. PARCEL2GO Parcel2Go. DELNEXT Delnext. RCL Red Carpet Logistics. CGS_EXPRESS CGS Express. HK_POST Hongkong Post (www.hongkongpost.hk). SAP_EXPRESS SAP EXPRESS. PARCELPOST_SG Parcel Post Singapore. HERMES HermesWorld UK. IND_SAFEEXPRESS Safexpress. TOPHATTEREXPRESS Tophatter Express. MGLOBAL PT MGLOBAL LOGISTICS INDONESIA. AVERITT Averitt Express. LEADER leader. _2EBOX 2ebox courier. SG_SPEEDPOST Singapore Speedpost. DBSCHENKER_SE DB Schenker (www.dbschenker.com). ISR_POST_DOMESTIC Israel Post Domestic. BESTWAYPARCEL Best Way Parcel. ASENDIA_DE asendia_de. NIGHTLINE_UK nightline_uk. TAQBIN_SG taqbin_sg. TCK_EXPRESS TCK Express. ENDEAVOUR_DELIVERY Endeavour Delivery. NANJINGWOYUAN Nanjing Woyuan. HEPPNER_FR Heppner France. EMPS_CN EMPS Express. FONSEN Fonsen Logistics. PICKRR Pickrr. APC_OVERNIGHT_CONNUM APC Overnight Consignment. STAR_TRACK_NEXT_FLIGHT Star Track Next Flight. DAJIN Shanghai Aqrum Chemical Logistics Co.Ltd. UPS_FREIGHT UPS Freight. POSTA_PLUS Posta Plus. CEVA CEVA LOGISTICS. ANSERX ANSERX courier. JS_EXPRESS JS EXPRESS. PADTF padtf.com. UPS_MAIL_INNOVATIONS UPS Mail Innovations. SYPOST Sunyou Post. AMAZON_SHIP_MCF Amazon Shipping + Amazon MCF. YUSEN Yusen Logistics. BRING Bring. SDA_IT SDA Italy. GBA GBA Services Ltd. NEWEGGEXPRESS Newegg Express. SPEEDCOURIERS_GR Speed Couriers. FORRUN forrun Pvt Ltd (Arpatech Venture). PICKUP Pickupp. ECMS ECMS International Logistics Co.. INTELIPOST Intelipost (TMS for LATAM). FLASHEXPRESS Flash Express. CN_STO STO Express. SEKO_SFTP SEKO Worldwide. HOME_DELIVERY_SOLUTIONS Home Delivery Solutions Ltd. DPD_HGRY DPD Hungary. KERRYTTC_VN Kerry Express (Vietnam) Co Ltd. JOYING_BOX Joying Box. TOTAL_EXPRESS Total Express. ZJS_EXPRESS ZJS International. STARKEN STARKEN couriers. DEMANDSHIP DemandShip. CN_DPEX DPEX. AUPOST_CN AuPost China. LOGISTERS Logisters. GOGLOBALPOST Global Post. GLS_CZ GLS Czech Republic. PAACK_WEBHOOK Paack courier. GRAB_WEBHOOK Grab courier. PARCELPOINT Parcelpoint. ICUMULUS iCumulus. DAIGLOBALTRACK DAI Post. GLOBAL_IPARCEL i-parcel. YURTICI_KARGO Yurtici Kargo. CN_PAYPAL_PACKAGE PayPal Package. PARCEL_2_POST Parcel To Post. GLS_IT GLS Italy. PIL_LOGISTICS PIL Logistics (China) Co.. HEPPNER Heppner Internationale Spedition GmbH & Co.. GENERAL_OVERNIGHT Go!Express and logistics. HAPPY2POINT Happy 2ThePoint. CHITCHATS Chit Chats. SMOOTH Smooth Couriers. CLE_LOGISTICS CL E-Logistics Solutions Limited. FIEGE Fiege Logistics. MX_CARGO M&X cargo. ZIINGFINALMILE Ziing Final Mile Inc. DAYTON_FREIGHT Dayton Freight. TCS TCS courier. AEX AEX Group. HERMES_DE Hermes Germany. ROUTIFIC_WEBHOOK Routific. GLOBAVEND Globavend. CJ_LOGISTICS CJ Logistics International. PALLET_NETWORK The Pallet Network. RAF_PH RAF Philippines. UK_XDP XDP Express. PAPER_EXPRESS Paper Express. LA_POSTE_SUIVI La Poste. PAQUETEXPRESS Paquetexpress. LIEFERY liefery. STRECK_TRANSPORT Streck Transport. PONY_EXPRESS Pony express. ALWAYS_EXPRESS Always Express. GBS_BROKER GBS-Broker. CITYLINK_MY City-Link Express. ALLJOY ALLJOY SUPPLY CHAIN. YODEL yodel. YODEL_DIR Yodel Direct. STONE3PL STONE3PL. PARCELPAL_WEBHOOK ParcelPal. DHL_ECOMERCE_ASA DHL eCommerce Asia (API). SIMPLYPOST J&T Express Singapore. KY_EXPRESS Kua Yue Express. SHENZHEN shenzhen 1st International Logistics(Group)Co. US_LASERSHIP LaserShip. UC_EXPRE ucexpress. DIDADI DIDADI Logistics tech. CJ_KR CJ Korea Express. DBSCHENKER_B2B DB Schenker B2B. MXE MXE Express. CAE_DELIVERS CAE Delivers. PFCEXPRESS PFC Express. WHISTL Whistl. WEPOST WePost Sdn Bhd. DHL_PARCEL_ES DHL parcel Spain(www.dhl.com). DDEXPRESS DD Express Courier. ARAMEX_AU Aramex Australia (formerly Fastway AU). BNEED Bneed courier. HK_TGX Kerry Express Hong Kong. LATVIJAS_PASTS Latvijas Pasts. VIAEUROPE ViaEurope. CORREO_UY Correo Uruguayo. CHRONOPOST_FR Chronopost france (www.chronopost.fr). J_NET J-Net. _6LS 6ls.com. BLR_BELPOST Belpost. BIRDSYSTEM BirdSystem. DOBROPOST DobroPost. WAHANA_ID Wahana express (www.wahana.com). WEASHIP Weaship. SONICTL Sonic Transportation & Logistics. KWT Shenzhen Jinghuada Logistics Co.. AFLLOG_FTP AFL LOGISTICS. SKYNET_WORLDWIDE SkyNet Worldwide Express. NOVA_POSHTA Nova Poshta (novaposhta.ua). SEINO Seino. SZENDEX SZENDEX. BPOST_INT Bpost international. DBSCHENKER_SV DB Schenker Sweden. AO_DEUTSCHLAND AO Deutschland. EU_FLEET_SOLUTIONS EU Fleet Solutions. PCFCORP PCF Final Mile. LINKBRIDGE Link Bridge(BeiJing)international logistics co.. PRIMAMULTICIPTA PT Prima Multi Cipta. COUREX Urbanfox. ZAJIL_EXPRESS Zajil Express Company. COLLECTCO CollectCo. JTEXPRESS J&T EXPRESS MALAYSIA. FEDEX_UK FedEx® UK. USHIP uShip courier. PIXSELL PIXSELL LOGISTICS. SHIPTOR Shiptor. CDEK CDEK courier. VNM_VIETTELPOST ViettelPost. CJ_CENTURY CJ Century. GSO GSO(GLS-USA). VIWO VIWO IoT. SKYBOX SKYBOX. KERRYTJ Kerry TJ Logistics. NTLOGISTICS_VN Nhat Tin Logistics. SDH_SCM lightning monkey. ZINC Zinc courier. DPE_SOUTH_AFRC DPE South Africa. CESKA_CZ Czech Post. ACS_GR ACS Courier. DEALERSEND DealerSend. JOCOM Jocom. CSE CSE courier. TFORCE_FINALMILE TForce Final Mile. SHIP_GATE ShipGate. SHIPTER SHIPTER. NATIONAL_SAMEDAY National Sameday. YUNEXPRESS YunExpress. CAINIAO AliExpress Standard Shipping. DMS_MATRIX DMSMatrix. DIRECTLOG Directlog (www.directlog.com.br). ASENDIA_US Asendia USA. _3JMSLOGISTICS 3JMS Logistics. LICCARDI_EXPRESS LICCARDI EXPRESS COURIER. SKY_POSTAL SkyPostal. CNWANGTONG cnwangtong. POSTNORD_LOGISTICS_DK ostnord denmark. LOGISTIKA Logistika. CELERITAS Celeritas Transporte. PRESSIODE Pressio. SHREE_MARUTI Shree Maruti Courier Services Pvt Ltd. LOGISTICSWORLDWIDE_HK Logistic Worldwide Express (LWE Honkong). EFEX eFEx (E-Commerce Fulfillment & Express). LOTTE Lotte Global Logistics. LONESTAR Lone Star Overnight. APRISAEXPRESS Aprisa Express. BEL_RS BEL North Russia. OSM_WORLDWIDE OSM Worldwide. WESTGATE_GL Westgate Global. FASTRACK Fasttrack. DTD_EXPR DTD Express. ALFATREX AlfaTrex. PROMEDDELIVERY ProMed Delivery. THABIT_LOGISTICS Thabit Logistics. HCT_LOGISTICS HCT LOGISTICS CO.LTD.. CARRY_FLAP Carry-Flap Co.. US_OLD_DOMINION Old Dominion Freight Line. ANICAM_BOX ANICAM BOX EXPRESS. WANBEXPRESS WanbExpress. AN_POST An Post. DPD_LOCAL DPD Local. STALLIONEXPRESS Stallion Express. RAIDEREX RaidereX. SHOPFANS ShopfansRU LLC. KYUNGDONG_PARCEL Kyungdong Parcel. CHAMPION_LOGISTICS Champion Logistics. PICKUPP_SGP PICK UPP (Singapore). MORNING_EXPRESS Morning Express. NACEX NACEX. THENILE_WEBHOOK SortHub courier. HOLISOL Holisol. LBCEXPRESS_FTP LBC EXPRESS INC.. KURASI KURASI. USF_REDDAWAY USF Reddaway. APG APG eCommerce Solutions. CN_BOXC BoxC courier. ECOSCOOTING ECOSCOOTING. MAINWAY Mainway. PAPERFLY Paperfly Private Limited. HOUNDEXPRESS Hound Express. BOX_BERRY Boxberry courier. EP_BOX EP-Box courier. PLUS_LOG_UK Plus UK Logistics. FULFILLA Fulfilla. ASE ASE KARGO. MAIL_PLUS MailPlus. XPO_LOGISTICS XPO logistics. WNDIRECT wnDirect. CLOUDWISH_ASIA Cloudwish Asia. ZELERIS Zeleris. GIO_EXPRESS Gio Express. OCS_WORLDWIDE OCS WORLDWIDE. ARK_LOGISTICS ARK Logistics. AQUILINE Aquiline. PILOT_FREIGHT Pilot Freight Services. QWINTRY Qwintry Logistics. DANSKE_FRAGT Danske Fragtaend. CARRIERS Carriers courier. AIR_CANADA_GLOBAL Rivo (Air canada). PRESIDENT_TRANS PRESIDENT TRANSNET CORP. STEPFORWARDFS STEP FORWARD FREIGHT SERVICE CO LTD. SKYNET_UK Skynet UK. PITTOHIO PITT OHIO. CORREOS_EXPRESS Correos Express. RL_US RL Carriers. DESTINY Destiny Transportation. UK_YODEL Yodel (www.yodel.co.uk). COMET_TECH CometTech. DHL_PARCEL_RU DHL Parcel Russia. TNT_REFR TNT Reference. SHREE_ANJANI_COURIER Shree Anjani Courier. MIKROPAKKET_BE Mikropakket Belgium. ETS_EXPRESS RETS express. COLIS_PRIVE Colis Privé. CN_YUNDA Yunda Express. AAA_COOPER AAA Cooper. ROCKET_PARCEL Rocket Parcel International. _360LION 360 Lion Express. PANDU PANDU. PROFESSIONAL_COURIERS PROFESSIONAL COURIERS. FLYTEXPRESS FLYTEXPRESS. LOGISTICSWORLDWIDE_MY LOGISTICSWORLDWIDE MY. CORREOS_DE_ESPANA CORREOS DE ESPANA. IMX IMX. FOUR_PX_EXPRESS FOUR PX EXPRESS. XPRESSBEES XPRESSBEES. PICKUPP_VNM pickupp_vnm. STARTRACK_EXPRESS startrack_express. FR_COLISSIMO fr_colissimo. NACEX_SPAIN_REFERENCE nacex_spain_reference. DHL_SUPPLY_CHAIN_AU dhl_supply_chain_au. ESHIPPING Eshipping. SHREETIRUPATI SHREE TIRUPATI COURIER SERVICES PVT. LTD.. HX_EXPRESS HX Express. INDOPAKET INDOPAKET. CN_17POST 17 Post Service. K1_EXPRESS K1 Express. CJ_GLS CJ GLS. MYS_GDEX GDEX courier. NATIONEX Nationex courier. ANJUN Anjun couriers. FARGOOD FarGood. SMG_EXPRESS SMG Direct. RZYEXPRESS RZY Express. SEFL Southeastern Freight Lines. TNT_CLICK_IT TNT-Click Italy. HDB Haidaibao. HIPSHIPPER Hipshipper. RPXLOGISTICS RPX Logistics. KUEHNE Kuehne + Nagel. IT_NEXIVE Nexive (TNT Post Italy). PTS PTS courier. SWISS_POST_FTP Swiss Post FTP. FASTRK_SERV Fastrak Services. _4_72 4-72 Entregando. US_YRC YRC courier. POSTNL_INTL_3S PostNL International 3S. ELIAN_POST Yilian (Elian) Supply Chain. CUBYN Cubyn. SAU_SAUDI_POST Saudi Post. ABXEXPRESS_MY ABX Express. HUAHAN_EXPRESS HUAHANG EXPRESS. ZES_EXPRESS Eshun international Logistic. ZEPTO_EXPRESS ZeptoExpress. SKYNET_ZA Skynet World Wide Express South Africa. ZEEK_2_DOOR Zeek2Door. BLINKLASTMILE Blink. POSTA_UKR UkrPoshta. CHROBINSON C.H. Robinson Worldwide. CN_POST56 Post56. COURANT_PLUS Courant Plus. SCUDEX_EXPRESS Scudex Express. SHIPENTEGRA ShipEntegra. B_TWO_C_EUROPE B2C courier Europe. COPE Cope Sensitive Freight. IND_GATI Gati-KWE. CN_WISHPOST WishPost. NACEX_ES NACEX Spain. TAQBIN_HK TAQBIN Hong Kong. GLOBALTRANZ GlobalTranz. HKD Qingdao HKD International Logistics. BJSHOMEDELIVERY BJS Distribution courier. OMNIVA Omniva. SUTTON Sutton Transport. PANTHER_REFERENCE Panther Reference. SFCSERVICE SFC Service. LTL LTL COURIER. PARKNPARCEL Park N Parcel. SPRING_GDS Spring GDS. ECEXPRESS ECexpress. INTERPARCEL_AU Interparcel Australia. AGILITY Agility. XL_EXPRESS XL Express. ADERONLINE Ader couriers. DIRECTCOURIERS Direct Couriers. PLANZER Planzer Group. SENDING Sending Transporte Urgente y Comunicacion. NINJAVAN_WB Ninjavan Webhook. NATIONWIDE_MY Nationwide Express Courier Services Bhd (www.nationwide.com.my). SENDIT Sendit. GB_ARROW Arrow XL. IND_GOJAVAS GoJavas. KPOST Korea Post. DHL_FREIGHT DHL Freight. BLUECARE Bluecare Express Ltd. JINDOUYUN jindouyun courier. TRACKON Trackon Couriers Pvt. Ltd. GB_TUFFNELLS Tuffnells Parcels Express. TRUMPCARD TRUMPCARD LLC. ETOTAL eTotal Solution Limited. SFPLUS_WEBHOOK Zeek courier. SEKOLOGISTICS SEKO Logistics. HERMES_2MANN_HANDLING Hermes Einrichtungs Service GmbH & Co. KG. DPD_LOCAL_REF DPD Local reference. UDS United Delivery Service. ZA_SPECIALISED_FREIGHT Specialised Freight. THA_KERRY Kerry Express Thailand. PRT_INT_SEUR SEUR International. BRA_CORREIOS Correios Brazil. NZ_NZ_POST New Zealand Post. CN_EQUICK Equick China. MYS_EMS Malaysia Post EMS / Pos Laju. GB_NORSK Norsk Global. ESP_MRW MRW spain. ESP_PACKLINK Packlink. KANGAROO_MY Kangaroo Worldwide Express. RPX RPX Online. XDP_UK_REFERENCE XDP Express Reference. NINJAVAN_MY ninja van (www.ninjavan.co). ADICIONAL Adicional Logistics. ROADBULL Red Carpet Logistics. YAKIT Yakit courier. MAILAMERICAS MailAmericas. MIKROPAKKET Mikropakket. DYNALOGIC Dynamic Logistics. DHL_ES DHL Spain(www.dhl.com). DHL_PARCEL_NL DHL Parcel NL. DHL_GLOBAL_MAIL_ASIA DHL Global Mail Asia (www.dhl.com). DAWN_WING Dawn Wing. GENIKI_GR Geniki Taxydromiki. HERMESWORLD_UK hermesworld_uk. ALPHAFAST Alphafast (www.alphafast.com). BUYLOGIC buylogic. EKART Ekart logistics (ekartlogistics.com). MEX_SENDA mexico senda express. SFC_LOGISTICS SFC. POST_SERBIA Posta Serbia. IND_DELHIVERY Delhivery India. DE_DPD_DELISTRACK DPD Germany. RPD2MAN RPD2man Deliveries. CN_SF_EXPRESS SF Express (www.sf-express.com). YANWEN Yanwen Logistics. MYS_SKYNET Skynet Malaysia. CORREOS_DE_MEXICO correos mexico. CBL_LOGISTICA CBL Logistica. MEX_ESTAFETA Estafeta (www.estafeta.com). AU_AUSTRIAN_POST Austrian Post (Registered). RINCOS Rincos. NLD_DHL DHL Netherland. RUSSIAN_POST Russian post. COURIERS_PLEASE CouriersPlease (couriersplease.com.au). POSTNORD_LOGISTICS PostNord Logistics. FEDEX Fedex. DPE_EXPRESS DPE Express. DPD DPD. ADSONE ADSone. IDN_JNE JNE Express (Jalur Nugraha Ekakurir). THECOURIERGUY The Courier Guy. CNEXPS CNE Express. PRT_CHRONOPOST Chronopost Portugal. LANDMARK_GLOBAL Landmark Global. IT_DHL_ECOMMERCE DHL International. ESP_NACEX NACEX Spain. PRT_CTT CTT Portugal. BE_KIALA Kiala. ASENDIA_UK Asendia UK. GLOBAL_TNT TNT global. POSTUR_IS Iceland Post. EPARCEL_KR eParcel Korea. INPOST_PACZKOMATY InPost Paczkomaty. IT_POSTE_ITALIA Poste italiane (www.poste.it). BE_BPOST Bpost (www.bpost.be). PL_POCZTA_POLSKA Poczta Polska (www.poczta-polska.pl). MYS_MYS_POST Malaysia Post. SG_SG_POST Singapore Post. THA_THAILAND_POST Thailand Post (www.thailandpost.co.th). LEXSHIP LexShip. FASTWAY_NZ Fastway New Zealand. DHL_AU DHL Supply Chain Australia. COSTMETICSNOW Cosmetics Now. PFLOGISTICS PFL. LOOMIS_EXPRESS Loomis Express. GLS_ITALY GLS Italy. LINE Line Clear Express & Logistics Sdn Bhd. GEL_EXPRESS Gel Express Logistik. HUODULL Huodull. NINJAVAN_SG Ninja van Singapore. JANIO Janio Asia. AO_COURIER AO Logistics. BRT_IT_SENDER_REF BRT Bartolini(Sender Reference). SAILPOST SAILPOST. LALAMOVE Lalamove. NEWZEALAND_COURIERS NEW ZEALAND COURIERS. ETOMARS Etomars. VIRTRANSPORT VIR Transport. WIZMO Wizmo. PALLETWAYS Palletways. I_DIKA i-dika. CFL_LOGISTICS CFL Logistics. GEMWORLDWIDE GEM Worldwide. GLOBAL_EXPRESS Tai Wan Global Business. LOGISTYX_TRANSGROUP Transgroup courier. WESTBANK_COURIER West Bank Courier. ARCO_SPEDIZIONI Arco Spedizioni SP. YDH_EXPRESS YDH express. PARCELINKLOGISTICS Parcelink Logistics. CNDEXPRESS CND Express. NOX_NIGHT_TIME_EXPRESS NOX NightTimeExpress. AERONET Aeronet couriers. LTIANEXP LTIAN EXP. INTEGRA2_FTP Integra2. PARCELONE PARCEL ONE. NOX_NACHTEXPRESS Innight Express Germany GmbH (nox NachtExpress). CN_CHINA_POST_EMS China Post. CHUKOU1 Chukou1. GLS_SLOV GLS General Logistics Systems Slovakia s.r.o.. ORANGE_DS OrangeDS (Orange Distribution Solutions Inc). JOOM_LOGIS Joom Logistics. AUS_STARTRACK StarTrack (startrack.com.au). DHL dhl Global. GB_APC APC postal logistics germany. BONDSCOURIERS Bonds Courier Service (bondscouriers.com.au). JPN_JAPAN_POST Japan Post. USPS United States Postal Service. WINIT WinIt. ARG_OCA OCA Argentina. TW_TAIWAN_POST Taiwan Post. DMM_NETWORK DMM Network. TNT TNT Express. BH_POSTA BH Posta (www.posta.ba). SWE_POSTNORD Postnord sweden. CA_CANADA_POST Canada Post. WISELOADS Wiseloads. ASENDIA_HK Asendia HonKong. NLD_GLS GLS Netherland. MEX_REDPACK Redpack. JET_SHIP Jet-Ship Worldwide. DE_DHL_EXPRESS DHL Express. NINJAVAN_THAI Ninja van Thai. RABEN_GROUP Raben Group. ESP_ASM ASM(GLS Spain). HRV_HRVATSKA Hrvatska posta. GLOBAL_ESTES Estes Express Lines. LTU_LIETUVOS Lietuvos pastas. BEL_DHL DHL Benelux. AU_AU_POST Australia Post. SPEEDEXCOURIER SPEEDEX couriers. FR_COLIS Colissimo. ARAMEX Aramex. DPEX DPEX (www.dpex.com). MYS_AIRPAK Airpak Express. CUCKOOEXPRESS Cuckoo Express. DPD_POLAND DPD Poland. NLD_POSTNL PostNL International. NIM_EXPRESS Nim Express. QUANTIUM Quantium. SENDLE Sendle. ESP_REDUR Redur Spain. MATKAHUOLTO Matkahuolto. CPACKET Cpacket couriers. POSTI Posti courier. HUNTER_EXPRESS Hunter Express. CHOIR_EXP Choir Express Indonesia. LEGION_EXPRESS Legion Express. AUSTRIAN_POST_EXPRESS austrian post. GRUPO Grupo ampm. POSTA_RO Post Roman (www.posta-romana.ro). INTERPARCEL_UK Interparcel UK. GLOBAL_ABF ABF Freight. POSTEN_NORGE Posten Norge (www.posten.no). XPERT_DELIVERY Xpert Delivery. DHL_REFR DHl (Reference number). DHL_HK DHL HonKong. SKYNET_UAE SKYNET UAE. GOJEK Gojek. YODEL_INTNL Yodel International. JANCO Janco Ecommerce. YTO YTO Express. WISE_EXPRESS Wise Express. JTEXPRESS_VN J&T Express Vietnam. FEDEX_INTL_MLSERV FedEx International MailService. VAMOX VAMOX. AMS_GRP AMS Group. DHL_JP DHL Japan. HRPARCEL HR Parcel. GESWL GESWL Express. BLUESTAR Blue Star. CDEK_TR CDEK TR. DESCARTES Innovel courier. DELTEC_UK Deltec Courier. DTDC_EXPRESS DTDC express. TOURLINE tourline. BH_WORLDWIDE B&H Worldwide. OCS OCS ANA Group. YINGNUO_LOGISTICS yingnuo logistics. UPS United Parcel Service. TOLL Toll IPEC. PRT_SEUR SEUR portugal. DTDC_AU DTDC Australia. THA_DYNAMIC_LOGISTICS Dynamic Logistics. UBI_LOGISTICS UBI Smart Parcel. FEDEX_CROSSBORDER FedEx Cross Border. A1POST A1Post. TAZMANIAN_FREIGHT Tazmanian Freight Systems. CJ_INT_MY CJ International malaysia. SAIA_FREIGHT Saia LTL Freight. SG_QXPRESS Qxpress. NHANS_SOLUTIONS Nhans Solutions. DPD_FR DPD France. COORDINADORA Coordinadora. ANDREANI Grupo logistico Andreani. DOORA Doora Logistics. INTERPARCEL_NZ Interparcel New Zealand. PHL_JAMEXPRESS Jam Express Philippines. BEL_BELGIUM_POST bel_belgium_post. US_APC us_apc. IDN_POS idn_pos. FR_MONDIAL fr_mondial. DE_DHL DE DHL. HK_RPX hk_rpx. DHL_PIECEID dhl_pieceid. VNPOST_EMS vnpost_ems. RRDONNELLEY rrdonnelley. DPD_DE dpd_de. DELCART_IN delcart_in. IMEXGLOBALSOLUTIONS imexglobalsolutions. ACOMMERCE ACOMMERCE. EURODIS eurodis. CANPAR CANPAR. GLS GLS. IND_ECOM Ecom Express. ESP_ENVIALIA Envialia. DHL_UK dhl UK. SMSA_EXPRESS SMSA Express. TNT_FR TNT France. DEX_I DEX-I courier. BUDBEE_WEBHOOK Budbee courier. COPA_COURIER Copa Airlines Courier. VNM_VIETNAM_POST Vietnam Post. DPD_HK DPD HongKong. TOLL_NZ Toll New Zealand. ECHO Echo courier. FEDEX_FR FedEx® Freight. BORDEREXPRESS Border Express. MAILPLUS_JPN MailPlus (Japan). TNT_UK_REFR TNT UK Reference. KEC KEC courier. DPD_RO DPD Romania. TNT_JP TNT_JP. TH_CJ TH_CJ. EC_CN EC_CN. FASTWAY_UK FASTWAY_UK. FASTWAY_US FASTWAY_US. GLS_DE GLS_DE. GLS_ES GLS_ES. GLS_FR GLS_FR. MONDIAL_BE MONDIAL_BE. SGT_IT SGT_IT. TNT_CN TNT_CN. TNT_DE TNT_DE. TNT_ES TNT_ES. TNT_PL TNT_PL. PARCELFORCE PARCELFORCE. SWISS_POST SWISS POST. TOLL_IPEC TOLL IPEC. AIR_21 AIR 21. AIRSPEED AIRSPEED. BERT BERT. BLUEDART BLUEDART. COLLECTPLUS COLLECTPLUS. COURIERPLUS COURIERPLUS. COURIER_POST COURIER POST. DHL_GLOBAL_MAIL dhl_global_mail. DPD_UK dpd_uk. DELTEC_DE DELTEC DE. DEUTSCHE_DE deutsche_de. DOTZOT DOTZOT. ELTA_GR elta_gr. EMS_CN ems_cn. ECARGO ECARGO. ENSENDA ENSENDA. FERCAM_IT fercam_it. FASTWAY_ZA fastway_za. FASTWAY_AU fastway_au. FIRST_LOGISITCS first_logisitcs. GEODIS GEODIS. GLOBEGISTICS GLOBEGISTICS. GREYHOUND GREYHOUND. JETSHIP_MY jetship_my. LION_PARCEL LION PARCEL. AEROFLASH AEROFLASH. ONTRAC ONTRAC. SAGAWA SAGAWA. SIODEMKA SIODEMKA. STARTRACK startrack. TNT_AU tnt_au. TNT_IT tnt_it. TRANSMISSION TRANSMISSION. YAMATO YAMATO. DHL_IT dhl_it. DHL_AT dhl_at. LOGISTICSWORLDWIDE_KR LOGISTICSWORLDWIDE KR. GLS_SPAIN gls_spain. AMAZON_UK_API amazon_uk_api. DPD_FR_REFERENCE dpd_fr_reference. DHLPARCEL_UK dhlparcel_uk. MEGASAVE megasave. QUALITYPOST qualitypost. IDS_LOGISTICS ids_logistics. JOYINGBOX joyingbox. PANTHER_ORDER_NUMBER panther_order_number. WATKINS_SHEPARD watkins_shepard. FASTTRACK fasttrack. UP_EXPRESS up_express. ELOGISTICA elogistica. ECOURIER ecourier. CJ_PHILIPPINES cj_philippines. SPEEDEX speedex. ORANGECONNEX orangeconnex. TECOR tecor. SAEE saee. GLS_ITALY_FTP gls_italy_ftp. DELIVERE delivere. YYCOM yycom. ADICIONAL_PT Adicional Logistics. DKSH DKSH. NIPPON_EXPRESS_FTP Nippon Express. GOLS GO Logistics & Storage. FUJEXP FUJIE EXPRESS. QTRACK QTrack. OMLOGISTICS_API OM LOGISTICS LTD. GDPHARM GDPharm Logistics. MISUMI_CN MISUMI Group Inc.. AIR_CANADA Rivo. CITY56_WEBHOOK City Express. SAGAWA_API Sagawa. KEDAEX KedaEX. PGEON_API Pgeon. WEWORLDEXPRESS We World Express. JT_LOGISTICS J&T International logistics. TRUSK Trusk France. VIAXPRESS ViaXpress. DHL_SUPPLYCHAIN_ID DHL Supply Chain Indonesia. ZUELLIGPHARMA_SFTP Zuellig Pharma Korea. MEEST Meest. TOLL_PRIORITY Toll Priority. MOTHERSHIP_API Mothership. CAPITAL Capital Transport. EUROPAKET_API Europacket+. HFD HFD. TOURLINE_REFERENCE Tourline Express. GIO_ECOURIER GIO Express Inc. CN_LOGISTICS CN Logistics. PANDION Pandion. BPOST_API Bpost API. PASSPORTSHIPPING Passport Shipping. PAKAJO Pakajo World. DACHSER DACHSER. YUSEN_SFTP Yusen Logistics. SHYPLITE Shypmax. XYY Xingyunyi Logistics. MWD Metropolitan Warehouse & Delivery. FAXECARGO Faxe Cargo. MAZET Groupe Mazet. FIRST_LOGISTICS_API First Logistics. SPRINT_PACK SPRINT PACK. HERMES_DE_FTP Hermes Germany. CONCISE Concise. KERRY_EXPRESS_TW_API Kerry Express TaiWan. EWE EWE Global Express. FASTDESPATCH Fast Despatch Logistics Limited. ABCUSTOM_SFTP AB Custom Group. CHAZKI Chazki. SHIPPIE Shippie. GEODIS_API GEODIS - Distribution & Express. NAQEL_EXPRESS Naqel Express. PAPA_WEBHOOK Papa. FORWARDAIR Forward Air. DIALOGO_LOGISTICA_API Dialogo Logistica. LALAMOVE_API Lalamove. TOMYDOOR Tomydoor. KRONOS_WEBHOOK Kronos Express. JTCARGO J&T CARGO. T_CAT T-cat. CONCISE_WEBHOOK Concise. TELEPORT_WEBHOOK Teleport. CUSTOMCO_API The Custom Companies. SPX_TH Shopee Xpress. BOLLORE_LOGISTICS Bollore Logistics. CLICKLINK_SFTP ClickLink. M3LOGISTICS M3 Logistics. VNPOST_API Vietnam Post. AXLEHIRE_FTP Axlehire. SHADOWFAX Shadowfax. MYHERMES_UK_API EVRi. DAIICHI Daiichi Freight System Inc. MENSAJEROSURBANOS_API Mensajeros Urbanos. POLARSPEED PolarSpeed Inc. IDEXPRESS_ID iDexpress Indonesia. PAYO Payo. WHISTL_SFTP Whistl. INTEX_DE INTEX Paketdienst GmbH. TRANS2U Trans2u. PRODUCTCAREGROUP_SFTP Product Care Services Limited. BIGSMART Big Smart. EXPEDITORS_API_REF Expeditors API Reference. AITWORLDWIDE_API AIT. WORLDCOURIER World Courier. QUIQUP Quiqup. AGEDISS_SFTP Agediss. ANDREANI_API Andreani. CRLEXPRESS CRL Express. SMARTCAT SMARTCAT. CROSSFLIGHT Crossflight Limited. PROCARRIER Pro Carrier. DHL_REFERENCE_API DHL (Reference number). SEINO_API Seino. WSPEXPRESS WSP Express. KRONOS Kronos Express. TOTAL_EXPRESS_API Total Express. PARCLL PARCLL. XPEDIGO Xpedigo. STAR_TRACK_WEBHOOK StarTrack. GPOST Georgian Post. UCS UCS. DMFGROUP DMF. COORDINADORA_API Coordinadora. MARKEN Marken. NTL NTL logistics. REDJEPAKKETJE Red je Pakketje. ALLIED_EXPRESS_FTP Allied Express (FTP). MONDIALRELAY_ES Mondial Relay Spain(Punto Pack). NAEKO_FTP Naeko Logistics. MHI Mhi. SHIPPIFY Shippify, Inc. MALCA_AMIT_API Malca Amit. JTEXPRESS_SG_API J&T Express Singapore. DACHSER_WEB DACHSER. FLIGHTLG Flight Logistics Group. CAGO Cago. COM1EXPRESS ComOne Express. TONAMI_FTP Tonami. PACKFLEET PACKFLEET. PUROLATOR_INTERNATIONAL Purolator International. WINESHIPPING_WEBHOOK Wineshipping. DHL_ES_SFTP DHL Spain Domestic. PCHOME_API 網家速配股份有限公司. CESKAPOSTA_API Czech Post. GORUSH Go Rush. HOMERUNNER HomeRunner. AMAZON_ORDER Amazon order. EFWNOW_API Estes Forwarding Worldwide. CBL_LOGISTICA_API CBL Logistica (API). NIMBUSPOST NimbusPost. LOGWIN_LOGISTICS Logwin Logistics. NOWLOG_API Sequoialog. DPD_NL DPD Netherlands. GODEPENDABLE Dependable Supply Chain Services. ESDEX Top Ideal Express. LOGISYSTEMS_SFTP Kiitäjät. EXPEDITORS Expeditors. SNTGLOBAL_API Snt Global Etrax. SHIPX ShipX. QINTL_API Quickstat Courier LLC. PACKS Packs. POSTNL_INTERNATIONAL PostNL International. AMAZON_EMAIL_PUSH Amazon. DHL_API DHL. SPX Shopee Express. AXLEHIRE AxleHire. ICSCOURIER ICS COURIER. DIALOGO_LOGISTICA Dialogo Logistica. SHUNBANG_EXPRESS ShunBang Express. TCS_API TCS. SF_EXPRESS_CN SF Express China. PACKETA Packeta. SIC_TELIWAY Teliway SIC Express. MONDIALRELAY_FR Mondial Relay France. INTIME_FTP InTime. JD_EXPRESS 京东物流. FASTBOX Fastbox. PATHEON Patheon Logistics. INDIA_POST India Post Domestic. TIPSA_REF Tipsa Reference. ECOFREIGHT Eco Freight. VOX VOX SOLUCION EMPRESARIAL SRL. DIRECTFREIGHT_AU_REF Direct Freight Express. BESTTRANSPORT_SFTP Best Transport. AUSTRALIA_POST_API Australia Post. FRAGILEPAK_SFTP FragilePAK. FLIPXP FlipXpress. VALUE_WEBHOOK Value Logistics. DAESHIN Daeshin. SHERPA Sherpa. MWD_API Metropolitan Warehouse & Delivery. SMARTKARGO SmartKargo. DNJ_EXPRESS DNJ Express. GOPEOPLE Go People. MYSENDLE_API mySendle. ARAMEX_API Aramex. PIDGE Pidge. THAIPARCELS TP Logistic. PANTHER_REFERENCE_API Panther Reference. POSTAPLUS Posta Plus. BUFFALO BUFFALO. U_ENVIOS U-ENVIOS. ELITE_CO Elite Express. ROCHE_INTERNAL_SFTP Roche Internal Courier. DBSCHENKER_ICELAND DB Schenker Iceland. TNT_FR_REFERENCE TNT France Reference. NEWGISTICSAPI Newgistics API. GLOVO Glovo. GWLOGIS_API G.I.G. SPREETAIL_API Spreetail. MOOVA Moova. PLYCONGROUP Plycon Transportation Group. USPS_WEBHOOK USPS Informed Visibility - Webhook. REIMAGINEDELIVERY maergo. EDF_FTP Eurodifarm. DAO365 DAO365. BIOCAIR_FTP BioCair. RANSA_WEBHOOK Ransa. SHIPXPRES SHIPXPRESS. COURANT_PLUS_API Courant Plus. SHIPA SHIPA. HOMELOGISTICS Home Logistics. DX DX. POSTE_ITALIANE_PACCOCELERE Poste Italiane Paccocelere. TOLL_WEBHOOK Toll Group. LCTBR_API LCT do Brasil. DX_FREIGHT DX Freight. DHL_SFTP DHL Express. SHIPROCKET Shiprocket X. UBER_WEBHOOK Uber. STATOVERNIGHT Stat Overnight. BURD Burd Delivery. FASTSHIP Fastship Express. IBVENTURE_WEBHOOK IB Venture. GATI_KWE_API Gati-KWE. CRYOPDP_FTP CryoPDP. HUBBED HUBBED. TIPSA_API Tipsa API. ARASKARGO Aras Cargo. THIJS_NL Thijs Logistiek. ATSHEALTHCARE_REFERENCE ATS Healthcare. 99MINUTOS 99minutos. HELLENIC_POST Hellenic (Greece) Post. HSM_GLOBAL HSM Global. MNX MNX. NMTRANSFER N&M Transfer Co., Inc.. LOGYSTO Logysto. INDIA_POST_INT India Post International. AMAZON_FBA_SWISHIP_IN Swiship IN. SRT_TRANSPORT SRT Transport. BOMI Bomi Group. DELIVERR_SFTP Deliverr. HSDEXPRESS HSDEXPRESS. SIMPLETIRE_WEBHOOK SimpleTire. HUNTER_EXPRESS_SFTP Hunter Express. UPS_API UPS. WOOYOUNG_LOGISTICS_SFTP WOO YOUNG LOGISTICS CO.,LTD.. PHSE_API PHSE. WISH_EMAIL_PUSH Wish. NORTHLINE Northline. MEDAFRICA Med Africa Logistics. DPD_AT_SFTP DPD Austria. ANTERAJA Anteraja. DHL_GLOBAL_FORWARDING_API DHL Global Forwarding API. LBCEXPRESS_API LBC EXPRESS INC.. SIMSGLOBAL Sims Global. CDLDELIVERS CDL Last Mile. TYP TYP. TESTING_COURIER_WEBHOOK Testing Courier. PANDAGO_API Pandago. ROYAL_MAIL_FTP Royal Mail. THUNDEREXPRESS Thunder Express Australia. SECRETLAB_WEBHOOK Secretlab. SETEL Setel Express. JD_WORLDWIDE JD Worldwide. DPD_RU_API DPD Russia. ARGENTS_WEBHOOK Argents Express Group. POSTONE Post ONE. TUSKLOGISTICS Tusk Logistics. RHENUS_UK_API Rhenus Logistics UK. TAQBIN_SG_API Yamato Singapore. INNTRALOG_SFTP Inntralog GmbH. DAYROSS Day & Ross. CORREOSEXPRESS_API Correos Express (API). INTERNATIONAL_SEUR_API International Seur API. YODEL_API Yodel API. HEROEXPRESS Hero Express. DHL_SUPPLYCHAIN_IN DHL supply chain India. URGENT_CARGUS Urgent Cargus. FRONTDOORCORP FRONTdoor Collective. JTEXPRESS_PH J&T Express Philippines. PARCELSTARS_WEBHOOK Parcelstars. DPD_SK_SFTP DPD Slovakia. MOVIANTO Movianto. OZEPARTS_SHIPPING Ozeparts Shipping. KARGOMKOLAY KargomKolay (CargoMini). TRUNKRS Trunkrs. OMNIRPS_WEBHOOK Omni Returns. CHILEXPRESS Chile Express. TESTING_COURIER Testing Courier. JNE_API JNE (API). BJSHOMEDELIVERY_FTP BJS Distribution, Storage & Couriers - FTP. DEXPRESS_WEBHOOK D Express. USPS_API USPS API. TRANSVIRTUAL TransVirtual. SOLISTICA_API solistica. CHIENVENTURE_WEBHOOK Chienventure. DPD_UK_SFTP DPD UK. INPOST_UK InPost. JAVIT Javit. ZTO_DOMESTIC ZTO Express China. DHL_GT_API DHL Global Forwarding Guatemala. CEVA_TRACKING CEVA Package. KOMON_EXPRESS Komon Express. EASTWESTCOURIER_FTP East West Courier Pte Ltd. DANNIAO Danniao. SPECTRAN Spectran. DELIVER_IT Deliver-iT. RELAISCOLIS Relais Colis. GLS_SPAIN_API GLS Spain. POSTPLUS PostPlus. AIRTERRA Airterra. GIO_ECOURIER_API GIO Express Ecourier. DPD_CH_SFTP DPD Switzerland. FEDEX_API FedEx®. INTERSMARTTRANS INTERSMARTTRANS & SOLUTIONS SL. HERMES_UK_SFTP Hermes UK. EXELOT_FTP Exelot Ltd.. DHL_PA_API DHL GLOBAL FORWARDING PANAMÁ. VIRTRANSPORT_SFTP Vir Transport. WORLDNET Worldnet Logistics. INSTABOX_WEBHOOK Instabox. KNG Keuhne + Nagel Global. FLASHEXPRESS_WEBHOOK Flash Express. MAGYAR_POSTA_API Magyar Posta. WESHIP_API WeShip. OHI_WEBHOOK Ohi. MUDITA MUDITA. BLUEDART_API Bluedart. T_CAT_API T-cat. ADS ADS Express. HERMES_IT HR Parcel. FITZMARK_API FitzMark. POSTI_API Posti API. SMSA_EXPRESS_WEBHOOK SMSA Express. TAMERGROUP_WEBHOOK Tamer Logistics. LIVRAPIDE Livrapide. NIPPON_EXPRESS Nippon Express. BETTERTRUCKS Better Trucks. FAN FAN COURIER EXPRESS. PB_USPSFLATS_FTP USPS Flats (Pitney Bowes). PARCELRIGHT Parcel Right. ITHINKLOGISTICS iThink Logistics. KERRY_EXPRESS_TH_WEBHOOK Kerry Logistics. ECOUTIER eCoutier. SHOWL SENHONG INTERNATIONAL LOGISTICS. BRT_IT_API BRT Bartolini API. RIXONHK_API Rixon Logistics. DBSCHENKER_API DB Schenker. ILYANGLOGIS Ilyang logistics. MAIL_BOX_ETC Mail Boxes Etc.. WESHIP WeShip. DHL_GLOBAL_MAIL_API DHL eCommerce Solutions. ACTIVOS24_API Activos24. ATSHEALTHCARE ATS Healthcare. LUWJISTIK Luwjistik. GW_WORLD Gebrüder Weiss. FAIRSENDEN_API fairsenden. SERVIP_WEBHOOK SerVIP. SWISHIP Swiship. TANET Transport Ambientales. HOTSIN_CARGO SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD. DIREX Direx. HUANTONG HuanTong. IMILE_API iMile. AUEXPRESS Au Express. NYTLOGISTICS NYT SUPPLY CHAIN LOGISTICS Co.,LTD. DSV_REFERENCE DSV Futurewave. NOVOFARMA_WEBHOOK Novofarma. AITWORLDWIDE_SFTP AIT. SHOPOLIVE Olive. FNF_ZA Fast & Furious. DHL_ECOMMERCE_GC DHL eCommerce Greater China. FETCHR Fetchr. STARLINKS_API Starlinks Global. YYEXPRESS YYEXPRESS. SERVIENTREGA Servientrega. HANJIN HanJin. SPANISH_SEUR_FTP Spanish Seur. DX_B2B_CONNUM DX (B2B). HELTHJEM_API Helthjem. INEXPOST Inexpost. A2B_BA A2B Express Logistics. RHENUS_GROUP Rhenus Logistics. SBERLOGISTICS_RU Sber Logistics. MALCA_AMIT Malca-Amit. PPL Professional Parcel Logistics. OSM_WORLDWIDE_SFTP OSM Worldwide. ACILOGISTIX ACI Logistix. OPTIMACOURIER Optima Courier. NOVA_POSHTA_API Nova Poshta API. LOGGI Loggi. YIFAN YiFan Express. MYDYNALOGIC My DynaLogic. MORNINGLOBAL Morning Global. CONCISE_API Concise. FXTRAN Falcon Express. DELIVERYOURPARCEL_ZA Deliver Your Parcel. UPARCEL uParcel. MOBI_BR Mobi Logistica. LOGINEXT_WEBHOOK T&W Delivery. EMS EMS. SPEEDY Speedy. ZOOM_RED Zoom. NAVLUNGO Navlungo. CASTLEPARCELS Castle Parcels. WEEE Weee. PACKALY Packaly. YUNHUIPOST Yunhuipost. YOUPARCEL YouParcel. LEMAN Leman. MOOVIN Moovin. URB_IT Urb-it. MULTIENTREGAPANAMA Multientrega. JUSDASR Jusdasr. DISCOUNTPOST Discount Post. RHENUS_UK Rhenus Logistics UK. SWISHIP_JP Swiship JP. GLS_US GLS USA. SMTL Southwestern Motor Transport. Inc. EMEGA Discount Post Emega. EXPRESSONE_SV EXPRESSONE Slovenia. HEPSIJET hepsiJET. WELIVERY Welivery. BRINGER Bringer Parcel Services. EASYROUTES EasyRoutes. MRW MRW. RPM RPM. DPD_PRT DPD Portugal. GLS_ROMANIA GLS Romania. LMPARCEL LM Parcel. GTAGSM GTA GSM. DOMINO DOMINO. ESHIPPER eShipper. TRANSPAK Transpak Inc.. XINDUS Xindus. AOYUE Aoyue. EASYPARCEL Easyparcel. EXPRESSONE EXPRESSONE. SENDEO_KARGO Sendeo Kargo. SPEEDAF Speedaf Express. ETOWER eTower. GCX GC Express. NINJAVAN_VN Ninjavan Vietnam. ALLEGRO Allegro. JUMPPOINT Jumppoint. SHIPGLOBAL_US ShipGlobal. KINISI Kinisi Transport Pty Ltd. OAKH Oakh Harbour Freight Lines. AWEST American West. BARSAN Barsan Global Lojistik. ENERGOLOGISTIC Energo Logistic. MADROOEX Madrooex. GOBOLT GoBolt. SWISS_UNIVERSAL_EXPRESS Swiss Universal Express. IORDIRECT IOR Direct Solutions. XMSZM xmszm. GLS_HUN GLS Hungary. SENDY Sendy Express. BRAUNSEXPRESS Brauns Express. GRANDSLAMEXPRESS Grand Slam Express. XGS XGS. OTSCHILE OTS. PACK_UP Pack-Up. PARCELSTARS Parcelstars. TEAMEXPRESSLLC Team Express Service LLC. ASYADEXPRESS Asyad Express. TDN TDN. EARLYBIRD Early Bird. CACESA Cacesa. PARCELJET Parceljet. MNG_KARGO MNG Kargo. SUPERPACKLINE Super Pac Line. SPEEDX SpeedX. VESYL Vesyl. SKYKING Sky King. DIRMENSAJERIA DIR. NETLOGIXGROUP Netlogix. ZYOU ZYEX. JAWAR Jawar. AGSYSTEMS Associate Global Systems. GPS GPS. PTT_KARGO PTT Kargo. MAERGO Maergo. ARIHANTCOURIER AICS. VTFE VicTas Freight Express. YUNANT Yunant. URBIFY Urbify. PACK_MAN pack-man. LIEFERGRUN LIEFERGRUN. OBIBOX Obibox. PAIKEDA Paikeda. SCOTTY Scotty. INTELCOM_CA Intelcom. SWE swe. ASENDIA Asendia Global. DPD_AT DPD Austria. RELAY Relay. ATA ATA. SKYEXPRESS_INTERNATIONAL SkyExpress Internationals. SURAT_KARGO Surat Kargo. SGLINK SG LINK. FLEETOPTICSINC FleetOptics. SHOPLINE shopline. PIGGYSHIP PIGGYSHIP. LOGOIX LogoiX. KOLAY_GELSIN Kolay Gelsin. ASSOCIATED_COURIERS Associated Couriers. UPS_CHECKER ups-checker. WINESHIPPING Wineshipping. SPEDISCI Spedisci online. FOURKITES Fourkites. ETONAS Etonas. FINMILE Fin Mile. UNIUNI Uniuni. RODONAVES Rodonaves. INPOST_IT Inpost Italy. TFORCE_FREIGHT Tforce Freight. RICHMOM Rich Mom. FRANCO Corriere Franco. ECPARCEL Ecparcel. FEDEX_CHINA Fedex China. GOFO_EXPRESS Gofo Express. SHIPBOB Shipbob. JERSEYPOST_ATLAS Jersey Post Group. CORETRAILS Coretrails. RHENUS_ITALY Rhenus Logistics Italy. JADLOG Jadlog. JITSU Jitsu. YANWEN_EXPRESS Yanwen Express. DASHLINK Dashlink. SEINO_SUPER_EXPRESS Seino Super Express. FLOSHIP Floship. METROSCG Metro Supply Chain. SENDPARCEL Sendparcel. P2P P2p. CN_EXPRESS Cn Express. CIRROTRACK Cirro Track. LAND_LOGISTICS Land Logistics. VEHO Veho. MEDLINE Medline. VDTRACK Vdtrack. SINO_SCM Sino Scm. 3PE_EXPRESS 3pe Express. SWIFTX Swiftx. SFYDEXPRESS Sfyd Express. TOPTRANS Toptrans. capture_id required string [ 1 .. 50 ] characters The PayPal capture ID.
notify_payer
boolean
Default: false
If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for notify_payer, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.
items
Array of objects
An array of details of items in the shipment.
CopyExpand allCollapse all { "tracking_number": "string", "carrier_name_other": "string", "carrier": "DPD_RU", "capture_id": "string", "notify_payer": false, "items": [ { "name": "string", "quantity": "string", "sku": "string", "url": "http://example.com", "image_url": "http://example.com", "upc": { "type": "UPC-A", "code": "string" } } ] } tracking_number_type The tracking number type.
string [ 1 .. 64 ] characters ^[0-9A-Z_]+$ The tracking number type.
Enum Value Description CARRIER_PROVIDED A carrier-provided tracking number. E2E_PARTNER_PROVIDED A marketplace-provided tracking number. Copy "CARRIER_PROVIDED" tracking_status The status of the item shipment. For allowed values, see Shipping Statuses.
string [ 1 .. 64 ] characters ^[0-9A-Z_]+$ The status of the item shipment. For allowed values, see Shipping Statuses.
Enum Value Description CANCELLED The shipment was cancelled and the tracking number no longer applies. DELIVERED The item was already delivered when the tracking number was uploaded. LOCAL_PICKUP Either the buyer physically picked up the item or the seller delivered the item in person without involving any couriers or postal companies. ON_HOLD The item is on hold. Its shipment was temporarily stopped due to bad weather, a strike, customs, or another reason. SHIPPED The item was shipped and is on the way. Copy "CANCELLED" trustly Information needed to pay using Trustly.
name
string [ 3 .. 300 ] characters
The name of the account holder associated with this payment method.
country_code
string = 2 characters ^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code.
email
string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern
The email address of the account holder associated with this payment method.
bic string [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...Show pattern The bank identification code (BIC).
iban_last_chars string [ 4 .. 34 ] characters ^.[a-zA-Z0-9]{4}.$ The last characters of the IBAN used to pay.
Copy { "name": "string", "country_code": "string", "email": "string", "bic": "string", "iban_last_chars": "string" } trustly_request Information needed to pay using Trustly.
name required string [ 3 .. 300 ] characters The name of the account holder associated with this payment method.
country_code required string = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 country code.
email required string [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:.[A-Za...Show pattern The email address of the account holder associated with this payment method.
experience_context
object
Customizes the payer experience during the approval process for the payment.
CopyExpand allCollapse all { "name": "string", "country_code": "string", "email": "string", "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "locale": "string", "return_url": "string", "cancel_url": "string" } } universal_product_code The Universal Product Code of the item.
type required string [ 1 .. 5 ] characters ^[0-9A-Z_-]+$ The Universal Product Code type.
Enum Value Description UPC-A N/A UPC-B N/A UPC-C N/A UPC-D N/A UPC-E N/A UPC-2 N/A UPC-5 N/A code required string [ 6 .. 17 ] characters The UPC product code of the item.
Copy { "type": "UPC-A", "code": "string" } url Describes the URL.
string (url) Describes the URL.
Copy "http://example.com" v3_vault_instruction_base Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.
store_in_vault required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Defines how and when the payment source gets vaulted.
Value Description ON_SUCCESS Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. Copy { "store_in_vault": "ON_SUCCESS" } vault_id The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
string [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$ The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
Copy "string" vault_instruction_base Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.
store_in_vault
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Defines how and when the payment source gets vaulted.
Value Description ON_SUCCESS Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. Copy { "store_in_vault": "ON_SUCCESS" } vault_paypal_wallet_base Resource consolidating common request and response attributes for vaulting PayPal Wallet.
store_in_vault
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Defines how and when the payment source gets vaulted.
Value Description ON_SUCCESS Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. description string [ 1 .. 128 ] characters The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.
usage_pattern
string [ 1 .. 30 ] characters
Expected business/pricing model for the billing agreement.
Enum Value Description IMMEDIATE On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency. DEFERRED Pay after use, non-recurring post-paid, variable amount, irregular frequency. RECURRING_PREPAID Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. RECURRING_POSTPAID Pay on a fixed date based on usage or consumption after the goods/service is delivered. THRESHOLD_PREPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. THRESHOLD_POSTPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. SUBSCRIPTION_PREPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered. SUBSCRIPTION_POSTPAID Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered. UNSCHEDULED_PREPAID Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans. UNSCHEDULED_POSTPAID Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans. INSTALLMENT_PREPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered. INSTALLMENT_POSTPAID Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered. usage_type required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The usage type associated with the PayPal payment token.
Enum Value Description
MERCHANT The PayPal Payment Token will be used for future transaction directly with a merchant.
PLATFORM The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants.
customer_type
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Default: "CONSUMER"
The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
Enum Value Description
CONSUMER The customer vaulting the PayPal payment token is a consumer on the merchant / platform.
BUSINESS The customer vaulting the PayPal payment token is a business on merchant / platform.
permit_multiple_payment_tokens
boolean
Default: false
Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.
Copy { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } vault_response The details about a saved payment source.
id
string [ 1 .. 255 ] characters
The PayPal-generated ID for the saved payment source.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.
Enum Value Description
VAULTED The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.
CREATED DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.
APPROVED Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault
links
Array of objects [ 1 .. 10 ] items
An array of request-related HATEOAS links.
CopyExpand allCollapse all { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ] } vault_response The details about a saved payment source.
id
string [ 1 .. 255 ] characters
The PayPal-generated ID for the saved payment source.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.
Enum Value Description
VAULTED The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.
CREATED DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.
APPROVED Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault
links
Array of objects [ 1 .. 10 ] items
An array of request-related HATEOAS links.
CopyExpand allCollapse all { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ] } vault_response The details about a saved payment source.
id
string [ 1 .. 255 ] characters
The PayPal-generated ID for the saved payment source.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.
Enum Value Description
VAULTED The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.
CREATED DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.
APPROVED Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault
links
Array of objects [ 1 .. 10 ] items
An array of request-related HATEOAS links.
customer
object
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
CopyExpand allCollapse all { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "name": { "given_name": "string", "surname": "string" } } } vault_response The details about a saved payment source.
id
string [ 1 .. 255 ] characters
The PayPal-generated ID for the saved payment source.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.
Enum Value Description
VAULTED The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.
CREATED DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.
APPROVED Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault
links
Array of objects [ 1 .. 10 ] items
An array of request-related HATEOAS links.
CopyExpand allCollapse all { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ] } vault_Venmo_wallet_base Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.
store_in_vault required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Defines how and when the payment source gets vaulted.
Value Description ON_SUCCESS Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. description string [ 1 .. 128 ] characters The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com.
usage_pattern
string [ 1 .. 30 ] characters ^[0-9A-Z_]+$
Expected business/pricing model for the billing agreement.
Enum Value Description IMMEDIATE On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency. DEFERRED Pay after use, non-recurring post-paid, variable amount, irregular frequency. RECURRING_PREPAID Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. RECURRING_POSTPAID Pay on a fixed date based on usage or consumption after the goods/service is delivered. THRESHOLD_PREPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. THRESHOLD_POSTPAID Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. usage_type required string [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The usage type associated with the Venmo payment token.
Enum Value Description
MERCHANT The Venmo Payment Token will be used for future transaction directly with a merchant.
PLATFORM The Venmo Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants.
customer_type
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
Default: "CONSUMER"
The customer type associated with the Venmo payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
Enum Value Description
CONSUMER The customer vaulting the Venmo payment token is a consumer on the merchant / platform.
BUSINESS The customer vaulting the Venmo payment token is a business on merchant / platform.
permit_multiple_payment_tokens
boolean
Default: false
Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same Venmo account.
Copy { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } venmo_vault_response The details about a saved venmo payment source.
id
string [ 1 .. 255 ] characters
The PayPal-generated ID for the saved payment source.
status
string [ 1 .. 255 ] characters ^[0-9A-Z_]+$
The vault status.
Enum Value Description
VAULTED The payment source has been saved in your customer's vault. This vault status reflects /v3/vault status.
CREATED DEPRECATED. The payment source has been saved in your customer's vault. This status applies to deprecated integration patterns and will not be returned for v3/vault integrations.
APPROVED Customer has approved the action of saving the specified payment_source into their vault. Use v3/vault/payment-tokens with given setup_token to save the payment source in the vault
links
Array of objects [ 1 .. 10 ] items
An array of request-related HATEOAS links.
customer
object
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
CopyExpand allCollapse all { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } } } venmo_wallet_attributes Additional attributes associated with the use of this Venmo Wallet.
customer
object
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
vault
object
Attributes used to provide the instructions during vaulting of the Venmo Wallet.
CopyExpand allCollapse all { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } venmo_wallet_attributes_response Additional attributes associated with the use of a Venmo Wallet.
vault
object
The details about a saved venmo payment source.
CopyExpand allCollapse all { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } } } } venmo_wallet_customer This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.
id
string [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.
phone
object
The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.
name
object
The full name of the customer as provided to the merchant or on file with the merchant.
CopyExpand allCollapse all { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } } venmo_wallet_experience_context Customizes the buyer experience during the approval process for payment with Venmo.
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.
brand_name
string [ 1 .. 127 ] characters
The business name of the merchant. The pattern is defined by an external party and supports Unicode.
shipping_preference string [ 1 .. 24 ] characters Default: "GET_FROM_FILE" The location from which the shipping address is derived.
Enum Value Description GET_FROM_FILE Get the customer-provided shipping address on the PayPal site. NO_SHIPPING Redacts the shipping address from the PayPal site. Recommended for digital goods. SET_PROVIDED_ADDRESS Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages. user_action string [ 1 .. 8 ] characters Default: "CONTINUE" Configures a Continue or Pay Now checkout flow.
Enum Value Description
CONTINUE After you redirect the customer to the Venmo payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.
PAY_NOW After you redirect the customer to the Venmo payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.
order_update_callback_config
object
Merchant provided Order Update callback configuration for Venmo Wallet.Venmo will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
CopyExpand allCollapse all { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } } venmo_wallet_request Information needed to pay using Venmo.
experience_context
object
Customizes the buyer experience during the approval process for payment with Venmo.
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.
vault_id
string [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the saved Venmo wallet payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of the payer.
attributes
object
Additional attributes associated with the use of this wallet.
CopyExpand allCollapse all { "experience_context": { "brand_name": "string", "shipping_preference": "GET_FROM_FILE", "user_action": "CONTINUE", "order_update_callback_config": { "callback_events": [ "string" ], "callback_url": "http://example.com" } }, "vault_id": "string", "email_address": "string", "attributes": { "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } }, "vault": { "store_in_vault": "ON_SUCCESS", "description": "string", "usage_pattern": "IMMEDIATE", "usage_type": "MERCHANT", "customer_type": "CONSUMER", "permit_multiple_payment_tokens": false } } } venmo_wallet_response Venmo wallet response.
user_name
string [ 1 .. 50 ] characters
The Venmo user name chosen by the user, also know as a Venmo handle.
return_flow string [ 1 .. 6 ] characters Default: "AUTO" Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the Venmo App.
Enum Value Description
AUTO After payment approval in the PayPal App, buyer will automatically be redirected to the merchant website.
MANUAL After payment approval in the PayPal App, buyer will be asked to manually navigate back to the merchant website where they started the transaction from. The buyer is shown a message like 'Return to Merchant' to return to the source where the transaction actually started.
attributes
object
Additional attributes associated with the use of a Venmo Wallet.
email_address
string [ 3 .. 254 ] characters ^.(?:[a-zA-Z0-9!#$%&'+/=?^_`{|}~-]+(?:.[a-...Show pattern
The email address of the payer.
account_id
string = 13 characters ^[2-9A-HJ-NP-Z]{13}$
This is an immutable system-generated id for a user's Venmo account.
name
object
The name associated with the Venmo account. Supports only the given_name and surname properties.
phone_number
object
The phone number associated with the Venmo account, in its canonical international E.164 numbering plan format. Supports only the national_number property.
address object The address of the payer. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer.
CopyExpand allCollapse all { "user_name": "string", "return_flow": "AUTO", "attributes": { "vault": { "id": "string", "status": "VAULTED", "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": { }, "dependencies": { }, "items": { }, "definitions": { }, "patternProperties": { }, "properties": { }, "allOf": [ { } ], "anyOf": [ { } ], "oneOf": [ { } ], "not": { }, "links": [ { } ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ], "customer": { "id": "string", "email_address": "string", "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "name": { "given_name": "string", "surname": "string" } } } }, "email_address": "string", "account_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone_number": { "national_number": "string" }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }
Country and region address requirements The Orders v2 REST API supports many countries for PayPal account payments if you have a business account. Depending on the country or region, a city or postal code may be required to validate an address.
For general country-specific offerings and limitations, see PayPal Offerings Worldwide and visit your country-specific site.
The Orders v2 REST API supports these countries:
Country or region Country or region code City Postal code Afghanistan AF Required Optional Aland Islands AX Required Optional Albania AL Required Optional Algeria DZ Required Optional American Samoa AS Required Optional Andorra AD Required Optional Angola AO Required Optional Anguilla AI Required Optional Antarctica AQ Required Optional Antigua and Barbuda AG Required Optional Argentina AR Required Required Armenia AM Required Optional Aruba AW Required Optional Australia AU Required Required Austria AT Required Required Azerbaijan AZ Required Optional Bahamas BS Required Optional Bahrain BH Required Optional Bangladesh BD Required Optional Barbados BB Required Optional Belarus BY Required Optional Belgium BE Required Optional Belize BZ Required Optional Benin BJ Required Optional Bermuda BM Required Optional Bhutan BT Required Required Bolivia BO Required Optional Bosnia and Herzegovina BA Required Optional Botswana BW Required Optional Bouvet Island BV Required Optional Brazil BR Required Required British Indian Ocean Territory IO Required Optional Brunei Darussalam BN Required Optional Bulgaria BG Required Optional Burkina Faso BF Required Optional Burundi BI Required Optional Cambodia KH Required Optional Cameroon CM Required Optional Canada CA Required Required Cape Verde Escudo CV Required Optional Cayman Islands KY Required Optional Central African Republic CF Required Optional Chad TD Required Optional Chile CL Required Optional China C2 Required Required China CN Required Required Christmas Island CX Required Optional Cocos Islands CC Required Required Colombia CO Required Optional Comoros KM Required Required Congo Democratic Republic CD Required Optional Congo Democratic Republic ZR Required Optional Congo Republic CG Required Optional Cook Islands CK Required Optional Costa Rica CR Required Optional Cote Divoire CI Required Optional Croatia HR Required Optional Cuba CU Required Optional Cyprus CY Required Optional Czech Republic CZ Required Optional Denmark DK Required Required Djibouti DJ Required Optional Dominica DM Required Optional Dominican Republic DO Required Optional East Timor TP Required Optional Ecuador EC Required Optional Egypt EG Required Optional El Salvador SV Required Optional Equatorial Guinea GQ Required Optional Eritrea ER Required Optional Estonia EE Required Optional Ethiopia ET Required Optional Falkland Islands FK Required Required Faroe Islands FO Required Required Federated States Of Micronesia FM Required Optional Fiji FJ Required Optional Finland FI Required Optional France FR Required Required French Guiana GF Required Optional French Polynesia PF Required Optional French Southern Territories TF Required Required Gabon Republic GA Required Optional Gambia GM Required Required Georgia Country GE Required Optional Germany DE Required Required Ghana GH Required Optional Gibraltar GI Required Optional Greece GR Required Optional Greenland GL Required Required Grenada GD Required Optional Guadeloupe GP Required Optional Guam GU Required Optional Guatemala GT Required Optional Guernsey GG Required Optional Guinea GN Required Optional Guinea Bissau GW Required Optional Guyana GY Required Optional Haiti HT Required Optional Heard and Mcdonald Islands HM Required Optional Honduras HN Required Optional Hong Kong HK Optional Optional Hungary HU Required Optional Iceland IS Required Optional India IN Required Optional Indonesia ID Required Optional Iran IR Required Optional Iraq IQ Required Optional Ireland IE Required Optional Isle of Man IM Required Optional Israel IL Required Optional Italy IT Required Required Jamaica JM Required Optional Japan JP Optional Required Jersey JE Required Optional Jordan JO Required Optional Kazakhstan KZ Required Optional Kenya KE Required Optional Kiribati KI Required Required Kuwait KW Required Optional Kyrgyzstan KG Required Required Laos LA Required Optional Latvia LV Required Optional Lebanon LB Required Optional Lesotho LS Required Optional Liberia LR Required Optional Libya LY Required Optional Liechtenstein LI Required Optional Lithuania LT Required Optional Luxembourg LU Required Optional Macau MO Required Optional Macedonia MK Required Optional Madagascar MG Required Optional Malawi MW Required Optional Malaysia MY Required Optional Maldives MV Required Optional Mali ML Required Optional Malta MT Required Optional Marshall Islands MH Required Optional Martinique MQ Required Optional Mauritania MR Required Required Mauritius MU Required Optional Mayotte YT Required Required Mexico MX Required Required Moldova MD Required Optional Monaco MC Required Optional Mongolia MN Required Optional Montenegro ME Required Optional Montserrat MS Required Optional Morocco MA Required Optional Mozambique MZ Required Optional Myanmar MM Required Optional Namibia NA Required Optional Nauru NR Required Required Nepal NP Required Optional Netherlands NL Required Required Netherlands Antilles AN Required Optional New Caledonia NC Required Optional New Zealand NZ Required Optional Nicaragua NI Required Optional Niger NE Required Required Nigeria NG Required Optional Niue NU Required Required Norfolk Island NF Required Required North Korea KP Required Optional Northern Mariana Islands MP Required Optional Norway NO Required Required Oman OM Required Optional Pakistan PK Required Optional Palau PW Required Optional Palestinian Territory Occupied PS Required Optional Panama PA Required Optional Papua New Guinea PG Required Optional Paraguay PY Required Optional Peru PE Required Optional Philippines PH Required Optional Pitcairn Islands PN Required Required Poland PL Required Required Portugal PT Required Optional Puerto Rico PR Required Optional Qatar QA Required Optional Reunion RE Required Optional Romania RO Required Optional Russia RU Required Optional Rwanda RW Required Optional Samoa WS Required Optional San Marino SM Required Required Sao Tome and Principe ST Required Optional Saudi Arabia SA Required Optional Senegal SN Required Optional Serbia RS Required Optional Serbia and Montenegro CS Required Optional Seychelles SC Required Optional Sierra Leone SL Required Optional Singapore SG Optional Required Slovakia SK Required Optional Slovenia SI Required Optional Solomon Islands SB Required Optional Somalia SO Required Optional South Africa ZA Required Optional South Georgia and the South Sandwich Islands GS Required Optional South Korea KR Required Optional Spain ES Required Required Sri Lanka LK Required Optional St Helena SH Required Required St Kitts and Nevis KN Required Optional St Lucia LC Required Optional St Pierre and Miquelon PM Required Required St Vincent and the Grenadines VC Required Optional Sudan SD Required Optional Suriname SR Required Required Svalbard and Jan Mayen Islands SJ Required Required Swaziland SZ Required Optional Sweden SE Required Required Switzerland CH Required Required Syria SY Required Optional Taiwan TW Required Optional Tajikistan TJ Required Optional Tanzania TZ Required Optional Thailand TH Required Required Timor Leste TL Required Optional Togo TG Required Optional Tokelau TK Required Required Tonga TO Required Optional Trinidad and Tobago TT Required Optional Tunisia TN Required Optional Turkey TR Required Optional Turkmenistan TM Required Optional Turks and Caicos Islands TC Required Optional Tuvalu TV Required Required Uganda UG Required Optional Ukraine UA Required Optional United Arab Emirates AE Required Optional United Kingdom GB Required Required United States US Required Required Uruguay UY Required Optional US Minor Outlying Islands UM Required Required Uzbekistan UZ Required Optional Vanuatu VU Required Optional Vatican City State VA Required Required Venezuela VE Required Optional Viet Nam VN Required Optional Virgin Islands British VG Required Optional Virgin Islands USA VI Required Optional Wallis and Futuna Islands WF Required Required Western Sahara EH Required Required Yemen YE Required Optional Yugoslavia YU Required Optional Zambia ZM Required Optional Zimbabwe ZW Required Optional
Orders v2 errors Errors are listed by endpoint and then by error name.
Get order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
RESOURCE_NOT_FOUND
The specified resource does not exist.
INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
INVALID_ACCOUNT_STATUS: Account validations failed for the user.
Create order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
RESOURCE_CONFLICT
The server has detected a conflict while processing this request.
PREVIOUS_REQUEST_IN_PROGRESS: A previous request on this resource is currently in progress. Please wait for some time and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
INVALID_ARRAY_MAX_ITEMS: The number of items in an array parameter is too large.
Possible error locations:
/purchase_units
/purchase_units/0/shipping/options
INVALID_ARRAY_MIN_ITEMS: The number of items in an array parameter is too small.
Possible error locations:
/purchase_units
INVALID_COUNTRY_CODE: Country code is invalid. Please refer to https://developer.paypal.com/api/rest/reference/country-codes/ for a list of supported country codes.
Possible error locations:
payer/address/country_code
purchase_units/0/shipping/address/country_code
payment_source/card/billing_address/country_code
payment_source/ideal/country_code
payment_source/bancomatpay/country_code
/payment_source/mbway/country_code
/payment_source/bizum/country_code
INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
Possible error locations:
application_context/locale
payer/address/country_code
payer/birth_date
payer/email_address
payer/payer_id
payer/phone/phone_number/country_code
payer/phone/phone_number/extension_number
payer/phone/phone_number/national_number
/payment_source/twint/country_code
purchase_units/0/amount/breakdown/handling/value
purchase_units/0/amount/breakdown/item_total/value
purchase_units/0/amount/breakdown/shipping/value
purchase_units/0/amount/breakdown/shipping_discount/value
purchase_units/0/amount/breakdown/discount/value
purchase_units/0/amount/breakdown/tax_total/value
purchase_units/0/amount/value
purchase_units/0/items/0/tax/value
purchase_units/0/items/1/unit_amount/value
purchase_units/0/payee/display_data/business_email
purchase_units/0/payee/email_address
purchase_units/0/payee/merchant_id
purchase_units/0/shipping/address/country_code
payment_source/paypal/experience_context/app_switch_preference/app_url
INVALID_STRING_LENGTH: The value of a field is either too short or too long
Possible error locations:
application_context/brand_name
application_context/locale
payer/address/admin_area1
payer/address/admin_area2
payer/address/address_line1
payer/address/address_line2
payer/address/country_code
payer/address/postal_code
payer/birth_date
payer/email_address
payer/external_id
payer/name/given_name
payer/name/surname
payer/payer_id
payer/phone/phone_number/country_code
payer/phone/phone_number/extension_number
payer/phone/phone_number/national_number
payer/tax_info/tax_id
purchase_units/0/amount/currency_code
purchase_units/0/custom_id
purchase_units/0/description
purchase_units/0/invoice_id
purchase_units/0/items/0/description
purchase_units/0/items/0/name
purchase_units/0/items/0/sku
purchase_units/0/items/0/tax/currency_code
purchase_units/0/items/0/unit_amount/currency_code
purchase_units/0/payee/display_data/business_email
purchase_units/0/payee/email_address
purchase_units/0/payee/merchant_id
purchase_units/0/payment_instruction/payee_pricing_tier_id
purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
purchase_units/0/reference_id
purchase_units/0/shipping/address/address_line1
purchase_units/0/shipping/address/address_line2
purchase_units/0/shipping/address/admin_area1
purchase_units/0/shipping/address/admin_area2
purchase_units/0/shipping/address/country_code
purchase_units/0/shipping/address/postal_code
purchase_units/0/soft_descriptor
/purchase_units/0/shipping/options/0/id
/purchase_units/0/shipping/options/0/label
payment_source/token/id
payment_source/card/billing_address/country_code
payment_source/google_pay/decrypted_token/cryptogram
payment_source/google_pay/decrypted_token/eci_indicator
payment_source/paypal/experience_context/app_switch_preference/os_type
payment_source/paypal/experience_context/app_switch_preference/os_version
INVALID_PARAMETER_VALUE: A parameter value is not valid.
Possible error locations:
application_context/landing_page
application_context/locale
application_context/shipping_preference
application_context/user_action
intent
payer/phone/phone_type
payer/tax_info/tax_id_type
prefer
purchase_units/0/items/0/category
payment_source/token/type
payment_source/google_pay/decrypted_token/message_id
payment_source/google_pay/decrypted_token/message_expiration
payment_source/google_pay/decrypted_token/payment_method
payment_source/google_pay/decrypted_token/authentication_method
payment_source/google_pay/decrypted_token/card
payment_source/paypal/experience_context/app_switch_preference/os_type
MISSING_REQUIRED_PARAMETER: A required parameter is missing.
Possible error locations:
intent
purchase_units
purchase_units/0/amount
purchase_units/0/amount/value
purchase_units/0/amount/currency_code
/purchase_units/0/shipping/options/0/id
/purchase_units/0/shipping/options/0/label
/purchase_units/0/shipping/options/0/selected
payment_source/token/id
payment_source/token/type
payment_source/card/expiry
payment_source/google_pay/decrypted_token/message_id
payment_source/google_pay/decrypted_token/message_expiration
payment_source/google_pay/decrypted_token/payment_method
payment_source/google_pay/decrypted_token/authentication_method
payment_source/google_pay/decrypted_token/card
payment_source/google_pay/decrypted_token/card/number
payment_source/google_pay/decrypted_token/card/expiry
/payment_source/card/network_token/number
/payment_source/card/network_token/expiry
/payment_source/bancontact/attributes/mandate
/payment_source/bancontact/attributes/mandate/type
/payment_source/bancontact/attributes/customer
/payment_source/bancontact/attributes/customer/id
/payment_source/bizum/name
/payment_source/bizum/name/full_name
/payment_source/bizum/country_code
/payment_source/ideal/attributes/mandate
/payment_source/ideal/attributes/mandate/type
/payment_source/ideal/attributes/customer
/payment_source/ideal/attributes/customer/id
/payment_source/paypal/attributes/vault/owner_id
/payment_source/bank/sepa_debit/attributes/vault/store_in_vault
/payment_source/trustly/email
/payment_source/twint/name
/payment_source/twint/country_code
NOT_SUPPORTED: This field is not currently supported.
Possible error locations:
payer/address/admin_area3
payer/address/admin_area4
payer/address/address_details/building_name
payer/address/address_details/delivery_service
payer/address/address_details/street_name
payer/address/address_details/street_number
payer/address/address_details/street_type
payer/address/address_details/sub_building
payer/address/address_line3
payer/name/alternate_full_name
payer/name/middle_name
payer/name/prefix
payer/name/suffix
payer/phone/phone_number/country_code
payer/phone/phone_number/extension_number
purchase_units/0/shipping/address/address_details/building_name
purchase_units/0/shipping/address/address_details/delivery_service
purchase_units/0/shipping/address/address_details/street_name
purchase_units/0/shipping/address/address_details/street_number
purchase_units/0/shipping/address/address_details/street_type
purchase_units/0/shipping/address/address_details/sub_building
purchase_units/0/shipping/address/address_line3
purchase_units/0/shipping/address/admin_area3
purchase_units/0/shipping/address/admin_area4
purchase_units/0/shipping/name/alternate_full_name
purchase_units/0/shipping/name/given_name
purchase_units/0/shipping/name/middle_name
purchase_units/0/shipping/name/prefix
purchase_units/0/shipping/name/suffix
purchase_units/0/shipping/name/surname
PAYPAL_REQUEST_ID_REQUIRED: A PayPal-Request-Id is required if you are trying to process payment for an Order. Please specify a PayPal-Request-Id or Create the Order without a 'payment_source' specified.
MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
PERMISSION_DENIED_FOR_DONATION_ITEMS: The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
MALFORMED_REQUEST: MALFORMED_REQUEST
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
AMOUNT_MISMATCH: Should equal item_total + tax_total + shipping + handling + insurance - shipping_discount - discount.
INVALID_POSTAL_CODE: For vaulting with purchase, postal code (billing_address.postal_code) can only contain letters, numbers, spaces, and hyphens
INVALID_POSTAL_CODE_LENGTH: For vaulting with purchase, postal code (billing_address.postal_code) may contain no more than 9 letter or number characters
BILLING_AGREEMENTS_CANNOT_BE_USED_FOR_SUBSCRIPTIONS: Billing Agreements cannot be used for Subscription orders.
CANNOT_BE_NEGATIVE: Must be greater than or equal to 0. If the currency supports decimals, only two decimal place precision is supported.
CANNOT_BE_ZERO_OR_NEGATIVE: Must be greater than zero. If the currency supports decimals, only two decimal place precision is supported.
CARD_EXPIRED: The card is expired
MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
CITY_REQUIRED: The specified country requires a city (address.admin_area_2).
DECIMAL_PRECISION: If the currency supports decimals, only two decimal place precision is supported.
DONATION_ITEMS_NOT_SUPPORTED: If 'purchase_unit' has "DONATION" as the 'items.category' then the Order can at most have one purchase_unit. Multiple purchase_units are not supported if either of them have at least one items with category as "DONATION".
DUPLICATE_REFERENCE_ID: reference_id must be unique if multiple purchase_unit are provided.
INVALID_CURRENCY_CODE: Currency code is invalid or is not currently supported. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
INVALID_PAYER_ID: The payer ID is not valid.
ITEM_TOTAL_MISMATCH: Should equal sum of (unit_amount * quantity) across all items for a given purchase_unit.
ITEM_TOTAL_REQUIRED: If item details are specified (items.unit_amount and items.quantity) corresponding amount.breakdown.item_total is required.
MAX_VALUE_EXCEEDED: Should be less than or equal to 999999999999999.99.
PAYMENT_DENIED: PayPal has declined to process this transaction.
MISSING_PICKUP_ADDRESS: A pickup address(shipping.address) is required for the provided shipping.type.
Possible error locations:
/purchase_units/0/shipping/type
MULTI_CURRENCY_ORDER: Multiple differing values of currency_code are not supported. Entire Order request must have the same currency_code.
MULTIPLE_ITEM_CATEGORIES: For a given 'purchase_unit' the 'items.category' could be either "PHYSICAL_GOODS" and/or "DIGITAL_GOODS" or just "DONATION". 'items.category' as "DONATION" cannot be combined with items with either "PHYSICAL_GOODS" or "DIGITAL_GOODS".
MULTIPLE_SHIPPING_ADDRESS_NOT_SUPPORTED: Multiple shipping addresses are not supported.
MULTIPLE_SHIPPING_TYPE_NOT_SUPPORTED: Different shipping.type are not supported across purchase units nor within an individual item's shipping options.
PAYEE_ACCOUNT_INVALID: Payee account specified is invalid. Please check the payee.email_address or payee.merchant_id specified and try again. Ensure that either payee.merchant_id or payee.email_address is specified.
PAYEE_ACCOUNT_LOCKED_OR_CLOSED: The merchant account is locked or closed.
PAYEE_ACCOUNT_RESTRICTED: The merchant account is restricted.
PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
PAYEE_PRICING_TIER_ID_NOT_ENABLED: The API Caller is not enabled to process transactions by specifying a 'payee_pricing_tier_id'. Please work with your Account Manager to enable this option for your account.
Possible error locations:
/purchase_units/0/payment_instruction/payee_pricing_tier_id
/purchase_units//payment_instruction/payee_pricing_tier_id
INVALID_PAYEE_PRICING_TIER_ID: Please check the value specified or confirm with your Account Manager that the 'payee_pricing_tier_id' specified has been setup for the account.
Possible error locations:
/purchase_units/0/payment_instruction/payee_pricing_tier_id
/purchase_units//payment_instruction/payee_pricing_tier_id
UNSUPPORTED_PAYMENT_SOURCE_FOR_SUBSCRIPTIONS: The specified payment source is not supported for subscriptions. Only a vault_id or vault_setup_token with payment_source.card and payment_source.paypal are supported.
Possible error locations:
/payment_source
PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
Possible error locations:
/purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
/purchase_units//payment_instruction/payee_receivable_fx_rate_id
PAYEE_FX_RATE_ID_CURRENCY_MISMATCH: The specified FX Rate ID is for a currency that does not match with the currency of this request. Please specify a different FX Rate ID and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
Possible error locations:
/purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
/purchase_units//payment_instruction/payee_receivable_fx_rate_id
INVALID_FX_RATE_ID: The specific FX Rate ID is not valid. This could be either because we are not able to look up the FX Rate based on this ID or it could be because the ID belongs to another API Caller.
Possible error locations:
/purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
/purchase_units//payment_instruction/payee_receivable_fx_rate_id
PLATFORM_FEES_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying 'platform_fees'. Please work with your PayPal Account Manager to enable this option for your account.
Possible error locations:
/purchase_units/0/payment_instruction/platform_fees
/purchase_units//payment_instruction/platform_fees
INVALID_PLATFORM_FEES_ACCOUNT: The specified platform_fees payee account is either invalid or account setup is incomplete.Please work with your PayPal Account Manager to enable this option for your account.
Possible error locations:
/purchase_units/0/payment_instruction/platform_fees/0/payee
/purchase_units//payment_instruction/platform_fees/0/payee
INVALID_PLATFORM_FEES_AMOUNT: The platform_fees amount cannot be greater than order amount.
Possible error locations:
/purchase_units/0/payment_instruction/platform_fees/0/amount/value
/purchase_units//payment_instruction/platform_fees/0/value
POSTAL_CODE_REQUIRED: The specified country requires a postal code.
REFERENCE_ID_REQUIRED: 'reference_id' is required for each 'purchase_unit' if multiple 'purchase_unit' are provided.
SHIPPING_OPTIONS_NOT_SUPPORTED: Shipping options are not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
TAX_TOTAL_MISMATCH: Should equal sum of (tax * quantity) across all items for a given purchase_unit.
TAX_TOTAL_REQUIRED: If item details are specified (items.tax_total and items.quantity) corresponding amount.breakdown.tax_total is required.
UNSUPPORTED_INTENT: intent=AUTHORIZE is not supported for this operation. Only intent=CAPTURE is supported.
UNSUPPORTED_INTENT_FOR_KYC_INCOMPLETE_PAYEE: intent=AUTHORIZE is not supported due to payee's incomplete KYC, while their partner is enabled for Progressive Onboarding. Only intent=CAPTURE is supported.
UNSUPPORTED_PAYMENT_INSTRUCTION: You must provide the payment instruction when you capture an authorized payment for intent=AUTHORIZE. For details, see Capture authorization. For intent=CAPTURE, send the payment instruction when you create the order.
SHIPPING_TYPE_NOT_SUPPORTED_FOR_CLIENT: The API Caller account is not setup to be able to support a shipping.type=PICKUP_IN_PERSON. This feature is only supported for PayPal Complete Payments Platform for Platforms and Marketplaces.
UNSUPPORTED_SHIPPING_TYPE: The provided shipping.type is only supported for application_context.shipping_preference=SET_PROVIDED_ADDRESS or NO_SHIPPING.
Possible error locations:
/purchase_units/0/shipping/type
SHIPPING_OPTION_NOT_SELECTED: At least one of the shipping.option should be set to 'selected = true'.
MULTIPLE_SHIPPING_OPTION_SELECTED: Only one shipping.option can be set to 'selected = true'.
INVALID_SHIPPING_OPTION_ID: The items.shipping.options_ids[].id does not exist in purchase_units.shipping.options[]. Please ensure that all ids used in options_ids are first defined in purchase_units.shipping.options[].
Possible error locations:
/purchase_units/0/items/0/shipping/options_ids/0/id
INVALID_DELIVERY_ESTIMATE: The provided delivery_time_max must be greater than the delivery_time_min, and vice versa.
Possible error locations:
/purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_min
/purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_max
INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
MISSING_SHIPPING_CALL_BACK_CONFIGURATION: payment_source.paypal.experience_context.order_update_callback_config is mandatory for one or more shipping.options provided in the request.
MISSING_ITEM_SHIPPING_OPTIONS: All items in the purchase_unit must have options_ids defined if any item in the Order has item[].shipping.options_ids defined.
PREFERRED_SHIPPING_OPTION_AMOUNT_MISMATCH: The amount provided in the preferred shipping option should match the amount provided in amount breakdown
Possible error locations:
/purchase_units/0/shipping/options/0/amount/value
AGREEMENT_ALREADY_CANCELLED: The requested agreement is already canceled.
BILLING_AGREEMENT_NOT_FOUND: The requested Billing Agreement token was not found.
COMPLIANCE_VIOLATION: Transaction is declined due to compliance violation.
DOMESTIC_TRANSACTION_REQUIRED: This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
DUPLICATE_INVOICE_ID: Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
INSTRUMENT_DECLINED: The instrument presented was either declined by the processor or bank, or it can't be used for this payment.
MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED: You have exceeded the maximum number of payment attempts.
NOT_ENABLED_FOR_CARD_PROCESSING: The API Caller account is not setup to be able to process card payments. Please contact PayPal customer support.
PAYEE_BLOCKED_TRANSACTION: Declined by fraud tool (Fraud Protection/Chargeback Protection) due to potential fraud risk. Please review your fraud settings.
PAYER_ACCOUNT_LOCKED_OR_CLOSED: The payer account cannot be used for this transaction.
PAYER_ACCOUNT_RESTRICTED: PAYER_ACCOUNT_RESTRICTED
PAYER_CANNOT_PAY: Combination of payer and payee settings mean that this buyer cannot pay this seller.
TRANSACTION_BLOCKED_BY_PAYEE: Transaction blocked by Payee’s Fraud Protection settings.
TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
TRANSACTION_RECEIVING_LIMIT_EXCEEDED: The transaction exceeds the receiver's receiving limit.
TRANSACTION_REFUSED: The request was refused.
AUTH_CAPTURE_NOT_ENABLED: Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
UNSUPPORTED_PROCESSING_INSTRUCTION: The specified processing_instruction is not supported for the given payment_source. Please refer to https://developer.paypal.com/api/orders/v2/#definition-processing_instruction for the list of payment_source that can be specified with this value.
ORDER_COMPLETE_ON_PAYMENT_APPROVAL: A processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL is required for the specified payment_source. Please refer to the integration guide https://developer.paypal.com/docs/limited-release/alternative-payment-methods-with-orders/ for more details
INVALID_EXPIRY_DATE: Expiry date is invalid. Expiry date should be a date in future and within the threshold for the payment source.
Possible error locations:
payment_source/oxxo/expiry_date
payment_source/boletobancario/expiry_date
INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
Possible error locations:
application_context/stored_payment_source/payment_initiator
application_context/stored_payment_source/payment_type
application_context/stored_payment_source/usage
application_context/stored_payment_source/previous_transaction_reference
application_context/stored_payment_source/previous_network_transaction_reference
payment_source/paypal/experience_context/brand_name
payment_source/paypal/experience_context/locale
payment_source/paypal/experience_context/shipping_preference
payment_source/paypal/experience_context/return_url
payment_source/paypal/experience_context/cancel_url
payment_source/paypal/experience_context/landing_page
payment_source/paypal/experience_context/user_action
payment_source/paypal/experience_context/payment_method_preference
payment_source/paypal/experience_context/payment_method_selected
application_context/brand_name
application_context/locale
application_context/shipping_preference
application_context/return_url
application_context/cancel_url
application_context/landing_page
application_context/user_action
application_context/payment_method/payee_preferred
application_context/payment_method/payer_selected
payment_source/paypal/payment_method_preference
payment_source/paypal/email_address
payment_source/paypal/name
payment_source/paypal/birth_date
payment_source/paypal/tax_info
payment_source/paypal/address
payer/email_address
payer/name
payer/birth_date
payer/tax_info
payer/address
payment_source/card/attributes/vault/confirm_payment_token
payment_source/card/attributes/vault/store_in_vault
payment_source/paypal/attributes/vault/confirm_payment_token
payment_source/paypal/attributes/vault/store_in_vault
payment_source/apple_pay/attributes/vault/store_in_vault
payment_source/card/number
payment_source/card/vault_id
payment_source/card/stored_credential
payment_source/apple_pay/stored_credential
application_context/stored_payment_source
payment_source/paypal/vault_id
payment_source/venmo/vault_id
payment_source/apple_pay/vault_id
payment_source/card/attributes/vault
payment_source/paypal/attributes/vault
payment_source/venmo/attributes/vault
payment_source/google_pay/decrypted_token/cryptogram
payment_source/google_pay/decrypted_token/eci_indicator
payment_source/google_pay/decrypted_token/authentication_method
payment_source/google_pay/token
payment_source/google_pay/decrypted_token
payment_source/card/paypal_transaction_id
payment_source/card/pnref
payment_source/paypal/billing_agreement_id
payment_source/apple_pay/attributes/vault
payment_source/apple_pay/decrypted_token/payment_data/cryptogram
/payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
payment_source/google_pay/decrypted_token/cryptogram
payment_source/google_pay/decrypted_token/eci_indicator
payment_source/google_pay/decrypted_token/authentication_method
payment_source/google_pay/token
payment_source/google_pay/decrypted_token
/payment_source/card/attributes/payment_origin
payment_source/bank/sepa_debit/stored_credential/payment_initiator
payment_source/bank/sepa_debit/stored_credential/payment_type
payment_source/bank/sepa_debit/vault_id
payment_source/bank/sepa_debit/iban
payment_source/bank/sepa_debit/account_holder_name
payment_source/bank/sepa_debit/billing_address
payment_source/bank/sepa_debit/attributes/mandate/type
payment_source/bank/sepa_debit/stored_credential/payment_type
payment_source/bank/ach_debit/account_number
payment_source/bank/ach_debit/routing_number
payment_source/bank/ach_debit/account_type
payment_source/bank/ach_debit/account_holder_name
payment_source/bank/ach_debit/vault_id
payment_source/bank/ach_debit/attributes/vault
payment_source/bank/ach_debit/stored_credential
processing_instruction
purchase_units/0/items/0/category
payment_source/paypal/donation_context/display_context/business_name
payment_source/paypal/donation_context/display_context/title
payment_source/paypal/donation_context/display_context/logo_url
payment_source/paypal/donation_context/payment_context/recurring_frequency
payment_source/paypal/donation_context/payment_context/product_id
payment_source/paypal/donation_context/payment_context/donor_note
payment_source/paypal/donation_context/payment_context/product_flow
payment_source/paypal/donation_context/payment_context/donor_preferences
INVALID_PREVIOUS_TRANSACTION_REFERENCE: The authorization or capture referenced by previous_transaction_reference is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid previous_transaction_reference.
PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK: The capture referenced by previous_transaction_reference has a chargeback and hence cannot be used for this order. Please use a previous_transaction_reference which does not have a chargeback.
PREVIOUS_TRANSACTION_REFERENCE_VOIDED: The status of authorization referenced by previous_transaction_reference is VOIDED and hence cannot be used for this order. Please use a previous_transaction_reference whose status is not VOIDED.
PAYMENT_SOURCE_MISMATCH: The payment_source in the request must match the payment_source used for the authorization or capture referenced by previous_transaction_reference. Please use previous_transaction_reference whose payment_source matches with the payment_source specified in the order.
MERCHANT_INITIATED_WITH_SECURITY_CODE: stored_payment_source.payment_initiator = MERCHANT is not supported if payment_source.card.security_code is present in the order. security_code can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with security_code is the order.
MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS: stored_payment_source.payment_initiator = MERCHANT is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order.
MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS: stored_payment_source.payment_initiator = MERCHANT is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit).
PAYMENT_SOURCE_INFO_CANNOT_BE_VERIFIED: The combination of the payment_source name, billing address, shipping name and shipping address could not be verified. Please correct this information and try again by creating a new order.
PAYMENT_SOURCE_DECLINED_BY_PROCESSOR: The provided payment source is declined by the processor. Please try again with a different payment source by creating a new order.
PAYMENT_SOURCE_CANNOT_BE_USED: The provided payment source cannot be used to pay for the order. Please try again with a different payment source by creating a new order.
NOT_ENABLED_FOR_APPLE_PAY: The 'API caller' and/or 'payee' is not setup to be able to process apple pay. Please contact your Account Manager.
NOT_ENABLED_FOR_GOOGLE_PAY: The 'API caller' and/or 'payee' is not setup to be able to process google pay. Please contact your Account Manager.
APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
BILLING_ADDRESS_INVALID: Provided billing address is invalid.
Possible error locations:
/payment_source/pay_upon_invoice/billing_address
SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
Possible error locations:
purchase_units/0/shipping/address
VAULT_INSTRUCTION_DUPLICATED: Only one vault instruction is allowed. Please use vault.store_in_vault to provide vault instruction.
VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact your account manager to enable the functionality.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
Possible error locations:
payment_source/venmo/vault_id
payment_source/card/vault_id
payment_source/paypal/vault_id
payment_source/apple_pay/vault_id
payment_source/bank/sepa_debit/vault_id
MISMATCHED_VAULT_SETUP_TOKEN_TO_PAYMENT_SOURCE: The vault_setup_token does not match the payment_source provided. Please verify that the vault_setup_token token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_setup_token field in the payment_source.card object.
Possible error locations:
payment_source/card/vault_setup_token
payment_source/paypal/vault_setup_token
CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
Possible error locations:
/payment_source/apple_pay/decrypted_token/payment_data/cryptogram
EMV_DATA_REQUIRED: EMV Data is required if authentication method is EMV.
Possible error locations:
/payment_source/apple_pay/decrypted_token/payment_data/emv_data
NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
Possible error locations:
payment_source/card/security_code
NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE: The API caller or the merchant on whose behalf the API call is initiated is not allowed to vault the given source. Please contact PayPal customer support for assistance.
REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
Possible error locations:
/payment_source/apple_pay/decrypted_token/transaction_amount
/payment_source/apple_pay/decrypted_token/payment_data
/payment_source/apple_pay/decrypted_token/payment_data_type
/payment_source/apple_pay/decrypted_token/device_manufacturer_id
TOKEN_EXPIRED: The token is expired and cannot be used for payment.
Possible error locations:
payment_source/google_pay/decrypted_token/message_expiration
payment_source/google_pay/token
INVALID_GOOGLE_PAY_TOKEN: The google pay token is invalid. PayPal was not able to decrypt the googlepay token or PayPal was not able to find the necessary data in the token after decryption.
Possible error locations:
/payment_source/google_pay/token
GOOGLE_PAY_GATEWAY_MERCHANT_ID_MISMATCH: The gateway merchant ID in Google Pay token is not valid. This could be because the gateway merchant Id that was authorized by payer/buyer on Google Pay does not match with the API caller of the order.
Possible error locations:
/payment_source/google_pay/token
CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
Possible error locations:
/payment_source/google_pay/decrypted_token/cryptogram
ONE_OF_PARAMETERS_REQUIRED: One or more field is required to continue with this request.
Possible error locations:
/payment_source/google_pay/token
/payment_source/google_pay/decrypted_token
payment_source/blik/experience_context/consumer_ip
payment_source/blik/experience_context/consumer_user_agent
ALIAS_DECLINED_BY_PROCESSOR: The provided alias was declined by the processor. Please create a new order with a different alias_key and/or alias_label and try again.
PREFERRED_BRAND_NOT_SUPPORTED: Processing of this preferred brand is not supported. Please use another brand preference to continue with this transaction.
BLIK_ONE_CLICK_MISSING_REQUIRED_PARAMETER: Blik's one_click flow requires one_click.auth_code and one_click.alias_label parameters for the buyer's first transaction. For all subsequent transactions,only the one_click.alias_key parameter is required.
Possible error locations:
payment_source/blik/one_click/auth_code
payment_source/blik/one_click/alias_label
payment_source/blik/one_click/alias_key
INCOMPATIBLE_ACCOUNT_OWNERSHIP_TYPE: Account ownership type is not compatible with standard entry class code.
DELAYED_DISBURSEMENT_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying disbursement mode as delayed.
Possible error locations:
/purchase_units/0/payment_instruction/disbursement_mode
/purchase_units//payment_instruction/disbursement_mode
DELAYED_DISBURSEMENT_NOT_SUPPORTED_FOR_KYC_INCOMPLETE_PAYEE: The Delayed disbursement is not supported due to payee's incomplete KYC, while their partner is enabled for Progressive Onboarding.
Possible error locations:
/purchase_units/0/payment_instruction/disbursement_mode
/purchase_units//payment_instruction/disbursement_mode
PARTNER_SETTLEMENT_NOT_SUPPORTED_FOR_KYC_INCOMPLETE_PAYEE: Partner settlement is not supported due to payee's incomplete KYC, while their partner is enabled for Progressive Onboarding.
NOT_ENABLED_FOR_PAYMENT_SOURCE: The 'API caller' and/or 'payee' is not setup to be able to process the selected payment source. If you have already completed the required steps, please allow 2 business days for PayPal to complete the setup. If you continue to receive this error, please contact your Account Manager or check status at https://www.paypal.com/businessmanage/account/payments.
Possible error locations:
/payment_source/alipay
/payment_source/bancomatpay
/payment_source/bancontact
/payment_source/bizum
/payment_source/blik
/payment_source/boletobancario
/payment_source/crypto
/payment_source/eps
/payment_source/giropay
/payment_source/ideal
/payment_source/mbway
/payment_source/mybank
/payment_source/multibanco
/payment_source/oxxo
/payment_source/payu
/payment_source/p24
/payment_source/paidy
/payment_source/safetypay
/payment_source/satispay
/payment_source/trustly
/payment_source/wechatpay
INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
Possible error locations:
/payment_source/paypal/vault_id
MULTIPLE_PURCHASE_UNITS_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: The provided payment source cannot be used to pay for the multiple purchase units order.
Possible error locations:
/payment_source/alipay
/payment_source/bancomatpay
/payment_source/bancontact
/payment_source/bizum
/payment_source/blik
/payment_source/eps
/payment_source/ideal
/payment_source/mbway
/payment_source/mybank
/payment_source/oxxo
/payment_source/payu
/payment_source/p24
/payment_source/trustly
/payment_source/wechatpay
/payment_source/grabpay
/payment_source/multibanco
/payment_source/satispay
/payment_source/pay_upon_invoice
COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Country code provided is not supported by the provided payment source.
Possible error locations:
/payment_source/ach_debit/billing_address/country_code
/payment_source/crypto/country_code
/payment_source/twint/country_code
/payment_source/bizum/country_code
LOCALE_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Locale provided is not supported by the provided payment source.
Possible error locations:
/payment_source/ach_debit/experience_context/locale
BANK_VERIFICATION_REQUIRED: Only verified bank accounts can be processed.
Possible error locations:
/payment_source/ach_debit/attributes/verification
SHIPPING_CALLBACK_CONFIG_NOT_SUPPORTED: The shipping address callback URL in 'order_update_callback_config' field is not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
MISSING_REQUIRED_PARAMETER_FOR_BILLING_PLAN: PayPal Vault billing plan requires usage_pattern to be passed in the request. Supported Values: SUBSCRIPTION, UNSCHEDULED, RECURRING, INSTALLMENT (prepaid/postpaid)
UNSUPPORTED_INTEGRATION_FOR_BILLING_PLAN: For Recurring Purchases, passing billing plan and vaulting instruction (in payment_source.paypal.attributes.vault or payment_source.paypal.billing) is mandatory. Also, only one billing plan, product and purchase unit are supported.
INCOMPATIBLE_PARAMETER_FOR_BILLING_PLAN: For Recurring Purchase, amount fields like handling, insurance, discount and shipping discount are unsupported.
BILLING_ITEM_AMOUNT_MISMATCH: For Recurring Purchases, the billing plan’s unit amount should include both the setup fee and the plan price (only if the plan starts immediately, i.e. no start_date).
PARTNER_OR_MERCHANT_RESTRICTED_FOR_COUNTRY: The Partner or Merchant is not allowed to process payments using this payment source in the specified country. Please contact PayPal technical support.
MAX_EXPIRY_TIME_EXCEEDED: The provided authorization_expiry is longer than allowed for the selected payment_source.
Possible error locations:
/payment_source/klarna/authorization_context/authorization_expiry
DISCOUNT_TOTAL_MISMATCH: The amount specified in amount.breakdown.discount should equal the sum of all individual discount values specified in amount.breakdown.discount.breakdown.
PAYER_NOT_SUPPORTED_BY_PAYMENT_SOURCE: The Payer was declined by the payment source.
UNSUPPORTED_AUTHENTICATION_METHODS_FOR_PAYMENT_SOURCE: The provided list of authentication methods is not supported for this payment source.
Possible error locations:
/payment_source/bizum/experience_context/authentication_methods
Patch order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
FIELD_NOT_PATCHABLE: Field cannot be patched.
Possible error locations:
id
status
INVALID_ARRAY_MAX_ITEMS: The number of items in an array parameter is too large.
Possible error locations:
/purchase_units/0/shipping/options
INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
Possible error locations:
/purchase_units/0/payee/email_address
INVALID_STRING_LENGTH: The value of a field is either too short or too long
Possible error locations:
/purchase_units/0/shipping/options/0/id
/purchase_units/0/shipping/options/0/label
INVALID_PARAMETER_VALUE: The value of a field is invalid.
Possible error locations:
op
MISSING_REQUIRED_PARAMETER: A required field / parameter is missing.
Possible error locations:
op
/purchase_units/0/shipping/options/0/id
/purchase_units/0/shipping/options/0/label
/purchase_units/0/shipping/options/0/selected
AMOUNT_NOT_PATCHABLE: The amount cannot be updated as the 'payer' has chosen and approved a specific financing offer for a given amount. Please Create a new Order with the updated Order amount and have the 'payer' approve the new payment terms.
Possible error locations:
/purchase_units/0/amount
INVALID_PATCH_OPERATION: The operation cannot be honored. Cannot add a property that's already present, use replace. Cannot remove a property thats not present, use add. Cannot replace a property thats not present, use add.
Possible error locations:
op
MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
PAYEE_ACCOUNT_NOT_SUPPORTED: Payee does not have an account. Your current setup requires the 'payee' to have a verified account with PayPal before you can process transactions on their behalf.
PAYEE_ACCOUNT_NOT_VERIFIED: Payee has not verified their account with PayPal. The selected payment method requires the recipient to have a verified PayPal account before transactions can be processed on their behalf.
PAYEE_NOT_CONSENTED: Payee does not have appropriate consent to allow the API caller to process this type of transaction on their behalf. Your current setup requires the 'payee' to provide a consent before this transaction can be processed successfully.
RESOURCE_NOT_FOUND
The specified resource does not exist.
INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
AMOUNT_MISMATCH: Should equal item_total + tax_total + shipping + handling + insurance - shipping_discount - discount.
CANNOT_BE_NEGATIVE: Must be greater than or equal to 0. If the currency supports decimals, only two decimal place precision is supported.
CANNOT_BE_ZERO_OR_NEGATIVE: Must be greater than zero. If the currency supports decimals, only two decimal place precision is supported.
CITY_REQUIRED: The specified country requires a city (address.admin_area_2).
DECIMAL_PRECISION: If the currency supports decimals, only two decimal place precision is supported.
DONATION_ITEMS_NOT_SUPPORTED: If 'purchase_unit' has "DONATION" as the 'items.category' then the Order can at most have one purchase_unit. Multiple purchase_units are not supported if either of them have at least one items with category as "DONATION".
DUPLICATE_REFERENCE_ID: reference_id must be unique if multiple purchase_unit are provided.
INVALID_CURRENCY_CODE: Currency code is invalid or is not currently supported. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
ITEM_TOTAL_MISMATCH: Should equal sum of (unit_amount * quantity) across all items for a given purchase_unit.
ITEM_TOTAL_REQUIRED: If item details are specified (items.unit_amount and items.quantity) corresponding amount.breakdown.item_total is required.
MAX_VALUE_EXCEEDED: Should be less than or equal to 999999999999999.99.
INVALID_JSON_POINTER_FORMAT: Path should be a valid JSON Pointer https://tools.ietf.org/html/rfc6901 that references a location within the request where the operation is performed.
INVALID_PARAMETER: Cannot be specified as part of the request.
NOT_PATCHABLE: Cannot be patched.
TAX_TOTAL_MISMATCH: Should equal sum of (tax * quantity) across all items for a given purchase_unit.
TAX_TOTAL_REQUIRED: If item details are specified (items.tax_total and items.quantity) corresponding amount.breakdown.tax_total is required.
UNSUPPORTED_INTENT: intent=AUTHORIZE is not supported for multiple purchase units. Only intent=CAPTURE is supported.
UNSUPPORTED_INTENT_FOR_KYC_INCOMPLETE_PAYEE: intent=AUTHORIZE is not supported due to payee's incomplete KYC, while their partner is enabled for Progressive Onboarding. Only intent=CAPTURE is supported.
UNSUPPORTED_PATCH_PARAMETER_VALUE: The value specified for this field is not currently supported.
PATCH_VALUE_REQUIRED: Please specify a 'value' to for the field that is being patched.
PATCH_PATH_REQUIRED: Please specify a 'path' for the field for which the operation needs to be performed.
PAYEE_ACCOUNT_LOCKED_OR_CLOSED: The merchant account is locked or closed.
PAYEE_ACCOUNT_RESTRICTED: The merchant account is restricted.
PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
Possible error locations:
/purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
/purchase_units//payment_instruction/payee_receivable_fx_rate_id
PAYEE_FX_RATE_ID_CURRENCY_MISMATCH: The specified FX Rate ID is for a currency that does not match with the currency of this request. Please specify a different FX Rate ID and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
Possible error locations:
/purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
/purchase_units//payment_instruction/payee_receivable_fx_rate_id
INVALID_FX_RATE_ID: The specific FX Rate ID is not valid. This could be either because we are not able to look up the FX Rate based on this ID or it could be because the ID belongs to another API Caller.
Possible error locations:
/purchase_units/0/payment_instruction/payee_receivable_fx_rate_id
/purchase_units//payment_instruction/payee_receivable_fx_rate_id
PLATFORM_FEES_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying 'platform_fees'. Please work with your PayPal Account Manager to enable this option for your account.
Possible error locations:
/purchase_units/0/payment_instruction/platform_fees
/purchase_units//payment_instruction/platform_fees
INVALID_PLATFORM_FEES_ACCOUNT: The specified platform_fees payee account is either invalid or account setup is incomplete.Please work with your PayPal Account Manager to enable this option for your account.
Possible error locations:
/purchase_units/0/payment_instruction/platform_fees/0/payee
/purchase_units//payment_instruction/platform_fees/0/payee
INVALID_PLATFORM_FEES_AMOUNT: The platform_fees amount cannot be greater than order amount.
Possible error locations:
/purchase_units/0/payment_instruction/platform_fees/0/amount/value
/purchase_units//payment_instruction/platform_fees/0/value
POSTAL_CODE_REQUIRED: The specified country requires a postal code.
REFERENCE_ID_NOT_FOUND: Filter expression value is incorrect. Please check the value of the reference_id and try again.
REFERENCE_ID_REQUIRED: 'reference_id' is required for each 'purchase_unit' if multiple 'purchase_unit' are provided.
MULTI_CURRENCY_ORDER: Multiple differing values of currency_code are not supported. Entire Order request must have the same currency_code.
INVALID_SHIPPING_OPTION_ID: The items.shipping.options_ids[].id does not exist in purchase_units.shipping.options[]. Please ensure that all ids used in options_ids are first defined in purchase_units.shipping.options[].
Possible error locations:
/purchase_units/0/items/0/shipping/options_ids/0/id
INVALID_DELIVERY_ESTIMATE: The provided delivery_time_max must be greater than the delivery_time_min, and vice versa.
Possible error locations:
/purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_min
/purchase_units/0/shipping/options/0/delivery_estimate/delivery_time_max
INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
MISSING_SHIPPING_CALL_BACK_CONFIGURATION: payment_source.paypal.experience_context.order_update_callback_config is mandatory for one or more shipping.options provided in the request.
MISSING_ITEM_SHIPPING_OPTIONS: All items in the purchase_unit must have options_ids defined if any item in the Order has item[].shipping.options_ids defined.
SHIPPING_OPTION_NOT_SELECTED: At least one of the shipping.option should be set to 'selected = true'.
SHIPPING_OPTIONS_NOT_SUPPORTED: Shipping options are not supported when shipping.type is specified or when 'payment_source.paypal.experience_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
MULTIPLE_SHIPPING_OPTION_SELECTED: Only one shipping.option can be set to 'selected = true'.
DUPLICATE_SHIPPING_OPTION_ID: Please specify a unique shipping option id for each shipping option provided in the request and try again.
ORDER_ALREADY_COMPLETED: The order cannot be patched after it is completed.
CANNOT_MODIFY_INTENT: The value of 'intent' cannot be changed. Please create a new order.
PREFERRED_SHIPPING_OPTION_AMOUNT_MISMATCH: The amount provided in the preferred shipping option should match the amount provided in amount breakdown
Possible error locations:
/purchase_units/0/shipping/options/0/amount/value
AMOUNT_CHANGE_NOT_ALLOWED: The amount specified is different from the amount authorized by payer.
DELAYED_DISBURSEMENT_NOT_SUPPORTED: The API Caller is not enabled to process transactions by specifying disbursement mode as delayed.
Possible error locations:
/purchase_units/0/payment_instruction/disbursement_mode
/purchase_units//payment_instruction/disbursement_mode
DELAYED_DISBURSEMENT_NOT_SUPPORTED_FOR_KYC_INCOMPLETE_PAYEE: The Delayed disbursement is not supported due to payee's incomplete KYC, while their partner is enabled for Progressive Onboarding.
Possible error locations:
/purchase_units/0/payment_instruction/disbursement_mode
/purchase_units//payment_instruction/disbursement_mode
PARTNER_SETTLEMENT_NOT_SUPPORTED_FOR_KYC_INCOMPLETE_PAYEE: Partner settlement is not supported due to payee's incomplete KYC, while their partner is enabled for Progressive Onboarding.
MULTIPLE_PURCHASE_UNITS_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: The provided payment source cannot be used to pay for the multiple purchase units order.
Possible error locations:
/payment_source/alipay
/payment_source/bancomatpay
/payment_source/bancontact
/payment_source/bizum
/payment_source/blik
/payment_source/eps
/payment_source/ideal
/payment_source/mbway
/payment_source/mybank
/payment_source/oxxo
/payment_source/payu
/payment_source/p24
/payment_source/trustly
/payment_source/wechatpay
/payment_source/grabpay
/payment_source/multibanco
/payment_source/satispay
/payment_source/pay_upon_invoice
DISCOUNT_TOTAL_MISMATCH: The amount specified in amount.breakdown.discount should equal the sum of all individual discount values specified in amount.breakdown.discount.breakdown.
Authorize order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
RESOURCE_CONFLICT
The server has detected a conflict while processing this request.
PREVIOUS_REQUEST_IN_PROGRESS: A previous request on this resource is currently in progress. Please wait for some time and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
INVALID_COUNTRY_CODE: Country code is invalid. Please refer to https://developer.paypal.com/api/rest/reference/country-codes/ for a list of supported country codes.
Possible error locations:
payment_source/card/billing_address/country_code
INVALID_PARAMETER_VALUE: A parameter value is not valid.
Possible error locations:
Prefer
payment_source/token/type
payment_source/google_pay/decrypted_token/payment_method
payment_source/google_pay/decrypted_token/authentication_method
MISSING_REQUIRED_PARAMETER: A required field / parameter is missing
Possible error locations:
payment_source/token/id
payment_source/token/type
payment_source/card/expiry
/payment_source/paypal/attributes/vault/confirm_payment_token
/payment_source/paypal/attributes/vault/usage_type
/payment_source/card/attributes/vault/confirm_payment_token
payment_source/google_pay/decrypted_token/card
payment_source/google_pay/decrypted_token/card/number
payment_source/google_pay/decrypted_token/card/expiry
/payment_source/card/network_token/number
/payment_source/card/network_token/expiry
/payment_source/paypal/attributes/vault/owner_id
INVALID_STRING_LENGTH: The value of a field is either too short or too long
Possible error locations:
payment_source/token/id
payment_source/card/billing_address/country_code
/payment_source/paypal/attributes/customer/id
payment_source/google_pay/decrypted_token/eci_indicator
payment_source/google_pay/decrypted_token/cryptogram
/payment_source/apple_pay/attributes/customer/id
INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
Possible error locations:
/payment_source/paypal/attributes/vault/usage_type
/payment_source/paypal/attributes/vault/customer_type
/payment_source/paypal/attributes/vault/confirm_payment_token
/payment_source/paypal/attributes/customer/id
/payment_source/card/attributes/customer/id
/payment_source/apple_pay/attributes/customer/id
/payment_source/card/attributes/vault/confirm_payment_token
/payment_source/paypal/payment_method_preference
payment_source/google_pay/decrypted_token/eci_indicator
MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
NOT_ELIGIBLE_FOR_TOKEN_PROCESSING: API caller is not enabled to process payments with the specified type of token. Please contact customer support to request permissions to process transactions with this type of token.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
PERMISSION_DENIED_FOR_DONATION_ITEMS: The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
RESOURCE_NOT_FOUND
The specified resource does not exist.
INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
ACTION_DOES_NOT_MATCH_INTENT: Order was created with an intent to 'CAPTURE'. Please use v2/checkout/orders/order_id/capture to complete the transaction or alternately Create an order with an intent of 'AUTHORIZE'.
PREFERRED_BRAND_NOT_SUPPORTED: Processing of this preferred brand is not supported. Please use another brand preference to continue with this transaction.
AGREEMENT_ALREADY_CANCELLED: The requested agreement is already canceled.
BILLING_AGREEMENT_NOT_FOUND: The requested Billing Agreement token was not found.
MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
CARD_BRAND_NOT_SUPPORTED: Processing of this card brand is not supported. Please use another card to continue with this transaction.
CARD_COUNTRY_NOT_SUPPORTED: The country in which this card was issued is not currently supported. Please use another card to continue with this transaction.
Possible error locations:
/payment_source/card/billing_address/country_code
CARD_DATA_NOT_FOUND: The card issuer data information could not be retrieved. Please use a different card to proceed with this transaction.
Possible error locations:
/payment_source/card/number
DECLINED_DUE_TO_RELATED_TXN: One or more transactions in this Order did not succeed. Since this Order is being processed as an All or None Order, if one or more transactions in this Order do not succeed, then all purchase units are marked declined and will not be processed.
DOMESTIC_TRANSACTION_REQUIRED: This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
DUPLICATE_INVOICE_ID: Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
ORDER_NOT_APPROVED: Payer has not yet approved the Order for payment. Please redirect the payer to the 'rel':'approve' url returned as part of the HATEOAS links within the Create Order call.
MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED: You have exceeded the maximum number of payment attempts.
PAYEE_BLOCKED_TRANSACTION: Declined by fraud tool (Fraud Protection/Chargeback Protection) due to potential fraud risk. Please review your fraud settings.
CONTINGENCY_NOT_SUCCESSFUL: 3D-Secure payer authentication is unsuccessful, so the payment cannot be completed.
PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
UNSUPPORTED_INTENT_FOR_PAYMENT_SOURCE: intent=AUTHORIZE is not supported for the specified payment_source. Only intent=CAPTURE is supported.
INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
PAYER_ACCOUNT_LOCKED_OR_CLOSED: The payer account cannot be used for this transaction.
PAYER_ACCOUNT_RESTRICTED: PAYER_ACCOUNT_RESTRICTED
PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
PAYER_CANNOT_PAY: Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction.
PAYPAL_TRANSACTION_ID_EXPIRED: Specified paypal_transaction_id has expired. PayPal transaction ID expires 4 years after the date of the initial transaction.
PNREF_EXPIRED: Specified pnref has expired. PNREF expires 15 months after the date of the initial transaction.
PAYMENT_DENIED: PayPal has declined to process this transaction.
REFERENCED_CARD_EXPIRED: The card underlying the token has expired and hence cannot be used to process a payment.
TOKEN_EXPIRED: The token is expired and cannot be used for payment.
Possible error locations:
payment_source/google_pay/decrypted_token/message_expiration
payment_source/google_pay/token
TOKEN_ID_NOT_FOUND: Specified token was not found. Verify the token and try the request again.
TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
TRANSACTION_RECEIVING_LIMIT_EXCEEDED: The transaction exceeds the receiver's receiving limit.
TRANSACTION_REFUSED: The request was refused.
ORDER_ALREADY_AUTHORIZED: Order already authorized.If 'intent=AUTHORIZE' only one authorization per order is allowed.
AUTH_CAPTURE_NOT_ENABLED: Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
AMOUNT_CANNOT_BE_SPECIFIED: An authorization amount can only be specified if an Order has been saved by calling /v2/checkout/orders/{order_id}/save. Please save the order and try again.
AUTHORIZATION_AMOUNT_EXCEEDED: Authorization amount specified exceeded allowable limit. Specify a different amount and try the request again. Alternately, contact Customer Support to increase your limits. Local regulations (e.g. in PSD2 countries) prohibit overages above the amount authorized by the payer.
AUTHORIZATION_CURRENCY_MISMATCH: The currency of the authorization should be same as that in which the Order was created and approved by the Payer. Please check the 'currency_code' and try again.
MAX_AUTHORIZATION_COUNT_EXCEEDED: Maximum number of authorization allowed for the order is reached. Please contact Customer Support if you need to increase your limit.
ORDER_COMPLETED_OR_VOIDED: Order is voided or completed and hence cannot be authorized.
ORDER_EXPIRED: Order is expired and hence cannot be authorized. Please contact Customer Support if you need to increase your order validity period.
INVALID_PICKUP_ADDRESS: If the 'shipping_option.type' is set as 'PICKUP' then the 'shipping_detail.name.full_name' should start with 'S2S' meaning Ship To Store. Example: 'S2S My Store'.
SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
PAYMENT_TYPE_NOT_SUPPORTED_FOR_INTENT: Provided payment type not supported for order intent. Payment authorizations are supported only for order with intent=AUTHORIZE and payment captures are supported only for order with intent=CAPTURE.
BILLING_AGREEMENT_ID_MISMATCH: Billing Agreement ID must exactly match the Billing Agreement ID that was provided during order creation.
PREFERRED_PAYMENT_SOURCE_MISMATCH: Payment Source must exactly match the Preferred Payment Source that was provided during order creation.
INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
Possible error locations:
application_context/stored_payment_source/payment_initiator
application_context/stored_payment_source/payment_type
application_context/stored_payment_source/usage
application_context/stored_payment_source/previous_transaction_reference
application_context/stored_payment_source/previous_network_transaction_reference
payment_source/card/attributes/vault/confirm_payment_token
payment_source/card/attributes/vault/store_in_vault
payment_source/paypal/attributes/vault/confirm_payment_token
payment_source/paypal/attributes/vault/store_in_vault
payment_source/apple_pay/attributes/vault/store_in_vault
payment_source/card/number
payment_source/card/vault_id
payment_source/card/stored_credential
payment_source/apple_pay/stored_credential
application_context/stored_payment_source
payment_source/paypal/vault_id
payment_source/venmo/vault_id
payment_source/apple_pay/vault_id
payment_source/card/attributes/vault
payment_source/paypal/attributes/vault
payment_source/venmo/attributes/vault
payment_source/google_pay/decrypted_token/cryptogram
payment_source/google_pay/decrypted_token/authentication_method
payment_source/google_pay/decrypted_token/eci_indicator
payment_source/google_pay/token
payment_source/google_pay/decrypted_token
payment_source/card/paypal_transaction_id
payment_source/card/pnref
payment_source/paypal/billing_agreement_id
payment_source/apple_pay/attributes/vault
payment_source/apple_pay/decrypted_token/payment_data/cryptogram
/payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
/payment_source/card/attributes/payment_origin
processing_instruction
purchase_units/0/items/0/category
INVALID_PREVIOUS_TRANSACTION_REFERENCE: The authorization or capture referenced by previous_transaction_reference is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid previous_transaction_reference.
PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK: The capture referenced by previous_transaction_reference has a chargeback and hence cannot be used for this order. Please use a previous_transaction_reference which does not have a chargeback.
PREVIOUS_TRANSACTION_REFERENCE_VOIDED: The status of authorization referenced by previous_transaction_reference is VOIDED and hence cannot be used for this order. Please use a previous_transaction_reference whose status is not VOIDED.
PAYMENT_SOURCE_MISMATCH: The payment_source in the request must match the payment_source used for the authorization or capture referenced by previous_transaction_reference. Please use previous_transaction_reference whose payment_source matches with the payment_source specified in the order.
MERCHANT_INITIATED_WITH_SECURITY_CODE: stored_payment_source.payment_initiator = MERCHANT is not supported if payment_source.card.security_code is present in the order. security_code can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with security_code is the order.
MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS: stored_payment_source.payment_initiator = MERCHANT is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order.
MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS: stored_payment_source.payment_initiator = MERCHANT is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit).
RETURN_URL_REQUIRED: The return url is required when attempting to vault this source.
CANCEL_URL_REQUIRED: The cancel url is required when attempting to vault this source.
PAYER_ACTION_REQUIRED: Transaction cannot complete successfully, instruct the buyer to return to PayPal.
APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
CARD_NUMBER_REQUIRED: The card number is required when attempting to process payment with card.
Possible error locations:
payment_source/card/number
CARD_EXPIRY_REQUIRED: The card expiry is required when attempting to process payment with card.
Possible error locations:
payment_source/card/expiry
VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact account manager to enable the functionality.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
Possible error locations:
payment_source/venmo/vault_id
payment_source/card/vault_id
payment_source/paypal/vault_id
payment_source/apple_pay/vault_id
ORDER_CANNOT_BE_SAVED: The option to save an order is only available if the intent is AUTHORIZE and processing_instruction uses one of the ORDER_SAVED options. For example, intent=AUTHORIZE, processing_instruction=ORDER_SAVED_EXPLICITLY. Please change the intent and/or processing_instructionand try again.
SAVE_ORDER_NOT_SUPPORTED: The API caller account is setup in a way that does not allow it to be used for saving the order. This functionality is not available for PayPal Complete Payments Platform for Platforms & Marketplaces.
NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
Possible error locations:
payment_source/card/security_code
REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
Possible error locations:
/payment_source/apple_pay/decrypted_token/transaction_amount
/payment_source/apple_pay/decrypted_token/payment_data
/payment_source/apple_pay/decrypted_token/payment_data_type
/payment_source/apple_pay/decrypted_token/device_manufacturer_id
INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
Possible error locations:
/payment_source/paypal/vault_id
ORDER_AUTHORIZATION_IN_PROGRESS: The processing_instruction sent with the selected payment_source was ORDER_COMPLETE_ON_PAYMENT_APPROVAL, resulting in auto-authorization. Merchant initiated authorization is not allowed.
Capture order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
RESOURCE_CONFLICT
The server has detected a conflict while processing this request.
PREVIOUS_REQUEST_IN_PROGRESS: A previous request on this resource is currently in progress. Please wait for some time and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
AUTHENTICATION_FAILURE
Authentication failed due to missing authorization header, or invalid authentication credentials.
INVALID_ACCOUNT_STATUS: Account validations failed for the user.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
INVALID_PARAMETER_VALUE: A parameter value is not valid.
Possible error locations:
intent
Prefer
payment_source/token/type
MISSING_REQUIRED_PARAMETER: A required field / parameter is missing
Possible error locations:
payment_source/token/id
payment_source/token/type
/payment_source/paypal/attributes/vault/confirm_payment_token
/payment_source/paypal/attributes/vault/usage_type
/payment_source/card/attributes/vault/confirm_payment_token
/payment_source/card/network_token/number
/payment_source/card/network_token/expiry
/payment_source/paypal/attributes/vault/owner_id
INVALID_STRING_LENGTH: The value of a field is either too short or too long
Possible error locations:
payment_source/token/id
/payment_source/paypal/attributes/customer/id
/payment_source/apple_pay/attributes/customer/id
INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
Possible error locations:
/payment_source/paypal/attributes/vault/usage_type
/payment_source/paypal/attributes/vault/customer_type
/payment_source/paypal/attributes/vault/confirm_payment_token
/payment_source/paypal/attributes/customer/id
/payment_source/card/attributes/customer/id
/payment_source/apple_pay/attributes/customer/id
/payment_source/card/attributes/vault/confirm_payment_token
/payment_source/paypal/payment_method_preference
MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
CONSENT_NEEDED: CONSENT_NEEDED
NOT_ELIGIBLE_FOR_TOKEN_PROCESSING: API caller is not enabled to process payments with the specified type of token. Please contact customer support to request permissions to process transactions with this type of token.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
PERMISSION_DENIED_FOR_DONATION_ITEMS: The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
RESOURCE_NOT_FOUND
The specified resource does not exist.
INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
AGREEMENT_ALREADY_CANCELLED: The requested agreement is already canceled.
PREFERRED_BRAND_NOT_SUPPORTED: Processing of this preferred brand is not supported. Please use another brand preference to continue with this transaction.
BILLING_AGREEMENT_NOT_FOUND: The requested Billing Agreement token was not found.
DECLINED_DUE_TO_RELATED_TXN: One or more transactions in this Order did not succeed. Since this Order is being processed as an All or None Order, if one or more transactions in this Order do not succeed, then all purchase units are marked declined and will not be processed.
MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
CARD_BRAND_NOT_SUPPORTED: Processing of this card brand is not supported. Please use another card to continue with this transaction.
CARD_COUNTRY_NOT_SUPPORTED: The country in which this card was issued is not currently supported. Please use another card to continue with this transaction.
Possible error locations:
/payment_source/card/billing_address/country_code
CARD_DATA_NOT_FOUND: The card issuer data information could not be retrieved. Please use a different card to proceed with this transaction.
Possible error locations:
/payment_source/card/number
COMPLIANCE_VIOLATION: Transaction is declined due to compliance violation.
DOMESTIC_TRANSACTION_REQUIRED: This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
DUPLICATE_INVOICE_ID: Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
INSTRUMENT_DECLINED: The instrument presented was either declined by the processor or bank, or it can't be used for this payment.
ORDER_NOT_APPROVED: Payer has not yet approved the Order for payment. Please redirect the payer to the 'rel':'approve' url returned as part of the HATEOAS links within the Create Order call or provide a valid payment_source in the request.
MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED: You have exceeded the maximum number of payment attempts.
PAYEE_BLOCKED_TRANSACTION: Declined by fraud tool (Fraud Protection/Chargeback Protection) due to potential fraud risk. Please review your fraud settings.
CONTINGENCY_NOT_SUCCESSFUL: 3D-Secure payer authentication is unsuccessful, so the payment cannot be completed.
PAYEE_FX_RATE_ID_EXPIRED: The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
PAYER_ACCOUNT_LOCKED_OR_CLOSED: The payer account cannot be used for this transaction.
PAYER_ACCOUNT_RESTRICTED: PAYER_ACCOUNT_RESTRICTED
PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
PAYER_CANNOT_PAY: Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction.
PAYPAL_TRANSACTION_ID_EXPIRED: Specified paypal_transaction_id has expired. PayPal transaction ID expires 4 years after the date of the initial transaction.
PNREF_EXPIRED: Specified pnref has expired. PNREF expires 15 months after the date of the initial transaction.
PAYMENT_DENIED: PayPal has declined to process this transaction.
REFERENCED_CARD_EXPIRED: The card underlying the token has expired and hence cannot be used to process a payment.
TOKEN_ID_NOT_FOUND: Specified token was not found. Verify the token and try the request again.
TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
TRANSACTION_RECEIVING_LIMIT_EXCEEDED: The transaction exceeds the receiver's receiving limit.
TRANSACTION_REFUSED: The request was refused.
REDIRECT_PAYER_FOR_ALTERNATE_FUNDING: Transaction failed. Redirect the payer to select another funding source.
ORDER_ALREADY_CAPTURED: Order already captured.If 'intent=CAPTURE' only one capture per order is allowed.
TRANSACTION_BLOCKED_BY_PAYEE: Transaction blocked by Payee’s Fraud Protection settings.
AUTH_CAPTURE_NOT_ENABLED: Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
NOT_ENABLED_FOR_BANK_PROCESSING: The API Caller account is not setup to be able to process bank payments. Please contact your PayPal account manager.
NOT_ENABLED_FOR_CARD_PROCESSING: The API Caller account is not setup to be able to process card payments. Please contact PayPal customer support.
PAYEE_NOT_ENABLED_FOR_BANK_PROCESSING: Payee account is not setup to be able to process bank payments. Please contact your PayPal account manager.
PAYEE_NOT_ENABLED_FOR_CARD_PROCESSING: Payee account is not setup to be able to process card payments. Please contact PayPal customer support.
INVALID_PICKUP_ADDRESS: If the 'shipping_option.type' is set as 'PICKUP' then the 'shipping_detail.name.full_name' should start with 'S2S' meaning Ship To Store. Example: 'S2S My Store'.
SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
PAYMENT_SOURCE_NOT_SUPPORTED: The payer selected method of payment is not supported when multiple purchase units are specified for an Order.
INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
ORDER_COMPLETION_IN_PROGRESS: The order was created with processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL. The customer has approved the payment and PayPal is still in the process of capturing the order on your behalf as instructed. Please try your request again.
BILLING_AGREEMENT_ID_MISMATCH: Billing Agreement ID must exactly match the Billing Agreement ID that was provided during order creation.
PREFERRED_PAYMENT_SOURCE_MISMATCH: Payment Source must exactly match the Preferred Payment Source that was provided during order creation.
INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
Possible error locations:
application_context/stored_payment_source/payment_initiator
application_context/stored_payment_source/payment_type
application_context/stored_payment_source/usage
application_context/stored_payment_source/previous_transaction_reference
application_context/stored_payment_source/previous_network_transaction_reference
payment_source/card/attributes/vault/confirm_payment_token
payment_source/card/attributes/vault/store_in_vault
payment_source/paypal/attributes/vault/confirm_payment_token
payment_source/paypal/attributes/vault/store_in_vault
payment_source/apple_pay/attributes/vault/store_in_vault
payment_source/card/number
payment_source/card/vault_id
payment_source/card/stored_credential
payment_source/apple_pay/stored_credential
application_context/stored_payment_source
payment_source/paypal/vault_id
payment_source/venmo/vault_id
payment_source/apple_pay/vault_id
payment_source/card/attributes/vault
payment_source/paypal/attributes/vault
payment_source/venmo/attributes/vault
payment_source/card/paypal_transaction_id
payment_source/card/pnref
payment_source/paypal/billing_agreement_id
payment_source/apple_pay/attributes/vault
payment_source/apple_pay/decrypted_token/payment_data/cryptogram
/payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
/payment_source/card/attributes/payment_origin
payment_source/bank/ach_debit/account_number
payment_source/bank/ach_debit/routing_number
payment_source/bank/ach_debit/account_type
payment_source/bank/ach_debit/account_holder_name
payment_source/bank/ach_debit/vault_id
payment_source/bank/ach_debit/attributes/vault
payment_source/bank/ach_debit/stored_credential
processing_instruction
purchase_units/0/items/0/category
payment_source/paypal/donation_context/display_context/business_name
payment_source/paypal/donation_context/display_context/title
payment_source/paypal/donation_context/display_context/logo_url
payment_source/paypal/donation_context/payment_context/recurring_frequency
payment_source/paypal/donation_context/payment_context/product_id
payment_source/paypal/donation_context/payment_context/donor_note
payment_source/paypal/donation_context/payment_context/product_flow
payment_source/paypal/donation_context/payment_context/donor_preferences
INVALID_PREVIOUS_TRANSACTION_REFERENCE: The authorization or capture referenced by previous_transaction_reference is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid previous_transaction_reference.
PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK: The capture referenced by previous_transaction_reference has a chargeback and hence cannot be used for this order. Please use a previous_transaction_reference which does not have a chargeback.
PREVIOUS_TRANSACTION_REFERENCE_VOIDED: The status of authorization referenced by previous_transaction_reference is VOIDED and hence cannot be used for this order. Please use a previous_transaction_reference whose status is not VOIDED.
PAYMENT_SOURCE_MISMATCH: The payment_source in the request must match the payment_source used for the authorization or capture referenced by previous_transaction_reference. Please use previous_transaction_reference whose payment_source matches with the payment_source specified in the order.
MERCHANT_INITIATED_WITH_SECURITY_CODE: stored_payment_source.payment_initiator = MERCHANT is not supported if payment_source.card.security_code is present in the order. security_code can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with security_code is the order.
MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS: stored_payment_source.payment_initiator = MERCHANT is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order.
MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS: stored_payment_source.payment_initiator = MERCHANT is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit).
RETURN_URL_REQUIRED: The return url is required when attempting to vault this source.
CANCEL_URL_REQUIRED: The cancel url is required when attempting to vault this source.
SETUP_ERROR_FOR_BANK: The API Caller account setup, for bank payments, is incomplete or incorrect. Please contact your PayPal account manager.
BANK_NOT_SUPPORTED_FOR_VERIFICATION: Verification for this bank account is not supported.
PAYER_ACTION_REQUIRED: Transaction cannot complete successfully, instruct the buyer to return to PayPal.
APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
CURRENCY_NOT_SUPPORTED_FOR_BANK: The payment_source does not support the currency of the Order. For ACH debit, only USD is supported and for SEPA debit, only EUR is supported.
ONLY_ONE_BANK_SOURCE_ALLOWED: More than one payment method within the bank payment object is not supported.
INVALID_IBAN: IBAN provided is not a valid bank account number.
IBAN_COUNTRY_NOT_SUPPORTED: Country code of issuer bank for the provided IBAN is not supported for SEPA debit payments.
CARD_NUMBER_REQUIRED: The card number is required when attempting to process payment with card.
Possible error locations:
payment_source/card/number
CARD_EXPIRY_REQUIRED: The card expiry is required when attempting to process payment with card.
Possible error locations:
payment_source/card/expiry
VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
Possible error locations:
payment_source/venmo/vault_id
payment_source/card/vault_id
payment_source/paypal/vault_id
payment_source/apple_pay/vault_id
MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact account manager to enable the functionality.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
INVALID_VAULT_SETUP_TOKEN: The specified Vault Setup Token is invalid or could not be found.
Possible error locations:
/payment_source/paypal/vault_setup_token
/payment_source/card/vault_setup_token
INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
Possible error locations:
payment_source/card/security_code
PLATFORM_FEE_PAYEE_CANNOT_BE_SAME_AS_PAYER: The payer cannot pay themselves. The recipient account of the platform fees must be different from the payer account.
REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
Possible error locations:
/payment_source/apple_pay/decrypted_token/transaction_amount
/payment_source/apple_pay/decrypted_token/payment_data
/payment_source/apple_pay/decrypted_token/payment_data_type
/payment_source/apple_pay/decrypted_token/device_manufacturer_id
IDENTIFIER_NOT_FOUND: Specified identifier was not found. Please verify the correct identifier was used and try the request again.
INCOMPATIBLE_ACCOUNT_OWNERSHIP_TYPE: Account ownership type is not compatible with standard entry class code.
COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Country code provided is not supported by the provided payment source.
Possible error locations:
/payment_source/ach_debit/billing_address/country_code
LOCALE_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Locale provided is not supported by the provided payment source.
Possible error locations:
/payment_source/ach_debit/experience_context/locale
BANK_VERIFICATION_REQUIRED: Only verified bank accounts can be processed.
Possible error locations:
/payment_source/ach_debit/attributes/verification
INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
Possible error locations:
/payment_source/paypal/vault_id
NOT_ENABLED_FOR_PAYMENT_SOURCE: The 'API caller' and/or 'payee' is not setup to be able to process the selected payment source. If you have already completed the required steps, please allow 2 business days for PayPal to complete the setup. If you continue to receive this error, please contact your Account Manager or check status at https://www.paypal.com/businessmanage/account/payments.
Possible error locations:
/payment_source/alipay
/payment_source/bancomatpay
/payment_source/bancontact
/payment_source/bizum
/payment_source/blik
/payment_source/boletobancario
/payment_source/eps
/payment_source/giropay
/payment_source/ideal
/payment_source/mbway
/payment_source/multibanco
/payment_source/mybank
/payment_source/oxxo
/payment_source/payu
/payment_source/p24
/payment_source/paidy
/payment_source/safetypay
/payment_source/satispay
/payment_source/trustly
/payment_source/wechatpay
AUTO_CAPTURE_ENABLED: This order is being auto-captured. Merchant initiated capture requests are not allowed.
Confirm order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well-formed, syntactically incorrect, or violates schema.
INVALID_PARAMETER_SYNTAX: The value of the field does not conform to the expected format.
Possible error locations:
/payment_source/card/billing_address/country_code
/payment_source/card/expiry
/payment_source/card/security_code
/payment_source/paypal/attributes/vault/usage_type
/payment_source/paypal/attributes/vault/customer_type
/payment_source/paypal/attributes/vault/confirm_payment_token
/payment_source/paypal/attributes/customer/id
/payment_source/card/attributes/customer/id
/payment_source/apple_pay/attributes/customer/id
/payment_source/card/attributes/vault/confirm_payment_token
/payment_source/paypal/payment_method_preference
payment_source/google_pay/decrypted_token/eci_indicator
INVALID_PARAMETER_VALUE: A parameter value is not valid.
Possible error locations:
Prefer
payment_source/google_pay/decrypted_token/payment_method
payment_source/google_pay/decrypted_token/authentication_method
payment_source/google_pay/decrypted_token/message_id
payment_source/google_pay/decrypted_token/message_expiration
MISSING_REQUIRED_PARAMETER: A required field / parameter is missing
Possible error locations:
/payment_source
/payment_source/card/number
/payment_source/card/expiry
/payment_source/card/billing_address/country_code
/payment_source/alipay/country_code
/payment_source/alipay/name
/payment_source/bancomatpay/country_code
/payment_source/bancomatpay/phone
/payment_source/bancomatpay/phone/national_number
/payment_source/bancomatpay/phone/country_code
/payment_source/bancomatpay/name
/payment_source/bancontact/country_code
/payment_source/bancontact/name
/payment_source/bancontact/attributes/mandate
/payment_source/bancontact/attributes/mandate/type
/payment_source/bancontact/attributes/customer
/payment_source/bancontact/attributes/customer/id
/payment_source/bizum/name
/payment_source/bizum/name/full_name
/payment_source/bizum/country_code
/payment_source/blik/country_code
/payment_source/blik/name
/payment_source/boletobancario/country_code
/payment_source/boletobancario/name
/payment_source/boletobancario/email
/payment_source/boletobancario/tax_info/tax_id
/payment_source/boletobancario/tax_info/tax_id_type
/payment_source/boletobancario/billing_address/address_line_1
/payment_source/boletobancario/billing_address/address_line_2
/payment_source/boletobancario/billing_address/admin_area_1
/payment_source/boletobancario/billing_address/admin_area_2
/payment_source/boletobancario/billing_address/postal_code
/payment_source/eps/country_code
/payment_source/eps/name
/payment_source/giropay/country_code
/payment_source/giropay/name
/payment_source/ideal/country_code
/payment_source/ideal/name
/payment_source/ideal/attributes/mandate
/payment_source/ideal/attributes/mandate/type
/payment_source/ideal/attributes/customer
/payment_source/ideal/attributes/customer/id
/payment_source/mbway/country_code
/payment_source/mbway/phone
/payment_source/mbway/phone/national_number
/payment_source/mbway/phone/country_code
/payment_source/mbway/name
/payment_source/mybank/country_code
/payment_source/mybank/name
/payment_source/oxxo/country_code
/payment_source/oxxo/name
/payment_source/oxxo/email
/payment_source/payu/country_code
/payment_source/payu/name
/payment_source/p24/country_code
/payment_source/p24/name
/payment_source/p24/email
/payment_source/sofort/country_code
/payment_source/sofort/name
/payment_source/trustly/country_code
/payment_source/trustly/name
/payment_source/trustly/email
/payment_source/verkkopankki/country_code
/payment_source/verkkopankki/name
/payment_source/verkkopankki/email
/payment_source/wechatpay/country_code
/payment_source/wechatpay/name
/payment_source/card/billing_address/country_code
/payment_source/paypal/attributes/vault/usage_type
/payment_source/card/attributes/vault/confirm_payment_token
payment_source/google_pay/decrypted_token/card
payment_source/google_pay/decrypted_token/card/number
payment_source/google_pay/decrypted_token/card/expiry
/payment_source/card/network_token/number
/payment_source/card/network_token/expiry
/payment_source/paypal/attributes/vault/owner_id
/payment_source/bank/sepa_debit/attributes/vault/store_in_vault
INVALID_STRING_LENGTH: The value of a field is either too short or too long
Possible error locations:
/payment_source/card/billing_address/country_code
/payment_source/google_pay/decrypted_token/message_expiration
/payment_source/google_pay/decrypted_token/authentication_method
/payment_source/google_pay/decrypted_token/cryptogram
/payment_source/google_pay/decrypted_token/eci_indicator
INVALID_STRING_MAX_LENGTH: The value of a field is too long.
Possible error locations:
/payment_source/card/name
/payment_source/card/billing_address/address_line_1
/payment_source/card/billing_address/address_line_2
/payment_source/card/billing_address/admin_area_1
/payment_source/card/billing_address/admin_area_2
/payment_source/card/billing_address/postal_code
/payment_source/paypal/attributes/customer/id
/payment_source/apple_pay/attributes/customer/id
MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
NOT_ENABLED_FOR_CARD_PROCESSING: The recipient for which the API call is made on behalf of is not enabled for card processing. Please contact PayPal customer support.
PAYEE_ACCOUNT_NOT_VERIFIED: Payee has not verified their account with PayPal. The selected payment method requires the recipient to have a verified PayPal account before transactions can be processed on their behalf.
RESOURCE_NOT_FOUND
The specified resource does not exist.
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
ORDER_ALREADY_CAPTURED: Order already captured. If 'intent=CAPTURE' only one capture per order is allowed.
ORDER_ALREADY_AUTHORIZED: Order already captured. If 'intent=CAPTURE' only one capture per order is allowed.
ORDER_CANNOT_BE_CONFIRMED: An order with status = 'COMPLETED' cannot be confirmed again.
MISSING_PREVIOUS_REFERENCE: For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
MISSING_CRYPTOGRAM: Cryptogram is mandatory for any customer initiated network token transactions.
CURRENCY_NOT_SUPPORTED_FOR_COUNTRY: For the payment_source specified, the currency of the Order is restricted by the country in which the payee account is based. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
CARD_EXPIRED: The card is expired
CARD_TYPE_NOT_SUPPORTED: Processing of this card type is not supported. Use another card type.
CURRENCY_NOT_SUPPORTED_FOR_CARD_TYPE: The issued currency code of this card is not supported for direct card payments. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
CARD_COUNTRY_NOT_SUPPORTED: The country in which this card was issued is not currently supported. Please use another card to continue with this transaction.
Possible error locations:
/payment_source/card/billing_address/country_code
CARD_DATA_NOT_FOUND: The card issuer data information could not be retrieved. Please use a different card to proceed with this transaction.
Possible error locations:
/payment_source/card/number
ONLY_ONE_PAYMENT_SOURCE_ALLOWED: More than one payment method within the payment source is not supported.
Possible error locations:
/payment_source
NO_PAYMENT_SOURCE_PROVIDED: At least one payment method is required within the payment source.
Possible error locations:
/payment_source
PAYMENT_ALREADY_APPROVED: The payment has already been approved. Please capture the order, or create and confirm a new order with this payment source.
PAYMENT_ORIGIN_NOT_ENABLED: The API caller account or payee is not enabled for the given 'payment_origin' option. Please contact customer support for assistance.
UNSUPPORTED_PROCESSING_INSTRUCTION: The specified processing_instruction is not supported for the given payment_source. Please refer to https://developer.paypal.com/api/orders/v2/#definition-processing_instruction for the list of payment_source that can be specified with this value.
INELIGIBLE_SHIPPING_OPTION: One or more shipping options cannot be used in conjunction with this Order.
ORDER_COMPLETE_ON_PAYMENT_APPROVAL: A processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL is required for the specified payment_source.
INVALID_EXPIRY_DATE: Expiry date is invalid. Expiry date should be a date in future and within the threshold for the payment source.
Possible error locations:
payment_source/oxxo/expiry_date
payment_source/boletobancario/expiry_date
TOKEN_EXPIRED: The token is expired and cannot be used for payment.
Possible error locations:
payment_source/google_pay/decrypted_token/message_expiration
payment_source/google_pay/token
INVALID_GOOGLE_PAY_TOKEN: The google pay token is invalid. PayPal was not able to decrypt the googlepay token or PayPal was not able to find the necessary data in the token after decryption.
Possible error locations:
/payment_source/google_pay/token
GOOGLE_PAY_GATEWAY_MERCHANT_ID_MISMATCH: The gateway merchant ID in Google Pay token is not valid. This could be because the gateway merchant Id that was authorized by payer/buyer on Google Pay does not match with the API caller of the order.
Possible error locations:
/payment_source/google_pay/token
CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
Possible error locations:
/payment_source/google_pay/decrypted_token/cryptogram
ONE_OF_PARAMETERS_REQUIRED: One or more field is required to continue with this request.
Possible error locations:
/payment_source/google_pay/token
/payment_source/google_pay/decrypted_token
RETURN_URL_REQUIRED: The return url is required when attempting to vault this source.
CANCEL_URL_REQUIRED: The cancel url is required when attempting to vault this source.
COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Country code provided is not supported by the provided payment source.
Possible error locations:
/payment_source/pay_upon_invoice/billing_address/country_code
/payment_source/bancomatpay/country_code
/payment_source/bancomatpay/phone/country_code
/payment_source/bizum/country_code
/payment_source/bizum/phone/country_code
/payment_source/mbway/country_code
/payment_source/mbway/phone/country_code
/payment_source/ach_debit/billing_address/country_code
/payment_source/crypto/country_code
/payment_source/twint/country_code
REQUIRED_PARAMETER_FOR_PAYMENT_SOURCE: The parameter is required for provided payment source.
Possible error locations:
/payment_source/pay_upon_invoice/name
/payment_source/pay_upon_invoice/name/given_name
/payment_source/pay_upon_invoice/name/surname
/payment_source/pay_upon_invoice/birth_date
/payment_source/pay_upon_invoice/email
/payment_source/pay_upon_invoice/phone
/payment_source/pay_upon_invoice/phone/national_number
/payment_source/pay_upon_invoice/phone/country_code
/payment_source/pay_upon_invoice/billing_address
/payment_source/pay_upon_invoice/billing_address/address_line_1
/payment_source/pay_upon_invoice/billing_address/admin_area_2
/payment_source/pay_upon_invoice/billing_address/postal_code
/payment_source/pay_upon_invoice/billing_address/country_code
REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT: This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=MERCHANT. For details, see Stored Credential.
Possible error locations:
/payment_source/apple_pay/decrypted_token/transaction_amount
/payment_source/apple_pay/decrypted_token/payment_data
/payment_source/apple_pay/decrypted_token/payment_data_type
/payment_source/apple_pay/decrypted_token/device_manufacturer_id
ITEM_CATEGORY_NOT_SUPPORTED_BY_PAYMENT_SOURCE: The provided payment source does not support provided item category.
Possible error locations:
/purchase_units/0/items/0/category
PAYMENT_SOURCE_INFO_CANNOT_BE_VERIFIED: The combination of the payment_source name, billing address, shipping name and shipping address could not be verified. Please correct this information and try again by creating a new order.
PAYMENT_SOURCE_DECLINED_BY_PROCESSOR: The provided payment source is declined by the processor. Please try again with a different payment source by creating a new order.
PAYMENT_SOURCE_CANNOT_BE_USED: The provided payment source cannot be used to pay for the order. Please try again with a different payment source by creating a new order.
SETUP_ERROR_FOR_BANK: The API Caller account setup, for bank payments, is incomplete or incorrect. Please contact your PayPal account manager.
BANK_NOT_SUPPORTED_FOR_VERIFICATION: Verification for this bank account is not supported.
APPLE_PAY_AMOUNT_MISMATCH: The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
ONE_OF_THE_PARAMETERS_REQUIRED: One or more field is required to continue with this request.
BILLING_ADDRESS_INVALID: Provided billing address is invalid.
Possible error locations:
/payment_source/pay_upon_invoice/billing_address
SHIPPING_ADDRESS_INVALID: Provided shipping address is invalid.
ORDER_IS_PENDING_APPROVAL: The order was confirmed and payer action completed but order approval processing from PayPal is pending. No action is needed from Payee or Payer. Please wait until order status changes to 'APPROVED'.
DEVICE_DATA_NOT_AVAILABLE: Device Data is not available for processing this order. The PayPal-Client-Metadata-Id header value sent during Create Order api call is either missing or incorrect or there was an error in collecting required data. Please verify if appropriate value for PayPal-Client-Metadata-Id header is being sent during 'Create Order' api call. Please note this error only applies to payment_source.pay_upon_invoice at the moment.
COMPLIANCE_VIOLATION: Transaction is declined due to compliance violation.
CURRENCY_NOT_SUPPORTED_FOR_BANK: The payment_source does not support the currency of the Order. For ACH debit, only USD is supported and for SEPA debit, only EUR is supported.
ONLY_ONE_BANK_SOURCE_ALLOWED: More than one payment method within the bank payment object is not supported.
INVALID_IBAN: IBAN provided is not a valid bank account number.
IBAN_COUNTRY_NOT_SUPPORTED: Country code of issuer bank for the provided IBAN is not supported for SEPA debit payments.
PAYEE_COUNTRY_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: Payee country code is not supported by the provided payment source.
CARD_NUMBER_REQUIRED: The card number is required when attempting to process payment with card.
Possible error locations:
payment_source/card/number
CARD_EXPIRY_REQUIRED: The card expiry is required when attempting to process payment with card.
Possible error locations:
payment_source/card/expiry
INCOMPATIBLE_PARAMETER_VALUE: The value of the field is incompatible/redundant with other fields in the order.
Possible error locations:
payment_source/paypal/experience_context/brand_name
payment_source/paypal/experience_context/locale
payment_source/paypal/experience_context/return_url
payment_source/paypal/experience_context/cancel_url
application_context/brand_name
application_context/locale
application_context/return_url
application_context/cancel_url
payment_source/google_pay/decrypted_token/cryptogram
payment_source/google_pay/decrypted_token/authentication_method
payment_source/google_pay/decrypted_token/eci_indicator
payment_source/google_pay/token
payment_source/google_pay/decrypted_token
payment_source/google_pay/decrypted_token/cryptogram
payment_source/card/attributes/vault/confirm_payment_token
payment_source/card/attributes/vault/store_in_vault
payment_source/paypal/attributes/vault/confirm_payment_token
payment_source/paypal/attributes/vault/store_in_vault
payment_source/apple_pay/attributes/vault/store_in_vault
payment_source/paypal/experience_context/brand_name
payment_source/paypal/experience_context/locale
payment_source/paypal/experience_context/return_url
payment_source/paypal/experience_context/cancel_url
application_context/brand_name
application_context/locale
application_context/return_url
application_context/cancel_url
payment_source/paypal/vault_id
payment_source/card/number
payment_source/card/vault_id
payment_source/venmo/vault_id
payment_source/card/attributes/vault
payment_source/paypal/attributes/vault
payment_source/venmo/attributes/vault
payment_source/card/paypal_transaction_id
payment_source/card/pnref
payment_source/paypal/billing_agreement_id
payment_source/apple_pay/vault_id
payment_source/apple_pay/attributes/vault
payment_source/apple_pay/decrypted_token/payment_data/cryptogram
/payment_source/apple_pay/decrypted_token/payment_data/eci_indicator
/payment_source/card/attributes/payment_origin
payment_source/bank/sepa_debit/stored_credential/payment_initiator
payment_source/bank/sepa_debit/stored_credential/payment_type
payment_source/bank/sepa_debit/vault_id
payment_source/bank/sepa_debit/iban
payment_source/bank/sepa_debit/account_holder_name
payment_source/bank/sepa_debit/billing_address
payment_source/bank/sepa_debit/attributes/mandate/type
payment_source/bank/sepa_debit/stored_credential/payment_type
processing_instruction
purchase_units/0/items/0/category
payment_source/paypal/donation_context/display_context/business_name
payment_source/paypal/donation_context/display_context/title
payment_source/paypal/donation_context/display_context/logo_url
payment_source/paypal/donation_context/payment_context/recurring_frequency
payment_source/paypal/donation_context/payment_context/product_id
payment_source/paypal/donation_context/payment_context/donor_note
payment_source/paypal/donation_context/payment_context/product_flow
payment_source/paypal/donation_context/payment_context/donor_preferences
VAULT_INSTRUCTION_DUPLICATED: Only one vault instruction is allowed. Please use vault.store_in_vault to provide vault instruction.
VAULT_INSTRUCTION_REQUIRED: Vault instruction is required. Please use vault.store_in_vault to provide vault instruction.
MISMATCHED_VAULT_OWNER_ID: The owner_id does not match with the API caller. Please verify that the owner_id is same as the API caller's payer id.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
VAULT_OWNER_ID_NOT_SUPPORTED: API caller is not enabled to specify the vault owner_id explicitly. Please contact account manager to enable the functionality.
Possible error locations:
/payment_source/paypal/attributes/vault/owner_id
MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE: The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
Possible error locations:
payment_source/venmo/vault_id
payment_source/card/vault_id
payment_source/paypal/vault_id
payment_source/apple_pay/vault_id
payment_source/bank/sepa_debit/vault_id
NOT_ELIGIBLE_FOR_PNREF_PROCESSING: API caller is not enabled to process payments with the pnref. Please contact customer support to request permissions to process transactions with PNREF.
NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING: API caller is not enable to process payments using paypal_transaction_id. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
PAYPAL_TRANSACTION_ID_NOT_FOUND: Specified paypal_transaction_id was not found. Verify the value and try the request again.
PNREF_NOT_FOUND: Specified pnref was not found. Verify the value and try the request again.
INVALID_SECURITY_CODE_LENGTH: The security_code length is invalid for the specified card brand.
Possible error locations:
payment_source/card/security_code
NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE: The API caller or the merchant on whose behalf the API call is initiated is not allowed to vault the given source. Please contact PayPal customer support for assistance.
CRYPTOGRAM_REQUIRED: Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
Possible error locations:
/payment_source/apple_pay/decrypted_token/payment_data/cryptogram
EMV_DATA_REQUIRED: EMV Data is required if authentication method is EMV.
Possible error locations:
/payment_source/apple_pay/decrypted_token/payment_data/emv_data
ALIAS_DECLINED_BY_PROCESSOR: The provided alias was declined by the processor. Please create a new order with a different alias_key and/or alias_label and try again.
BLIK_ONE_CLICK_MISSING_REQUIRED_PARAMETER: Blik's one_click flow requires one_click.auth_code and one_click.alias_label parameters for the buyer's first transaction. For all subsequent transactions,only the one_click.alias_key parameter is required.
Possible error locations:
payment_source/blik/one_click/auth_code
payment_source/blik/one_click/alias_label
payment_source/blik/one_click/alias_key
TRANSACTION_LIMIT_EXCEEDED: Total payment amount exceeded transaction limit.
PUI_DUPLICATE_ORDER: A Pay Upon Invoice (Rechnungskauf) order with the same payload has already been successfully processed in the last few seconds. To process a new order, please try again in a few seconds.
NOT_ENABLED_FOR_PAYMENT_SOURCE: The 'API caller' and/or 'payee' is not setup to be able to process the selected payment source. If you have already completed the required steps, please allow 2 business days for PayPal to complete the setup. If you continue to receive this error, please contact your Account Manager or check status at https://www.paypal.com/businessmanage/account/payments.
Possible error locations:
/payment_source/alipay
/payment_source/bancomatpay
/payment_source/bancontact
/payment_source/bizum
/payment_source/blik
/payment_source/boletobancario
/payment_source/crypto
/payment_source/eps
/payment_source/giropay
/payment_source/ideal
/payment_source/mbway
/payment_source/multibanco
/payment_source/mybank
/payment_source/oxxo
/payment_source/payu
/payment_source/p24
/payment_source/paidy
/payment_source/safetypay
/payment_source/satispay
/payment_source/trustly
/payment_source/wechatpay
INVALID_VAULT_ID: The specified Vault ID is invalid or could not be found.
Possible error locations:
/payment_source/paypal/vault_id
MULTIPLE_PURCHASE_UNITS_NOT_SUPPORTED_FOR_PAYMENT_SOURCE: The provided payment source cannot be used to pay for the multiple purchase units order.
Possible error locations:
/payment_source/alipay
/payment_source/bancomatpay
/payment_source/bancontact
/payment_source/bizum
/payment_source/blik
/payment_source/eps
/payment_source/ideal
/payment_source/mbway
/payment_source/mybank
/payment_source/oxxo
/payment_source/payu
/payment_source/p24
/payment_source/trustly
/payment_source/wechatpay
/payment_source/grabpay
/payment_source/multibanco
/payment_source/satispay
/payment_source/pay_upon_invoice
LOCALE_NOT_SUPPORTED_BY_PAYMENT_SOURCE: Locale provided is not supported by the provided payment source.
Possible error locations:
/payment_source/ach_debit/experience_context/locale
BANK_VERIFICATION_REQUIRED: Only verified bank accounts can be processed.
Possible error locations:
/payment_source/ach_debit/attributes/verification
PARTNER_OR_MERCHANT_RESTRICTED_FOR_COUNTRY: The Partner or Merchant is not allowed to process payments using this payment source in the specified country. Please contact PayPal technical support.
PAYER_NOT_SUPPORTED_BY_PAYMENT_SOURCE: The Payer was declined by the payment source.
UNSUPPORTED_AUTHENTICATION_METHODS_FOR_PAYMENT_SOURCE: The provided list of authentication methods is not supported for this payment source.
Possible error locations:
/payment_source/bizum/experience_context/authentication_methods
FEE_REFERENCE_ID_NOT_FOUND
fee_reference_id is invalid or not found. Possible error locations:
/payment_source/card/attributes/installments/fee_reference_id
FEE_REFERENCE_AMOUNT_MISMATCH
Mismatch of amount used to for financing offer and order amount. Pass new amount to get financing offer & pass new fee_reference_id. Possible error locations:
/payment_source/card/attributes/installments/fee_reference_id
UNSUPPORTED_INSTALLMENTS
Installments are not supported for this payee, payment_source, amount and currency combination. Possible error locations:
/payment_source/card/attributes/installments
UNSUPPORTED_INSTALLMENT_TERM
Unsupported installment term. Issuer does not have support for this installment term. Possible error locations:
/payment_source/card/attributes/installments/term
UNSUPPORTED_INSTALLMENT_INTERVAL_DURATION
Unsupported installment interval duration. Only interval duration 'P1M' is supported. Possible error locations:
/payment_source/card/attributes/installments/interval_duration
UNSUPPORTED_INTENT_FOR_INSTALLMENTS
‘intent=AUTHORIZE is not supported for installments. Only 'intent=CAPTURE' is supported. Possible error locations:
/intent
UNSUPPORTED_PAYMENT_SOURCE_FOR_INSTALLMENTS
Installments are not supported for this payment_source. Possible error locations:
/payment_source
UNSUPPORTED_INSTALLMENTS_FOR_MULTIPLE_PURCHASE_UNITS
Issuer installments are not supported for multiple purchase units. Possible error locations:
/purchase_units
MAX_EXPIRY_TIME_EXCEEDED
The provided authorization_expiry is longer than allowed for the selected payment_source. Possible error locations:
/payment_source/klarna/authorization_context/authorization_expiry
Save order
Error Description Issue
UNPROCESSABLE_ENTITY
The requested action could not be performed, semantically incorrect, or failed business validation.
ORDER_CANNOT_BE_SAVED: The option to save an order is only available if the intent is AUTHORIZE and processing_instruction uses one of the ORDER_SAVED options. For example, intent=AUTHORIZE, processing_instruction=ORDER_SAVED_EXPLICITLY. Please change the intent and/or processing_instruction` and try again.
SAVE_ORDER_NOT_SUPPORTED: The API caller account is setup in a way that does not allow it to be used for saving the order. This functionality is not available for PayPal Complete Payments Platform for Platforms & Marketplaces.
Track order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well formed, is syntactically incorrect, or violates schema.
MISSING_REQUIRED_PARAMETER: A required field / parameter is missing.
Possible error locations:
/tracking_number
/capture_id
/carrier
INVALID_STRING_LENGTH: The value of a field is either too short or too long.
Possible error locations:
/capture_id
/tracking_number
/carrier_name_other
/items/0/name
/items/0/image_url
/items/0/url
INVALID_PARAMETER_VALUE: A parameter value is not valid.
Possible error locations:
/carrier
/items/0/upc
INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
Possible error locations:
/capture_id
/items/0/image_url
/items/0/url
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
UNPROCESSABLE_ENTITY
The requested action could not be performed, is semantically incorrect, or failed business validation.
INVALID_TRACKING_NUMBER: Use a valid tracking number. It must not be empty, contain spaces or tab characters
CAPTURE_STATUS_NOT_VALID: Invalid capture status. Tracker information can only be added to captures in COMPLETED state.
ITEM_SKU_MISMATCH: Item sku must match one of the items sku that was provided during order creation.
Possible error locations:
/items/0/sku
CAPTURE_ID_NOT_FOUND: Specified capture ID does not exist. Check the capture ID and try again.
Possible error locations:
/capture_id
MSP_NOT_SUPPORTED: Multiple purchase units are not supported for this operation.
RESOURCE_NOT_FOUND
The specified resource does not exist.
INVALID_RESOURCE_ID: Specified resource ID does not exist. Please check the resource ID and try again.
Trackers order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well formed, is syntactically incorrect, or violates schema.
FIELD_NOT_PATCHABLE: Field cannot be patched.
Possible error locations:
/capture_id
/tracking_number
INVALID_PARAMETER_VALUE: The value of a field is invalid.
Possible error locations:
op
/carrier
MISSING_REQUIRED_PARAMETER: A required field or parameter is missing.
Possible error locations:
op
INVALID_STRING_LENGTH: The value of a field is either too short or too long.
Possible error locations:
/carrier_name_other
INVALID_PATCH_OPERATION: The operation cannot be honored. Cannot add a property that's already present, use replace. Cannot remove a property thats not present, use add. Cannot replace a property thats not present, use add.
Possible error locations:
op
MALFORMED_REQUEST_JSON: The request JSON is not well formed.
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
RESOURCE_NOT_FOUND
The specified resource does not exist.
TRACKER_ID_NOT_FOUND: Specified tracker ID does not exist. Check the tracker ID and try again.
UNPROCESSABLE_ENTITY
The requested action could not be performed, is semantically incorrect, or failed business validation.
INVALID_JSON_POINTER_FORMAT: Path should be a valid JSON Pointer that references a location within the request where the operation is performed.
NOT_PATCHABLE: Cannot be patched.
PATCH_VALUE_REQUIRED: Specify a value for the field being patched.
PATCH_PATH_REQUIRED: Specify a value for the field in which the operation needs to be performed.
ITEM_SKU_MISMATCH: Item sku must match one of the items sku that was provided during order creation.
Possible error locations:
/items/0/sku
MAX_TRACKER_UPDATE_COUNT_EXCEEDED: Exceeding the permissible number of updates; tracker update operations do not support more than 15 updates.
Post order
Error Description Issue
INTERNAL_SERVER_ERROR
An internal server error occurred.
INVALID_REQUEST
Request is not well formed, is syntactically incorrect, or violates schema.
INVALID_STRING_LENGTH: The value of a field is either too short or too long.
Possible error locations:
/merchant_id
/order_id
/session_type
/apple_pay/domain_name
/apple_pay/display_name
/apple_pay/validation_url
MISSING_REQUIRED_PARAMETER: A required field or parameter is missing
Possible error locations:
/apple_pay/validation_url
/session_type
INVALID_PARAMETER_SYNTAX: The value of a field does not conform to the expected format.
Possible error locations:
/merchant_id
NOT_AUTHORIZED
Authorization failed due to insufficient permissions.
PERMISSION_DENIED: You do not have permission to access or perform operations on this resource.
UNPROCESSABLE_ENTITY
The requested action could not be performed, is semantically incorrect, or failed business validation.
NOT_ENABLED_FOR_APPLE_PAY: The 'API caller' and/or 'payee' is not setup to be able to process apple pay. Please contact your Account Manager.
DOMAIN_NOT_REGISTERED: The provided domain is not registered for this merchant.
TESTING_WITH_REAL_WALLET_NOT_ENABLED: Testing with real wallet is not supported for this domain. To enable testing using real wallet, please unregister the domain and register the domain again.
Possible error locations:
/use_real_wallet