Orders (2)

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

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.

SecurityOauth2
Request
header Parameters
PayPal-Request-Id
string [ 1 .. 108 ] characters ^[\S\s]*$

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 ^[\S\s]*$

PayPal Partner can send a PayPal-Partner-Attribution-Id request header with the value that they have been assigned by the PayPal Partner program. This value is known as a BN Code. In order to reward such partners (through partner programs), all the activities (including API calls) that they are doing on behalf of the merchants need to be tracked.

PayPal-Client-Metadata-Id
string (GUID) [ 1 .. 68 ] characters ^[A-Za-z0-9-{}(),]*$

A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to correlate calls which, in turn, might result in lower decline rates..

Examples:
A paypal-client-metadata-id header with a randomized value.
1295065d-6f34-42dc-ac65-fac0c86af250
Prefer
string [ 1 .. 25 ] characters ^[a-zA-Z=,-]*$
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.

Authorization
string (Schema Object for standard headers) [ 1 .. 16000 ] characters ^.*$

Holds authorization information for external API calls.

Examples:
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example.
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string [ 1 .. 10000 ] characters ^.*$

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Examples:
A paypal-auth-assertion header with a randomized value.
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Request Body schema: application/json
required
intent
required
string (checkout_payment_intent)

The intent to either capture payment immediately or authorize a payment for an order after order creation.

Enum: "CAPTURE" "AUTHORIZE"
object (payer)
Deprecated

The customer who approves and pays for the order. The customer is also known as the payer.

required
Array of objects (Purchase Unit Request) [ 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.

object (payment_source)

The payment source definition.

object (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.

Responses
200

A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows order details.

201

A 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.

400

Request is not well-formed, syntactically incorrect, or violates schema.

422

The requested action could not be performed, semantically incorrect, or failed business validation.

Request samples 
Response samples 
application/json
{}
Show order details
get/v2/checkout/orders/{id}
Shows details for an order, by ID.
Note: For error handling and troubleshooting, see Orders v2 errors.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which to show details.


 
query Parameters
fields
string  [ 0 .. 2147483647 ] characters ^[a-z_]*$
A comma-separated list of fields that should be returned for the order. Valid filter field is payment_source.


 
header Parameters
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string  [ 1 .. 10000 ] characters ^.*$
Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.


  Examples: 
A paypal-auth-assertion header with a randomized value. 
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Responses 
200
A successful request returns the HTTP 200 OK status code and a JSON response body that shows order details.


404
Default description


Request samples 
curl -v -X get https://api-m.sandbox.paypal.com//v2/checkout/orders/5O190127TN364715T \
-H 'Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ' \
-d '{}' 
Response samples 
application/json
{}
Update order
patch/v2/checkout/orders/{id}
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:

AttributeOpNotes
intentreplace
payerreplace, addUsing replace op for payer will replace the whole payer object with the value sent in request.
purchase_unitsreplace, add
purchase_units[].custom_idreplace, add, remove
purchase_units[].descriptionreplace, add, remove
purchase_units[].payee.emailreplace
purchase_units[].shipping.namereplace, add
purchase_units[].shipping.email_addressreplace, add
purchase_units[].shipping.phone_numberreplace, add
purchase_units[].shipping.optionsreplace, add
purchase_units[].shipping.addressreplace, add
purchase_units[].shipping.typereplace, add
purchase_units[].soft_descriptorreplace, remove
purchase_units[].amountreplace
purchase_units[].itemsreplace, add, remove
purchase_units[].invoice_idreplace, add, remove
purchase_units[].payment_instructionreplace
purchase_units[].payment_instruction.disbursement_modereplaceBy default, disbursement_mode is INSTANT.
purchase_units[].payment_instruction.payee_receivable_fx_rate_idreplace, add, remove
purchase_units[].payment_instruction.platform_feesreplace, add, remove
purchase_units[].supplementary_data.airlinereplace, add, remove
purchase_units[].supplementary_data.cardreplace, add, remove
application_context.client_configurationreplace, add


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order to update.


 
header Parameters
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string  [ 1 .. 10000 ] characters ^.*$
Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.


  Examples: 
A paypal-auth-assertion header with a randomized value. 
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Request Body schema: application/json
optional
 Array ([ 0 .. 32767 ] items)
op
required
string
The operation.


 Enum: "add" "remove" "replace" "move" "copy" "test"  
path
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
Responses 
204
No Content


400
Request is not well-formed, syntactically incorrect, or violates schema.


422
The requested action could not be performed, semantically incorrect, or failed business validation.


Request samples 
Response samples 
application/json
{ }
Confirm the Order
post/v2/checkout/orders/{id}/confirm-payment-source
Payer confirms their intent to pay for the the Order with the given payment source.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which the payer confirms their intent to pay.


 
header Parameters
PayPal-Client-Metadata-Id
string (GUID)   [ 1 .. 68 ] characters ^[A-Za-z0-9-{}(),]*$
A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to correlate calls which, in turn, might result in lower decline rates..


  Examples: 
A paypal-client-metadata-id header with a randomized value. 
1295065d-6f34-42dc-ac65-fac0c86af250
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string  [ 1 .. 10000 ] characters ^.*$
Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.


  Examples: 
A paypal-auth-assertion header with a randomized value. 
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Prefer
string  [ 1 .. 25 ] characters ^[a-zA-Z=]*$
 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
optional
required
object (payment_source) 
The payment source definition.


 
object (Order Confirm Application Context) 
Customizes the payer confirmation experience.


 
Responses 
200
A 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.


204
No Content


400
Request is not well-formed, syntactically incorrect, or violates schema.


403
Authorization failed due to insufficient permissions


422
The requested action could not be performed, semantically incorrect, or failed business validation.


500
An internal server error has occurred


Request samples 
Response samples 
application/json
{}
Authorize payment for order
post/v2/checkout/orders/{id}/authorize
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.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which to authorize.


 
header Parameters
PayPal-Request-Id
string  [ 1 .. 108 ] characters ^[\S\s]*$
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 ^[a-zA-Z=,-]*$
 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 (GUID)   [ 1 .. 68 ] characters ^[A-Za-z0-9-{}(),]*$
A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to correlate calls which, in turn, might result in lower decline rates..


  Examples: 
A paypal-client-metadata-id header with a randomized value. 
1295065d-6f34-42dc-ac65-fac0c86af250
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string  [ 1 .. 10000 ] characters ^.*$
Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.


  Examples: 
A paypal-auth-assertion header with a randomized value. 
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Request Body schema: application/json
optional
object (payment_source) 
The payment source definition.


 
Responses 
200
A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows authorized payment details.


201
A 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.


403
Authorization failed due to insufficient permissions


422
The requested action could not be performed, semantically incorrect, or failed business validation.


Request samples 
Response samples 
application/json
{}
Capture payment for order
post/v2/checkout/orders/{id}/capture
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.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order for which to capture a payment.


 
header Parameters
PayPal-Request-Id
string  [ 1 .. 108 ] characters ^[\S\s]*$
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 ^[a-zA-Z=,-]*$
 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 (GUID)   [ 1 .. 68 ] characters ^[A-Za-z0-9-{}(),]*$
A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to correlate calls which, in turn, might result in lower decline rates..


  Examples: 
A paypal-client-metadata-id header with a randomized value. 
1295065d-6f34-42dc-ac65-fac0c86af250
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string  [ 1 .. 10000 ] characters ^.*$
Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.


  Examples: 
A paypal-auth-assertion header with a randomized value. 
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Request Body schema: application/json
optional
object (payment_source) 
The payment source definition.


 
Responses 
200
A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows captured payment details.


201
A 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.


403
Authorization failed due to insufficient permissions


404
Default description


422
The requested action could not be performed, semantically incorrect, or failed business validation.


Request samples 
Response samples 
application/json
{
  • "id": "5O190127TN364715T",
  • "payment_source": {
    • "paypal": {
      • "name": {
        • "given_name": "John",
        • "surname": "Doe"
        },
      • "email_address": "[email protected]",
      • "account_id": "QYR5Z8XDVJNXQ",
      • "account_status": "VERIFIED"
      }
    },
  • "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,
            • "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": []
            }
          ]
        }
      }
    ],
  • "payer": {
    • "name": {
      • "given_name": "John",
      • "surname": "Doe"
      },
    • "email_address": "[email protected]",
    • "payer_id": "QYR5Z8XDVJNXQ"
    },
  • "links": []
}
Add tracking information for an Order.
post/v2/checkout/orders/{id}/track
Adds tracking information for an Order.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order that the tracking information is associated with.


 
header Parameters
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string  [ 1 .. 10000 ] characters ^.*$
Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.


  Examples: 
A paypal-auth-assertion header with a randomized value. 
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Request Body schema: application/json
required
tracking_number
required
string  [ 1 .. 64 ] characters ^[\S\s]*$
The tracking number for the shipment. This property supports Unicode.


 
carrier
required
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.


 Enum: "DPD_RU" "BG_BULGARIAN_POST" "KR_KOREA_POST" "ZA_COURIERIT" "FR_EXAPAQ" "ARE_EMIRATES_POST" "GAC" "GEIS" "SF_EX" "PAGO" "MYHERMES" "DIAMOND_EUROGISTICS" "CORPORATECOURIERS_WEBHOOK" "BOND" "OMNIPARCEL" "SK_POSTA" "PUROLATOR" "FETCHR_WEBHOOK" "THEDELIVERYGROUP" "CELLO_SQUARE" "TARRIVE" "COLLIVERY" "MAINFREIGHT" "IND_FIRSTFLIGHT" "ACSWORLDWIDE" "AMSTAN" "OKAYPARCEL" "ENVIALIA_REFERENCE" "SEUR_ES" "CONTINENTAL" "FDSEXPRESS" "AMAZON_FBA_SWISHIP" "WYNGS" "DHL_ACTIVE_TRACING" "ZYLLEM" "RUSTON" "XPOST" "CORREOS_ES" "DHL_FR" "PAN_ASIA" "BRT_IT" "SRE_KOREA" "SPEEDEE" "TNT_UK" "VENIPAK" "SHREENANDANCOURIER" "CROSHOT" "NIPOST_NG" "EPST_GLBL" "NEWGISTICS" "POST_SLOVENIA" "JERSEY_POST" "BOMBINOEXP" "WMG" "XQ_EXPRESS" "FURDECO" "LHT_EXPRESS" "SOUTH_AFRICAN_POST_OFFICE" "SPOTON" "DIMERCO" "CYPRUS_POST_CYP" "ABCUSTOM" "IND_DELIVREE" "CN_BESTEXPRESS" "DX_SFTP" "PICKUPP_MYS" "FMX" "HELLMANN" "SHIP_IT_ASIA" "KERRY_ECOMMERCE" "FRETERAPIDO" "PITNEY_BOWES" "XPRESSEN_DK" "SEUR_SP_API" "DELIVERYONTIME" "JINSUNG" "TRANS_KARGO" "SWISHIP_DE" "IVOY_WEBHOOK" "AIRMEE_WEBHOOK" "DHL_BENELUX" "FIRSTMILE" "FASTWAY_IR" "HH_EXP" "MYS_MYPOST_ONLINE" "TNT_NL" "TIPSA" "TAQBIN_MY" "KGMHUB" "INTEXPRESS" "OVERSE_EXP" "ONECLICK" "ROADRUNNER_FREIGHT" "GLS_CROTIA" "MRW_FTP" "BLUEX" "DYLT" "DPD_IR" "SIN_GLBL" "TUFFNELLS_REFERENCE" "CJPACKET" "MILKMAN" "ASIGNA" "ONEWORLDEXPRESS" "ROYAL_MAIL" "VIA_EXPRESS" "TIGFREIGHT" "ZTO_EXPRESS" "TWO_GO" "IML" "INTEL_VALLEY" "EFS" "UK_UK_MAIL" "RAM" "ALLIEDEXPRESS" "APC_OVERNIGHT" "SHIPPIT" "TFM" "M_XPRESS" "HDB_BOX" "CLEVY_LINKS" "IBEONE" "FIEGE_NL" "KWE_GLOBAL" "CTC_EXPRESS" "AMAZON" "MORE_LINK" "JX" "EASY_MAIL" "ADUIEPYLE" "GB_PANTHER" "EXPRESSSALE" "SG_DETRACK" "TRUNKRS_WEBHOOK" "MATDESPATCH" "DICOM" "MBW" "KHM_CAMBODIA_POST" "SINOTRANS" "BRT_IT_PARCELID" "DHL_SUPPLY_CHAIN" "DHL_PL" "TOPYOU" "PALEXPRESS" "DHL_SG" "CN_WEDO" "FULFILLME" "DPD_DELISTRACK" "UPS_REFERENCE" "CARIBOU" "LOCUS_WEBHOOK" "DSV" "P2P_TRC" "DIRECTPARCELS" "NOVA_POSHTA_INT" "FEDEX_POLAND" "CN_JCEX" "FAR_INTERNATIONAL" "IDEXPRESS" "GANGBAO" "NEWAY" "POSTNL_INT_3_S" "RPX_ID" "DESIGNERTRANSPORT_WEBHOOK" "GLS_SLOVEN" "PARCELLED_IN" "GSI_EXPRESS" "CON_WAY" "BROUWER_TRANSPORT" "CPEX" "ISRAEL_POST" "DTDC_IN" "PTT_POST" "XDE_WEBHOOK" "TOLOS" "GIAO_HANG" "GEODIS_ESPACE" "MAGYAR_HU" "DOORDASH_WEBHOOK" "TIKI_ID" "CJ_HK_INTERNATIONAL" "STAR_TRACK_EXPRESS" "HELTHJEM" "SFB2C" "FREIGHTQUOTE" "LANDMARK_GLOBAL_REFERENCE" "PARCEL2GO" "DELNEXT" "RCL" "CGS_EXPRESS" "HK_POST" "SAP_EXPRESS" "PARCELPOST_SG" "HERMES" "IND_SAFEEXPRESS" "TOPHATTEREXPRESS" "MGLOBAL" "AVERITT" "LEADER" "_2EBOX" "SG_SPEEDPOST" "DBSCHENKER_SE" "ISR_POST_DOMESTIC" "BESTWAYPARCEL" "ASENDIA_DE" "NIGHTLINE_UK" "TAQBIN_SG" "TCK_EXPRESS" "ENDEAVOUR_DELIVERY" "NANJINGWOYUAN" "HEPPNER_FR" "EMPS_CN" "FONSEN" "PICKRR" "APC_OVERNIGHT_CONNUM" "STAR_TRACK_NEXT_FLIGHT" "DAJIN" "UPS_FREIGHT" "POSTA_PLUS" "CEVA" "ANSERX" "JS_EXPRESS" "PADTF" "UPS_MAIL_INNOVATIONS" "SYPOST" "AMAZON_SHIP_MCF" "YUSEN" "BRING" "SDA_IT" "GBA" "NEWEGGEXPRESS" "SPEEDCOURIERS_GR" "FORRUN" "PICKUP" "ECMS" "INTELIPOST" "FLASHEXPRESS" "CN_STO" "SEKO_SFTP" "HOME_DELIVERY_SOLUTIONS" "DPD_HGRY" "KERRYTTC_VN" "JOYING_BOX" "TOTAL_EXPRESS" "ZJS_EXPRESS" "STARKEN" "DEMANDSHIP" "CN_DPEX" "AUPOST_CN" "LOGISTERS" "GOGLOBALPOST" "GLS_CZ" "PAACK_WEBHOOK" "GRAB_WEBHOOK" "PARCELPOINT" "ICUMULUS" "DAIGLOBALTRACK" "GLOBAL_IPARCEL" "YURTICI_KARGO" "CN_PAYPAL_PACKAGE" "PARCEL_2_POST" "GLS_IT" "PIL_LOGISTICS" "HEPPNER" "GENERAL_OVERNIGHT" "HAPPY2POINT" "CHITCHATS" "SMOOTH" "CLE_LOGISTICS" "FIEGE" "MX_CARGO" "ZIINGFINALMILE" "DAYTON_FREIGHT" "TCS" "AEX" "HERMES_DE" "ROUTIFIC_WEBHOOK" "GLOBAVEND" "CJ_LOGISTICS" "PALLET_NETWORK" "RAF_PH" "UK_XDP" "PAPER_EXPRESS" "LA_POSTE_SUIVI" "PAQUETEXPRESS" "LIEFERY" "STRECK_TRANSPORT" "PONY_EXPRESS" "ALWAYS_EXPRESS" "GBS_BROKER" "CITYLINK_MY" "ALLJOY" "YODEL" "YODEL_DIR" "STONE3PL" "PARCELPAL_WEBHOOK" "DHL_ECOMERCE_ASA" "SIMPLYPOST" "KY_EXPRESS" "SHENZHEN" "US_LASERSHIP" "UC_EXPRE" "DIDADI" "CJ_KR" "DBSCHENKER_B2B" "MXE" "CAE_DELIVERS" "PFCEXPRESS" "WHISTL" "WEPOST" "DHL_PARCEL_ES" "DDEXPRESS" "ARAMEX_AU" "BNEED" "HK_TGX" "LATVIJAS_PASTS" "VIAEUROPE" "CORREO_UY" "CHRONOPOST_FR" "J_NET" "_6LS" "BLR_BELPOST" "BIRDSYSTEM" "DOBROPOST" "WAHANA_ID" "WEASHIP" "SONICTL" "KWT" "AFLLOG_FTP" "SKYNET_WORLDWIDE" "NOVA_POSHTA" "SEINO" "SZENDEX" "BPOST_INT" "DBSCHENKER_SV" "AO_DEUTSCHLAND" "EU_FLEET_SOLUTIONS" "PCFCORP" "LINKBRIDGE" "PRIMAMULTICIPTA" "COUREX" "ZAJIL_EXPRESS" "COLLECTCO" "JTEXPRESS" "FEDEX_UK" "USHIP" "PIXSELL" "SHIPTOR" "CDEK" "VNM_VIETTELPOST" "CJ_CENTURY" "GSO" "VIWO" "SKYBOX" "KERRYTJ" "NTLOGISTICS_VN" "SDH_SCM" "ZINC" "DPE_SOUTH_AFRC" "CESKA_CZ" "ACS_GR" "DEALERSEND" "JOCOM" "CSE" "TFORCE_FINALMILE" "SHIP_GATE" "SHIPTER" "NATIONAL_SAMEDAY" "YUNEXPRESS" "CAINIAO" "DMS_MATRIX" "DIRECTLOG" "ASENDIA_US" "_3JMSLOGISTICS" "LICCARDI_EXPRESS" "SKY_POSTAL" "CNWANGTONG" "POSTNORD_LOGISTICS_DK" "LOGISTIKA" "CELERITAS" "PRESSIODE" "SHREE_MARUTI" "LOGISTICSWORLDWIDE_HK" "EFEX" "LOTTE" "LONESTAR" "APRISAEXPRESS" "BEL_RS" "OSM_WORLDWIDE" "WESTGATE_GL" "FASTRACK" "DTD_EXPR" "ALFATREX" "PROMEDDELIVERY" "THABIT_LOGISTICS" "HCT_LOGISTICS" "CARRY_FLAP" "US_OLD_DOMINION" "ANICAM_BOX" "WANBEXPRESS" "AN_POST" "DPD_LOCAL" "STALLIONEXPRESS" "RAIDEREX" "SHOPFANS" "KYUNGDONG_PARCEL" "CHAMPION_LOGISTICS" "PICKUPP_SGP" "MORNING_EXPRESS" "NACEX" "THENILE_WEBHOOK" "HOLISOL" "LBCEXPRESS_FTP" "KURASI" "USF_REDDAWAY" "APG" "CN_BOXC" "ECOSCOOTING" "MAINWAY" "PAPERFLY" "HOUNDEXPRESS" "BOX_BERRY" "EP_BOX" "PLUS_LOG_UK" "FULFILLA" "ASE" "MAIL_PLUS" "XPO_LOGISTICS" "WNDIRECT" "CLOUDWISH_ASIA" "ZELERIS" "GIO_EXPRESS" "OCS_WORLDWIDE" "ARK_LOGISTICS" "AQUILINE" "PILOT_FREIGHT" "QWINTRY" "DANSKE_FRAGT" "CARRIERS" "AIR_CANADA_GLOBAL" "PRESIDENT_TRANS" "STEPFORWARDFS" "SKYNET_UK" "PITTOHIO" "CORREOS_EXPRESS" "RL_US" "DESTINY" "UK_YODEL" "COMET_TECH" "DHL_PARCEL_RU" "TNT_REFR" "SHREE_ANJANI_COURIER" "MIKROPAKKET_BE" "ETS_EXPRESS" "COLIS_PRIVE" "CN_YUNDA" "AAA_COOPER" "ROCKET_PARCEL" "_360LION" "PANDU" "PROFESSIONAL_COURIERS" "FLYTEXPRESS" "LOGISTICSWORLDWIDE_MY" "CORREOS_DE_ESPANA" "IMX" "FOUR_PX_EXPRESS" "XPRESSBEES" "PICKUPP_VNM" "STARTRACK_EXPRESS" "FR_COLISSIMO" "NACEX_SPAIN_REFERENCE" "DHL_SUPPLY_CHAIN_AU" "ESHIPPING" "SHREETIRUPATI" "HX_EXPRESS" "INDOPAKET" "CN_17POST" "K1_EXPRESS" "CJ_GLS" "MYS_GDEX" "NATIONEX" "ANJUN" "FARGOOD" "SMG_EXPRESS" "RZYEXPRESS" "SEFL" "TNT_CLICK_IT" "HDB" "HIPSHIPPER" "RPXLOGISTICS" "KUEHNE" "IT_NEXIVE" "PTS" "SWISS_POST_FTP" "FASTRK_SERV" "_4_72" "US_YRC" "POSTNL_INTL_3S" "ELIAN_POST" "CUBYN" "SAU_SAUDI_POST" "ABXEXPRESS_MY" "HUAHAN_EXPRESS" "ZES_EXPRESS" "ZEPTO_EXPRESS" "SKYNET_ZA" "ZEEK_2_DOOR" "BLINKLASTMILE" "POSTA_UKR" "CHROBINSON" "CN_POST56" "COURANT_PLUS" "SCUDEX_EXPRESS" "SHIPENTEGRA" "B_TWO_C_EUROPE" "COPE" "IND_GATI" "CN_WISHPOST" "NACEX_ES" "TAQBIN_HK" "GLOBALTRANZ" "HKD" "BJSHOMEDELIVERY" "OMNIVA" "SUTTON" "PANTHER_REFERENCE" "SFCSERVICE" "LTL" "PARKNPARCEL" "SPRING_GDS" "ECEXPRESS" "INTERPARCEL_AU" "AGILITY" "XL_EXPRESS" "ADERONLINE" "DIRECTCOURIERS" "PLANZER" "SENDING" "NINJAVAN_WB" "NATIONWIDE_MY" "SENDIT" "GB_ARROW" "IND_GOJAVAS" "KPOST" "DHL_FREIGHT" "BLUECARE" "JINDOUYUN" "TRACKON" "GB_TUFFNELLS" "TRUMPCARD" "ETOTAL" "SFPLUS_WEBHOOK" "SEKOLOGISTICS" "HERMES_2MANN_HANDLING" "DPD_LOCAL_REF" "UDS" "ZA_SPECIALISED_FREIGHT" "THA_KERRY" "PRT_INT_SEUR" "BRA_CORREIOS" "NZ_NZ_POST" "CN_EQUICK" "MYS_EMS" "GB_NORSK" "ESP_MRW" "ESP_PACKLINK" "KANGAROO_MY" "RPX" "XDP_UK_REFERENCE" "NINJAVAN_MY" "ADICIONAL" "ROADBULL" "YAKIT" "MAILAMERICAS" "MIKROPAKKET" "DYNALOGIC" "DHL_ES" "DHL_PARCEL_NL" "DHL_GLOBAL_MAIL_ASIA" "DAWN_WING" "GENIKI_GR" "HERMESWORLD_UK" "ALPHAFAST" "BUYLOGIC" "EKART" "MEX_SENDA" "SFC_LOGISTICS" "POST_SERBIA" "IND_DELHIVERY" "DE_DPD_DELISTRACK" "RPD2MAN" "CN_SF_EXPRESS" "YANWEN" "MYS_SKYNET" "CORREOS_DE_MEXICO" "CBL_LOGISTICA" "MEX_ESTAFETA" "AU_AUSTRIAN_POST" "RINCOS" "NLD_DHL" "RUSSIAN_POST" "COURIERS_PLEASE" "POSTNORD_LOGISTICS" "FEDEX" "DPE_EXPRESS" "DPD" "ADSONE" "IDN_JNE" "THECOURIERGUY" "CNEXPS" "PRT_CHRONOPOST" "LANDMARK_GLOBAL" "IT_DHL_ECOMMERCE" "ESP_NACEX" "PRT_CTT" "BE_KIALA" "ASENDIA_UK" "GLOBAL_TNT" "POSTUR_IS" "EPARCEL_KR" "INPOST_PACZKOMATY" "IT_POSTE_ITALIA" "BE_BPOST" "PL_POCZTA_POLSKA" "MYS_MYS_POST" "SG_SG_POST" "THA_THAILAND_POST" "LEXSHIP" "FASTWAY_NZ" "DHL_AU" "COSTMETICSNOW" "PFLOGISTICS" "LOOMIS_EXPRESS" "GLS_ITALY" "LINE" "GEL_EXPRESS" "HUODULL" "NINJAVAN_SG" "JANIO" "AO_COURIER" "BRT_IT_SENDER_REF" "SAILPOST" "LALAMOVE" "NEWZEALAND_COURIERS" "ETOMARS" "VIRTRANSPORT" "WIZMO" "PALLETWAYS" "I_DIKA" "CFL_LOGISTICS" "GEMWORLDWIDE" "GLOBAL_EXPRESS" "LOGISTYX_TRANSGROUP" "WESTBANK_COURIER" "ARCO_SPEDIZIONI" "YDH_EXPRESS" "PARCELINKLOGISTICS" "CNDEXPRESS" "NOX_NIGHT_TIME_EXPRESS" "AERONET" "LTIANEXP" "INTEGRA2_FTP" "PARCELONE" "NOX_NACHTEXPRESS" "CN_CHINA_POST_EMS" "CHUKOU1" "GLS_SLOV" "ORANGE_DS" "JOOM_LOGIS" "AUS_STARTRACK" "DHL" "GB_APC" "BONDSCOURIERS" "JPN_JAPAN_POST" "USPS" "WINIT" "ARG_OCA" "TW_TAIWAN_POST" "DMM_NETWORK" "TNT" "BH_POSTA" "SWE_POSTNORD" "CA_CANADA_POST" "WISELOADS" "ASENDIA_HK" "NLD_GLS" "MEX_REDPACK" "JET_SHIP" "DE_DHL_EXPRESS" "NINJAVAN_THAI" "RABEN_GROUP" "ESP_ASM" "HRV_HRVATSKA" "GLOBAL_ESTES" "LTU_LIETUVOS" "BEL_DHL" "AU_AU_POST" "SPEEDEXCOURIER" "FR_COLIS" "ARAMEX" "DPEX" "MYS_AIRPAK" "CUCKOOEXPRESS" "DPD_POLAND" "NLD_POSTNL" "NIM_EXPRESS" "QUANTIUM" "SENDLE" "ESP_REDUR" "MATKAHUOLTO" "CPACKET" "POSTI" "HUNTER_EXPRESS" "CHOIR_EXP" "LEGION_EXPRESS" "AUSTRIAN_POST_EXPRESS" "GRUPO" "POSTA_RO" "INTERPARCEL_UK" "GLOBAL_ABF" "POSTEN_NORGE" "XPERT_DELIVERY" "DHL_REFR" "DHL_HK" "SKYNET_UAE" "GOJEK" "YODEL_INTNL" "JANCO" "YTO" "WISE_EXPRESS" "JTEXPRESS_VN" "FEDEX_INTL_MLSERV" "VAMOX" "AMS_GRP" "DHL_JP" "HRPARCEL" "GESWL" "BLUESTAR" "CDEK_TR" "DESCARTES" "DELTEC_UK" "DTDC_EXPRESS" "TOURLINE" "BH_WORLDWIDE" "OCS" "YINGNUO_LOGISTICS" "UPS" "TOLL" "PRT_SEUR" "DTDC_AU" "THA_DYNAMIC_LOGISTICS" "UBI_LOGISTICS" "FEDEX_CROSSBORDER" "A1POST" "TAZMANIAN_FREIGHT" "CJ_INT_MY" "SAIA_FREIGHT" "SG_QXPRESS" "NHANS_SOLUTIONS" "DPD_FR" "COORDINADORA" "ANDREANI" "DOORA" "INTERPARCEL_NZ" "PHL_JAMEXPRESS" "BEL_BELGIUM_POST" "US_APC" "IDN_POS" "FR_MONDIAL" "DE_DHL" "HK_RPX" "DHL_PIECEID" "VNPOST_EMS" "RRDONNELLEY" "DPD_DE" "DELCART_IN" "IMEXGLOBALSOLUTIONS" "ACOMMERCE" "EURODIS" "CANPAR" "GLS" "IND_ECOM" "ESP_ENVIALIA" "DHL_UK" "SMSA_EXPRESS" "TNT_FR" "DEX_I" "BUDBEE_WEBHOOK" "COPA_COURIER" "VNM_VIETNAM_POST" "DPD_HK" "TOLL_NZ" "ECHO" "FEDEX_FR" "BORDEREXPRESS" "MAILPLUS_JPN" "TNT_UK_REFR" "KEC" "DPD_RO" "TNT_JP" "TH_CJ" "EC_CN" "FASTWAY_UK" "FASTWAY_US" "GLS_DE" "GLS_ES" "GLS_FR" "MONDIAL_BE" "SGT_IT" "TNT_CN" "TNT_DE" "TNT_ES" "TNT_PL" "PARCELFORCE" "SWISS_POST" "TOLL_IPEC" "AIR_21" "AIRSPEED" "BERT" "BLUEDART" "COLLECTPLUS" "COURIERPLUS" "COURIER_POST" "DHL_GLOBAL_MAIL" "DPD_UK" "DELTEC_DE" "DEUTSCHE_DE" "DOTZOT" "ELTA_GR" "EMS_CN" "ECARGO" "ENSENDA" "FERCAM_IT" "FASTWAY_ZA" "FASTWAY_AU" "FIRST_LOGISITCS" "GEODIS" "GLOBEGISTICS" "GREYHOUND" "JETSHIP_MY" "LION_PARCEL" "AEROFLASH" "ONTRAC" "SAGAWA" "SIODEMKA" "STARTRACK" "TNT_AU" "TNT_IT" "TRANSMISSION" "YAMATO" "DHL_IT" "DHL_AT" "LOGISTICSWORLDWIDE_KR" "GLS_SPAIN" "AMAZON_UK_API" "DPD_FR_REFERENCE" "DHLPARCEL_UK" "MEGASAVE" "QUALITYPOST" "IDS_LOGISTICS" "JOYINGBOX" "PANTHER_ORDER_NUMBER" "WATKINS_SHEPARD" "FASTTRACK" "UP_EXPRESS" "ELOGISTICA" "ECOURIER" "CJ_PHILIPPINES" "SPEEDEX" "ORANGECONNEX" "TECOR" "SAEE" "GLS_ITALY_FTP" "DELIVERE" "YYCOM" "ADICIONAL_PT" "DKSH" "NIPPON_EXPRESS_FTP" "GOLS" "FUJEXP" "QTRACK" "OMLOGISTICS_API" "GDPHARM" "MISUMI_CN" "AIR_CANADA" "CITY56_WEBHOOK" "SAGAWA_API" "KEDAEX" "PGEON_API" "WEWORLDEXPRESS" "JT_LOGISTICS" "TRUSK" "VIAXPRESS" "DHL_SUPPLYCHAIN_ID" "ZUELLIGPHARMA_SFTP" "MEEST" "TOLL_PRIORITY" "MOTHERSHIP_API" "CAPITAL" "EUROPAKET_API" "HFD" "TOURLINE_REFERENCE" "GIO_ECOURIER" "CN_LOGISTICS" "PANDION" "BPOST_API" "PASSPORTSHIPPING" "PAKAJO" "DACHSER" "YUSEN_SFTP" "SHYPLITE" "XYY" "MWD" "FAXECARGO" "MAZET" "FIRST_LOGISTICS_API" "SPRINT_PACK" "HERMES_DE_FTP" "CONCISE" "KERRY_EXPRESS_TW_API" "EWE" "FASTDESPATCH" "ABCUSTOM_SFTP" "CHAZKI" "SHIPPIE" "GEODIS_API" "NAQEL_EXPRESS" "PAPA_WEBHOOK" "FORWARDAIR" "DIALOGO_LOGISTICA_API" "LALAMOVE_API" "TOMYDOOR" "KRONOS_WEBHOOK" "JTCARGO" "T_CAT" "CONCISE_WEBHOOK" "TELEPORT_WEBHOOK" "CUSTOMCO_API" "SPX_TH" "BOLLORE_LOGISTICS" "CLICKLINK_SFTP" "M3LOGISTICS" "VNPOST_API" "AXLEHIRE_FTP" "SHADOWFAX" "MYHERMES_UK_API" "DAIICHI" "MENSAJEROSURBANOS_API" "POLARSPEED" "IDEXPRESS_ID" "PAYO" "WHISTL_SFTP" "INTEX_DE" "TRANS2U" "PRODUCTCAREGROUP_SFTP" "BIGSMART" "EXPEDITORS_API_REF" "AITWORLDWIDE_API" "WORLDCOURIER" "QUIQUP" "AGEDISS_SFTP" "ANDREANI_API" "CRLEXPRESS" "SMARTCAT" "CROSSFLIGHT" "PROCARRIER" "DHL_REFERENCE_API" "SEINO_API" "WSPEXPRESS" "KRONOS" "TOTAL_EXPRESS_API" "PARCLL" "XPEDIGO" "STAR_TRACK_WEBHOOK" "GPOST" "UCS" "DMFGROUP" "COORDINADORA_API" "MARKEN" "NTL" "REDJEPAKKETJE" "ALLIED_EXPRESS_FTP" "MONDIALRELAY_ES" "NAEKO_FTP" "MHI" "SHIPPIFY" "MALCA_AMIT_API" "JTEXPRESS_SG_API" "DACHSER_WEB" "FLIGHTLG" "CAGO" "COM1EXPRESS" "TONAMI_FTP" "PACKFLEET" "PUROLATOR_INTERNATIONAL" "WINESHIPPING_WEBHOOK" "DHL_ES_SFTP" "PCHOME_API" "CESKAPOSTA_API" "GORUSH" "HOMERUNNER" "AMAZON_ORDER" "EFWNOW_API" "CBL_LOGISTICA_API" "NIMBUSPOST" "LOGWIN_LOGISTICS" "NOWLOG_API" "DPD_NL" "GODEPENDABLE" "ESDEX" "LOGISYSTEMS_SFTP" "EXPEDITORS" "SNTGLOBAL_API" "SHIPX" "QINTL_API" "PACKS" "POSTNL_INTERNATIONAL" "AMAZON_EMAIL_PUSH" "DHL_API" "SPX" "AXLEHIRE" "ICSCOURIER" "DIALOGO_LOGISTICA" "SHUNBANG_EXPRESS" "TCS_API" "SF_EXPRESS_CN" "PACKETA" "SIC_TELIWAY" "MONDIALRELAY_FR" "INTIME_FTP" "JD_EXPRESS" "FASTBOX" "PATHEON" "INDIA_POST" "TIPSA_REF" "ECOFREIGHT" "VOX" "DIRECTFREIGHT_AU_REF" "BESTTRANSPORT_SFTP" "AUSTRALIA_POST_API" "FRAGILEPAK_SFTP" "FLIPXP" "VALUE_WEBHOOK" "DAESHIN" "SHERPA" "MWD_API" "SMARTKARGO" "DNJ_EXPRESS" "GOPEOPLE" "MYSENDLE_API" "ARAMEX_API" "PIDGE" "THAIPARCELS" "PANTHER_REFERENCE_API" "POSTAPLUS" "BUFFALO" "U_ENVIOS" "ELITE_CO" "ROCHE_INTERNAL_SFTP" "DBSCHENKER_ICELAND" "TNT_FR_REFERENCE" "NEWGISTICSAPI" "GLOVO" "GWLOGIS_API" "SPREETAIL_API" "MOOVA" "PLYCONGROUP" "USPS_WEBHOOK" "REIMAGINEDELIVERY" "EDF_FTP" "DAO365" "BIOCAIR_FTP" "RANSA_WEBHOOK" "SHIPXPRES" "COURANT_PLUS_API" "SHIPA" "HOMELOGISTICS" "DX" "POSTE_ITALIANE_PACCOCELERE" "TOLL_WEBHOOK" "LCTBR_API" "DX_FREIGHT" "DHL_SFTP" "SHIPROCKET" "UBER_WEBHOOK" "STATOVERNIGHT" "BURD" "FASTSHIP" "IBVENTURE_WEBHOOK" "GATI_KWE_API" "CRYOPDP_FTP" "HUBBED" "TIPSA_API" "ARASKARGO" "THIJS_NL" "ATSHEALTHCARE_REFERENCE" "99MINUTOS" "HELLENIC_POST" "HSM_GLOBAL" "MNX" "NMTRANSFER" "LOGYSTO" "INDIA_POST_INT" "AMAZON_FBA_SWISHIP_IN" "SRT_TRANSPORT" "BOMI" "DELIVERR_SFTP" "HSDEXPRESS" "SIMPLETIRE_WEBHOOK" "HUNTER_EXPRESS_SFTP" "UPS_API" "WOOYOUNG_LOGISTICS_SFTP" "PHSE_API" "WISH_EMAIL_PUSH" "NORTHLINE" "MEDAFRICA" "DPD_AT_SFTP" "ANTERAJA" "DHL_GLOBAL_FORWARDING_API" "LBCEXPRESS_API" "SIMSGLOBAL" "CDLDELIVERS" "TYP" "TESTING_COURIER_WEBHOOK" "PANDAGO_API" "ROYAL_MAIL_FTP" "THUNDEREXPRESS" "SECRETLAB_WEBHOOK" "SETEL" "JD_WORLDWIDE" "DPD_RU_API" "ARGENTS_WEBHOOK" "POSTONE" "TUSKLOGISTICS" "RHENUS_UK_API" "TAQBIN_SG_API" "INNTRALOG_SFTP" "DAYROSS" "CORREOSEXPRESS_API" "INTERNATIONAL_SEUR_API" "YODEL_API" "HEROEXPRESS" "DHL_SUPPLYCHAIN_IN" "URGENT_CARGUS" "FRONTDOORCORP" "JTEXPRESS_PH" "PARCELSTARS_WEBHOOK" "DPD_SK_SFTP" "MOVIANTO" "OZEPARTS_SHIPPING" "KARGOMKOLAY" "TRUNKRS" "OMNIRPS_WEBHOOK" "CHILEXPRESS" "TESTING_COURIER" "JNE_API" "BJSHOMEDELIVERY_FTP" "DEXPRESS_WEBHOOK" "USPS_API" "TRANSVIRTUAL" "SOLISTICA_API" "CHIENVENTURE_WEBHOOK" "DPD_UK_SFTP" "INPOST_UK" "JAVIT" "ZTO_DOMESTIC" "DHL_GT_API" "CEVA_TRACKING" "KOMON_EXPRESS" "EASTWESTCOURIER_FTP" "DANNIAO" "SPECTRAN" "DELIVER_IT" "RELAISCOLIS" "GLS_SPAIN_API" "POSTPLUS" "AIRTERRA" "GIO_ECOURIER_API" "DPD_CH_SFTP" "FEDEX_API" "INTERSMARTTRANS" "HERMES_UK_SFTP" "EXELOT_FTP" "DHL_PA_API" "VIRTRANSPORT_SFTP" "WORLDNET" "INSTABOX_WEBHOOK" "KNG" "FLASHEXPRESS_WEBHOOK" "MAGYAR_POSTA_API" "WESHIP_API" "OHI_WEBHOOK" "MUDITA" "BLUEDART_API" "T_CAT_API" "ADS" "HERMES_IT" "FITZMARK_API" "POSTI_API" "SMSA_EXPRESS_WEBHOOK" "TAMERGROUP_WEBHOOK" "LIVRAPIDE" "NIPPON_EXPRESS" "BETTERTRUCKS" "FAN" "PB_USPSFLATS_FTP" "PARCELRIGHT" "ITHINKLOGISTICS" "KERRY_EXPRESS_TH_WEBHOOK" "ECOUTIER" "SHOWL" "BRT_IT_API" "RIXONHK_API" "DBSCHENKER_API" "ILYANGLOGIS" "MAIL_BOX_ETC" "WESHIP" "DHL_GLOBAL_MAIL_API" "ACTIVOS24_API" "ATSHEALTHCARE" "LUWJISTIK" "GW_WORLD" "FAIRSENDEN_API" "SERVIP_WEBHOOK" "SWISHIP" "TANET" "HOTSIN_CARGO" "DIREX" "HUANTONG" "IMILE_API" "AUEXPRESS" "NYTLOGISTICS" "DSV_REFERENCE" "NOVOFARMA_WEBHOOK" "AITWORLDWIDE_SFTP" "SHOPOLIVE" "FNF_ZA" "DHL_ECOMMERCE_GC" "FETCHR" "STARLINKS_API" "YYEXPRESS" "SERVIENTREGA" "HANJIN" "SPANISH_SEUR_FTP" "DX_B2B_CONNUM" "HELTHJEM_API" "INEXPOST" "A2B_BA" "RHENUS_GROUP" "SBERLOGISTICS_RU" "MALCA_AMIT" "PPL" "OSM_WORLDWIDE_SFTP" "ACILOGISTIX" "OPTIMACOURIER" "NOVA_POSHTA_API" "LOGGI" "YIFAN" "MYDYNALOGIC" "MORNINGLOBAL" "CONCISE_API" "FXTRAN" "DELIVERYOURPARCEL_ZA" "UPARCEL" "MOBI_BR" "LOGINEXT_WEBHOOK" "EMS" "SPEEDY" "ZOOM_RED" "NAVLUNGO" "CASTLEPARCELS" "WEEE" "PACKALY" "YUNHUIPOST" "YOUPARCEL" "LEMAN" "MOOVIN" "URB_IT" "MULTIENTREGAPANAMA" "JUSDASR" "DISCOUNTPOST" "RHENUS_UK" "SWISHIP_JP" "GLS_US" "SMTL" "EMEGA" "EXPRESSONE_SV" "HEPSIJET" "WELIVERY" "BRINGER" "EASYROUTES" "MRW" "RPM" "DPD_PRT" "GLS_ROMANIA" "LMPARCEL" "GTAGSM" "DOMINO" "ESHIPPER" "TRANSPAK" "XINDUS" "AOYUE" "EASYPARCEL" "EXPRESSONE" "SENDEO_KARGO" "SPEEDAF" "ETOWER" "GCX" "NINJAVAN_VN" "ALLEGRO" "JUMPPOINT" "SHIPGLOBAL_US" "KINISI" "OAKH" "AWEST" "BARSAN" "ENERGOLOGISTIC" "MADROOEX" "GOBOLT" "SWISS_UNIVERSAL_EXPRESS" "IORDIRECT" "XMSZM" "GLS_HUN" "SENDY" "BRAUNSEXPRESS" "GRANDSLAMEXPRESS" "XGS" "OTSCHILE" "PACK_UP" "PARCELSTARS" "TEAMEXPRESSLLC" "ASYADEXPRESS" "TDN" "EARLYBIRD" "CACESA" "PARCELJET" "MNG_KARGO" "SUPERPACKLINE" "SPEEDX" "VESYL" "SKYKING" "DIRMENSAJERIA" "NETLOGIXGROUP" "ZYOU" "JAWAR" "AGSYSTEMS" "GPS" "PTT_KARGO" "MAERGO" "ARIHANTCOURIER" "VTFE" "YUNANT" "URBIFY" "PACK_MAN" "LIEFERGRUN" "OBIBOX" "PAIKEDA" "SCOTTY" "INTELCOM_CA" "SWE" "ASENDIA" "DPD_AT" "RELAY" "ATA" "SKYEXPRESS_INTERNATIONAL" "SURAT_KARGO" "SGLINK" "FLEETOPTICSINC" "SHOPLINE" "PIGGYSHIP" "LOGOIX" "KOLAY_GELSIN" "ASSOCIATED_COURIERS" "UPS_CHECKER" "WINESHIPPING" "SPEDISCI" "FOURKITES" "ETONAS" "FINMILE" "UNIUNI" "RODONAVES" "INPOST_IT" "TFORCE_FREIGHT" "RICHMOM" "FRANCO" "ECPARCEL" "FEDEX_CHINA" "GOFO_EXPRESS" "SHIPBOB" "JERSEYPOST_ATLAS" "CORETRAILS" "RHENUS_ITALY" "JADLOG" "JITSU" "YANWEN_EXPRESS" "DASHLINK" "SEINO_SUPER_EXPRESS" "FLOSHIP" "METROSCG" "SENDPARCEL" "P2P" "CN_EXPRESS" "CIRROTRACK" "LAND_LOGISTICS" "VEHO" "MEDLINE" "VDTRACK" "SINO_SCM" "3PE_EXPRESS" "SWIFTX" "SFYDEXPRESS" "TOPTRANS" "OTHER"  
carrier_name_other
string  [ 1 .. 64 ] characters ^[\S\s]*$
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.


 
capture_id
required
string  [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$
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.


 
Array of objects (tracker_item)   [ 0 .. 32767 ] items 
An array of details of items in the shipment.


 
Responses 
200
A successful response to an idempotent request returns the HTTP 200 OK status code with a JSON response body that shows tracker details.


201
A 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.


400
Request is not well-formed, syntactically incorrect, or violates schema.


403
Authorization failed due to insufficient permissions


422
The requested action could not be performed, semantically incorrect, or failed business validation.


500
An internal server error has occurred


Request samples 
Response samples 
application/json
{}
Update or cancel tracking information for an order
patch/v2/checkout/orders/{id}/trackers/{tracker_id}
Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:

AttributeOpNotes
itemsreplaceUsing replace op for items will replace the entire items object with the value sent in request.
notify_payerreplace, add
statusreplaceOnly patching status to CANCELLED is currently supported.


SecurityOauth2 
Request 
path Parameters
id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The ID of the order that the tracking information is associated with.


 
tracker_id
required
string  [ 1 .. 36 ] characters ^[A-Z0-9]+$
The order tracking ID.


 
header Parameters
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
PayPal-Auth-Assertion
string  [ 1 .. 10000 ] characters ^.*$
Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.


  Examples: 
A paypal-auth-assertion header with a randomized value. 
eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9
Request Body schema: application/json
optional
 Array ([ 0 .. 32767 ] items)
op
required
string
The operation.


 Enum: "add" "remove" "replace" "move" "copy" "test"  
path
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
Responses 
204
No Content


400
Request is not well-formed, syntactically incorrect, or violates schema.


403
Authorization failed due to insufficient permissions


404
Default description


422
The requested action could not be performed, semantically incorrect, or failed business validation.


500
An internal server error has occurred


Request samples 
Response samples 
application/json
{ }
Receive updated order information via callback URL
post/v2/checkout/orders/order-update-callback
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.


SecurityOauth2 
Request 
header Parameters
Authorization
string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Holds authorization information for external API calls.


  Examples: 
An authorization header with information for the Bearer authorization scheme. The authorization parameter value is randomized for this example. 
Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ
Request Body schema: application/json
optional
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
object (shipping_option) 
The options that the payee or merchant offers to the payer to ship or pick up their items.


 
required
Array of objects (Purchase Unit Request)   = 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.


 
Responses 
200
The callback to merchant was successful.


Request samples 
Response samples 
application/json
{
  • "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": "T-Shirt",
        • "description": "Green XL",
        • "sku": "sku01",
        • "unit_amount": {
          • "currency_code": "USD",
          • "value": "90.00"
          },
        • "tax": {
          • "currency_code": "USD",
          • "value": "10.00"
          },
        • "quantity": "1",
        • "category": "PHYSICAL_GOODS"
        }
      ],
    • "shipping": {
      • "options": [
        • {
          • "id": "FEDEX",
          • "amount": {
            • "currency_code": "USD",
            • "value": "0.00"
            },
          • "type": "SHIPPING",
          • "label": "Free Shipping",
          • "selected": true
          }
        ]
      }
    }
}
Definitions
account_id-2
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-2)   = 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.


 
"stringstrings"
activity_timestamps
The date and time stamps that are common to authorized payment, captured payment, and refund transactions.


create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
{
  • "create_time": "string",
  • "update_time": "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.


object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (discount_with_breakdown) 
The discount amount and currency code. For list of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.


 
{
  • "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 (currency_code)   = 3 characters ^[\S\s]*$
The three-character ISO-4217 currency code that identifies the currency.


 
value
required
string  [ 0 .. 32 ] characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
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.


 
object (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.


 
{
  • "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"
      }
    }
}
App Switch Preferences on Native App
Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.


os_type
string
Operating System type of the device that the buyer is using.


 Enum: "ANDROID" "IOS" "OTHER"  
os_version
string  [ 1 .. 64 ] characters ^.*$
Operating System version of the device that the buyer is using.


 
{
  • "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.


 
name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
email_address
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (Phone) 
The phone number, in its canonical international E.164 numbering plan format.


 
object (apple_pay_card_response) 
The Card from Apple Pay Wallet used to fund the payment.


 
object (apple_pay_attributes_response) 
Additional attributes associated with the use of Apple Pay.


 
object (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.


 
{
  • "id": "string",
  • "token": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string",
    • "extension_number": "string"
    },
  • "card": {
    • "name": "string",
    • "last_digits": "string",
    • "brand": "VISA",
    • "available_networks": [
      • "VISA"
      ],
    • "type": "CREDIT",
    • "authentication_result": {
      • "liability_shift": "NO",
      • "three_d_secure": {
        • "authentication_status": "Y",
        • "enrollment_status": "Y"
        }
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_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"
              }
            }
          ]
        }
      },
    • "from_request": {
      • "expiry": "string",
      • "last_digits": "stri"
      },
    • "expiry": "string",
    • "bin_details": {
      • "bin": "string",
      • "issuing_bank": "string",
      • "bin_country_code": "string",
      • "products": [
        • "string"
        ]
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        }
      },
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "country_code": "string"
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "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"
            }
          }
        ]
      }
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "network": "VISA",
      • "acquirer_reference_number": "string"
      }
    }
}
apple_pay_attributes
Additional attributes associated with apple pay.


object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
object (v3_vault_instruction_base) 
Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      }
    },
  • "vault": {
    • "store_in_vault": "ON_SUCCESS"
    }
}
apple_pay_attributes_response
Additional attributes associated with the use of Apple Pay.


object (vault_response) 
The details about a saved payment source.


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "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"
          }
        }
      ]
    }
}
apple_pay_card_response
The Card from Apple Pay Wallet used to fund the payment.


name
string  [ 0 .. 300 ] characters ^[\S\s]*$
The card holder's name as it appears on the card.


 
last_digits
string  [ 0 .. 2147483647 ] characters ^.*[0-9]{2,}.*$
The last digits of the payment card.


 
brand
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
available_networks
Array of strings (card_brand)   [ 1 .. 256 ] items 
Array of brands or networks associated with the card.


Items Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
type
string (card_type) 
Type of card. i.e Credit, Debit and so on.


 Enum: "CREDIT" "DEBIT" "PREPAID" "STORE" "UNKNOWN"  
object (authentication_response) 
Results of Authentication such as 3D Secure.


 
object (card_attributes_response) 
Additional attributes associated with the use of this card.


 
object (card_from_request) 
Representation of card details as received in the request.


 
expiry
string (date_year_month)   = 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.


 
object (bin_details) 
Bank Identification Number (BIN) details used to fund a payment.


 
object (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.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
country_code
string (country_code-2)   = 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.


 
{
  • "name": "string",
  • "last_digits": "string",
  • "brand": "VISA",
  • "available_networks": [
    • "VISA"
    ],
  • "type": "CREDIT",
  • "authentication_result": {
    • "liability_shift": "NO",
    • "three_d_secure": {
      • "authentication_status": "Y",
      • "enrollment_status": "Y"
      }
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "merchant_customer_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"
            }
          }
        ]
      }
    },
  • "from_request": {
    • "expiry": "string",
    • "last_digits": "stri"
    },
  • "expiry": "string",
  • "bin_details": {
    • "bin": "string",
    • "issuing_bank": "string",
    • "bin_country_code": "string",
    • "products": [
      • "string"
      ]
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "network": "VISA",
      • "acquirer_reference_number": "string"
      }
    },
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "country_code": "string"
}
apple_pay_decrypted_token_data
Information about the Payment data obtained by decrypting Apple Pay token.


object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
required
object (card) 
The payment card to use to fund a payment. Can be a credit or debit card.


 
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
Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.


 Enum: "3DSECURE" "EMV"  
object (apple_pay_payment_data) 
Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator.


 
{
  • "transaction_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tokenized_card": {
    • "id": "string",
    • "name": "string",
    • "number": "stringstrings",
    • "expiry": "string",
    • "security_code": "stri",
    • "last_digits": "stri",
    • "card_type": "VISA",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        },
      • "verification": {
        • "method": "SCA_ALWAYS"
        }
      }
    },
  • "device_manufacturer_id": "string",
  • "payment_data_type": "3DSECURE",
  • "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 <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
cancel_url
required
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
{}
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.


 
{
  • "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.


 
name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
email_address
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (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.


 
object (apple_pay_decrypted_token_data) 
Information about the Payment data obtained by decrypting Apple Pay token.


 
object (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.


 
vault_id
string (vault_id)   [ 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.


 
object (apple_pay_attributes) 
Additional attributes associated with apple pay.


 
object (apple_pay_experience_context) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "id": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": {
    • "national_number": "string"
    },
  • "decrypted_token": {
    • "transaction_amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "tokenized_card": {
      • "id": "string",
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "security_code": "stri",
      • "last_digits": "stri",
      • "card_type": "VISA",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        }
      },
    • "device_manufacturer_id": "string",
    • "payment_data_type": "3DSECURE",
    • "payment_data": {
      • "cryptogram": "string",
      • "eci_indicator": "string",
      • "emv_data": "string",
      • "pin": "string"
      }
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "network": "VISA",
      • "acquirer_reference_number": "string"
      }
    },
  • "vault_id": "string",
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        }
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS"
      }
    },
  • "experience_context": {}
}
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 ^[\S\s]*$
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.


 
locale
string (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
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.


 
landing_page
string (Order Application Context Landing Page) 
 Deprecated 
 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. DEPRECATED
SeeSince Version
payment_source.paypal.experience_context.landing_page2.9


 Enum: "LOGIN" "BILLING" "NO_PREFERENCE"  
shipping_preference
string (Order Application Context Shipping Preference) 
 Deprecated 
 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. DEPRECATED
SeeSince Version
payment_source.paypal.experience_context.shipping_preference2.9


 Enum: "GET_FROM_FILE" "NO_SHIPPING" "SET_PROVIDED_ADDRESS"  
user_action
string
 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: "CONTINUE" "PAY_NOW"  
object (payment_method) 
The customer and merchant payment preferences.


 
return_url
string <uri>   [ 0 .. 2147483647 ] characters 
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 <uri>   [ 0 .. 2147483647 ] characters 
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.


 
object (stored_payment_source) 
 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.


 
{
  • "brand_name": "string",
  • "locale": "string",
  • "landing_page": "LOGIN",
  • "shipping_preference": "GET_FROM_FILE",
  • "user_action": "CONTINUE",
  • "payment_method": {
    • "payee_preferred": "UNRESTRICTED",
    • "standard_entry_class_code": "TEL"
    },
  • "return_url": "http://example.com",
  • "cancel_url": "http://example.com",
  • "stored_payment_source": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "network": "VISA",
      • "acquirer_reference_number": "string"
      }
    }
}
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.


 
{
  • "account_verified": false,
  • "card_holder_authenticated": false
}
authentication_response
Results of Authentication such as 3D Secure.


liability_shift
string (liability_shift) 
Liability shift indicator. The outcome of the issuer's authentication.


 Enum: "NO" "POSSIBLE" "UNKNOWN"  
object (three_d_secure_authentication_response) 
Results of 3D Secure Authentication.


 
{
  • "liability_shift": "NO",
  • "three_d_secure": {
    • "authentication_status": "Y",
    • "enrollment_status": "Y"
    }
}
authorization
The authorized payment transaction.


status
string (Authorization Status) 
The status for the authorized payment.


 Enum: "CREATED" "CAPTURED" "DENIED" "PARTIALLY_CAPTURED" "VOIDED" "PENDING"  
object (authorization_status_details) 
The details of the authorized payment status.


 
id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The PayPal-generated ID for the authorized payment.


 
object (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.


 
invoice_id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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  [ 0 .. 255 ] characters ^[\S\s]*$
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
object (network_transaction) 
Reference values used by the card network to identify a transaction.


 
object (seller_protection) 
The level of protection offered as defined by PayPal Seller Protection for Merchants.


 
expiration_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
Array of objects (Link Description)   [ 0 .. 32767 ] items 
An array of related HATEOAS links.


 
create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
{
  • "status": "CREATED",
  • "status_details": {
    • "reason": "PENDING_REVIEW"
    },
  • "id": "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"
        }
      }
    },
  • "invoice_id": "string",
  • "custom_id": "string",
  • "network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "network": "VISA",
    • "acquirer_reference_number": "string"
    },
  • "seller_protection": {
    • "status": "ELIGIBLE",
    • "dispute_categories": [
      • "ITEM_NOT_RECEIVED"
      ]
    },
  • "expiration_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"
        }
      }
    ],
  • "create_time": "string",
  • "update_time": "string"
}
authorization_status
The status fields and status details for an authorized payment.


status
string (Authorization Status) 
The status for the authorized payment.


 Enum: "CREATED" "CAPTURED" "DENIED" "PARTIALLY_CAPTURED" "VOIDED" "PENDING"  
object (authorization_status_details) 
The details of the authorized payment status.


 
{
  • "status": "CREATED",
  • "status_details": {
    • "reason": "PENDING_REVIEW"
    }
}
authorization_status_details
The details of the authorized payment status.


reason
string (Authorization Incomplete Reason) 
The reason why the authorized status is PENDING.


 Enum: "PENDING_REVIEW" "DECLINED_BY_RISK_FRAUD_FILTERS"  
{
  • "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 (Authorization Status) 
The status for the authorized payment.


 Enum: "CREATED" "CAPTURED" "DENIED" "PARTIALLY_CAPTURED" "VOIDED" "PENDING"  
object (authorization_status_details) 
The details of the authorized payment status.


 
id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The PayPal-generated ID for the authorized payment.


 
object (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.


 
invoice_id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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  [ 0 .. 255 ] characters ^[\S\s]*$
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
object (network_transaction) 
Reference values used by the card network to identify a transaction.


 
object (seller_protection) 
The level of protection offered as defined by PayPal Seller Protection for Merchants.


 
expiration_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
Array of objects (Link Description)   [ 0 .. 32767 ] items 
An array of related HATEOAS links.


 
create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
object (processor_response) 
The processor response information for payment requests, such as direct credit card transactions.


 
{
  • "status": "CREATED",
  • "status_details": {
    • "reason": "PENDING_REVIEW"
    },
  • "id": "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"
        }
      }
    },
  • "invoice_id": "string",
  • "custom_id": "string",
  • "network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "network": "VISA",
    • "acquirer_reference_number": "string"
    },
  • "seller_protection": {
    • "status": "ELIGIBLE",
    • "dispute_categories": [
      • "ITEM_NOT_RECEIVED"
      ]
    },
  • "expiration_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"
        }
      }
    ],
  • "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.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters ^.*[a-zA-Z0-9]{4}.*$
The last characters of the IBAN used to pay.


 
card_last_digits
string  = 4 characters ^[0-9]{4}$
The last digits of the card used to fund the Bancontact payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string",
  • "card_last_digits": "stri"
}
bancontact_request
Information needed to pay using Bancontact.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {}
}
BIC
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
"stringst"
billing_agreement_id
The PayPal billing agreement ID. References an approved recurring payment for goods or services.


string (billing_agreement_id)   [ 2 .. 128 ] characters ^[a-zA-Z0-9-]+$
The PayPal billing agreement ID. References an approved recurring payment for goods or services.


 
"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
The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.


 Enum: "REGULAR" "TRIAL"  
object (pricing_scheme) 
The pricing scheme details.


 
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.


 
start_date
string (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
{
  • "tenure_type": "REGULAR",
  • "pricing_scheme": {
    • "price": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "pricing_model": "FIXED",
    • "reload_threshold_amount": {
      • "currency_code": "str",
      • "value": "string"
      }
    },
  • "total_cycles": 1,
  • "sequence": 1,
  • "start_date": "string"
}
bin_details
Bank Identification Number (BIN) details used to fund a payment.


bin
string  [ 1 .. 25 ] characters ^[0-9]+$
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 ^[\S\s]*$
The issuer of the card instrument.


 
bin_country_code
string (country_code-2)   = 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.


 
products
Array of strings (products)   [ 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": "string",
  • "issuing_bank": "string",
  • "bin_country_code": "string",
  • "products": [
    • "string"
    ]
}
blik
Information used to pay using BLIK.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
email
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (blik_one_click_response) 
Information used to pay using BLIK one-click flow.


 
{
  • "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.


 
locale
string (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
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.


 
shipping_preference
string
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum: "GET_FROM_FILE" "NO_SHIPPING" "SET_PROVIDED_ADDRESS"  
return_url
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
cancel_url
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
consumer_ip
string (IP Address)   [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...
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.


 
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).


 
{
  • "brand_name": "string",
  • "locale": "string",
  • "shipping_preference": "GET_FROM_FILE",
  • "return_url": "http://example.com",
  • "cancel_url": "http://example.com",
  • "consumer_ip": "string",
  • "consumer_user_agent": "string"
}
blik_level_0
Information used to pay using BLIK level_0 flow.


auth_code
required
string  = 6 characters ^[0-9]{6}$
The 6-digit code used to authenticate a consumer within BLIK.


 
{
  • "auth_code": "string"
}
blik_one_click
Information used to pay using BLIK one-click flow.


auth_code
string  = 6 characters ^[0-9]{6}$
The 6-digit code used to authenticate a consumer within BLIK.


 
consumer_reference
required
string  [ 3 .. 64 ] characters ^[ -~]{3,64}$
The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.


 
alias_label
string  [ 8 .. 35 ] characters ^[ -~]{8,35}$
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 ^[0-9]+$
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.


 
{
  • "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 ^[ -~]{3,64}$
The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.


 
{
  • "consumer_reference": "string"
}
blik_request
Information needed to pay using BLIK.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
email
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (blik_experience_context) 
Customizes the payer experience during the approval process for the BLIK payment.


 
object (blik_level_0) 
Information used to pay using BLIK level_0 flow.


 
object (blik_one_click) 
Information used to pay using BLIK one-click flow.


 
{
  • "name": "string",
  • "country_code": "string",
  • "email": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "locale": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "return_url": "http://example.com",
    • "cancel_url": "http://example.com",
    • "consumer_ip": "string",
    • "consumer_user_agent": "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 (callback events)   [ 1 .. 5 ] items  unique 
An array of callback events merchant can subscribe to for the corresponding callback url.


Items Enum: "SHIPPING_ADDRESS" "SHIPPING_OPTIONS"  
callback_url
required
string <uri>   [ 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.


 
{}
capture
A captured payment.


status
string (Capture Status) 
The status of the captured payment.


 Enum: "COMPLETED" "DECLINED" "PARTIALLY_REFUNDED" "PENDING" "REFUNDED" "FAILED"  
object (capture_status_details) 
The details of the captured payment status.


 
id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The PayPal-generated ID for the captured payment.


 
object (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.


 
invoice_id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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  [ 0 .. 255 ] characters ^[\S\s]*$
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.


 
object (network_transaction) 
Reference values used by the card network to identify a transaction.


 
object (seller_protection) 
The level of protection offered as defined by PayPal Seller Protection for Merchants.


 
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.


 
object (Seller Receivable Breakdown) 
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.


 
disbursement_mode
string (disbursement_mode) 
 Default:  "INSTANT"
The funds that are held on behalf of the merchant.


 Enum: "INSTANT" "DELAYED"  
Array of objects (Link Description)   [ 0 .. 32767 ] items 
An array of related HATEOAS links.


 
object (processor_response) 
The processor response information for payment requests, such as direct credit card transactions.


 
create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
{
  • "status": "COMPLETED",
  • "status_details": {
    • "reason": "BUYER_COMPLAINT"
    },
  • "id": "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"
        }
      }
    },
  • "invoice_id": "string",
  • "custom_id": "string",
  • "network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "network": "VISA",
    • "acquirer_reference_number": "string"
    },
  • "seller_protection": {
    • "status": "ELIGIBLE",
    • "dispute_categories": [
      • "ITEM_NOT_RECEIVED"
      ]
    },
  • "final_capture": false,
  • "seller_receivable_breakdown": {
    • "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": {
      • "source_currency": "string",
      • "target_currency": "string",
      • "value": "string"
      },
    • "platform_fees": [
      • {
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "payee": {
          • "email_address": "string",
          • "merchant_id": "string"
          }
        }
      ]
    },
  • "disbursement_mode": "INSTANT",
  • "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"
        }
      }
    ],
  • "processor_response": {
    • "avs_code": "A",
    • "cvv_code": "E",
    • "response_code": "0000",
    • "payment_advice_code": "01"
    },
  • "create_time": "string",
  • "update_time": "string"
}
capture_status
The status and status details of a captured payment.


status
string (Capture Status) 
The status of the captured payment.


 Enum: "COMPLETED" "DECLINED" "PARTIALLY_REFUNDED" "PENDING" "REFUNDED" "FAILED"  
object (capture_status_details) 
The details of the captured payment status.


 
{
  • "status": "COMPLETED",
  • "status_details": {
    • "reason": "BUYER_COMPLAINT"
    }
}
capture_status_details
The details of the captured payment status.


reason
string (Capture Incomplete Reason) 
The reason why the captured payment status is PENDING or DENIED.


 Enum: "BUYER_COMPLAINT" "CHARGEBACK" "ECHECK" "INTERNATIONAL_WITHDRAWAL" "OTHER" "PENDING_REVIEW" "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION" "REFUNDED" "TRANSACTION_APPROVED_AWAITING_FUNDING" "UNILATERAL" "VERIFICATION_REQUIRED" "DECLINED_BY_RISK_FRAUD_FILTERS"  
{
  • "reason": "BUYER_COMPLAINT"
}
card
The payment card to use to fund a payment. Can be a credit or debit card.


id
string (instrument_id)   [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+=]+$
The identifier of the instrument.


 
name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
number
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
The primary account number (PAN) for the payment card.


 
expiry
string (date_year_month)   = 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.


 
security_code
string  [ 3 .. 4 ] characters ^[0-9]{3,4}$
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.


 
last_digits
string  [ 2 .. 4 ] characters ^[0-9]{2,4}$
The last digits of the payment card.


 
card_type
string (card_brand) 
 Deprecated 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
type
string (card_type) 
Type of card. i.e Credit, Debit and so on.


 Enum: "CREDIT" "DEBIT" "PREPAID" "STORE" "UNKNOWN"  
brand
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
object (card_attributes) 
Additional attributes associated with the use of this card.


 
{
  • "id": "string",
  • "name": "string",
  • "number": "stringstrings",
  • "expiry": "string",
  • "security_code": "stri",
  • "last_digits": "stri",
  • "card_type": "VISA",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "merchant_customer_id": "string"
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS"
      },
    • "verification": {
      • "method": "SCA_ALWAYS"
      }
    }
}
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 (card_verification) 
 Default:  "SCA_WHEN_REQUIRED"
The method used for card verification.


 Enum: "SCA_ALWAYS" "SCA_WHEN_REQUIRED" "3D_SECURE" "AVS_CVV"  
{
  • "method": "SCA_ALWAYS"
}
card_attributes
Additional attributes associated with the use of this card.


object (card_customer) 
The details about a customer in PayPal's system of record.


 
object (vault_instruction_base) 
Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.


 
object (Card Verification) 
The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "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.


object (card_vault_response) 
The details about a saved Card payment source.


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "merchant_customer_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"
          }
        }
      ]
    }
}
card_brand
The card network or brand. Applies to credit, debit, gift, and payment cards.


string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
"VISA"
card_customer
The details about a customer in PayPal's system of record.


id
string (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
object (phone_with_type) 
The phone information.


 
object (Name) 
The name of the party.


 
merchant_customer_id
string  [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$
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.


 
{
  • "id": "string",
  • "email_address": "string",
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "string"
    },
  • "merchant_customer_id": "string"
}
card_experience_context
Customizes the payer experience during the 3DS Approval for payment.


return_url
string <uri>  (url)   [ 10 .. 4000 ] characters 
Describes the URL.


 
cancel_url
string <uri>  (url)   [ 10 .. 4000 ] characters 
Describes the URL.


 
{}
card_from_request
Representation of card details as received in the request.


expiry
string (date_year_month)   = 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.


 
last_digits
string  [ 2 .. 4 ] characters ^.*[0-9]{2,}.*$
The last digits of the payment card.


 
{
  • "expiry": "string",
  • "last_digits": "stri"
}
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.


id
string (instrument_id)   [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+=]+$
The identifier of the instrument.


 
name
string  [ 1 .. 300 ] characters ^.{1,300}$
The card holder's name as it appears on the card.


 
number
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
The primary account number (PAN) for the payment card.


 
expiry
string (date_year_month)   = 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.


 
security_code
string  [ 3 .. 4 ] characters ^[0-9]{3,4}$
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.


 
last_digits
string  [ 2 .. 4 ] characters ^[0-9]{2,4}$
The last digits of the payment card.


 
card_type
string (card_brand) 
 Deprecated 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
type
string (card_type) 
Type of card. i.e Credit, Debit and so on.


 Enum: "CREDIT" "DEBIT" "PREPAID" "STORE" "UNKNOWN"  
brand
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
object (card_attributes) 
Additional attributes associated with the use of this card.


 
vault_id
string (vault_id)   [ 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.


 
single_use_token
string (single_use_token)   [ 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.


 
object (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.


 
object (network_token) 
The Third Party Network token used to fund a payment.


 
object (card_experience_context) 
Customizes the payer experience during the 3DS Approval for payment.


 
{
  • "id": "string",
  • "name": "string",
  • "number": "stringstrings",
  • "expiry": "string",
  • "security_code": "stri",
  • "last_digits": "stri",
  • "card_type": "VISA",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "merchant_customer_id": "string"
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS"
      },
    • "verification": {
      • "method": "SCA_ALWAYS"
      }
    },
  • "vault_id": "string",
  • "single_use_token": "string",
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "network": "VISA",
      • "acquirer_reference_number": "string"
      }
    },
  • "network_token": {
    • "number": "stringstrings",
    • "expiry": "string",
    • "cryptogram": "stringstringstringstringstri",
    • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION",
    • "token_requestor_id": "string"
    },
  • "experience_context": {}
}
card_response
The payment card to use to fund a payment. Card can be a credit or debit card.


name
string  [ 2 .. 300 ] characters ^[\S\s]*$
The card holder's name as it appears on the card.


 
last_digits
string  [ 0 .. 2147483647 ] characters ^.*[0-9]{2,}.*$
The last digits of the payment card.


 
brand
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
available_networks
Array of strings (card_brand)   [ 1 .. 256 ] items 
Array of brands or networks associated with the card.


Items Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
type
string (card_type) 
Type of card. i.e Credit, Debit and so on.


 Enum: "CREDIT" "DEBIT" "PREPAID" "STORE" "UNKNOWN"  
object (authentication_response) 
Results of Authentication such as 3D Secure.


 
object (card_attributes_response) 
Additional attributes associated with the use of this card.


 
object (card_from_request) 
Representation of card details as received in the request.


 
expiry
string (date_year_month)   = 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.


 
object (bin_details) 
Bank Identification Number (BIN) details used to fund a payment.


 
object (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.


 
{
  • "name": "string",
  • "last_digits": "string",
  • "brand": "VISA",
  • "available_networks": [
    • "VISA"
    ],
  • "type": "CREDIT",
  • "authentication_result": {
    • "liability_shift": "NO",
    • "three_d_secure": {
      • "authentication_status": "Y",
      • "enrollment_status": "Y"
      }
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "merchant_customer_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"
            }
          }
        ]
      }
    },
  • "from_request": {
    • "expiry": "string",
    • "last_digits": "stri"
    },
  • "expiry": "string",
  • "bin_details": {
    • "bin": "string",
    • "issuing_bank": "string",
    • "bin_country_code": "string",
    • "products": [
      • "string"
      ]
    },
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "network": "VISA",
      • "acquirer_reference_number": "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 (payment_initiator) 
The person or party who initiated or triggered the payment.


 Enum: "CUSTOMER" "MERCHANT"  
payment_type
required
string (stored_payment_source_payment_type) 
Indicates the type of the stored payment_source payment.


 Enum: "ONE_TIME" "RECURRING" "UNSCHEDULED"  
usage
string (stored_payment_source_usage_type) 
 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: "FIRST" "SUBSEQUENT" "DERIVED"  
object (network_transaction_reference) 
Reference values used by the card network to identify a transaction.


 
{
  • "payment_initiator": "CUSTOMER",
  • "payment_type": "ONE_TIME",
  • "usage": "FIRST",
  • "previous_network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "network": "VISA",
    • "acquirer_reference_number": "string"
    }
}
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.


object (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.


 
object (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.


 
{
  • "level_2": {
    • "invoice_id": "string",
    • "tax_total": {
      • "currency_code": "str",
      • "value": "string"
      }
    },
  • "level_3": {
    • "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",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "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",
              • "pricing_scheme": {
                • "price": null,
                • "pricing_model": null,
                • "reload_threshold_amount": null
                },
              • "total_cycles": 1,
              • "sequence": 1,
              • "start_date": "string"
              }
            ],
          • "setup_fee": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "name": "string"
          },
        • "unit_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tax": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "commodity_code": "string",
        • "discount_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "total_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "unit_of_measure": "string"
        }
      ]
    }
}
card_type
Type of card. i.e Credit, Debit and so on.


string (card_type) 
Type of card. i.e Credit, Debit and so on.


 Enum: "CREDIT" "DEBIT" "PREPAID" "STORE" "UNKNOWN"  
"CREDIT"
card_vault_response
The details about a saved Card payment source.


id
string  [ 1 .. 255 ] characters ^[\S\s]*$
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status) 
The vault status.


 Enum: "VAULTED" "CREATED" "APPROVED"  
object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "merchant_customer_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"
        }
      }
    ]
}
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 (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.


 Enum: "DPD_RU" "BG_BULGARIAN_POST" "KR_KOREA_POST" "ZA_COURIERIT" "FR_EXAPAQ" "ARE_EMIRATES_POST" "GAC" "GEIS" "SF_EX" "PAGO" "MYHERMES" "DIAMOND_EUROGISTICS" "CORPORATECOURIERS_WEBHOOK" "BOND" "OMNIPARCEL" "SK_POSTA" "PUROLATOR" "FETCHR_WEBHOOK" "THEDELIVERYGROUP" "CELLO_SQUARE" "TARRIVE" "COLLIVERY" "MAINFREIGHT" "IND_FIRSTFLIGHT" "ACSWORLDWIDE" "AMSTAN" "OKAYPARCEL" "ENVIALIA_REFERENCE" "SEUR_ES" "CONTINENTAL" "FDSEXPRESS" "AMAZON_FBA_SWISHIP" "WYNGS" "DHL_ACTIVE_TRACING" "ZYLLEM" "RUSTON" "XPOST" "CORREOS_ES" "DHL_FR" "PAN_ASIA" "BRT_IT" "SRE_KOREA" "SPEEDEE" "TNT_UK" "VENIPAK" "SHREENANDANCOURIER" "CROSHOT" "NIPOST_NG" "EPST_GLBL" "NEWGISTICS" "POST_SLOVENIA" "JERSEY_POST" "BOMBINOEXP" "WMG" "XQ_EXPRESS" "FURDECO" "LHT_EXPRESS" "SOUTH_AFRICAN_POST_OFFICE" "SPOTON" "DIMERCO" "CYPRUS_POST_CYP" "ABCUSTOM" "IND_DELIVREE" "CN_BESTEXPRESS" "DX_SFTP" "PICKUPP_MYS" "FMX" "HELLMANN" "SHIP_IT_ASIA" "KERRY_ECOMMERCE" "FRETERAPIDO" "PITNEY_BOWES" "XPRESSEN_DK" "SEUR_SP_API" "DELIVERYONTIME" "JINSUNG" "TRANS_KARGO" "SWISHIP_DE" "IVOY_WEBHOOK" "AIRMEE_WEBHOOK" "DHL_BENELUX" "FIRSTMILE" "FASTWAY_IR" "HH_EXP" "MYS_MYPOST_ONLINE" "TNT_NL" "TIPSA" "TAQBIN_MY" "KGMHUB" "INTEXPRESS" "OVERSE_EXP" "ONECLICK" "ROADRUNNER_FREIGHT" "GLS_CROTIA" "MRW_FTP" "BLUEX" "DYLT" "DPD_IR" "SIN_GLBL" "TUFFNELLS_REFERENCE" "CJPACKET" "MILKMAN" "ASIGNA" "ONEWORLDEXPRESS" "ROYAL_MAIL" "VIA_EXPRESS" "TIGFREIGHT" "ZTO_EXPRESS" "TWO_GO" "IML" "INTEL_VALLEY" "EFS" "UK_UK_MAIL" "RAM" "ALLIEDEXPRESS" "APC_OVERNIGHT" "SHIPPIT" "TFM" "M_XPRESS" "HDB_BOX" "CLEVY_LINKS" "IBEONE" "FIEGE_NL" "KWE_GLOBAL" "CTC_EXPRESS" "AMAZON" "MORE_LINK" "JX" "EASY_MAIL" "ADUIEPYLE" "GB_PANTHER" "EXPRESSSALE" "SG_DETRACK" "TRUNKRS_WEBHOOK" "MATDESPATCH" "DICOM" "MBW" "KHM_CAMBODIA_POST" "SINOTRANS" "BRT_IT_PARCELID" "DHL_SUPPLY_CHAIN" "DHL_PL" "TOPYOU" "PALEXPRESS" "DHL_SG" "CN_WEDO" "FULFILLME" "DPD_DELISTRACK" "UPS_REFERENCE" "CARIBOU" "LOCUS_WEBHOOK" "DSV" "P2P_TRC" "DIRECTPARCELS" "NOVA_POSHTA_INT" "FEDEX_POLAND" "CN_JCEX" "FAR_INTERNATIONAL" "IDEXPRESS" "GANGBAO" "NEWAY" "POSTNL_INT_3_S" "RPX_ID" "DESIGNERTRANSPORT_WEBHOOK" "GLS_SLOVEN" "PARCELLED_IN" "GSI_EXPRESS" "CON_WAY" "BROUWER_TRANSPORT" "CPEX" "ISRAEL_POST" "DTDC_IN" "PTT_POST" "XDE_WEBHOOK" "TOLOS" "GIAO_HANG" "GEODIS_ESPACE" "MAGYAR_HU" "DOORDASH_WEBHOOK" "TIKI_ID" "CJ_HK_INTERNATIONAL" "STAR_TRACK_EXPRESS" "HELTHJEM" "SFB2C" "FREIGHTQUOTE" "LANDMARK_GLOBAL_REFERENCE" "PARCEL2GO" "DELNEXT" "RCL" "CGS_EXPRESS" "HK_POST" "SAP_EXPRESS" "PARCELPOST_SG" "HERMES" "IND_SAFEEXPRESS" "TOPHATTEREXPRESS" "MGLOBAL" "AVERITT" "LEADER" "_2EBOX" "SG_SPEEDPOST" "DBSCHENKER_SE" "ISR_POST_DOMESTIC" "BESTWAYPARCEL" "ASENDIA_DE" "NIGHTLINE_UK" "TAQBIN_SG" "TCK_EXPRESS" "ENDEAVOUR_DELIVERY" "NANJINGWOYUAN" "HEPPNER_FR" "EMPS_CN" "FONSEN" "PICKRR" "APC_OVERNIGHT_CONNUM" "STAR_TRACK_NEXT_FLIGHT" "DAJIN" "UPS_FREIGHT" "POSTA_PLUS" "CEVA" "ANSERX" "JS_EXPRESS" "PADTF" "UPS_MAIL_INNOVATIONS" "SYPOST" "AMAZON_SHIP_MCF" "YUSEN" "BRING" "SDA_IT" "GBA" "NEWEGGEXPRESS" "SPEEDCOURIERS_GR" "FORRUN" "PICKUP" "ECMS" "INTELIPOST" "FLASHEXPRESS" "CN_STO" "SEKO_SFTP" "HOME_DELIVERY_SOLUTIONS" "DPD_HGRY" "KERRYTTC_VN" "JOYING_BOX" "TOTAL_EXPRESS" "ZJS_EXPRESS" "STARKEN" "DEMANDSHIP" "CN_DPEX" "AUPOST_CN" "LOGISTERS" "GOGLOBALPOST" "GLS_CZ" "PAACK_WEBHOOK" "GRAB_WEBHOOK" "PARCELPOINT" "ICUMULUS" "DAIGLOBALTRACK" "GLOBAL_IPARCEL" "YURTICI_KARGO" "CN_PAYPAL_PACKAGE" "PARCEL_2_POST" "GLS_IT" "PIL_LOGISTICS" "HEPPNER" "GENERAL_OVERNIGHT" "HAPPY2POINT" "CHITCHATS" "SMOOTH" "CLE_LOGISTICS" "FIEGE" "MX_CARGO" "ZIINGFINALMILE" "DAYTON_FREIGHT" "TCS" "AEX" "HERMES_DE" "ROUTIFIC_WEBHOOK" "GLOBAVEND" "CJ_LOGISTICS" "PALLET_NETWORK" "RAF_PH" "UK_XDP" "PAPER_EXPRESS" "LA_POSTE_SUIVI" "PAQUETEXPRESS" "LIEFERY" "STRECK_TRANSPORT" "PONY_EXPRESS" "ALWAYS_EXPRESS" "GBS_BROKER" "CITYLINK_MY" "ALLJOY" "YODEL" "YODEL_DIR" "STONE3PL" "PARCELPAL_WEBHOOK" "DHL_ECOMERCE_ASA" "SIMPLYPOST" "KY_EXPRESS" "SHENZHEN" "US_LASERSHIP" "UC_EXPRE" "DIDADI" "CJ_KR" "DBSCHENKER_B2B" "MXE" "CAE_DELIVERS" "PFCEXPRESS" "WHISTL" "WEPOST" "DHL_PARCEL_ES" "DDEXPRESS" "ARAMEX_AU" "BNEED" "HK_TGX" "LATVIJAS_PASTS" "VIAEUROPE" "CORREO_UY" "CHRONOPOST_FR" "J_NET" "_6LS" "BLR_BELPOST" "BIRDSYSTEM" "DOBROPOST" "WAHANA_ID" "WEASHIP" "SONICTL" "KWT" "AFLLOG_FTP" "SKYNET_WORLDWIDE" "NOVA_POSHTA" "SEINO" "SZENDEX" "BPOST_INT" "DBSCHENKER_SV" "AO_DEUTSCHLAND" "EU_FLEET_SOLUTIONS" "PCFCORP" "LINKBRIDGE" "PRIMAMULTICIPTA" "COUREX" "ZAJIL_EXPRESS" "COLLECTCO" "JTEXPRESS" "FEDEX_UK" "USHIP" "PIXSELL" "SHIPTOR" "CDEK" "VNM_VIETTELPOST" "CJ_CENTURY" "GSO" "VIWO" "SKYBOX" "KERRYTJ" "NTLOGISTICS_VN" "SDH_SCM" "ZINC" "DPE_SOUTH_AFRC" "CESKA_CZ" "ACS_GR" "DEALERSEND" "JOCOM" "CSE" "TFORCE_FINALMILE" "SHIP_GATE" "SHIPTER" "NATIONAL_SAMEDAY" "YUNEXPRESS" "CAINIAO" "DMS_MATRIX" "DIRECTLOG" "ASENDIA_US" "_3JMSLOGISTICS" "LICCARDI_EXPRESS" "SKY_POSTAL" "CNWANGTONG" "POSTNORD_LOGISTICS_DK" "LOGISTIKA" "CELERITAS" "PRESSIODE" "SHREE_MARUTI" "LOGISTICSWORLDWIDE_HK" "EFEX" "LOTTE" "LONESTAR" "APRISAEXPRESS" "BEL_RS" "OSM_WORLDWIDE" "WESTGATE_GL" "FASTRACK" "DTD_EXPR" "ALFATREX" "PROMEDDELIVERY" "THABIT_LOGISTICS" "HCT_LOGISTICS" "CARRY_FLAP" "US_OLD_DOMINION" "ANICAM_BOX" "WANBEXPRESS" "AN_POST" "DPD_LOCAL" "STALLIONEXPRESS" "RAIDEREX" "SHOPFANS" "KYUNGDONG_PARCEL" "CHAMPION_LOGISTICS" "PICKUPP_SGP" "MORNING_EXPRESS" "NACEX" "THENILE_WEBHOOK" "HOLISOL" "LBCEXPRESS_FTP" "KURASI" "USF_REDDAWAY" "APG" "CN_BOXC" "ECOSCOOTING" "MAINWAY" "PAPERFLY" "HOUNDEXPRESS" "BOX_BERRY" "EP_BOX" "PLUS_LOG_UK" "FULFILLA" "ASE" "MAIL_PLUS" "XPO_LOGISTICS" "WNDIRECT" "CLOUDWISH_ASIA" "ZELERIS" "GIO_EXPRESS" "OCS_WORLDWIDE" "ARK_LOGISTICS" "AQUILINE" "PILOT_FREIGHT" "QWINTRY" "DANSKE_FRAGT" "CARRIERS" "AIR_CANADA_GLOBAL" "PRESIDENT_TRANS" "STEPFORWARDFS" "SKYNET_UK" "PITTOHIO" "CORREOS_EXPRESS" "RL_US" "DESTINY" "UK_YODEL" "COMET_TECH" "DHL_PARCEL_RU" "TNT_REFR" "SHREE_ANJANI_COURIER" "MIKROPAKKET_BE" "ETS_EXPRESS" "COLIS_PRIVE" "CN_YUNDA" "AAA_COOPER" "ROCKET_PARCEL" "_360LION" "PANDU" "PROFESSIONAL_COURIERS" "FLYTEXPRESS" "LOGISTICSWORLDWIDE_MY" "CORREOS_DE_ESPANA" "IMX" "FOUR_PX_EXPRESS" "XPRESSBEES" "PICKUPP_VNM" "STARTRACK_EXPRESS" "FR_COLISSIMO" "NACEX_SPAIN_REFERENCE" "DHL_SUPPLY_CHAIN_AU" "ESHIPPING" "SHREETIRUPATI" "HX_EXPRESS" "INDOPAKET" "CN_17POST" "K1_EXPRESS" "CJ_GLS" "MYS_GDEX" "NATIONEX" "ANJUN" "FARGOOD" "SMG_EXPRESS" "RZYEXPRESS" "SEFL" "TNT_CLICK_IT" "HDB" "HIPSHIPPER" "RPXLOGISTICS" "KUEHNE" "IT_NEXIVE" "PTS" "SWISS_POST_FTP" "FASTRK_SERV" "_4_72" "US_YRC" "POSTNL_INTL_3S" "ELIAN_POST" "CUBYN" "SAU_SAUDI_POST" "ABXEXPRESS_MY" "HUAHAN_EXPRESS" "ZES_EXPRESS" "ZEPTO_EXPRESS" "SKYNET_ZA" "ZEEK_2_DOOR" "BLINKLASTMILE" "POSTA_UKR" "CHROBINSON" "CN_POST56" "COURANT_PLUS" "SCUDEX_EXPRESS" "SHIPENTEGRA" "B_TWO_C_EUROPE" "COPE" "IND_GATI" "CN_WISHPOST" "NACEX_ES" "TAQBIN_HK" "GLOBALTRANZ" "HKD" "BJSHOMEDELIVERY" "OMNIVA" "SUTTON" "PANTHER_REFERENCE" "SFCSERVICE" "LTL" "PARKNPARCEL" "SPRING_GDS" "ECEXPRESS" "INTERPARCEL_AU" "AGILITY" "XL_EXPRESS" "ADERONLINE" "DIRECTCOURIERS" "PLANZER" "SENDING" "NINJAVAN_WB" "NATIONWIDE_MY" "SENDIT" "GB_ARROW" "IND_GOJAVAS" "KPOST" "DHL_FREIGHT" "BLUECARE" "JINDOUYUN" "TRACKON" "GB_TUFFNELLS" "TRUMPCARD" "ETOTAL" "SFPLUS_WEBHOOK" "SEKOLOGISTICS" "HERMES_2MANN_HANDLING" "DPD_LOCAL_REF" "UDS" "ZA_SPECIALISED_FREIGHT" "THA_KERRY" "PRT_INT_SEUR" "BRA_CORREIOS" "NZ_NZ_POST" "CN_EQUICK" "MYS_EMS" "GB_NORSK" "ESP_MRW" "ESP_PACKLINK" "KANGAROO_MY" "RPX" "XDP_UK_REFERENCE" "NINJAVAN_MY" "ADICIONAL" "ROADBULL" "YAKIT" "MAILAMERICAS" "MIKROPAKKET" "DYNALOGIC" "DHL_ES" "DHL_PARCEL_NL" "DHL_GLOBAL_MAIL_ASIA" "DAWN_WING" "GENIKI_GR" "HERMESWORLD_UK" "ALPHAFAST" "BUYLOGIC" "EKART" "MEX_SENDA" "SFC_LOGISTICS" "POST_SERBIA" "IND_DELHIVERY" "DE_DPD_DELISTRACK" "RPD2MAN" "CN_SF_EXPRESS" "YANWEN" "MYS_SKYNET" "CORREOS_DE_MEXICO" "CBL_LOGISTICA" "MEX_ESTAFETA" "AU_AUSTRIAN_POST" "RINCOS" "NLD_DHL" "RUSSIAN_POST" "COURIERS_PLEASE" "POSTNORD_LOGISTICS" "FEDEX" "DPE_EXPRESS" "DPD" "ADSONE" "IDN_JNE" "THECOURIERGUY" "CNEXPS" "PRT_CHRONOPOST" "LANDMARK_GLOBAL" "IT_DHL_ECOMMERCE" "ESP_NACEX" "PRT_CTT" "BE_KIALA" "ASENDIA_UK" "GLOBAL_TNT" "POSTUR_IS" "EPARCEL_KR" "INPOST_PACZKOMATY" "IT_POSTE_ITALIA" "BE_BPOST" "PL_POCZTA_POLSKA" "MYS_MYS_POST" "SG_SG_POST" "THA_THAILAND_POST" "LEXSHIP" "FASTWAY_NZ" "DHL_AU" "COSTMETICSNOW" "PFLOGISTICS" "LOOMIS_EXPRESS" "GLS_ITALY" "LINE" "GEL_EXPRESS" "HUODULL" "NINJAVAN_SG" "JANIO" "AO_COURIER" "BRT_IT_SENDER_REF" "SAILPOST" "LALAMOVE" "NEWZEALAND_COURIERS" "ETOMARS" "VIRTRANSPORT" "WIZMO" "PALLETWAYS" "I_DIKA" "CFL_LOGISTICS" "GEMWORLDWIDE" "GLOBAL_EXPRESS" "LOGISTYX_TRANSGROUP" "WESTBANK_COURIER" "ARCO_SPEDIZIONI" "YDH_EXPRESS" "PARCELINKLOGISTICS" "CNDEXPRESS" "NOX_NIGHT_TIME_EXPRESS" "AERONET" "LTIANEXP" "INTEGRA2_FTP" "PARCELONE" "NOX_NACHTEXPRESS" "CN_CHINA_POST_EMS" "CHUKOU1" "GLS_SLOV" "ORANGE_DS" "JOOM_LOGIS" "AUS_STARTRACK" "DHL" "GB_APC" "BONDSCOURIERS" "JPN_JAPAN_POST" "USPS" "WINIT" "ARG_OCA" "TW_TAIWAN_POST" "DMM_NETWORK" "TNT" "BH_POSTA" "SWE_POSTNORD" "CA_CANADA_POST" "WISELOADS" "ASENDIA_HK" "NLD_GLS" "MEX_REDPACK" "JET_SHIP" "DE_DHL_EXPRESS" "NINJAVAN_THAI" "RABEN_GROUP" "ESP_ASM" "HRV_HRVATSKA" "GLOBAL_ESTES" "LTU_LIETUVOS" "BEL_DHL" "AU_AU_POST" "SPEEDEXCOURIER" "FR_COLIS" "ARAMEX" "DPEX" "MYS_AIRPAK" "CUCKOOEXPRESS" "DPD_POLAND" "NLD_POSTNL" "NIM_EXPRESS" "QUANTIUM" "SENDLE" "ESP_REDUR" "MATKAHUOLTO" "CPACKET" "POSTI" "HUNTER_EXPRESS" "CHOIR_EXP" "LEGION_EXPRESS" "AUSTRIAN_POST_EXPRESS" "GRUPO" "POSTA_RO" "INTERPARCEL_UK" "GLOBAL_ABF" "POSTEN_NORGE" "XPERT_DELIVERY" "DHL_REFR" "DHL_HK" "SKYNET_UAE" "GOJEK" "YODEL_INTNL" "JANCO" "YTO" "WISE_EXPRESS" "JTEXPRESS_VN" "FEDEX_INTL_MLSERV" "VAMOX" "AMS_GRP" "DHL_JP" "HRPARCEL" "GESWL" "BLUESTAR" "CDEK_TR" "DESCARTES" "DELTEC_UK" "DTDC_EXPRESS" "TOURLINE" "BH_WORLDWIDE" "OCS" "YINGNUO_LOGISTICS" "UPS" "TOLL" "PRT_SEUR" "DTDC_AU" "THA_DYNAMIC_LOGISTICS" "UBI_LOGISTICS" "FEDEX_CROSSBORDER" "A1POST" "TAZMANIAN_FREIGHT" "CJ_INT_MY" "SAIA_FREIGHT" "SG_QXPRESS" "NHANS_SOLUTIONS" "DPD_FR" "COORDINADORA" "ANDREANI" "DOORA" "INTERPARCEL_NZ" "PHL_JAMEXPRESS" "BEL_BELGIUM_POST" "US_APC" "IDN_POS" "FR_MONDIAL" "DE_DHL" "HK_RPX" "DHL_PIECEID" "VNPOST_EMS" "RRDONNELLEY" "DPD_DE" "DELCART_IN" "IMEXGLOBALSOLUTIONS" "ACOMMERCE" "EURODIS" "CANPAR" "GLS" "IND_ECOM" "ESP_ENVIALIA" "DHL_UK" "SMSA_EXPRESS" "TNT_FR" "DEX_I" "BUDBEE_WEBHOOK" "COPA_COURIER" "VNM_VIETNAM_POST" "DPD_HK" "TOLL_NZ" "ECHO" "FEDEX_FR" "BORDEREXPRESS" "MAILPLUS_JPN" "TNT_UK_REFR" "KEC" "DPD_RO" "TNT_JP" "TH_CJ" "EC_CN" "FASTWAY_UK" "FASTWAY_US" "GLS_DE" "GLS_ES" "GLS_FR" "MONDIAL_BE" "SGT_IT" "TNT_CN" "TNT_DE" "TNT_ES" "TNT_PL" "PARCELFORCE" "SWISS_POST" "TOLL_IPEC" "AIR_21" "AIRSPEED" "BERT" "BLUEDART" "COLLECTPLUS" "COURIERPLUS" "COURIER_POST" "DHL_GLOBAL_MAIL" "DPD_UK" "DELTEC_DE" "DEUTSCHE_DE" "DOTZOT" "ELTA_GR" "EMS_CN" "ECARGO" "ENSENDA" "FERCAM_IT" "FASTWAY_ZA" "FASTWAY_AU" "FIRST_LOGISITCS" "GEODIS" "GLOBEGISTICS" "GREYHOUND" "JETSHIP_MY" "LION_PARCEL" "AEROFLASH" "ONTRAC" "SAGAWA" "SIODEMKA" "STARTRACK" "TNT_AU" "TNT_IT" "TRANSMISSION" "YAMATO" "DHL_IT" "DHL_AT" "LOGISTICSWORLDWIDE_KR" "GLS_SPAIN" "AMAZON_UK_API" "DPD_FR_REFERENCE" "DHLPARCEL_UK" "MEGASAVE" "QUALITYPOST" "IDS_LOGISTICS" "JOYINGBOX" "PANTHER_ORDER_NUMBER" "WATKINS_SHEPARD" "FASTTRACK" "UP_EXPRESS" "ELOGISTICA" "ECOURIER" "CJ_PHILIPPINES" "SPEEDEX" "ORANGECONNEX" "TECOR" "SAEE" "GLS_ITALY_FTP" "DELIVERE" "YYCOM" "ADICIONAL_PT" "DKSH" "NIPPON_EXPRESS_FTP" "GOLS" "FUJEXP" "QTRACK" "OMLOGISTICS_API" "GDPHARM" "MISUMI_CN" "AIR_CANADA" "CITY56_WEBHOOK" "SAGAWA_API" "KEDAEX" "PGEON_API" "WEWORLDEXPRESS" "JT_LOGISTICS" "TRUSK" "VIAXPRESS" "DHL_SUPPLYCHAIN_ID" "ZUELLIGPHARMA_SFTP" "MEEST" "TOLL_PRIORITY" "MOTHERSHIP_API" "CAPITAL" "EUROPAKET_API" "HFD" "TOURLINE_REFERENCE" "GIO_ECOURIER" "CN_LOGISTICS" "PANDION" "BPOST_API" "PASSPORTSHIPPING" "PAKAJO" "DACHSER" "YUSEN_SFTP" "SHYPLITE" "XYY" "MWD" "FAXECARGO" "MAZET" "FIRST_LOGISTICS_API" "SPRINT_PACK" "HERMES_DE_FTP" "CONCISE" "KERRY_EXPRESS_TW_API" "EWE" "FASTDESPATCH" "ABCUSTOM_SFTP" "CHAZKI" "SHIPPIE" "GEODIS_API" "NAQEL_EXPRESS" "PAPA_WEBHOOK" "FORWARDAIR" "DIALOGO_LOGISTICA_API" "LALAMOVE_API" "TOMYDOOR" "KRONOS_WEBHOOK" "JTCARGO" "T_CAT" "CONCISE_WEBHOOK" "TELEPORT_WEBHOOK" "CUSTOMCO_API" "SPX_TH" "BOLLORE_LOGISTICS" "CLICKLINK_SFTP" "M3LOGISTICS" "VNPOST_API" "AXLEHIRE_FTP" "SHADOWFAX" "MYHERMES_UK_API" "DAIICHI" "MENSAJEROSURBANOS_API" "POLARSPEED" "IDEXPRESS_ID" "PAYO" "WHISTL_SFTP" "INTEX_DE" "TRANS2U" "PRODUCTCAREGROUP_SFTP" "BIGSMART" "EXPEDITORS_API_REF" "AITWORLDWIDE_API" "WORLDCOURIER" "QUIQUP" "AGEDISS_SFTP" "ANDREANI_API" "CRLEXPRESS" "SMARTCAT" "CROSSFLIGHT" "PROCARRIER" "DHL_REFERENCE_API" "SEINO_API" "WSPEXPRESS" "KRONOS" "TOTAL_EXPRESS_API" "PARCLL" "XPEDIGO" "STAR_TRACK_WEBHOOK" "GPOST" "UCS" "DMFGROUP" "COORDINADORA_API" "MARKEN" "NTL" "REDJEPAKKETJE" "ALLIED_EXPRESS_FTP" "MONDIALRELAY_ES" "NAEKO_FTP" "MHI" "SHIPPIFY" "MALCA_AMIT_API" "JTEXPRESS_SG_API" "DACHSER_WEB" "FLIGHTLG" "CAGO" "COM1EXPRESS" "TONAMI_FTP" "PACKFLEET" "PUROLATOR_INTERNATIONAL" "WINESHIPPING_WEBHOOK" "DHL_ES_SFTP" "PCHOME_API" "CESKAPOSTA_API" "GORUSH" "HOMERUNNER" "AMAZON_ORDER" "EFWNOW_API" "CBL_LOGISTICA_API" "NIMBUSPOST" "LOGWIN_LOGISTICS" "NOWLOG_API" "DPD_NL" "GODEPENDABLE" "ESDEX" "LOGISYSTEMS_SFTP" "EXPEDITORS" "SNTGLOBAL_API" "SHIPX" "QINTL_API" "PACKS" "POSTNL_INTERNATIONAL" "AMAZON_EMAIL_PUSH" "DHL_API" "SPX" "AXLEHIRE" "ICSCOURIER" "DIALOGO_LOGISTICA" "SHUNBANG_EXPRESS" "TCS_API" "SF_EXPRESS_CN" "PACKETA" "SIC_TELIWAY" "MONDIALRELAY_FR" "INTIME_FTP" "JD_EXPRESS" "FASTBOX" "PATHEON" "INDIA_POST" "TIPSA_REF" "ECOFREIGHT" "VOX" "DIRECTFREIGHT_AU_REF" "BESTTRANSPORT_SFTP" "AUSTRALIA_POST_API" "FRAGILEPAK_SFTP" "FLIPXP" "VALUE_WEBHOOK" "DAESHIN" "SHERPA" "MWD_API" "SMARTKARGO" "DNJ_EXPRESS" "GOPEOPLE" "MYSENDLE_API" "ARAMEX_API" "PIDGE" "THAIPARCELS" "PANTHER_REFERENCE_API" "POSTAPLUS" "BUFFALO" "U_ENVIOS" "ELITE_CO" "ROCHE_INTERNAL_SFTP" "DBSCHENKER_ICELAND" "TNT_FR_REFERENCE" "NEWGISTICSAPI" "GLOVO" "GWLOGIS_API" "SPREETAIL_API" "MOOVA" "PLYCONGROUP" "USPS_WEBHOOK" "REIMAGINEDELIVERY" "EDF_FTP" "DAO365" "BIOCAIR_FTP" "RANSA_WEBHOOK" "SHIPXPRES" "COURANT_PLUS_API" "SHIPA" "HOMELOGISTICS" "DX" "POSTE_ITALIANE_PACCOCELERE" "TOLL_WEBHOOK" "LCTBR_API" "DX_FREIGHT" "DHL_SFTP" "SHIPROCKET" "UBER_WEBHOOK" "STATOVERNIGHT" "BURD" "FASTSHIP" "IBVENTURE_WEBHOOK" "GATI_KWE_API" "CRYOPDP_FTP" "HUBBED" "TIPSA_API" "ARASKARGO" "THIJS_NL" "ATSHEALTHCARE_REFERENCE" "99MINUTOS" "HELLENIC_POST" "HSM_GLOBAL" "MNX" "NMTRANSFER" "LOGYSTO" "INDIA_POST_INT" "AMAZON_FBA_SWISHIP_IN" "SRT_TRANSPORT" "BOMI" "DELIVERR_SFTP" "HSDEXPRESS" "SIMPLETIRE_WEBHOOK" "HUNTER_EXPRESS_SFTP" "UPS_API" "WOOYOUNG_LOGISTICS_SFTP" "PHSE_API" "WISH_EMAIL_PUSH" "NORTHLINE" "MEDAFRICA" "DPD_AT_SFTP" "ANTERAJA" "DHL_GLOBAL_FORWARDING_API" "LBCEXPRESS_API" "SIMSGLOBAL" "CDLDELIVERS" "TYP" "TESTING_COURIER_WEBHOOK" "PANDAGO_API" "ROYAL_MAIL_FTP" "THUNDEREXPRESS" "SECRETLAB_WEBHOOK" "SETEL" "JD_WORLDWIDE" "DPD_RU_API" "ARGENTS_WEBHOOK" "POSTONE" "TUSKLOGISTICS" "RHENUS_UK_API" "TAQBIN_SG_API" "INNTRALOG_SFTP" "DAYROSS" "CORREOSEXPRESS_API" "INTERNATIONAL_SEUR_API" "YODEL_API" "HEROEXPRESS" "DHL_SUPPLYCHAIN_IN" "URGENT_CARGUS" "FRONTDOORCORP" "JTEXPRESS_PH" "PARCELSTARS_WEBHOOK" "DPD_SK_SFTP" "MOVIANTO" "OZEPARTS_SHIPPING" "KARGOMKOLAY" "TRUNKRS" "OMNIRPS_WEBHOOK" "CHILEXPRESS" "TESTING_COURIER" "JNE_API" "BJSHOMEDELIVERY_FTP" "DEXPRESS_WEBHOOK" "USPS_API" "TRANSVIRTUAL" "SOLISTICA_API" "CHIENVENTURE_WEBHOOK" "DPD_UK_SFTP" "INPOST_UK" "JAVIT" "ZTO_DOMESTIC" "DHL_GT_API" "CEVA_TRACKING" "KOMON_EXPRESS" "EASTWESTCOURIER_FTP" "DANNIAO" "SPECTRAN" "DELIVER_IT" "RELAISCOLIS" "GLS_SPAIN_API" "POSTPLUS" "AIRTERRA" "GIO_ECOURIER_API" "DPD_CH_SFTP" "FEDEX_API" "INTERSMARTTRANS" "HERMES_UK_SFTP" "EXELOT_FTP" "DHL_PA_API" "VIRTRANSPORT_SFTP" "WORLDNET" "INSTABOX_WEBHOOK" "KNG" "FLASHEXPRESS_WEBHOOK" "MAGYAR_POSTA_API" "WESHIP_API" "OHI_WEBHOOK" "MUDITA" "BLUEDART_API" "T_CAT_API" "ADS" "HERMES_IT" "FITZMARK_API" "POSTI_API" "SMSA_EXPRESS_WEBHOOK" "TAMERGROUP_WEBHOOK" "LIVRAPIDE" "NIPPON_EXPRESS" "BETTERTRUCKS" "FAN" "PB_USPSFLATS_FTP" "PARCELRIGHT" "ITHINKLOGISTICS" "KERRY_EXPRESS_TH_WEBHOOK" "ECOUTIER" "SHOWL" "BRT_IT_API" "RIXONHK_API" "DBSCHENKER_API" "ILYANGLOGIS" "MAIL_BOX_ETC" "WESHIP" "DHL_GLOBAL_MAIL_API" "ACTIVOS24_API" "ATSHEALTHCARE" "LUWJISTIK" "GW_WORLD" "FAIRSENDEN_API" "SERVIP_WEBHOOK" "SWISHIP" "TANET" "HOTSIN_CARGO" "DIREX" "HUANTONG" "IMILE_API" "AUEXPRESS" "NYTLOGISTICS" "DSV_REFERENCE" "NOVOFARMA_WEBHOOK" "AITWORLDWIDE_SFTP" "SHOPOLIVE" "FNF_ZA" "DHL_ECOMMERCE_GC" "FETCHR" "STARLINKS_API" "YYEXPRESS" "SERVIENTREGA" "HANJIN" "SPANISH_SEUR_FTP" "DX_B2B_CONNUM" "HELTHJEM_API" "INEXPOST" "A2B_BA" "RHENUS_GROUP" "SBERLOGISTICS_RU" "MALCA_AMIT" "PPL" "OSM_WORLDWIDE_SFTP" "ACILOGISTIX" "OPTIMACOURIER" "NOVA_POSHTA_API" "LOGGI" "YIFAN" "MYDYNALOGIC" "MORNINGLOBAL" "CONCISE_API" "FXTRAN" "DELIVERYOURPARCEL_ZA" "UPARCEL" "MOBI_BR" "LOGINEXT_WEBHOOK" "EMS" "SPEEDY" "ZOOM_RED" "NAVLUNGO" "CASTLEPARCELS" "WEEE" "PACKALY" "YUNHUIPOST" "YOUPARCEL" "LEMAN" "MOOVIN" "URB_IT" "MULTIENTREGAPANAMA" "JUSDASR" "DISCOUNTPOST" "RHENUS_UK" "SWISHIP_JP" "GLS_US" "SMTL" "EMEGA" "EXPRESSONE_SV" "HEPSIJET" "WELIVERY" "BRINGER" "EASYROUTES" "MRW" "RPM" "DPD_PRT" "GLS_ROMANIA" "LMPARCEL" "GTAGSM" "DOMINO" "ESHIPPER" "TRANSPAK" "XINDUS" "AOYUE" "EASYPARCEL" "EXPRESSONE" "SENDEO_KARGO" "SPEEDAF" "ETOWER" "GCX" "NINJAVAN_VN" "ALLEGRO" "JUMPPOINT" "SHIPGLOBAL_US" "KINISI" "OAKH" "AWEST" "BARSAN" "ENERGOLOGISTIC" "MADROOEX" "GOBOLT" "SWISS_UNIVERSAL_EXPRESS" "IORDIRECT" "XMSZM" "GLS_HUN" "SENDY" "BRAUNSEXPRESS" "GRANDSLAMEXPRESS" "XGS" "OTSCHILE" "PACK_UP" "PARCELSTARS" "TEAMEXPRESSLLC" "ASYADEXPRESS" "TDN" "EARLYBIRD" "CACESA" "PARCELJET" "MNG_KARGO" "SUPERPACKLINE" "SPEEDX" "VESYL" "SKYKING" "DIRMENSAJERIA" "NETLOGIXGROUP" "ZYOU" "JAWAR" "AGSYSTEMS" "GPS" "PTT_KARGO" "MAERGO" "ARIHANTCOURIER" "VTFE" "YUNANT" "URBIFY" "PACK_MAN" "LIEFERGRUN" "OBIBOX" "PAIKEDA" "SCOTTY" "INTELCOM_CA" "SWE" "ASENDIA" "DPD_AT" "RELAY" "ATA" "SKYEXPRESS_INTERNATIONAL" "SURAT_KARGO" "SGLINK" "FLEETOPTICSINC" "SHOPLINE" "PIGGYSHIP" "LOGOIX" "KOLAY_GELSIN" "ASSOCIATED_COURIERS" "UPS_CHECKER" "WINESHIPPING" "SPEDISCI" "FOURKITES" "ETONAS" "FINMILE" "UNIUNI" "RODONAVES" "INPOST_IT" "TFORCE_FREIGHT" "RICHMOM" "FRANCO" "ECPARCEL" "FEDEX_CHINA" "GOFO_EXPRESS" "SHIPBOB" "JERSEYPOST_ATLAS" "CORETRAILS" "RHENUS_ITALY" "JADLOG" "JITSU" "YANWEN_EXPRESS" "DASHLINK" "SEINO_SUPER_EXPRESS" "FLOSHIP" "METROSCG" "SENDPARCEL" "P2P" "CN_EXPRESS" "CIRROTRACK" "LAND_LOGISTICS" "VEHO" "MEDLINE" "VDTRACK" "SINO_SCM" "3PE_EXPRESS" "SWIFTX" "SFYDEXPRESS" "TOPTRANS" "OTHER"  
"DPD_RU"
charge_pattern
Expected business/pricing model for the billing agreement.


string (charge_pattern) 
Expected business/pricing model for the billing agreement.


 Enum: "IMMEDIATE" "DEFERRED" "RECURRING_PREPAID" "RECURRING_POSTPAID" "THRESHOLD_PREPAID" "THRESHOLD_POSTPAID" "SUBSCRIPTION_PREPAID" "SUBSCRIPTION_POSTPAID" "UNSCHEDULED_PREPAID" "UNSCHEDULED_POSTPAID" "INSTALLMENT_PREPAID" "INSTALLMENT_POSTPAID"  
"IMMEDIATE"
checkout_payment_intent
The intent to either capture payment immediately or authorize a payment for an order after order creation.


string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum: "CAPTURE" "AUTHORIZE"  
"CAPTURE"
cobranded_card
Details about the merchant cobranded card used for order purchase.


labels
Array of strings (label)   [ 1 .. 25 ] items 
Array of labels for the cobranded card.


 
object (payee_base) 
The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
{
  • "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.


required
object (payment_source) 
The payment source definition.


 
object (Order Confirm Application Context) 
Customizes the payer confirmation experience.


 
{
  • "payment_source": {
    • "card": {
      • "id": "string",
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "security_code": "stri",
      • "last_digits": "stri",
      • "card_type": "VISA",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "network_token": {
        • "number": "stringstrings",
        • "expiry": "string",
        • "cryptogram": "stringstringstringstringstri",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION",
        • "token_requestor_id": "string"
        },
      • "experience_context": {}
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "string",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "shipping": {
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "email_address": "string",
            • "phone_number": {
              • "country_code": "str",
              • "national_number": "string",
              • "extension_number": "string"
              },
            • "type": "SHIPPING",
            • "options": [
              • {
                • "id": null,
                • "label": null,
                • "type": null,
                • "amount": null,
                • "selected": null
                }
              ],
            • "address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              }
            },
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        },
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "app_switch_context": {
          • "native_app": {
            • "os_type": "ANDROID",
            • "os_version": "string"
            },
          • "mobile_web": {
            • "return_flow": "AUTO",
            • "buyer_user_agent": "string"
            }
          },
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        }
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "blik": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "consumer_ip": "string",
        • "consumer_user_agent": "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": {}
      },
    • "giropay": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "ideal": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "experience_context": {}
      },
    • "mybank": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "p24": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "sofort": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "trustly": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {}
      },
    • "apple_pay": {
      • "id": "string",
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "id": "string",
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "security_code": "stri",
          • "last_digits": "stri",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            },
          • "attributes": {
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "prefix": null,
                • "given_name": null,
                • "surname": null,
                • "middle_name": null,
                • "suffix": null,
                • "full_name": null
                },
              • "merchant_customer_id": "string"
              },
            • "vault": {
              • "store_in_vault": "ON_SUCCESS"
              },
            • "verification": {
              • "method": "SCA_ALWAYS"
              }
            }
          },
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "vault_id": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "experience_context": {}
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "last_digits": "stri",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "last_digits": "stri",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            }
          },
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string"
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {}
      },
    • "venmo": {
      • "vault_id": "string",
      • "email_address": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {},
        • "user_action": "CONTINUE"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "crypto": {
      • "country_code": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string"
        },
      • "experience_context": {}
      }
    },
  • "application_context": {
    • "brand_name": "string",
    • "locale": "string",
    • "return_url": "http://example.com",
    • "cancel_url": "http://example.com",
    • "stored_payment_source": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        }
      }
    }
}
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.


 
"st"
country_code-2
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)   = 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.


 
"st"
crypto
Pay With Crypto details response object.


country_code
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.


 
object (crypto_account_holder_name) 
Crypto account holder name.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "country_code": "string",
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string"
    },
  • "experience_context": {}
}
crypto_account_holder_name
Crypto account holder name.


prefix
string  [ 1 .. 140 ] characters ^[\S\s]*$
The prefix, or title, to the account holder's name.


 
given_name
required
string  [ 1 .. 140 ] characters ^[\S\s]*$
When the account holder is a person, the account holder's given, or first, name.


 
surname
required
string  [ 1 .. 140 ] characters ^[\S\s]*$
When the account holder is a person, the account holder's surname or family name. Also known as the last name. Required when the account holder is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.


 
middle_name
string  [ 1 .. 140 ] characters ^[\S\s]*$
When the account holder is a person, the account holder's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.


 
{
  • "prefix": "string",
  • "given_name": "string",
  • "surname": "string",
  • "middle_name": "string"
}
crypto_request
Crypto payment used to fund the transaction.


country_code
required
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.


 
required
object (crypto_account_holder_name) 
Crypto account holder name.


 
required
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "country_code": "string",
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string"
    },
  • "experience_context": {}
}
currency_code
The three-character ISO-4217 currency code that identifies the currency.


string (currency_code)   = 3 characters ^[\S\s]*$
The three-character ISO-4217 currency code that identifies the currency.


 
"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 (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
object (phone_with_type) 
The phone information.


 
object (Name) 
The name of the party.


 
{
  • "id": "string",
  • "email_address": "string",
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "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]|...
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.


 
"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]|...
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.


 
"stringstringstringst"
date_year_month
The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.


string (date_year_month)   = 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.


 
"strings"
disbursement_mode
The funds that are held on behalf of the merchant.


string (disbursement_mode) 
 Default:  "INSTANT"
The funds that are held on behalf of the merchant.


 Enum: "INSTANT" "DELAYED"  
"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 (currency_code)   = 3 characters ^[\S\s]*$
The three-character ISO-4217 currency code that identifies the currency.


 
value
required
string  [ 0 .. 32 ] characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
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.


 
{
  • "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 (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.


 Enum: "MASTERCARD_NON_3D_SECURE_TRANSACTION" "MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION" "MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION" "FULLY_AUTHENTICATED_TRANSACTION" "ATTEMPTED_AUTHENTICATION_TRANSACTION" "NON_3D_SECURE_TRANSACTION"  
"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 (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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
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...
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"
enrolled
Status of Authentication eligibility.


string (enrolled) 
Status of Authentication eligibility.


 Enum: "Y" "N" "U" "B"  
"Y"
eps
Information used to pay using eps.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string"
}
eps_request
Information needed to pay using eps.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {}
}
Error
The error details.


name
required
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The human-readable, unique name of the error.


 
message
required
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The message that describes the error.


 
debug_id
required
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The PayPal internal ID. Used for correlation purposes.


 
Array of objects (Error Details)   [ 0 .. 32767 ] items 
An array of additional details about the error.


 
Array of objects (Link Description)   [ 0 .. 32767 ] items 
An array of request-related HATEOAS links.


 
{
  • "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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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 .. 2147483647 ] characters ^[\S\s]*$
The value of the field that caused the error.


 
location
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
 Default:  "body"
The location of the field that caused the error. Value is body, path, or query.


 
issue
required
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The unique, fine-grained application-level error code.


 
Array of objects (Link Description)   [ 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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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.


 
{
  • "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.


source_currency
string (currency_code)   = 3 characters ^[\S\s]*$
The three-character ISO-4217 currency code that identifies the currency.


 
target_currency
string (currency_code)   = 3 characters ^[\S\s]*$
The three-character ISO-4217 currency code that identifies the currency.


 
value
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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",
  • "target_currency": "string",
  • "value": "string"
}
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.


 
locale
string (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
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.


 
shipping_preference
string
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum: "GET_FROM_FILE" "NO_SHIPPING" "SET_PROVIDED_ADDRESS"  
return_url
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
cancel_url
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
{}
experience_context_base
Customizes the payer experience during the approval process for the payment.


locale
string (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
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.


 
return_url
required
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
cancel_url
required
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
{}
giropay
Information needed to pay using giropay.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string"
}
giropay_request
Information needed to pay using giropay.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {}
}
google_pay
Google Pay Wallet payment data.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
email_address
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (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.


 
object (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",
  • "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",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "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 ^.{1,300}$
The card holder's name as it appears on the card.


 
number
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
The primary account number (PAN) for the payment card.


 
expiry
string (date_year_month)   = 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.


 
last_digits
string  [ 2 .. 4 ] characters ^[0-9]{2,4}$
The last digits of the payment card.


 
type
string (card_type) 
Type of card. i.e Credit, Debit and so on.


 Enum: "CREDIT" "DEBIT" "PREPAID" "STORE" "UNKNOWN"  
brand
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
{
  • "name": "string",
  • "number": "stringstrings",
  • "expiry": "string",
  • "last_digits": "stri",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    }
}
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 ^.{1,300}$
The card holder's name as it appears on the card.


 
last_digits
string  [ 2 .. 4 ] characters ^[0-9]{2,4}$
The last digits of the payment card.


 
type
string (card_type) 
Type of card. i.e Credit, Debit and so on.


 Enum: "CREDIT" "DEBIT" "PREPAID" "STORE" "UNKNOWN"  
brand
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
object (authentication_response) 
Results of Authentication such as 3D Secure.


 
{
  • "name": "string",
  • "last_digits": "stri",
  • "type": "CREDIT",
  • "brand": "VISA",
  • "billing_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "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 ^\d{13}$
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
The type of the payment credential. Currently, only CARD is supported.


 Value: "CARD"  
required
object (google_pay_card) 
Google Pay tokenized credit card used to pay.


 
authentication_method
required
string
Authentication Method which is used for the card transaction.


 Enum: "PAN_ONLY" "CRYPTOGRAM_3DS"  
cryptogram
string  [ 1 .. 2000 ] characters ^[\S\s]*$
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.


 
{
  • "message_id": "string",
  • "message_expiration": "stringstrings",
  • "payment_method": "CARD",
  • "card": {
    • "name": "string",
    • "number": "stringstrings",
    • "expiry": "string",
    • "last_digits": "stri",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      }
    },
  • "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 <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
cancel_url
required
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
{}
google_pay_request
Information needed to pay using Google Pay.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
email_address
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (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.


 
object (google_pay_card) 
The payment card used to fund a Google Pay payment. Can be a credit or debit card.


 
object (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.


 
object (assurance_details) 
Information about cardholder possession validation and cardholder identification and verifications (ID&V).


 
object (google_pay_experience_context) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string"
    },
  • "card": {
    • "name": "string",
    • "number": "stringstrings",
    • "expiry": "string",
    • "last_digits": "stri",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      }
    },
  • "decrypted_token": {
    • "message_id": "string",
    • "message_expiration": "stringstrings",
    • "payment_method": "CARD",
    • "card": {
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "last_digits": "stri",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        }
      },
    • "authentication_method": "PAN_ONLY",
    • "cryptogram": "string",
    • "eci_indicator": "string"
    },
  • "assurance_details": {
    • "account_verified": false,
    • "card_holder_authenticated": false
    },
  • "experience_context": {}
}
GUID
A Globally Unique Identifier (GUID) value.


string (GUID)   [ 1 .. 68 ] characters ^[A-Za-z0-9-{}(),]*$
A Globally Unique Identifier (GUID) value.


 
"string"
iban_last_chars
The last characters of the IBAN used to pay.


string (iban_last_chars)   [ 4 .. 34 ] characters ^.*[a-zA-Z0-9]{4}.*$
The last characters of the IBAN used to pay.


 
"string"
ideal
Information used to pay using iDEAL.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters ^.*[a-zA-Z0-9]{4}.*$
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
ideal_request
Information needed to pay using iDEAL.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "experience_context": {}
}
instrument_id
The identifier of the instrument.


string (instrument_id)   [ 1 .. 256 ] characters ^[A-Za-z0-9-_.+=]+$
The identifier of the instrument.


 
"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[...
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.


 
"strings"
item
The details for the items to be purchased.


name
required
string  [ 1 .. 127 ] characters ^[\S\s]*$
The item name or title.


 
quantity
required
string  [ 0 .. 10 ] characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
description
string  [ 0 .. 2048 ] characters ^[\S\s]*$
The detailed item description.


 
sku
string  [ 0 .. 127 ] characters ^[\S\s]*$
The stock keeping unit (SKU) for the item.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
image_url
string <uri>   [ 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.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
object (order_billing_plan) 
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


 
{
  • "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",
        • "pricing_scheme": {
          • "price": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "pricing_model": "FIXED",
          • "reload_threshold_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "total_cycles": 1,
        • "sequence": 1,
        • "start_date": "string"
        }
      ],
    • "setup_fee": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "name": "string"
    }
}
item
The details for the items to be purchased.


name
required
string  [ 1 .. 127 ] characters ^[\S\s]*$
The item name or title.


 
required
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
quantity
required
string  [ 0 .. 10 ] characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
description
string  [ 0 .. 2048 ] characters ^[\S\s]*$
The detailed item description.


 
sku
string  [ 0 .. 127 ] characters ^[\S\s]*$
The stock keeping unit (SKU) for the item.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
category
string
The item category type.


 Enum: "DIGITAL_GOODS" "PHYSICAL_GOODS" "DONATION"  
image_url
string <uri>   [ 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.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
object (order_billing_plan) 
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


 
{
  • "name": "string",
  • "unit_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "quantity": "string",
  • "description": "string",
  • "sku": "string",
  • "url": "http://example.com",
  • "category": "DIGITAL_GOODS",
  • "image_url": "http://example.com",
  • "upc": {
    • "type": "UPC-A",
    • "code": "string"
    },
  • "billing_plan": {
    • "billing_cycles": [
      • {
        • "tenure_type": "REGULAR",
        • "pricing_scheme": {
          • "price": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "pricing_model": "FIXED",
          • "reload_threshold_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "total_cycles": 1,
        • "sequence": 1,
        • "start_date": "string"
        }
      ],
    • "setup_fee": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "name": "string"
    }
}
item_request
The details for the items to be purchased.


name
required
string  [ 1 .. 3000 ] characters ^[\S\s]*$
The item name or title. 
This field supports up to 3000 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
.


 
required
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
quantity
required
string  [ 0 .. 10 ] characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
description
string  [ 0 .. 4000 ] characters ^[\S\s]*$
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  [ 0 .. 127 ] characters ^[\S\s]*$
The stock keeping unit (SKU) for the item.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
category
string
The item category type.


 Enum: "DIGITAL_GOODS" "PHYSICAL_GOODS" "DONATION"  
image_url
string <uri>   [ 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.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
object (order_billing_plan) 
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


 
{
  • "name": "string",
  • "unit_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "quantity": "string",
  • "description": "string",
  • "sku": "string",
  • "url": "http://example.com",
  • "category": "DIGITAL_GOODS",
  • "image_url": "http://example.com",
  • "upc": {
    • "type": "UPC-A",
    • "code": "string"
    },
  • "billing_plan": {
    • "billing_cycles": [
      • {
        • "tenure_type": "REGULAR",
        • "pricing_scheme": {
          • "price": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "pricing_model": "FIXED",
          • "reload_threshold_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "total_cycles": 1,
        • "sequence": 1,
        • "start_date": "string"
        }
      ],
    • "setup_fee": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "name": "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}|[...
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"
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 ^[\w‘\-.,":;\!?]*$
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.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
{
  • "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.


object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
ships_from_postal_code
string  [ 1 .. 60 ] characters ^[a-zA-Z0-9_'.-]*$
Use this field to specify the postal code of the shipping location.


 
Array of objects (line_item)   [ 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": {
    • "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",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "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",
            • "pricing_scheme": {
              • "price": {
                • "currency_code": null,
                • "value": null
                },
              • "pricing_model": "FIXED",
              • "reload_threshold_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "total_cycles": 1,
            • "sequence": 1,
            • "start_date": "string"
            }
          ],
        • "setup_fee": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "name": "string"
        },
      • "unit_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "commodity_code": "string",
      • "discount_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "total_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "unit_of_measure": "string"
      }
    ]
}
liability_shift
Liability shift indicator. The outcome of the issuer's authentication.


string (liability_shift) 
Liability shift indicator. The outcome of the issuer's authentication.


 Enum: "NO" "POSSIBLE" "UNKNOWN"  
"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 ^[\S\s]*$
The item name or title.


 
quantity
required
string  [ 0 .. 10 ] characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
description
string  [ 0 .. 2048 ] characters ^[\S\s]*$
The detailed item description.


 
sku
string  [ 0 .. 127 ] characters ^[\S\s]*$
The stock keeping unit (SKU) for the item.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
image_url
string <uri>   [ 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.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
object (order_billing_plan) 
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
commodity_code
string  [ 1 .. 12 ] characters ^[a-zA-Z0-9_'.-]*$
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.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
unit_of_measure
string  [ 1 .. 12 ] characters ^[a-zA-Z0-9_'.-]*$
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).


 
{
  • "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",
        • "pricing_scheme": {
          • "price": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "pricing_model": "FIXED",
          • "reload_threshold_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "total_cycles": 1,
        • "sequence": 1,
        • "start_date": "string"
        }
      ],
    • "setup_fee": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "name": "string"
    },
  • "unit_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "tax": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "commodity_code": "string",
  • "discount_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "total_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "unit_of_measure": "string"
}
Link Description
The request-related HATEOAS link information.


href
required
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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: "GET" "POST" "PUT" "DELETE" "HEAD" "CONNECT" "OPTIONS" "PATCH"  
title
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The link title.


 
mediaType
string (media_type)   [ 0 .. 2147483647 ] characters ^[\S\s]*$
The media type, as defined by RFC 2046. Describes the link target.


 
encType
string (enc_type)   [ 0 .. 2147483647 ] characters ^[\S\s]*$
 Default:  "application/json"
The media type in which to submit the request data.


 
object (Link Schema) 
The request data or link target.


 
object (Link Schema) 
The request data or link target.


 
{
  • "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 (additional_items) 
Any additional items.


 
dependencies
object (Dependencies) 
Any Dependencies.


 
items
object (Items) 
An item.


 
definitions
object (Definitions) 
Definitions.


 
patternProperties
object (pattern_properties) 
The pattern properties.


 
properties
object (Properties) 
Properties.


 
allOf
Array of objects (all_of)   [ 0 .. 32767 ] items 
An array of sub-schemas. The data must validate against all sub-schemas.


 
anyOf
Array of objects (any_of)   [ 0 .. 32767 ] items 
An array of sub-schemas. The data must validate against one or more sub-schemas.


 
oneOf
Array of objects (one_of)   [ 0 .. 32767 ] items 
An array of sub-schemas. The data must validate against one sub-schema.


 
not
object (Not) 
Not.


 
links
Array of objects (link)   [ 0 .. 32767 ] items 
An array of links.


 
fragmentResolution
string (fragment_resolution)   [ 0 .. 2147483647 ] characters ^[\S\s]*$
The fragment resolution.


 
object (Media) 
The media type and context-encoding scheme.


 
pathStart
string <uri>  (path_start)   [ 0 .. 2147483647 ] characters 
To apply this schema to the instances' URIs, start the URIs with this value.


 
{
  • "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.


object (App Switch Preferences on Native App) 
Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.


 
object (Mobile Web App Switch Context) 
Buyer's mobile web browser context to app switch to the PayPal consumer app.


 
{
  • "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 (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
"string"
Mobile Web App Switch Context
Buyer's mobile web browser context to app switch to the PayPal consumer app.


return_flow
string
 Default:  "AUTO"
Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the PayPal App.


 Enum: "AUTO" "MANUAL"  
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.


 
{
  • "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 (currency_code)   = 3 characters ^[\S\s]*$
The three-character ISO-4217 currency code that identifies the currency.


 
value
required
string  [ 0 .. 32 ] characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
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.


 
{
  • "currency_code": "str",
  • "value": "string"
}
mybank
Information used to pay using MyBank.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters ^.*[a-zA-Z0-9]{4}.*$
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
mybank_request
Information needed to pay using MyBank.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {}
}
Name
The name of the party.


prefix
string  [ 0 .. 140 ] characters ^[\S\s]*$
The prefix, or title, to the party's name.


 
given_name
string  [ 0 .. 140 ] characters ^[\S\s]*$
When the party is a person, the party's given, or first, name.


 
surname
string  [ 0 .. 140 ] characters ^[\S\s]*$
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.


 
middle_name
string  [ 0 .. 140 ] characters ^[\S\s]*$
When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.


 
suffix
string  [ 0 .. 140 ] characters ^[\S\s]*$
The suffix for the party's name.


 
full_name
string  [ 0 .. 300 ] characters ^[\S\s]*$
When the party is a person, the party's full name.


 
{
  • "prefix": "string",
  • "given_name": "string",
  • "surname": "string",
  • "middle_name": "string",
  • "suffix": "string",
  • "full_name": "string"
}
name
The full name representation like Mr J Smith.


string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
"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.


object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (exchange_rate) 
The exchange rate that determines the amount to convert from one currency to another currency.


 
{
  • "payable_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "converted_amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "exchange_rate": {
    • "source_currency": "string",
    • "target_currency": "string",
    • "value": "string"
    }
}
network_token
The Third Party Network token used to fund a payment.


number
required
string  [ 13 .. 19 ] characters ^[0-9]{13,19}$
Third party network token number.


 
expiry
required
string (date_year_month)   = 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.


 
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.


 
eci_flag
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.


 Enum: "MASTERCARD_NON_3D_SECURE_TRANSACTION" "MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION" "MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION" "FULLY_AUTHENTICATED_TRANSACTION" "ATTEMPTED_AUTHENTICATION_TRANSACTION" "NON_3D_SECURE_TRANSACTION"  
token_requestor_id
string  [ 1 .. 11 ] characters ^[0-9A-Z_]+$
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.


 
{
  • "number": "stringstrings",
  • "expiry": "string",
  • "cryptogram": "stringstringstringstringstri",
  • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION",
  • "token_requestor_id": "string"
}
network_transaction
Reference values used by the card network to identify a transaction.


id
string  [ 9 .. 36 ] characters ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
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 ^[0-9]+$
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.


 
network
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
acquirer_reference_number
string  [ 1 .. 36 ] characters ^[a-zA-Z0-9]+$
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.


 
{
  • "id": "stringstr",
  • "date": "stri",
  • "network": "VISA",
  • "acquirer_reference_number": "string"
}
network_transaction_reference
Reference values used by the card network to identify a transaction.


id
required
string  [ 9 .. 36 ] characters ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
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 ^[0-9]+$
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.


 
network
string (card_brand) 
The card network or brand. Applies to credit, debit, gift, and payment cards.


 Enum: "VISA" "MASTERCARD" "DISCOVER" "AMEX" "SOLO" "JCB" "STAR" "DELTA" "SWITCH" "MAESTRO" "CB_NATIONALE" "CONFIGOGA" "CONFIDIS" "ELECTRON" "CETELEM" "CHINA_UNION_PAY" "DINERS" "ELO" "HIPER" "HIPERCARD" "RUPAY" "GE" "SYNCHRONY" "EFTPOS" "CARTE_BANCAIRE" "STAR_ACCESS" "PULSE" "NYCE" "ACCEL" "UNKNOWN"  
acquirer_reference_number
string  [ 1 .. 36 ] characters ^[a-zA-Z0-9]+$
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.


 
{
  • "id": "stringstr",
  • "date": "stri",
  • "network": "VISA",
  • "acquirer_reference_number": "string"
}
Order
The order details.


create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The ID of the order.


 
object (payment_source_response) 
The payment source used to fund the payment.


 
intent
string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum: "CAPTURE" "AUTHORIZE"  
object (payer) 
 Deprecated 
The customer who approves and pays for the order. The customer is also known as the payer.


 
Array of objects (Purchase Unit)   [ 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.


 
status
string (Order Status) 
The order status.


 Enum: "CREATED" "SAVED" "APPROVED" "VOIDED" "COMPLETED" "PAYER_ACTION_REQUIRED"  
Array of objects (Link Description)   [ 0 .. 32767 ] items 
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.


 
{
  • "create_time": "string",
  • "update_time": "string",
  • "id": "string",
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "last_digits": "string",
      • "brand": "VISA",
      • "available_networks": [
        • "VISA"
        ],
      • "type": "CREDIT",
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "merchant_customer_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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          }
        },
      • "from_request": {
        • "expiry": "string",
        • "last_digits": "stri"
        },
      • "expiry": "string",
      • "bin_details": {
        • "bin": "string",
        • "issuing_bank": "string",
        • "bin_country_code": "string",
        • "products": [
          • "string"
          ]
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        }
      },
    • "paypal": {
      • "email_address": "string",
      • "account_id": "string",
      • "account_status": "VERIFIED",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        },
      • "birth_date": "string",
      • "business_name": "string",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "merchant_customer_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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          },
        • "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"
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "iban_last_chars": "string",
      • "card_last_digits": "stri"
      },
    • "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": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "payment_descriptor": "string",
      • "method_id": "string",
      • "method_description": "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"
      },
    • "apple_pay": {
      • "id": "string",
      • "token": "string",
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string",
        • "extension_number": "string"
        },
      • "card": {
        • "name": "string",
        • "last_digits": "string",
        • "brand": "VISA",
        • "available_networks": [
          • "VISA"
          ],
        • "type": "CREDIT",
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          },
        • "attributes": {
          • "vault": {
            • "id": "string",
            • "status": "VAULTED",
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "prefix": null,
                • "given_name": null,
                • "surname": null,
                • "middle_name": null,
                • "suffix": null,
                • "full_name": null
                },
              • "merchant_customer_id": "string"
              },
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ]
            }
          },
        • "from_request": {
          • "expiry": "string",
          • "last_digits": "stri"
          },
        • "expiry": "string",
        • "bin_details": {
          • "bin": "string",
          • "issuing_bank": "string",
          • "bin_country_code": "string",
          • "products": [
            • "string"
            ]
          },
        • "stored_credential": {
          • "payment_initiator": "CUSTOMER",
          • "payment_type": "ONE_TIME",
          • "usage": "FIRST",
          • "previous_network_transaction_reference": {
            • "id": "stringstr",
            • "date": "stri",
            • "network": "VISA",
            • "acquirer_reference_number": "string"
            }
          },
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "country_code": "string"
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "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",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          }
        }
      },
    • "venmo": {
      • "email_address": "string",
      • "account_id": "string",
      • "user_name": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone_number": {
        • "national_number": "string"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "return_flow": "AUTO",
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          }
        }
      },
    • "crypto": {
      • "country_code": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string"
        },
      • "experience_context": {}
      }
    },
  • "intent": "CAPTURE",
  • "payer": {
    • "email_address": "string",
    • "payer_id": "string",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "string",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      }
    },
  • "purchase_units": [
    • {
      • "reference_id": "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"
              }
            }
          ],
        • "disbursement_mode": "INSTANT",
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string"
        },
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "pricing_scheme": null,
                • "total_cycles": null,
                • "sequence": null,
                • "start_date": null
                }
              ],
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "name": "string"
            }
          }
        ],
      • "shipping": {
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string",
          • "extension_number": "string"
          },
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "selected": true
            }
          ],
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "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": {
            • "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",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              },
            • "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,
                • "unit_amount": null,
                • "tax": null,
                • "commodity_code": null,
                • "discount_amount": null,
                • "total_amount": null,
                • "unit_of_measure": null
                }
              ]
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        },
      • "payments": {
        • "authorizations": [
          • {
            • "status": "CREATED",
            • "status_details": {
              • "reason": "PENDING_REVIEW"
              },
            • "id": "string",
            • "amount": {
              • "currency_code": "str",
              • "value": "string",
              • "breakdown": {
                • "item_total": null,
                • "shipping": null,
                • "handling": null,
                • "tax_total": null,
                • "insurance": null,
                • "shipping_discount": null,
                • "discount": null
                }
              },
            • "invoice_id": "string",
            • "custom_id": "string",
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "network": "VISA",
              • "acquirer_reference_number": "string"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "expiration_time": "string",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ],
            • "create_time": "string",
            • "update_time": "string",
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              }
            }
          ],
        • "captures": [
          • {
            • "status": "COMPLETED",
            • "status_details": {
              • "reason": "BUYER_COMPLAINT"
              },
            • "id": "string",
            • "amount": {
              • "currency_code": "str",
              • "value": "string",
              • "breakdown": {
                • "item_total": null,
                • "shipping": null,
                • "handling": null,
                • "tax_total": null,
                • "insurance": null,
                • "shipping_discount": null,
                • "discount": null
                }
              },
            • "invoice_id": "string",
            • "custom_id": "string",
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "network": "VISA",
              • "acquirer_reference_number": "string"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "final_capture": false,
            • "seller_receivable_breakdown": {
              • "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": {
                • "source_currency": null,
                • "target_currency": null,
                • "value": null
                },
              • "platform_fees": [
                • null
                ]
              },
            • "disbursement_mode": "INSTANT",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ],
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              },
            • "create_time": "string",
            • "update_time": "string"
            }
          ],
        • "refunds": [
          • {
            • "status": "CANCELLED",
            • "status_details": {
              • "reason": "ECHECK"
              },
            • "id": "string",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "invoice_id": "string",
            • "custom_id": "string",
            • "acquirer_reference_number": "string",
            • "note_to_payer": "string",
            • "seller_payable_breakdown": {
              • "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
                },
              • "platform_fees": [
                • null
                ],
              • "net_amount_breakdown": [
                • null
                ],
              • "total_refunded_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "payer": {
              • "email_address": "string",
              • "merchant_id": "string"
              },
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ],
            • "create_time": "string",
            • "update_time": "string"
            }
          ]
        }
      }
    ],
  • "status": "CREATED",
  • "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"
        }
      }
    ]
}
Order Authorize Request
The authorization of an order request.


object (payment_source) 
The payment source definition.


 
{
  • "payment_source": {
    • "card": {
      • "id": "string",
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "security_code": "stri",
      • "last_digits": "stri",
      • "card_type": "VISA",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "network_token": {
        • "number": "stringstrings",
        • "expiry": "string",
        • "cryptogram": "stringstringstringstringstri",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION",
        • "token_requestor_id": "string"
        },
      • "experience_context": {}
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "string",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "shipping": {
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "email_address": "string",
            • "phone_number": {
              • "country_code": "str",
              • "national_number": "string",
              • "extension_number": "string"
              },
            • "type": "SHIPPING",
            • "options": [
              • {
                • "id": null,
                • "label": null,
                • "type": null,
                • "amount": null,
                • "selected": null
                }
              ],
            • "address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              }
            },
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        },
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "app_switch_context": {
          • "native_app": {
            • "os_type": "ANDROID",
            • "os_version": "string"
            },
          • "mobile_web": {
            • "return_flow": "AUTO",
            • "buyer_user_agent": "string"
            }
          },
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        }
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "blik": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "consumer_ip": "string",
        • "consumer_user_agent": "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": {}
      },
    • "giropay": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "ideal": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "experience_context": {}
      },
    • "mybank": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "p24": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "sofort": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "trustly": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {}
      },
    • "apple_pay": {
      • "id": "string",
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "id": "string",
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "security_code": "stri",
          • "last_digits": "stri",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            },
          • "attributes": {
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "prefix": null,
                • "given_name": null,
                • "surname": null,
                • "middle_name": null,
                • "suffix": null,
                • "full_name": null
                },
              • "merchant_customer_id": "string"
              },
            • "vault": {
              • "store_in_vault": "ON_SUCCESS"
              },
            • "verification": {
              • "method": "SCA_ALWAYS"
              }
            }
          },
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "vault_id": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "experience_context": {}
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "last_digits": "stri",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "last_digits": "stri",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            }
          },
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string"
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {}
      },
    • "venmo": {
      • "vault_id": "string",
      • "email_address": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {},
        • "user_action": "CONTINUE"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "crypto": {
      • "country_code": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string"
        },
      • "experience_context": {}
      }
    }
}
Order Authorize Response
The order authorize response.


create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The ID of the order.


 
object (payment_source_response) 
The payment source used to fund the payment.


 
intent
string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum: "CAPTURE" "AUTHORIZE"  
object (payer) 
The customer who approves and pays for the order. The customer is also known as the payer.


 
Array of objects (Purchase Unit)   [ 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.


 
status
string (Order Status) 
The order status.


 Enum: "CREATED" "SAVED" "APPROVED" "VOIDED" "COMPLETED" "PAYER_ACTION_REQUIRED"  
Array of objects (Link Description)   [ 0 .. 32767 ] items 
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.


 
{
  • "create_time": "string",
  • "update_time": "string",
  • "id": "string",
  • "payment_source": {
    • "card": {
      • "name": "string",
      • "last_digits": "string",
      • "brand": "VISA",
      • "available_networks": [
        • "VISA"
        ],
      • "type": "CREDIT",
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "merchant_customer_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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          }
        },
      • "from_request": {
        • "expiry": "string",
        • "last_digits": "stri"
        },
      • "expiry": "string",
      • "bin_details": {
        • "bin": "string",
        • "issuing_bank": "string",
        • "bin_country_code": "string",
        • "products": [
          • "string"
          ]
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        }
      },
    • "paypal": {
      • "email_address": "string",
      • "account_id": "string",
      • "account_status": "VERIFIED",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        },
      • "birth_date": "string",
      • "business_name": "string",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "merchant_customer_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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          },
        • "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"
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "iban_last_chars": "string",
      • "card_last_digits": "stri"
      },
    • "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": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "payment_descriptor": "string",
      • "method_id": "string",
      • "method_description": "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"
      },
    • "apple_pay": {
      • "id": "string",
      • "token": "string",
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string",
        • "extension_number": "string"
        },
      • "card": {
        • "name": "string",
        • "last_digits": "string",
        • "brand": "VISA",
        • "available_networks": [
          • "VISA"
          ],
        • "type": "CREDIT",
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          },
        • "attributes": {
          • "vault": {
            • "id": "string",
            • "status": "VAULTED",
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "prefix": null,
                • "given_name": null,
                • "surname": null,
                • "middle_name": null,
                • "suffix": null,
                • "full_name": null
                },
              • "merchant_customer_id": "string"
              },
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ]
            }
          },
        • "from_request": {
          • "expiry": "string",
          • "last_digits": "stri"
          },
        • "expiry": "string",
        • "bin_details": {
          • "bin": "string",
          • "issuing_bank": "string",
          • "bin_country_code": "string",
          • "products": [
            • "string"
            ]
          },
        • "stored_credential": {
          • "payment_initiator": "CUSTOMER",
          • "payment_type": "ONE_TIME",
          • "usage": "FIRST",
          • "previous_network_transaction_reference": {
            • "id": "stringstr",
            • "date": "stri",
            • "network": "VISA",
            • "acquirer_reference_number": "string"
            }
          },
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "country_code": "string"
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "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",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "authentication_result": {
          • "liability_shift": "NO",
          • "three_d_secure": {
            • "authentication_status": "Y",
            • "enrollment_status": "Y"
            }
          }
        }
      },
    • "venmo": {
      • "email_address": "string",
      • "account_id": "string",
      • "user_name": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone_number": {
        • "national_number": "string"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "return_flow": "AUTO",
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          }
        }
      },
    • "crypto": {
      • "country_code": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string"
        },
      • "experience_context": {}
      }
    },
  • "intent": "CAPTURE",
  • "payer": {
    • "email_address": "string",
    • "payer_id": "string",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "string",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      }
    },
  • "purchase_units": [
    • {
      • "reference_id": "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"
              }
            }
          ],
        • "disbursement_mode": "INSTANT",
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string"
        },
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "pricing_scheme": null,
                • "total_cycles": null,
                • "sequence": null,
                • "start_date": null
                }
              ],
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "name": "string"
            }
          }
        ],
      • "shipping": {
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string",
          • "extension_number": "string"
          },
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "selected": true
            }
          ],
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "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": {
            • "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",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              },
            • "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,
                • "unit_amount": null,
                • "tax": null,
                • "commodity_code": null,
                • "discount_amount": null,
                • "total_amount": null,
                • "unit_of_measure": null
                }
              ]
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        },
      • "payments": {
        • "authorizations": [
          • {
            • "status": "CREATED",
            • "status_details": {
              • "reason": "PENDING_REVIEW"
              },
            • "id": "string",
            • "amount": {
              • "currency_code": "str",
              • "value": "string",
              • "breakdown": {
                • "item_total": null,
                • "shipping": null,
                • "handling": null,
                • "tax_total": null,
                • "insurance": null,
                • "shipping_discount": null,
                • "discount": null
                }
              },
            • "invoice_id": "string",
            • "custom_id": "string",
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "network": "VISA",
              • "acquirer_reference_number": "string"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "expiration_time": "string",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ],
            • "create_time": "string",
            • "update_time": "string",
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              }
            }
          ],
        • "captures": [
          • {
            • "status": "COMPLETED",
            • "status_details": {
              • "reason": "BUYER_COMPLAINT"
              },
            • "id": "string",
            • "amount": {
              • "currency_code": "str",
              • "value": "string",
              • "breakdown": {
                • "item_total": null,
                • "shipping": null,
                • "handling": null,
                • "tax_total": null,
                • "insurance": null,
                • "shipping_discount": null,
                • "discount": null
                }
              },
            • "invoice_id": "string",
            • "custom_id": "string",
            • "network_transaction_reference": {
              • "id": "stringstr",
              • "date": "stri",
              • "network": "VISA",
              • "acquirer_reference_number": "string"
              },
            • "seller_protection": {
              • "status": "ELIGIBLE",
              • "dispute_categories": [
                • null
                ]
              },
            • "final_capture": false,
            • "seller_receivable_breakdown": {
              • "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": {
                • "source_currency": null,
                • "target_currency": null,
                • "value": null
                },
              • "platform_fees": [
                • null
                ]
              },
            • "disbursement_mode": "INSTANT",
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ],
            • "processor_response": {
              • "avs_code": "A",
              • "cvv_code": "E",
              • "response_code": "0000",
              • "payment_advice_code": "01"
              },
            • "create_time": "string",
            • "update_time": "string"
            }
          ],
        • "refunds": [
          • {
            • "status": "CANCELLED",
            • "status_details": {
              • "reason": "ECHECK"
              },
            • "id": "string",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "invoice_id": "string",
            • "custom_id": "string",
            • "acquirer_reference_number": "string",
            • "note_to_payer": "string",
            • "seller_payable_breakdown": {
              • "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
                },
              • "platform_fees": [
                • null
                ],
              • "net_amount_breakdown": [
                • null
                ],
              • "total_refunded_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "payer": {
              • "email_address": "string",
              • "merchant_id": "string"
              },
            • "links": [
              • {
                • "href": null,
                • "rel": null,
                • "method": null,
                • "title": null,
                • "mediaType": null,
                • "encType": null,
                • "schema": null,
                • "targetSchema": null
                }
              ],
            • "create_time": "string",
            • "update_time": "string"
            }
          ]
        }
      }
    ],
  • "status": "CREATED",
  • "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"
        }
      }
    ]
}
Order Capture Request
Completes an capture payment for an order.


object (payment_source) 
The payment source definition.


 
{
  • "payment_source": {
    • "card": {
      • "id": "string",
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "security_code": "stri",
      • "last_digits": "stri",
      • "card_type": "VISA",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "network_token": {
        • "number": "stringstrings",
        • "expiry": "string",
        • "cryptogram": "stringstringstringstringstri",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION",
        • "token_requestor_id": "string"
        },
      • "experience_context": {}
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "string",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "shipping": {
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "email_address": "string",
            • "phone_number": {
              • "country_code": "str",
              • "national_number": "string",
              • "extension_number": "string"
              },
            • "type": "SHIPPING",
            • "options": [
              • {
                • "id": null,
                • "label": null,
                • "type": null,
                • "amount": null,
                • "selected": null
                }
              ],
            • "address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              }
            },
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        },
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "app_switch_context": {
          • "native_app": {
            • "os_type": "ANDROID",
            • "os_version": "string"
            },
          • "mobile_web": {
            • "return_flow": "AUTO",
            • "buyer_user_agent": "string"
            }
          },
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        }
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "blik": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "consumer_ip": "string",
        • "consumer_user_agent": "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": {}
      },
    • "giropay": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "ideal": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "experience_context": {}
      },
    • "mybank": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "p24": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "sofort": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "trustly": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {}
      },
    • "apple_pay": {
      • "id": "string",
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "id": "string",
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "security_code": "stri",
          • "last_digits": "stri",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            },
          • "attributes": {
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "prefix": null,
                • "given_name": null,
                • "surname": null,
                • "middle_name": null,
                • "suffix": null,
                • "full_name": null
                },
              • "merchant_customer_id": "string"
              },
            • "vault": {
              • "store_in_vault": "ON_SUCCESS"
              },
            • "verification": {
              • "method": "SCA_ALWAYS"
              }
            }
          },
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "vault_id": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "experience_context": {}
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "last_digits": "stri",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "last_digits": "stri",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            }
          },
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string"
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {}
      },
    • "venmo": {
      • "vault_id": "string",
      • "email_address": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {},
        • "user_action": "CONTINUE"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "crypto": {
      • "country_code": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string"
        },
      • "experience_context": {}
      }
    }
}
Order Confirm Application Context
Customizes the payer confirmation experience.


brand_name
string  [ 1 .. 127 ] characters ^[\S\s]*$
Label to present to your payer as part of the PayPal hosted web experience.


 
locale
string (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
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.


 
return_url
string <uri>   [ 10 .. 4000 ] characters 
The URL where the customer is redirected after the customer approves the payment.


 
cancel_url
string <uri>   [ 10 .. 4000 ] characters 
The URL where the customer is redirected after the customer cancels the payment.


 
object (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.


 
{
  • "brand_name": "string",
  • "locale": "string",
  • "return_url": "http://example.com",
  • "cancel_url": "http://example.com",
  • "stored_payment_source": {
    • "payment_initiator": "CUSTOMER",
    • "payment_type": "ONE_TIME",
    • "usage": "FIRST",
    • "previous_network_transaction_reference": {
      • "id": "stringstr",
      • "date": "stri",
      • "network": "VISA",
      • "acquirer_reference_number": "string"
      }
    }
}
Order Request
The order request details.


intent
required
string (checkout_payment_intent) 
The intent to either capture payment immediately or authorize a payment for an order after order creation.


 Enum: "CAPTURE" "AUTHORIZE"  
object (payer) 
 Deprecated 
The customer who approves and pays for the order. The customer is also known as the payer.


 
required
Array of objects (Purchase Unit Request)   [ 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.


 
object (payment_source) 
The payment source definition.


 
object (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.


 
{
  • "intent": "CAPTURE",
  • "payer": {
    • "email_address": "string",
    • "payer_id": "string",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "string",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      }
    },
  • "purchase_units": [
    • {
      • "reference_id": "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"
              }
            }
          ],
        • "disbursement_mode": "INSTANT",
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string"
        },
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "pricing_scheme": null,
                • "total_cycles": null,
                • "sequence": null,
                • "start_date": null
                }
              ],
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "name": "string"
            }
          }
        ],
      • "shipping": {
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string",
          • "extension_number": "string"
          },
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "selected": true
            }
          ],
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "supplementary_data": {
        • "card": {
          • "level_2": {
            • "invoice_id": "string",
            • "tax_total": {
              • "currency_code": "str",
              • "value": "string"
              }
            },
          • "level_3": {
            • "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",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              },
            • "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,
                • "unit_amount": null,
                • "tax": null,
                • "commodity_code": null,
                • "discount_amount": null,
                • "total_amount": null,
                • "unit_of_measure": null
                }
              ]
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        }
      }
    ],
  • "payment_source": {
    • "card": {
      • "id": "string",
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "security_code": "stri",
      • "last_digits": "stri",
      • "card_type": "VISA",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          },
        • "verification": {
          • "method": "SCA_ALWAYS"
          }
        },
      • "vault_id": "string",
      • "single_use_token": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "network_token": {
        • "number": "stringstrings",
        • "expiry": "string",
        • "cryptogram": "stringstringstringstringstri",
        • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION",
        • "token_requestor_id": "string"
        },
      • "experience_context": {}
      },
    • "token": {
      • "id": "string",
      • "type": "BILLING_AGREEMENT"
      },
    • "paypal": {
      • "vault_id": "string",
      • "email_address": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "birth_date": "string",
      • "tax_info": {
        • "tax_id": "string",
        • "tax_id_type": "BR_CPF"
        },
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_id": "string"
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "shipping": {
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "email_address": "string",
            • "phone_number": {
              • "country_code": "str",
              • "national_number": "string",
              • "extension_number": "string"
              },
            • "type": "SHIPPING",
            • "options": [
              • {
                • "id": null,
                • "label": null,
                • "type": null,
                • "amount": null,
                • "selected": null
                }
              ],
            • "address": {
              • "address_line_1": "string",
              • "address_line_2": "string",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              }
            },
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        },
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "contact_preference": "NO_CONTACT_INFO",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "app_switch_context": {
          • "native_app": {
            • "os_type": "ANDROID",
            • "os_version": "string"
            },
          • "mobile_web": {
            • "return_flow": "AUTO",
            • "buyer_user_agent": "string"
            }
          },
        • "landing_page": "LOGIN",
        • "user_action": "CONTINUE",
        • "payment_method_preference": "UNRESTRICTED",
        • "order_update_callback_config": {}
        },
      • "billing_agreement_id": "string",
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "charge_pattern": "IMMEDIATE",
        • "usage_pattern": "IMMEDIATE",
        • "usage": "FIRST"
        }
      },
    • "bancontact": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "blik": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "locale": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "return_url": "http://example.com",
        • "cancel_url": "http://example.com",
        • "consumer_ip": "string",
        • "consumer_user_agent": "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": {}
      },
    • "giropay": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "ideal": {
      • "name": "string",
      • "country_code": "string",
      • "bic": "string",
      • "experience_context": {}
      },
    • "mybank": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "p24": {
      • "name": "string",
      • "email": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "sofort": {
      • "name": "string",
      • "country_code": "string",
      • "experience_context": {}
      },
    • "trustly": {
      • "name": "string",
      • "country_code": "string",
      • "email": "string",
      • "experience_context": {}
      },
    • "apple_pay": {
      • "id": "string",
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "national_number": "string"
        },
      • "decrypted_token": {
        • "transaction_amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "tokenized_card": {
          • "id": "string",
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "security_code": "stri",
          • "last_digits": "stri",
          • "card_type": "VISA",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            },
          • "attributes": {
            • "customer": {
              • "id": "string",
              • "email_address": "string",
              • "phone": {
                • "phone_type": null,
                • "phone_number": null
                },
              • "name": {
                • "prefix": null,
                • "given_name": null,
                • "surname": null,
                • "middle_name": null,
                • "suffix": null,
                • "full_name": null
                },
              • "merchant_customer_id": "string"
              },
            • "vault": {
              • "store_in_vault": "ON_SUCCESS"
              },
            • "verification": {
              • "method": "SCA_ALWAYS"
              }
            }
          },
        • "device_manufacturer_id": "string",
        • "payment_data_type": "3DSECURE",
        • "payment_data": {
          • "cryptogram": "string",
          • "eci_indicator": "string",
          • "emv_data": "string",
          • "pin": "string"
          }
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "vault_id": "string",
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS"
          }
        },
      • "experience_context": {}
      },
    • "google_pay": {
      • "name": "string",
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string"
        },
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "last_digits": "stri",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "decrypted_token": {
        • "message_id": "string",
        • "message_expiration": "stringstrings",
        • "payment_method": "CARD",
        • "card": {
          • "name": "string",
          • "number": "stringstrings",
          • "expiry": "string",
          • "last_digits": "stri",
          • "type": "CREDIT",
          • "brand": "VISA",
          • "billing_address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            }
          },
        • "authentication_method": "PAN_ONLY",
        • "cryptogram": "string",
        • "eci_indicator": "string"
        },
      • "assurance_details": {
        • "account_verified": false,
        • "card_holder_authenticated": false
        },
      • "experience_context": {}
      },
    • "venmo": {
      • "vault_id": "string",
      • "email_address": "string",
      • "experience_context": {
        • "brand_name": "string",
        • "shipping_preference": "GET_FROM_FILE",
        • "order_update_callback_config": {},
        • "user_action": "CONTINUE"
        },
      • "attributes": {
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            }
          },
        • "vault": {
          • "store_in_vault": "ON_SUCCESS",
          • "description": "string",
          • "usage_pattern": "IMMEDIATE",
          • "usage_type": "MERCHANT",
          • "customer_type": "CONSUMER",
          • "permit_multiple_payment_tokens": false
          }
        }
      },
    • "crypto": {
      • "country_code": "string",
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string"
        },
      • "experience_context": {}
      }
    },
  • "application_context": {
    • "brand_name": "string",
    • "locale": "string",
    • "landing_page": "LOGIN",
    • "shipping_preference": "GET_FROM_FILE",
    • "user_action": "CONTINUE",
    • "payment_method": {
      • "payee_preferred": "UNRESTRICTED",
      • "standard_entry_class_code": "TEL"
      },
    • "return_url": "http://example.com",
    • "cancel_url": "http://example.com",
    • "stored_payment_source": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        }
      }
    }
}
Order Status
The order status.


string (Order Status) 
The order status.


 Enum: "CREATED" "SAVED" "APPROVED" "VOIDED" "COMPLETED" "PAYER_ACTION_REQUIRED"  
"CREATED"
order_billing_plan
Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.


required
Array of objects (billing_cycle)   [ 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.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
name
string  [ 1 .. 127 ] characters ^[A-Za-z0-9() +',.:-]+$
Name of the recurring plan.


 
{
  • "billing_cycles": [
    • {
      • "tenure_type": "REGULAR",
      • "pricing_scheme": {
        • "price": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "pricing_model": "FIXED",
        • "reload_threshold_amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "total_cycles": 1,
      • "sequence": 1,
      • "start_date": "string"
      }
    ],
  • "setup_fee": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "name": "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.


 
Array of objects (OrderUpdateCallbackErrorResponseDetails)   [ 1 .. 100 ] items 
An array of additional details about the error.


 
{
  • "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.


 
{
  • "field": "string",
  • "value": "string",
  • "issue": "string"
}
OrderUpdateCallbackRequest
Shipping Options Callback request. This will be implemented by the merchants.


id
string  [ 1 .. 36 ] characters ^[A-Z0-9-]+$
The ID of the order.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
object (shipping_option) 
The options that the payee or merchant offers to the payer to ship or pick up their items.


 
required
Array of objects (Purchase Unit Request)   = 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.


 
{
  • "id": "string",
  • "shipping_address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "shipping_option": {
    • "id": "string",
    • "label": "string",
    • "type": "SHIPPING",
    • "amount": {
      • "currency_code": "str",
      • "value": "string"
      },
    • "selected": true
    },
  • "purchase_units": [
    • {
      • "reference_id": "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"
              }
            }
          ],
        • "disbursement_mode": "INSTANT",
        • "payee_pricing_tier_id": "string",
        • "payee_receivable_fx_rate_id": "string"
        },
      • "description": "string",
      • "custom_id": "string",
      • "invoice_id": "string",
      • "soft_descriptor": "string",
      • "items": [
        • {
          • "name": "string",
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "quantity": "string",
          • "description": "string",
          • "sku": "string",
          • "url": "http://example.com",
          • "category": "DIGITAL_GOODS",
          • "image_url": "http://example.com",
          • "upc": {
            • "type": "UPC-A",
            • "code": "string"
            },
          • "billing_plan": {
            • "billing_cycles": [
              • {
                • "tenure_type": null,
                • "pricing_scheme": null,
                • "total_cycles": null,
                • "sequence": null,
                • "start_date": null
                }
              ],
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "name": "string"
            }
          }
        ],
      • "shipping": {
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string",
          • "extension_number": "string"
          },
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "selected": true
            }
          ],
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "supplementary_data": {
        • "card": {
          • "level_2": {
            • "invoice_id": "string",
            • "tax_total": {
              • "currency_code": "str",
              • "value": "string"
              }
            },
          • "level_3": {
            • "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",
              • "address_line_3": "string",
              • "admin_area_4": "string",
              • "admin_area_3": "string",
              • "admin_area_2": "string",
              • "admin_area_1": "string",
              • "postal_code": "string",
              • "country_code": "st",
              • "address_details": {
                • "street_number": null,
                • "street_name": null,
                • "street_type": null,
                • "delivery_service": null,
                • "building_name": null,
                • "sub_building": null
                }
              },
            • "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,
                • "unit_amount": null,
                • "tax": null,
                • "commodity_code": null,
                • "discount_amount": null,
                • "total_amount": null,
                • "unit_of_measure": null
                }
              ]
            }
          },
        • "risk": {
          • "customer": {
            • "ip_address": "string"
            }
          }
        }
      }
    ]
}
OrderUpdateCallbackResponse
Returns the updated shipping options for an order.


id
string  [ 1 .. 36 ] characters ^[A-Z0-9-]+$
The ID of the order.


 
{
  • "id": "string"
}
p24
Information used to pay using P24(Przelewy24).


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
email
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
country_code
string (country_code-2)   = 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.


 
payment_descriptor
string  [ 1 .. 2000 ] characters ^[\S\s]*$
P24 generated payment description.


 
method_id
string  [ 1 .. 300 ] characters ^[\S\s]*$
Numeric identifier of the payment scheme or bank used for the payment.


 
method_description
string  [ 1 .. 2000 ] characters ^[\S\s]*$
Friendly name of the payment scheme or bank used for the payment.


 
{
  • "name": "string",
  • "email": "string",
  • "country_code": "string",
  • "payment_descriptor": "string",
  • "method_id": "string",
  • "method_description": "string"
}
p24_request
Information needed to pay using P24 (Przelewy24).


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
email
required
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
country_code
required
string (country_code-2)   = 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.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "email": "string",
  • "country_code": "string",
  • "experience_context": {}
}
pares_status
Transactions status result identifier. The outcome of the issuer's authentication.


string (pares_status) 
Transactions status result identifier. The outcome of the issuer's authentication.


 Enum: "Y" "N" "U" "A" "C" "R" "D" "I"  
"Y"
participant_metadata
Profile information of the sender or receiver.


ip_address
string (IP Address)   [ 7 .. 39 ] characters ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[...
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.


 
{
  • "ip_address": "string"
}
Patch
The JSON patch object to apply partial updates to resources.


op
required
string
The operation.


 Enum: "add" "remove" "replace" "move" "copy" "test"  
path
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
{
  • "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: "add" "remove" "replace" "move" "copy" "test"  
path
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location at which to complete the operation.


 
value
any (Patch Value) 
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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The JSON Pointer to the target document location from which to move the value. Required for the move operation.


 
[
  • {
    • "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 (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
merchant_id
string (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The account identifier for a PayPal account.


 
{
  • "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 (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
merchant_id
string (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The account identifier for a PayPal account.


 
{
  • "email_address": "string",
  • "merchant_id": "string"
}
payee_payment_method_preference
The merchant-preferred payment methods.


string (payee_payment_method_preference) 
 Default:  "UNRESTRICTED"
The merchant-preferred payment methods.


 Enum: "UNRESTRICTED" "IMMEDIATE_PAYMENT_REQUIRED"  
"UNRESTRICTED"
payer
The customer who approves and pays for the order. The customer is also known as the payer.


email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
payer_id
string (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The account identifier for a PayPal account.


 
object (Name) 
The name of the party.


 
object (phone_with_type) 
The phone information.


 
birth_date
string (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
object (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.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
{
  • "email_address": "string",
  • "payer_id": "string",
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "string"
    },
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "birth_date": "string",
  • "tax_info": {
    • "tax_id": "string",
    • "tax_id_type": "BR_CPF"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    }
}
payer_base
The customer who approves and pays for the order. The customer is also known as the payer.


email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
payer_id
string (PayPal Account Identifier)   = 13 characters ^[2-9A-HJ-NP-Z]{13}$
The account identifier for a PayPal account.


 
{
  • "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.


Array of objects (authorization_with_additional_data)   [ 0 .. 32767 ] items 
An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.


 
Array of objects (capture)   [ 0 .. 32767 ] items 
An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.


 
Array of objects (refund)   [ 0 .. 32767 ] items 
An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.


 
{
  • "authorizations": [
    • {
      • "status": "CREATED",
      • "status_details": {
        • "reason": "PENDING_REVIEW"
        },
      • "id": "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"
            }
          }
        },
      • "invoice_id": "string",
      • "custom_id": "string",
      • "network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        },
      • "seller_protection": {
        • "status": "ELIGIBLE",
        • "dispute_categories": [
          • "ITEM_NOT_RECEIVED"
          ]
        },
      • "expiration_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"
            }
          }
        ],
      • "create_time": "string",
      • "update_time": "string",
      • "processor_response": {
        • "avs_code": "A",
        • "cvv_code": "E",
        • "response_code": "0000",
        • "payment_advice_code": "01"
        }
      }
    ],
  • "captures": [
    • {
      • "status": "COMPLETED",
      • "status_details": {
        • "reason": "BUYER_COMPLAINT"
        },
      • "id": "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"
            }
          }
        },
      • "invoice_id": "string",
      • "custom_id": "string",
      • "network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        },
      • "seller_protection": {
        • "status": "ELIGIBLE",
        • "dispute_categories": [
          • "ITEM_NOT_RECEIVED"
          ]
        },
      • "final_capture": false,
      • "seller_receivable_breakdown": {
        • "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": {
          • "source_currency": "string",
          • "target_currency": "string",
          • "value": "string"
          },
        • "platform_fees": [
          • {
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "payee": {
              • "email_address": "string",
              • "merchant_id": "string"
              }
            }
          ]
        },
      • "disbursement_mode": "INSTANT",
      • "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"
            }
          }
        ],
      • "processor_response": {
        • "avs_code": "A",
        • "cvv_code": "E",
        • "response_code": "0000",
        • "payment_advice_code": "01"
        },
      • "create_time": "string",
      • "update_time": "string"
      }
    ],
  • "refunds": [
    • {
      • "status": "CANCELLED",
      • "status_details": {
        • "reason": "ECHECK"
        },
      • "id": "string",
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "invoice_id": "string",
      • "custom_id": "string",
      • "acquirer_reference_number": "string",
      • "note_to_payer": "string",
      • "seller_payable_breakdown": {
        • "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"
          },
        • "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": {
              • "source_currency": "string",
              • "target_currency": "string",
              • "value": "string"
              }
            }
          ],
        • "total_refunded_amount": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "payer": {
        • "email_address": "string",
        • "merchant_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"
            }
          }
        ],
      • "create_time": "string",
      • "update_time": "string"
      }
    ]
}
payment_initiator
The person or party who initiated or triggered the payment.


string (payment_initiator) 
The person or party who initiated or triggered the payment.


 Enum: "CUSTOMER" "MERCHANT"  
"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.


Array of objects (platform_fee)   [ 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.


 
disbursement_mode
string (disbursement_mode) 
 Default:  "INSTANT"
The funds that are held on behalf of the merchant.


 Enum: "INSTANT" "DELAYED"  
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.


 
{
  • "platform_fees": [
    • {
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        }
      }
    ],
  • "disbursement_mode": "INSTANT",
  • "payee_pricing_tier_id": "string",
  • "payee_receivable_fx_rate_id": "string"
}
payment_method
The customer and merchant payment preferences.


payee_preferred
string (payee_payment_method_preference) 
 Default:  "UNRESTRICTED"
The merchant-preferred payment methods.


 Enum: "UNRESTRICTED" "IMMEDIATE_PAYMENT_REQUIRED"  
standard_entry_class_code
string
 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: "TEL" "WEB" "CCD" "PPD"  
{
  • "payee_preferred": "UNRESTRICTED",
  • "standard_entry_class_code": "TEL"
}
payment_source
The payment source definition.


object (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.


 
object (token) 
The tokenized payment source to fund a payment.


 
object (paypal_wallet) 
A resource that identifies a PayPal Wallet is used for payment.


 
object (bancontact_request) 
Information needed to pay using Bancontact.


 
object (blik_request) 
Information needed to pay using BLIK.


 
object (eps_request) 
Information needed to pay using eps.


 
object (giropay_request) 
Information needed to pay using giropay.


 
object (ideal_request) 
Information needed to pay using iDEAL.


 
object (mybank_request) 
Information needed to pay using MyBank.


 
object (p24_request) 
Information needed to pay using P24 (Przelewy24).


 
object (sofort_request) 
Information needed to pay using Sofort.


 
object (trustly_request) 
Information needed to pay using Trustly.


 
object (apple_pay_request) 
Information needed to pay using ApplePay.


 
object (google_pay_request) 
Information needed to pay using Google Pay.


 
object (venmo_wallet_request) 
Information needed to pay using Venmo.


 
object (crypto_request) 
Crypto payment used to fund the transaction.


 
{
  • "card": {
    • "id": "string",
    • "name": "string",
    • "number": "stringstrings",
    • "expiry": "string",
    • "security_code": "stri",
    • "last_digits": "stri",
    • "card_type": "VISA",
    • "type": "CREDIT",
    • "brand": "VISA",
    • "billing_address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        },
      • "verification": {
        • "method": "SCA_ALWAYS"
        }
      },
    • "vault_id": "string",
    • "single_use_token": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        }
      },
    • "network_token": {
      • "number": "stringstrings",
      • "expiry": "string",
      • "cryptogram": "stringstringstringstringstri",
      • "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION",
      • "token_requestor_id": "string"
      },
    • "experience_context": {}
    },
  • "token": {
    • "id": "string",
    • "type": "BILLING_AGREEMENT"
    },
  • "paypal": {
    • "vault_id": "string",
    • "email_address": "string",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "birth_date": "string",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "merchant_customer_id": "string"
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "IMMEDIATE",
        • "shipping": {
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "email_address": "string",
          • "phone_number": {
            • "country_code": "str",
            • "national_number": "string",
            • "extension_number": "string"
            },
          • "type": "SHIPPING",
          • "options": [
            • {
              • "id": "string",
              • "label": "string",
              • "type": "SHIPPING",
              • "amount": {
                • "currency_code": null,
                • "value": null
                },
              • "selected": true
              }
            ],
          • "address": {
            • "address_line_1": "string",
            • "address_line_2": "string",
            • "address_line_3": "string",
            • "admin_area_4": "string",
            • "admin_area_3": "string",
            • "admin_area_2": "string",
            • "admin_area_1": "string",
            • "postal_code": "string",
            • "country_code": "st",
            • "address_details": {
              • "street_number": "string",
              • "street_name": "string",
              • "street_type": "string",
              • "delivery_service": "string",
              • "building_name": "string",
              • "sub_building": "string"
              }
            }
          },
        • "usage_type": "MERCHANT",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      },
    • "experience_context": {
      • "brand_name": "string",
      • "locale": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "contact_preference": "NO_CONTACT_INFO",
      • "return_url": "http://example.com",
      • "cancel_url": "http://example.com",
      • "app_switch_context": {
        • "native_app": {
          • "os_type": "ANDROID",
          • "os_version": "string"
          },
        • "mobile_web": {
          • "return_flow": "AUTO",
          • "buyer_user_agent": "string"
          }
        },
      • "landing_page": "LOGIN",
      • "user_action": "CONTINUE",
      • "payment_method_preference": "UNRESTRICTED",
      • "order_update_callback_config": {}
      },
    • "billing_agreement_id": "string",
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "charge_pattern": "IMMEDIATE",
      • "usage_pattern": "IMMEDIATE",
      • "usage": "FIRST"
      }
    },
  • "bancontact": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {}
    },
  • "blik": {
    • "name": "string",
    • "country_code": "string",
    • "email": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "locale": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "return_url": "http://example.com",
      • "cancel_url": "http://example.com",
      • "consumer_ip": "string",
      • "consumer_user_agent": "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": {}
    },
  • "giropay": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {}
    },
  • "ideal": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string",
    • "experience_context": {}
    },
  • "mybank": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {}
    },
  • "p24": {
    • "name": "string",
    • "email": "string",
    • "country_code": "string",
    • "experience_context": {}
    },
  • "sofort": {
    • "name": "string",
    • "country_code": "string",
    • "experience_context": {}
    },
  • "trustly": {
    • "name": "string",
    • "country_code": "string",
    • "email": "string",
    • "experience_context": {}
    },
  • "apple_pay": {
    • "id": "string",
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "national_number": "string"
      },
    • "decrypted_token": {
      • "transaction_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tokenized_card": {
        • "id": "string",
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "security_code": "stri",
        • "last_digits": "stri",
        • "card_type": "VISA",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "attributes": {
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "merchant_customer_id": "string"
            },
          • "vault": {
            • "store_in_vault": "ON_SUCCESS"
            },
          • "verification": {
            • "method": "SCA_ALWAYS"
            }
          }
        },
      • "device_manufacturer_id": "string",
      • "payment_data_type": "3DSECURE",
      • "payment_data": {
        • "cryptogram": "string",
        • "eci_indicator": "string",
        • "emv_data": "string",
        • "pin": "string"
        }
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        }
      },
    • "vault_id": "string",
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS"
        }
      },
    • "experience_context": {}
    },
  • "google_pay": {
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string"
      },
    • "card": {
      • "name": "string",
      • "number": "stringstrings",
      • "expiry": "string",
      • "last_digits": "stri",
      • "type": "CREDIT",
      • "brand": "VISA",
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        }
      },
    • "decrypted_token": {
      • "message_id": "string",
      • "message_expiration": "stringstrings",
      • "payment_method": "CARD",
      • "card": {
        • "name": "string",
        • "number": "stringstrings",
        • "expiry": "string",
        • "last_digits": "stri",
        • "type": "CREDIT",
        • "brand": "VISA",
        • "billing_address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "authentication_method": "PAN_ONLY",
      • "cryptogram": "string",
      • "eci_indicator": "string"
      },
    • "assurance_details": {
      • "account_verified": false,
      • "card_holder_authenticated": false
      },
    • "experience_context": {}
    },
  • "venmo": {
    • "vault_id": "string",
    • "email_address": "string",
    • "experience_context": {
      • "brand_name": "string",
      • "shipping_preference": "GET_FROM_FILE",
      • "order_update_callback_config": {},
      • "user_action": "CONTINUE"
      },
    • "attributes": {
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          }
        },
      • "vault": {
        • "store_in_vault": "ON_SUCCESS",
        • "description": "string",
        • "usage_pattern": "IMMEDIATE",
        • "usage_type": "MERCHANT",
        • "customer_type": "CONSUMER",
        • "permit_multiple_payment_tokens": false
        }
      }
    },
  • "crypto": {
    • "country_code": "string",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string"
      },
    • "experience_context": {}
    }
}
payment_source_response
The payment source used to fund the payment.


object (card_response) 
The payment card to use to fund a payment. Card can be a credit or debit card.


 
object (paypal_wallet_response) 
The PayPal Wallet response.


 
object (bancontact) 
Information used to pay Bancontact.


 
object (blik) 
Information used to pay using BLIK.


 
object (eps) 
Information used to pay using eps.


 
object (giropay) 
Information needed to pay using giropay.


 
object (ideal) 
Information used to pay using iDEAL.


 
object (mybank) 
Information used to pay using MyBank.


 
object (p24) 
Information used to pay using P24(Przelewy24).


 
object (sofort) 
Information used to pay using Sofort.


 
object (trustly) 
Information needed to pay using Trustly.


 
object (apple_pay) 
Information needed to pay using ApplePay.


 
object (google_pay) 
Google Pay Wallet payment data.


 
object (venmo_wallet_response) 
Venmo wallet response.


 
object (crypto) 
Pay With Crypto details response object.


 
{
  • "card": {
    • "name": "string",
    • "last_digits": "string",
    • "brand": "VISA",
    • "available_networks": [
      • "VISA"
      ],
    • "type": "CREDIT",
    • "authentication_result": {
      • "liability_shift": "NO",
      • "three_d_secure": {
        • "authentication_status": "Y",
        • "enrollment_status": "Y"
        }
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_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"
              }
            }
          ]
        }
      },
    • "from_request": {
      • "expiry": "string",
      • "last_digits": "stri"
      },
    • "expiry": "string",
    • "bin_details": {
      • "bin": "string",
      • "issuing_bank": "string",
      • "bin_country_code": "string",
      • "products": [
        • "string"
        ]
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "string"
        }
      }
    },
  • "paypal": {
    • "email_address": "string",
    • "account_id": "string",
    • "account_status": "VERIFIED",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      },
    • "birth_date": "string",
    • "business_name": "string",
    • "tax_info": {
      • "tax_id": "string",
      • "tax_id_type": "BR_CPF"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "string"
            },
          • "merchant_customer_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"
              }
            }
          ]
        },
      • "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"
    },
  • "bancontact": {
    • "name": "string",
    • "country_code": "string",
    • "bic": "string",
    • "iban_last_chars": "string",
    • "card_last_digits": "stri"
    },
  • "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": {
    • "name": "string",
    • "email": "string",
    • "country_code": "string",
    • "payment_descriptor": "string",
    • "method_id": "string",
    • "method_description": "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"
    },
  • "apple_pay": {
    • "id": "string",
    • "token": "string",
    • "name": "string",
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string",
      • "extension_number": "string"
      },
    • "card": {
      • "name": "string",
      • "last_digits": "string",
      • "brand": "VISA",
      • "available_networks": [
        • "VISA"
        ],
      • "type": "CREDIT",
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        },
      • "attributes": {
        • "vault": {
          • "id": "string",
          • "status": "VAULTED",
          • "customer": {
            • "id": "string",
            • "email_address": "string",
            • "phone": {
              • "phone_type": "FAX",
              • "phone_number": {
                • "national_number": null
                }
              },
            • "name": {
              • "prefix": "string",
              • "given_name": "string",
              • "surname": "string",
              • "middle_name": "string",
              • "suffix": "string",
              • "full_name": "string"
              },
            • "merchant_customer_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": null,
                • "media": { },
                • "pathStart": null
                },
              • "targetSchema": {
                • "additionalItems": { },
                • "dependencies": { },
                • "items": { },
                • "definitions": { },
                • "patternProperties": { },
                • "properties": { },
                • "allOf": [ ],
                • "anyOf": [ ],
                • "oneOf": [ ],
                • "not": { },
                • "links": [ ],
                • "fragmentResolution": null,
                • "media": { },
                • "pathStart": null
                }
              }
            ]
          }
        },
      • "from_request": {
        • "expiry": "string",
        • "last_digits": "stri"
        },
      • "expiry": "string",
      • "bin_details": {
        • "bin": "string",
        • "issuing_bank": "string",
        • "bin_country_code": "string",
        • "products": [
          • "string"
          ]
        },
      • "stored_credential": {
        • "payment_initiator": "CUSTOMER",
        • "payment_type": "ONE_TIME",
        • "usage": "FIRST",
        • "previous_network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          }
        },
      • "billing_address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "country_code": "string"
      },
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "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"
              }
            }
          ]
        }
      },
    • "stored_credential": {
      • "payment_initiator": "CUSTOMER",
      • "payment_type": "ONE_TIME",
      • "usage": "FIRST",
      • "previous_network_transaction_reference": {
        • "id": "stringstr",
        • "date": "stri",
        • "network": "VISA",
        • "acquirer_reference_number": "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",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "authentication_result": {
        • "liability_shift": "NO",
        • "three_d_secure": {
          • "authentication_status": "Y",
          • "enrollment_status": "Y"
          }
        }
      }
    },
  • "venmo": {
    • "email_address": "string",
    • "account_id": "string",
    • "user_name": "string",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "phone_number": {
      • "national_number": "string"
      },
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "return_flow": "AUTO",
    • "attributes": {
      • "vault": {
        • "id": "string",
        • "status": "VAULTED",
        • "customer": {
          • "id": "string",
          • "email_address": "string",
          • "phone": {
            • "phone_type": "FAX",
            • "phone_number": {
              • "national_number": "string"
              }
            },
          • "name": {
            • "prefix": "string",
            • "given_name": "string",
            • "surname": "string",
            • "middle_name": "string",
            • "suffix": "string",
            • "full_name": "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"
              }
            }
          ]
        }
      }
    },
  • "crypto": {
    • "country_code": "string",
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string"
      },
    • "experience_context": {}
    }
}
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.


 
"stringstrings"
paypal_wallet
A resource that identifies a PayPal Wallet is used for payment.


vault_id
string (vault_id)   [ 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.


 
email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
object (Name) 
The name of the party.


 
object (phone_with_type) 
The phone information.


 
birth_date
string (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
object (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.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
object (paypal_wallet_attributes) 
Additional attributes associated with the use of this PayPal Wallet.


 
object (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.


 
billing_agreement_id
string (billing_agreement_id)   [ 2 .. 128 ] characters ^[a-zA-Z0-9-]+$
The PayPal billing agreement ID. References an approved recurring payment for goods or services.


 
object (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.


 
{
  • "vault_id": "string",
  • "email_address": "string",
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "string"
    },
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "birth_date": "string",
  • "tax_info": {
    • "tax_id": "string",
    • "tax_id_type": "BR_CPF"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "merchant_customer_id": "string"
      },
    • "vault": {
      • "store_in_vault": "ON_SUCCESS",
      • "description": "string",
      • "usage_pattern": "IMMEDIATE",
      • "shipping": {
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "email_address": "string",
        • "phone_number": {
          • "country_code": "str",
          • "national_number": "string",
          • "extension_number": "string"
          },
        • "type": "SHIPPING",
        • "options": [
          • {
            • "id": "string",
            • "label": "string",
            • "type": "SHIPPING",
            • "amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "selected": true
            }
          ],
        • "address": {
          • "address_line_1": "string",
          • "address_line_2": "string",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          }
        },
      • "usage_type": "MERCHANT",
      • "customer_type": "CONSUMER",
      • "permit_multiple_payment_tokens": false
      }
    },
  • "experience_context": {
    • "brand_name": "string",
    • "locale": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "contact_preference": "NO_CONTACT_INFO",
    • "return_url": "http://example.com",
    • "cancel_url": "http://example.com",
    • "app_switch_context": {
      • "native_app": {
        • "os_type": "ANDROID",
        • "os_version": "string"
        },
      • "mobile_web": {
        • "return_flow": "AUTO",
        • "buyer_user_agent": "string"
        }
      },
    • "landing_page": "LOGIN",
    • "user_action": "CONTINUE",
    • "payment_method_preference": "UNRESTRICTED",
    • "order_update_callback_config": {}
    },
  • "billing_agreement_id": "string",
  • "stored_credential": {
    • "payment_initiator": "CUSTOMER",
    • "charge_pattern": "IMMEDIATE",
    • "usage_pattern": "IMMEDIATE",
    • "usage": "FIRST"
    }
}
paypal_wallet_attributes
Additional attributes associated with the use of this PayPal Wallet.


object (paypal_wallet_customer) 
The details about a customer in PayPal's system of record.


 
object (vault_paypal_wallet_base) 
Resource consolidating common request and response attributes for vaulting PayPal Wallet.


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "merchant_customer_id": "string"
    },
  • "vault": {
    • "store_in_vault": "ON_SUCCESS",
    • "description": "string",
    • "usage_pattern": "IMMEDIATE",
    • "shipping": {
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "email_address": "string",
      • "phone_number": {
        • "country_code": "str",
        • "national_number": "string",
        • "extension_number": "string"
        },
      • "type": "SHIPPING",
      • "options": [
        • {
          • "id": "string",
          • "label": "string",
          • "type": "SHIPPING",
          • "amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "selected": true
          }
        ],
      • "address": {
        • "address_line_1": "string",
        • "address_line_2": "string",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        }
      },
    • "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.


object (paypal_wallet_vault_response) 
The details about a saved PayPal Wallet payment source.


 
Array of objects (cobranded_card)   [ 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).


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "string"
        },
      • "merchant_customer_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"
          }
        }
      ]
    },
  • "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 (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
object (phone_with_type) 
The phone information.


 
object (Name) 
The name of the party.


 
merchant_customer_id
string  [ 1 .. 64 ] characters ^[0-9a-zA-Z-_.^*$@#]+$
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.


 
{
  • "id": "string",
  • "email_address": "string",
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "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.


 
locale
string (language)   [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[...
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.


 
shipping_preference
string
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum: "GET_FROM_FILE" "NO_SHIPPING" "SET_PROVIDED_ADDRESS"  
contact_preference
string
 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: "NO_CONTACT_INFO" "UPDATE_CONTACT_INFO" "RETAIN_CONTACT_INFO"  
return_url
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
cancel_url
string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
object (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.


 
landing_page
string
 Default:  "NO_PREFERENCE"
The type of landing page to show on the PayPal site for customer checkout.


 Enum: "LOGIN" "GUEST_CHECKOUT" "NO_PREFERENCE" "BILLING"  
user_action
string
 Default:  "CONTINUE"
Configures a Continue or Pay Now checkout flow.


 Enum: "CONTINUE" "PAY_NOW"  
payment_method_preference
string
 Default:  "UNRESTRICTED"
The merchant-preferred payment methods.


 Enum: "UNRESTRICTED" "IMMEDIATE_PAYMENT_REQUIRED"  
object (callback_configuration) 
CallBack Configuration that the merchant can provide to PayPal/Venmo.


 
{
  • "brand_name": "string",
  • "locale": "string",
  • "shipping_preference": "GET_FROM_FILE",
  • "contact_preference": "NO_CONTACT_INFO",
  • "return_url": "http://example.com",
  • "cancel_url": "http://example.com",
  • "app_switch_context": {
    • "native_app": {
      • "os_type": "ANDROID",
      • "os_version": "string"
      },
    • "mobile_web": {
      • "return_flow": "AUTO",
      • "buyer_user_agent": "string"
      }
    },
  • "landing_page": "LOGIN",
  • "user_action": "CONTINUE",
  • "payment_method_preference": "UNRESTRICTED",
  • "order_update_callback_config": {}
}
paypal_wallet_response
The PayPal Wallet response.


email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
account_id
string (account_id-2)   = 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.


 
account_status
string
The account status indicates whether the buyer has verified the financial details associated with their PayPal account.


 Enum: "VERIFIED" "UNVERIFIED"  
object (Name) 
The name of the party.


 
phone_type
string (Phone Type) 
The phone type.


 Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"  
object (Phone Number) 
The phone number in its canonical international E.164 numbering plan format.


 
birth_date
string (date_no_time)   = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
business_name
string  [ 0 .. 300 ] characters ^.*$
The business name of the PayPal account holder (populated for business accounts only)


 
object (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.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
object (paypal_wallet_attributes_response) 
Additional attributes associated with the use of a PayPal Wallet.


 
object (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.


 
experience_status
string
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: "NOT_STARTED" "IN_PROGRESS" "CANCELED" "APPROVED"  
{
  • "email_address": "string",
  • "account_id": "string",
  • "account_status": "VERIFIED",
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "string"
    },
  • "phone_type": "FAX",
  • "phone_number": {
    • "national_number": "string"
    },
  • "birth_date": "string",
  • "business_name": "string",
  • "tax_info": {
    • "tax_id": "string",
    • "tax_id_type": "BR_CPF"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "string"
          },
        • "merchant_customer_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"
            }
          }
        ]
      },
    • "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"
}
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 (payment_initiator) 
The person or party who initiated or triggered the payment.


 Enum: "CUSTOMER" "MERCHANT"  
charge_pattern
string (charge_pattern) 
 Deprecated 
Expected business/pricing model for the billing agreement.


 Enum: "IMMEDIATE" "DEFERRED" "RECURRING_PREPAID" "RECURRING_POSTPAID" "THRESHOLD_PREPAID" "THRESHOLD_POSTPAID" "SUBSCRIPTION_PREPAID" "SUBSCRIPTION_POSTPAID" "UNSCHEDULED_PREPAID" "UNSCHEDULED_POSTPAID" "INSTALLMENT_PREPAID" "INSTALLMENT_POSTPAID"  
usage_pattern
string (charge_pattern) 
Expected business/pricing model for the billing agreement.


 Enum: "IMMEDIATE" "DEFERRED" "RECURRING_PREPAID" "RECURRING_POSTPAID" "THRESHOLD_PREPAID" "THRESHOLD_POSTPAID" "SUBSCRIPTION_PREPAID" "SUBSCRIPTION_POSTPAID" "UNSCHEDULED_PREPAID" "UNSCHEDULED_POSTPAID" "INSTALLMENT_PREPAID" "INSTALLMENT_POSTPAID"  
usage
string (stored_payment_source_usage_type) 
 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: "FIRST" "SUBSEQUENT" "DERIVED"  
{
  • "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 ^[\S\s]*$
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status) 
The vault status.


 Enum: "VAULTED" "CREATED" "APPROVED"  
object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "merchant_customer_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"
        }
      }
    ]
}
Phone
The phone number, in its canonical international E.164 numbering plan format.


country_code
required
string (country_calling_code)   [ 1 .. 3 ] characters ^[0-9]{1,3}?$
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 ^[0-9]{1,14}?$
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).


 
extension_number
string  [ 1 .. 15 ] characters ^[0-9]{1,15}?$
The extension number.


 
{
  • "country_code": "str",
  • "national_number": "string",
  • "extension_number": "string"
}
Phone Number
The phone number in its canonical international E.164 numbering plan format.


national_number
required
string  [ 1 .. 14 ] characters ^[0-9]{1,14}?$
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).


 
{
  • "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 ^[0-9]{1,14}?$
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).


 
{
  • "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 (country_calling_code)   [ 1 .. 3 ] characters ^[0-9]{1,3}?$
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 ^[0-9]{1,14}?$
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).


 
{
  • "country_code": "str",
  • "national_number": "string"
}
Phone Type
The phone type.


string (Phone Type) 
The phone type.


 Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"  
"FAX"
phone_with_type
The phone information.


phone_type
string (Phone Type) 
The phone type.


 Enum: "FAX" "HOME" "MOBILE" "OTHER" "PAGER"  
required
object (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.


 
{
  • "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.


required
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (payee_base) 
The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


 
{
  • "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  [ 0 .. 300 ] characters ^[\S\s]*$
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  [ 0 .. 300 ] characters ^[\S\s]*$
The second line of the address, for example, a suite or apartment number.


 
address_line_3
string  [ 0 .. 100 ] characters ^[\S\s]*$
The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.


 
admin_area_4
string  [ 0 .. 100 ] characters ^[\S\s]*$
The neighborhood, ward, or district. This is smaller than admin_area_level_3 or sub_locality. Value is:
  • The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
  • The fine-grained administrative levels in China.


 
admin_area_3
string  [ 0 .. 100 ] characters ^[\S\s]*$
The sub-locality, suburb, neighborhood, or district. This is smaller than admin_area_level_2. Value is:
  • Brazil. Suburb, bairro, or neighborhood.
  • India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.


 
admin_area_2
string  [ 0 .. 120 ] characters ^[\S\s]*$
A city, town, or village. Smaller than admin_area_level_1.


 
admin_area_1
string  [ 0 .. 300 ] characters ^[\S\s]*$
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  [ 0 .. 60 ] characters ^[\S\s]*$
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 (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.


 
object (Address Details) 
The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.


 
{
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "address_line_3": "string",
  • "admin_area_4": "string",
  • "admin_area_3": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "country_code": "st",
  • "address_details": {
    • "street_number": "string",
    • "street_name": "string",
    • "street_type": "string",
    • "delivery_service": "string",
    • "building_name": "string",
    • "sub_building": "string"
    }
}
pricing_scheme
The pricing scheme details.


object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
pricing_model
required
string
The pricing model for the billing cycle.


 Enum: "FIXED" "VARIABLE" "AUTO_RELOAD"  
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
{
  • "price": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "pricing_model": "FIXED",
  • "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: "A" "B" "C" "D" "E" "F" "G" "I" "M" "N" "P" "R" "S" "U" "W" "X" "Y" "Z" "Null" "0" "1" "2" "3" "4"  
cvv_code
string
The card verification value code for for Visa, Discover, Mastercard, or American Express.


 Enum: "E" "I" "M" "N" "P" "S" "U" "X" "All others" "0" "1" "2" "3" "4"  
response_code
string
Processor response code for the non-PayPal payment processor errors.


 Enum: "0000" "00N7" "0100" "0390" "0500" "0580" "0800" "0880" "0890" "0960" "0R00" "1000" "10BR" "1300" "1310" "1312" "1317" "1320" "1330" "1335" "1340" "1350" "1352" "1360" "1370" "1380" "1382" "1384" "1390" "1393" "5100" "5110" "5120" "5130" "5135" "5140" "5150" "5160" "5170" "5180" "5190" "5200" "5210" "5400" "5500" "5650" "5700" "5710" "5800" "5900" "5910" "5920" "5930" "5950" "6300" "7600" "7700" "7710" "7800" "7900" "8000" "8010" "8020" "8030" "8100" "8110" "8220" "9100" "9500" "9510" "9520" "9530" "9540" "9600" "PCNR" "PCVV" "PP06" "PPRN" "PPAD" "PPAB" "PPAE" "PPAG" "PPAI" "PPAR" "PPAU" "PPAV" "PPAX" "PPBG" "PPC2" "PPCE" "PPCO" "PPCR" "PPCT" "PPCU" "PPD3" "PPDC" "PPDI" "PPDV" "PPDT" "PPEF" "PPEL" "PPER" "PPEX" "PPFE" "PPFI" "PPFR" "PPFV" "PPGR" "PPH1" "PPIF" "PPII" "PPIM" "PPIT" "PPLR" "PPLS" "PPMB" "PPMC" "PPMD" "PPNC" "PPNL" "PPNM" "PPNT" "PPPH" "PPPI" "PPPM" "PPQC" "PPRE" "PPRF" "PPRR" "PPS0" "PPS1" "PPS2" "PPS3" "PPS4" "PPS5" "PPS6" "PPSC" "PPSD" "PPSE" "PPTE" "PPTF" "PPTI" "PPTR" "PPTT" "PPTV" "PPUA" "PPUC" "PPUE" "PPUI" "PPUP" "PPUR" "PPVC" "PPVE" "PPVT"  
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: "01" "02" "03" "04" "21" "22" "24" "25" "26" "27" "28" "29" "30" "40" "43"  
{
  • "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 ^[\S\s]*$
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.


 
object (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.


 
object (payee) 
The merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


 
object (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.


 
description
string  [ 1 .. 127 ] characters ^[\S\s]*$
The purchase description.


 
custom_id
string  [ 1 .. 255 ] characters ^[\S\s]*$
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 ^[\S\s]*$
The API caller-provided external invoice ID for this order.


 
id
string  [ 1 .. 19 ] characters ^[\S\s]*$
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 ^[\S\s]*$
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.


 
Array of objects (item)   [ 0 .. 32767 ] items 
An array of items that the customer purchases from the merchant.


 
object (shipping_with_tracking_details) 
The order shipping details.


 
object (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.


 
object (Payment Collection) 
The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.


 
{
  • "reference_id": "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"
          }
        }
      ],
    • "disbursement_mode": "INSTANT",
    • "payee_pricing_tier_id": "string",
    • "payee_receivable_fx_rate_id": "string"
    },
  • "description": "string",
  • "custom_id": "string",
  • "invoice_id": "string",
  • "id": "string",
  • "soft_descriptor": "string",
  • "items": [
    • {
      • "name": "string",
      • "unit_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "quantity": "string",
      • "description": "string",
      • "sku": "string",
      • "url": "http://example.com",
      • "category": "DIGITAL_GOODS",
      • "image_url": "http://example.com",
      • "upc": {
        • "type": "UPC-A",
        • "code": "string"
        },
      • "billing_plan": {
        • "billing_cycles": [
          • {
            • "tenure_type": "REGULAR",
            • "pricing_scheme": {
              • "price": {
                • "currency_code": null,
                • "value": null
                },
              • "pricing_model": "FIXED",
              • "reload_threshold_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "total_cycles": 1,
            • "sequence": 1,
            • "start_date": "string"
            }
          ],
        • "setup_fee": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "name": "string"
        }
      }
    ],
  • "shipping": {
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string",
      • "extension_number": "string"
      },
    • "type": "SHIPPING",
    • "options": [
      • {
        • "id": "string",
        • "label": "string",
        • "type": "SHIPPING",
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "selected": true
        }
      ],
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      },
    • "trackers": [
      • {
        • "id": "string",
        • "status": "CANCELLED",
        • "items": [],
        • "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": {
        • "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",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "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
                ],
              • "setup_fee": {
                • "currency_code": null,
                • "value": null
                },
              • "name": "string"
              },
            • "unit_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "tax": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "commodity_code": "string",
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "total_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "unit_of_measure": "string"
            }
          ]
        }
      },
    • "risk": {
      • "customer": {
        • "ip_address": "string"
        }
      }
    },
  • "payments": {
    • "authorizations": [
      • {
        • "status": "CREATED",
        • "status_details": {
          • "reason": "PENDING_REVIEW"
          },
        • "id": "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"
              }
            }
          },
        • "invoice_id": "string",
        • "custom_id": "string",
        • "network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          },
        • "seller_protection": {
          • "status": "ELIGIBLE",
          • "dispute_categories": [
            • "ITEM_NOT_RECEIVED"
            ]
          },
        • "expiration_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": 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",
        • "processor_response": {
          • "avs_code": "A",
          • "cvv_code": "E",
          • "response_code": "0000",
          • "payment_advice_code": "01"
          }
        }
      ],
    • "captures": [
      • {
        • "status": "COMPLETED",
        • "status_details": {
          • "reason": "BUYER_COMPLAINT"
          },
        • "id": "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"
              }
            }
          },
        • "invoice_id": "string",
        • "custom_id": "string",
        • "network_transaction_reference": {
          • "id": "stringstr",
          • "date": "stri",
          • "network": "VISA",
          • "acquirer_reference_number": "string"
          },
        • "seller_protection": {
          • "status": "ELIGIBLE",
          • "dispute_categories": [
            • "ITEM_NOT_RECEIVED"
            ]
          },
        • "final_capture": false,
        • "seller_receivable_breakdown": {
          • "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": {
            • "source_currency": "string",
            • "target_currency": "string",
            • "value": "string"
            },
          • "platform_fees": [
            • {
              • "amount": {
                • "currency_code": null,
                • "value": null
                },
              • "payee": {
                • "email_address": null,
                • "merchant_id": null
                }
              }
            ]
          },
        • "disbursement_mode": "INSTANT",
        • "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"
              }
            }
          ],
        • "processor_response": {
          • "avs_code": "A",
          • "cvv_code": "E",
          • "response_code": "0000",
          • "payment_advice_code": "01"
          },
        • "create_time": "string",
        • "update_time": "string"
        }
      ],
    • "refunds": [
      • {
        • "status": "CANCELLED",
        • "status_details": {
          • "reason": "ECHECK"
          },
        • "id": "string",
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "invoice_id": "string",
        • "custom_id": "string",
        • "acquirer_reference_number": "string",
        • "note_to_payer": "string",
        • "seller_payable_breakdown": {
          • "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"
            },
          • "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": {
                • "source_currency": null,
                • "target_currency": null,
                • "value": null
                }
              }
            ],
          • "total_refunded_amount": {
            • "currency_code": "str",
            • "value": "string"
            }
          },
        • "payer": {
          • "email_address": "string",
          • "merchant_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"
              }
            }
          ],
        • "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 ^[\S\s]*$
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.


 
required
object (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.


 
object (payee) 
The merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


 
object (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.


 
description
string  [ 1 .. 3000 ] characters ^[\S\s]*$
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 ^[\S\s]*$
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 ^[\S\s]*$
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 ^[\S\s]*$
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.
 
Array of objects (item_request)   [ 0 .. 32767 ] items 
An array of items that the customer purchases from the merchant.


 
object (shipping_detail) 
The shipping details.


 
object (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.


 
{
  • "reference_id": "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"
          }
        }
      ],
    • "disbursement_mode": "INSTANT",
    • "payee_pricing_tier_id": "string",
    • "payee_receivable_fx_rate_id": "string"
    },
  • "description": "string",
  • "custom_id": "string",
  • "invoice_id": "string",
  • "soft_descriptor": "string",
  • "items": [
    • {
      • "name": "string",
      • "unit_amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "tax": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "quantity": "string",
      • "description": "string",
      • "sku": "string",
      • "url": "http://example.com",
      • "category": "DIGITAL_GOODS",
      • "image_url": "http://example.com",
      • "upc": {
        • "type": "UPC-A",
        • "code": "string"
        },
      • "billing_plan": {
        • "billing_cycles": [
          • {
            • "tenure_type": "REGULAR",
            • "pricing_scheme": {
              • "price": {
                • "currency_code": null,
                • "value": null
                },
              • "pricing_model": "FIXED",
              • "reload_threshold_amount": {
                • "currency_code": null,
                • "value": null
                }
              },
            • "total_cycles": 1,
            • "sequence": 1,
            • "start_date": "string"
            }
          ],
        • "setup_fee": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "name": "string"
        }
      }
    ],
  • "shipping": {
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string",
      • "extension_number": "string"
      },
    • "type": "SHIPPING",
    • "options": [
      • {
        • "id": "string",
        • "label": "string",
        • "type": "SHIPPING",
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "selected": true
        }
      ],
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      }
    },
  • "supplementary_data": {
    • "card": {
      • "level_2": {
        • "invoice_id": "string",
        • "tax_total": {
          • "currency_code": "str",
          • "value": "string"
          }
        },
      • "level_3": {
        • "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",
          • "address_line_3": "string",
          • "admin_area_4": "string",
          • "admin_area_3": "string",
          • "admin_area_2": "string",
          • "admin_area_1": "string",
          • "postal_code": "string",
          • "country_code": "st",
          • "address_details": {
            • "street_number": "string",
            • "street_name": "string",
            • "street_type": "string",
            • "delivery_service": "string",
            • "building_name": "string",
            • "sub_building": "string"
            }
          },
        • "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
                ],
              • "setup_fee": {
                • "currency_code": null,
                • "value": null
                },
              • "name": "string"
              },
            • "unit_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "tax": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "commodity_code": "string",
            • "discount_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "total_amount": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "unit_of_measure": "string"
            }
          ]
        }
      },
    • "risk": {
      • "customer": {
        • "ip_address": "string"
        }
      }
    }
}
refund
The refund information.


status
string (Refund Status With Details) 
The status of the refund.


 Enum: "CANCELLED" "FAILED" "PENDING" "COMPLETED"  
object (refund_status_details) 
The details of the refund status.


 
id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The PayPal-generated ID for the refund.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
invoice_id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
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 ^[A-Za-z0-9-_.,]*$
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 ^[a-zA-Z0-9]+$
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  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.


 
object (Seller Payable Breakdown) 
The breakdown of the refund.


 
object (payee_base) 
The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.


 
Array of objects (Link Description)   [ 0 .. 32767 ] items 
An array of related HATEOAS links.


 
create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
{
  • "status": "CANCELLED",
  • "status_details": {
    • "reason": "ECHECK"
    },
  • "id": "string",
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "invoice_id": "string",
  • "custom_id": "string",
  • "acquirer_reference_number": "string",
  • "note_to_payer": "string",
  • "seller_payable_breakdown": {
    • "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"
      },
    • "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": {
          • "source_currency": "string",
          • "target_currency": "string",
          • "value": "string"
          }
        }
      ],
    • "total_refunded_amount": {
      • "currency_code": "str",
      • "value": "string"
      }
    },
  • "payer": {
    • "email_address": "string",
    • "merchant_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"
        }
      }
    ],
  • "create_time": "string",
  • "update_time": "string"
}
refund_status
The refund status with details.


status
string (Refund Status With Details) 
The status of the refund.


 Enum: "CANCELLED" "FAILED" "PENDING" "COMPLETED"  
object (refund_status_details) 
The details of the refund status.


 
{
  • "status": "CANCELLED",
  • "status_details": {
    • "reason": "ECHECK"
    }
}
refund_status_details
The details of the refund status.


reason
string (Refund Incomplete Reason) 
The reason why the refund has the PENDING or FAILED status.


 Value: "ECHECK"  
{
  • "reason": "ECHECK"
}
risk_supplementary_data
Additional information necessary to evaluate the risk profile of a transaction.


object (participant_metadata) 
Profile information of the sender or receiver.


 
{
  • "customer": {
    • "ip_address": "string"
    }
}
Schema Object for standard headers
Standard headers are generally less restrictive in structure due to historical precedent across browsers, etc. This is a common schema for use in defining most standard headers.


string (Schema Object for standard headers)   [ 1 .. 16000 ] characters ^.*$
Standard headers are generally less restrictive in structure due to historical precedent across browsers, etc. This is a common schema for use in defining most standard headers.


 
"string"
Seller Receivable Breakdown
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.


required
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
object (exchange_rate) 
The exchange rate that determines the amount to convert from one currency to another currency.


 
Array of objects (platform_fee)   [ 0 .. 1 ] items 
An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.


 
{
  • "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": {
    • "source_currency": "string",
    • "target_currency": "string",
    • "value": "string"
    },
  • "platform_fees": [
    • {
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "payee": {
        • "email_address": "string",
        • "merchant_id": "string"
        }
      }
    ]
}
seller_protection
The level of protection offered as defined by PayPal Seller Protection for Merchants.


status
string (Seller Protection Status) 
Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.


 Enum: "ELIGIBLE" "PARTIALLY_ELIGIBLE" "NOT_ELIGIBLE"  
dispute_categories
Array of strings (dispute_category)   [ 0 .. 32767 ] items 
An array of conditions that are covered for the transaction.


Items Enum: "ITEM_NOT_RECEIVED" "UNAUTHORIZED_TRANSACTION"  
{
  • "status": "ELIGIBLE",
  • "dispute_categories": [
    • "ITEM_NOT_RECEIVED"
    ]
}
shipping_detail
The shipping details.


object (Name) 
The name of the party.


 
email_address
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (Phone) 
The phone number, in its canonical international E.164 numbering plan format.


 
type
string (Fulfillment Type) 
 Default:  "SHIPPING"
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: "SHIPPING" "PICKUP_IN_PERSON" "PICKUP_IN_STORE" "PICKUP_FROM_PERSON"  
Array of objects (shipping_option)   [ 0 .. 30 ] items 
An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
{
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "string"
    },
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string",
    • "extension_number": "string"
    },
  • "type": "SHIPPING",
  • "options": [
    • {
      • "id": "string",
      • "label": "string",
      • "type": "SHIPPING",
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "selected": true
      }
    ],
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    }
}
shipping_option
The options that the payee or merchant offers to the payer to ship or pick up their items.


id
required
string  [ 0 .. 127 ] characters ^[\S\s]*$
A unique ID that identifies a payer-selected shipping option.


 
label
required
string  [ 0 .. 127 ] characters ^[\S\s]*$
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 (shipping_type) 
 Default:  "SHIPPING"
A classification for the method of purchase fulfillment.


 Enum: "SHIPPING" "PICKUP" "PICKUP_IN_STORE" "PICKUP_FROM_PERSON"  
object (Money) 
The currency and amount for a financial transaction, such as a balance or payment due.


 
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.


 
{
  • "id": "string",
  • "label": "string",
  • "type": "SHIPPING",
  • "amount": {
    • "currency_code": "str",
    • "value": "string"
    },
  • "selected": true
}
shipping_type
A classification for the method of purchase fulfillment.


string (shipping_type) 
 Default:  "SHIPPING"
A classification for the method of purchase fulfillment.


 Enum: "SHIPPING" "PICKUP" "PICKUP_IN_STORE" "PICKUP_FROM_PERSON"  
"SHIPPING"
shipping_with_tracking_details
The order shipping details.


object (Name) 
The name of the party.


 
email_address
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (Phone) 
The phone number, in its canonical international E.164 numbering plan format.


 
type
string (Fulfillment Type) 
 Default:  "SHIPPING"
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: "SHIPPING" "PICKUP_IN_PERSON" "PICKUP_IN_STORE" "PICKUP_FROM_PERSON"  
Array of objects (shipping_option)   [ 0 .. 30 ] items 
An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
Array of objects (tracker)   [ 0 .. 32767 ] items 
An array of trackers for a transaction.


 
{
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "string"
    },
  • "email_address": "string",
  • "phone_number": {
    • "country_code": "str",
    • "national_number": "string",
    • "extension_number": "string"
    },
  • "type": "SHIPPING",
  • "options": [
    • {
      • "id": "string",
      • "label": "string",
      • "type": "SHIPPING",
      • "amount": {
        • "currency_code": "str",
        • "value": "string"
        },
      • "selected": true
      }
    ],
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "trackers": [
    • {
      • "id": "string",
      • "status": "CANCELLED",
      • "items": [],
      • "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 (single_use_token)   [ 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.


 
"string"
sofort
Information used to pay using Sofort.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters ^.*[a-zA-Z0-9]{4}.*$
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
sofort_request
Information needed to pay using Sofort.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "experience_context": {}
}
store_in_vault_instruction
Defines how and when the payment source gets vaulted.


string (store_in_vault_instruction) 
Defines how and when the payment source gets vaulted.


 Value: "ON_SUCCESS"  
"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 (payment_initiator) 
The person or party who initiated or triggered the payment.


 Enum: "CUSTOMER" "MERCHANT"  
payment_type
required
string (stored_payment_source_payment_type) 
Indicates the type of the stored payment_source payment.


 Enum: "ONE_TIME" "RECURRING" "UNSCHEDULED"  
usage
string (stored_payment_source_usage_type) 
 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: "FIRST" "SUBSEQUENT" "DERIVED"  
object (network_transaction_reference) 
Reference values used by the card network to identify a transaction.


 
{
  • "payment_initiator": "CUSTOMER",
  • "payment_type": "ONE_TIME",
  • "usage": "FIRST",
  • "previous_network_transaction_reference": {
    • "id": "stringstr",
    • "date": "stri",
    • "network": "VISA",
    • "acquirer_reference_number": "string"
    }
}
stored_payment_source_payment_type
Indicates the type of the stored payment_source payment.


string (stored_payment_source_payment_type) 
Indicates the type of the stored payment_source payment.


 Enum: "ONE_TIME" "RECURRING" "UNSCHEDULED"  
"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 (stored_payment_source_usage_type) 
 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: "FIRST" "SUBSEQUENT" "DERIVED"  
"FIRST"
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.


object (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.


 
object (risk_supplementary_data) 
Additional information necessary to evaluate the risk profile of a transaction.


 
{
  • "card": {
    • "level_2": {
      • "invoice_id": "string",
      • "tax_total": {
        • "currency_code": "str",
        • "value": "string"
        }
      },
    • "level_3": {
      • "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",
        • "address_line_3": "string",
        • "admin_area_4": "string",
        • "admin_area_3": "string",
        • "admin_area_2": "string",
        • "admin_area_1": "string",
        • "postal_code": "string",
        • "country_code": "st",
        • "address_details": {
          • "street_number": "string",
          • "street_name": "string",
          • "street_type": "string",
          • "delivery_service": "string",
          • "building_name": "string",
          • "sub_building": "string"
          }
        },
      • "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,
                • "pricing_scheme": null,
                • "total_cycles": null,
                • "sequence": null,
                • "start_date": null
                }
              ],
            • "setup_fee": {
              • "currency_code": "str",
              • "value": "string"
              },
            • "name": "string"
            },
          • "unit_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "tax": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "commodity_code": "string",
          • "discount_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "total_amount": {
            • "currency_code": "str",
            • "value": "string"
            },
          • "unit_of_measure": "string"
          }
        ]
      }
    },
  • "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 ^.*([a-zA-Z0-9]).*$
The customer's tax ID value.


 
tax_id_type
required
string
The customer's tax ID type.


 Enum: "BR_CPF" "BR_CNPJ"  
{
  • "tax_id": "string",
  • "tax_id_type": "BR_CPF"
}
three_d_secure_authentication_response
Results of 3D Secure Authentication.


authentication_status
string (pares_status) 
Transactions status result identifier. The outcome of the issuer's authentication.


 Enum: "Y" "N" "U" "A" "C" "R" "D" "I"  
enrollment_status
string (enrolled) 
Status of Authentication eligibility.


 Enum: "Y" "N" "U" "B"  
{
  • "authentication_status": "Y",
  • "enrollment_status": "Y"
}
token
The tokenized payment source to fund a payment.


id
required
string  [ 1 .. 255 ] characters ^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the token.


 
type
required
string
The tokenization method that generated the ID.


 Value: "BILLING_AGREEMENT"  
{
  • "id": "string",
  • "type": "BILLING_AGREEMENT"
}
tracker
The tracking response on creation of tracker.


id
string  [ 0 .. 2147483647 ] characters ^[\S\s]*$
The tracker id.


 
status
string (Tracker Status) 
The status of the item shipment.


 Enum: "CANCELLED" "SHIPPED"  
Array of objects (tracker_item)   [ 0 .. 32767 ] items 
An array of details of items in the shipment.


 
Array of objects (Link Description)   [ 0 .. 32767 ] items 
An array of request-related HATEOAS links.


 
create_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
update_time
string (date_time)   [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...
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.


 
{
  • "id": "string",
  • "status": "CANCELLED",
  • "items": [],
  • "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 ^[\S\s]*$
The tracking number for the shipment. This property supports Unicode.


 
carrier
required
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.


 Enum: "DPD_RU" "BG_BULGARIAN_POST" "KR_KOREA_POST" "ZA_COURIERIT" "FR_EXAPAQ" "ARE_EMIRATES_POST" "GAC" "GEIS" "SF_EX" "PAGO" "MYHERMES" "DIAMOND_EUROGISTICS" "CORPORATECOURIERS_WEBHOOK" "BOND" "OMNIPARCEL" "SK_POSTA" "PUROLATOR" "FETCHR_WEBHOOK" "THEDELIVERYGROUP" "CELLO_SQUARE" "TARRIVE" "COLLIVERY" "MAINFREIGHT" "IND_FIRSTFLIGHT" "ACSWORLDWIDE" "AMSTAN" "OKAYPARCEL" "ENVIALIA_REFERENCE" "SEUR_ES" "CONTINENTAL" "FDSEXPRESS" "AMAZON_FBA_SWISHIP" "WYNGS" "DHL_ACTIVE_TRACING" "ZYLLEM" "RUSTON" "XPOST" "CORREOS_ES" "DHL_FR" "PAN_ASIA" "BRT_IT" "SRE_KOREA" "SPEEDEE" "TNT_UK" "VENIPAK" "SHREENANDANCOURIER" "CROSHOT" "NIPOST_NG" "EPST_GLBL" "NEWGISTICS" "POST_SLOVENIA" "JERSEY_POST" "BOMBINOEXP" "WMG" "XQ_EXPRESS" "FURDECO" "LHT_EXPRESS" "SOUTH_AFRICAN_POST_OFFICE" "SPOTON" "DIMERCO" "CYPRUS_POST_CYP" "ABCUSTOM" "IND_DELIVREE" "CN_BESTEXPRESS" "DX_SFTP" "PICKUPP_MYS" "FMX" "HELLMANN" "SHIP_IT_ASIA" "KERRY_ECOMMERCE" "FRETERAPIDO" "PITNEY_BOWES" "XPRESSEN_DK" "SEUR_SP_API" "DELIVERYONTIME" "JINSUNG" "TRANS_KARGO" "SWISHIP_DE" "IVOY_WEBHOOK" "AIRMEE_WEBHOOK" "DHL_BENELUX" "FIRSTMILE" "FASTWAY_IR" "HH_EXP" "MYS_MYPOST_ONLINE" "TNT_NL" "TIPSA" "TAQBIN_MY" "KGMHUB" "INTEXPRESS" "OVERSE_EXP" "ONECLICK" "ROADRUNNER_FREIGHT" "GLS_CROTIA" "MRW_FTP" "BLUEX" "DYLT" "DPD_IR" "SIN_GLBL" "TUFFNELLS_REFERENCE" "CJPACKET" "MILKMAN" "ASIGNA" "ONEWORLDEXPRESS" "ROYAL_MAIL" "VIA_EXPRESS" "TIGFREIGHT" "ZTO_EXPRESS" "TWO_GO" "IML" "INTEL_VALLEY" "EFS" "UK_UK_MAIL" "RAM" "ALLIEDEXPRESS" "APC_OVERNIGHT" "SHIPPIT" "TFM" "M_XPRESS" "HDB_BOX" "CLEVY_LINKS" "IBEONE" "FIEGE_NL" "KWE_GLOBAL" "CTC_EXPRESS" "AMAZON" "MORE_LINK" "JX" "EASY_MAIL" "ADUIEPYLE" "GB_PANTHER" "EXPRESSSALE" "SG_DETRACK" "TRUNKRS_WEBHOOK" "MATDESPATCH" "DICOM" "MBW" "KHM_CAMBODIA_POST" "SINOTRANS" "BRT_IT_PARCELID" "DHL_SUPPLY_CHAIN" "DHL_PL" "TOPYOU" "PALEXPRESS" "DHL_SG" "CN_WEDO" "FULFILLME" "DPD_DELISTRACK" "UPS_REFERENCE" "CARIBOU" "LOCUS_WEBHOOK" "DSV" "P2P_TRC" "DIRECTPARCELS" "NOVA_POSHTA_INT" "FEDEX_POLAND" "CN_JCEX" "FAR_INTERNATIONAL" "IDEXPRESS" "GANGBAO" "NEWAY" "POSTNL_INT_3_S" "RPX_ID" "DESIGNERTRANSPORT_WEBHOOK" "GLS_SLOVEN" "PARCELLED_IN" "GSI_EXPRESS" "CON_WAY" "BROUWER_TRANSPORT" "CPEX" "ISRAEL_POST" "DTDC_IN" "PTT_POST" "XDE_WEBHOOK" "TOLOS" "GIAO_HANG" "GEODIS_ESPACE" "MAGYAR_HU" "DOORDASH_WEBHOOK" "TIKI_ID" "CJ_HK_INTERNATIONAL" "STAR_TRACK_EXPRESS" "HELTHJEM" "SFB2C" "FREIGHTQUOTE" "LANDMARK_GLOBAL_REFERENCE" "PARCEL2GO" "DELNEXT" "RCL" "CGS_EXPRESS" "HK_POST" "SAP_EXPRESS" "PARCELPOST_SG" "HERMES" "IND_SAFEEXPRESS" "TOPHATTEREXPRESS" "MGLOBAL" "AVERITT" "LEADER" "_2EBOX" "SG_SPEEDPOST" "DBSCHENKER_SE" "ISR_POST_DOMESTIC" "BESTWAYPARCEL" "ASENDIA_DE" "NIGHTLINE_UK" "TAQBIN_SG" "TCK_EXPRESS" "ENDEAVOUR_DELIVERY" "NANJINGWOYUAN" "HEPPNER_FR" "EMPS_CN" "FONSEN" "PICKRR" "APC_OVERNIGHT_CONNUM" "STAR_TRACK_NEXT_FLIGHT" "DAJIN" "UPS_FREIGHT" "POSTA_PLUS" "CEVA" "ANSERX" "JS_EXPRESS" "PADTF" "UPS_MAIL_INNOVATIONS" "SYPOST" "AMAZON_SHIP_MCF" "YUSEN" "BRING" "SDA_IT" "GBA" "NEWEGGEXPRESS" "SPEEDCOURIERS_GR" "FORRUN" "PICKUP" "ECMS" "INTELIPOST" "FLASHEXPRESS" "CN_STO" "SEKO_SFTP" "HOME_DELIVERY_SOLUTIONS" "DPD_HGRY" "KERRYTTC_VN" "JOYING_BOX" "TOTAL_EXPRESS" "ZJS_EXPRESS" "STARKEN" "DEMANDSHIP" "CN_DPEX" "AUPOST_CN" "LOGISTERS" "GOGLOBALPOST" "GLS_CZ" "PAACK_WEBHOOK" "GRAB_WEBHOOK" "PARCELPOINT" "ICUMULUS" "DAIGLOBALTRACK" "GLOBAL_IPARCEL" "YURTICI_KARGO" "CN_PAYPAL_PACKAGE" "PARCEL_2_POST" "GLS_IT" "PIL_LOGISTICS" "HEPPNER" "GENERAL_OVERNIGHT" "HAPPY2POINT" "CHITCHATS" "SMOOTH" "CLE_LOGISTICS" "FIEGE" "MX_CARGO" "ZIINGFINALMILE" "DAYTON_FREIGHT" "TCS" "AEX" "HERMES_DE" "ROUTIFIC_WEBHOOK" "GLOBAVEND" "CJ_LOGISTICS" "PALLET_NETWORK" "RAF_PH" "UK_XDP" "PAPER_EXPRESS" "LA_POSTE_SUIVI" "PAQUETEXPRESS" "LIEFERY" "STRECK_TRANSPORT" "PONY_EXPRESS" "ALWAYS_EXPRESS" "GBS_BROKER" "CITYLINK_MY" "ALLJOY" "YODEL" "YODEL_DIR" "STONE3PL" "PARCELPAL_WEBHOOK" "DHL_ECOMERCE_ASA" "SIMPLYPOST" "KY_EXPRESS" "SHENZHEN" "US_LASERSHIP" "UC_EXPRE" "DIDADI" "CJ_KR" "DBSCHENKER_B2B" "MXE" "CAE_DELIVERS" "PFCEXPRESS" "WHISTL" "WEPOST" "DHL_PARCEL_ES" "DDEXPRESS" "ARAMEX_AU" "BNEED" "HK_TGX" "LATVIJAS_PASTS" "VIAEUROPE" "CORREO_UY" "CHRONOPOST_FR" "J_NET" "_6LS" "BLR_BELPOST" "BIRDSYSTEM" "DOBROPOST" "WAHANA_ID" "WEASHIP" "SONICTL" "KWT" "AFLLOG_FTP" "SKYNET_WORLDWIDE" "NOVA_POSHTA" "SEINO" "SZENDEX" "BPOST_INT" "DBSCHENKER_SV" "AO_DEUTSCHLAND" "EU_FLEET_SOLUTIONS" "PCFCORP" "LINKBRIDGE" "PRIMAMULTICIPTA" "COUREX" "ZAJIL_EXPRESS" "COLLECTCO" "JTEXPRESS" "FEDEX_UK" "USHIP" "PIXSELL" "SHIPTOR" "CDEK" "VNM_VIETTELPOST" "CJ_CENTURY" "GSO" "VIWO" "SKYBOX" "KERRYTJ" "NTLOGISTICS_VN" "SDH_SCM" "ZINC" "DPE_SOUTH_AFRC" "CESKA_CZ" "ACS_GR" "DEALERSEND" "JOCOM" "CSE" "TFORCE_FINALMILE" "SHIP_GATE" "SHIPTER" "NATIONAL_SAMEDAY" "YUNEXPRESS" "CAINIAO" "DMS_MATRIX" "DIRECTLOG" "ASENDIA_US" "_3JMSLOGISTICS" "LICCARDI_EXPRESS" "SKY_POSTAL" "CNWANGTONG" "POSTNORD_LOGISTICS_DK" "LOGISTIKA" "CELERITAS" "PRESSIODE" "SHREE_MARUTI" "LOGISTICSWORLDWIDE_HK" "EFEX" "LOTTE" "LONESTAR" "APRISAEXPRESS" "BEL_RS" "OSM_WORLDWIDE" "WESTGATE_GL" "FASTRACK" "DTD_EXPR" "ALFATREX" "PROMEDDELIVERY" "THABIT_LOGISTICS" "HCT_LOGISTICS" "CARRY_FLAP" "US_OLD_DOMINION" "ANICAM_BOX" "WANBEXPRESS" "AN_POST" "DPD_LOCAL" "STALLIONEXPRESS" "RAIDEREX" "SHOPFANS" "KYUNGDONG_PARCEL" "CHAMPION_LOGISTICS" "PICKUPP_SGP" "MORNING_EXPRESS" "NACEX" "THENILE_WEBHOOK" "HOLISOL" "LBCEXPRESS_FTP" "KURASI" "USF_REDDAWAY" "APG" "CN_BOXC" "ECOSCOOTING" "MAINWAY" "PAPERFLY" "HOUNDEXPRESS" "BOX_BERRY" "EP_BOX" "PLUS_LOG_UK" "FULFILLA" "ASE" "MAIL_PLUS" "XPO_LOGISTICS" "WNDIRECT" "CLOUDWISH_ASIA" "ZELERIS" "GIO_EXPRESS" "OCS_WORLDWIDE" "ARK_LOGISTICS" "AQUILINE" "PILOT_FREIGHT" "QWINTRY" "DANSKE_FRAGT" "CARRIERS" "AIR_CANADA_GLOBAL" "PRESIDENT_TRANS" "STEPFORWARDFS" "SKYNET_UK" "PITTOHIO" "CORREOS_EXPRESS" "RL_US" "DESTINY" "UK_YODEL" "COMET_TECH" "DHL_PARCEL_RU" "TNT_REFR" "SHREE_ANJANI_COURIER" "MIKROPAKKET_BE" "ETS_EXPRESS" "COLIS_PRIVE" "CN_YUNDA" "AAA_COOPER" "ROCKET_PARCEL" "_360LION" "PANDU" "PROFESSIONAL_COURIERS" "FLYTEXPRESS" "LOGISTICSWORLDWIDE_MY" "CORREOS_DE_ESPANA" "IMX" "FOUR_PX_EXPRESS" "XPRESSBEES" "PICKUPP_VNM" "STARTRACK_EXPRESS" "FR_COLISSIMO" "NACEX_SPAIN_REFERENCE" "DHL_SUPPLY_CHAIN_AU" "ESHIPPING" "SHREETIRUPATI" "HX_EXPRESS" "INDOPAKET" "CN_17POST" "K1_EXPRESS" "CJ_GLS" "MYS_GDEX" "NATIONEX" "ANJUN" "FARGOOD" "SMG_EXPRESS" "RZYEXPRESS" "SEFL" "TNT_CLICK_IT" "HDB" "HIPSHIPPER" "RPXLOGISTICS" "KUEHNE" "IT_NEXIVE" "PTS" "SWISS_POST_FTP" "FASTRK_SERV" "_4_72" "US_YRC" "POSTNL_INTL_3S" "ELIAN_POST" "CUBYN" "SAU_SAUDI_POST" "ABXEXPRESS_MY" "HUAHAN_EXPRESS" "ZES_EXPRESS" "ZEPTO_EXPRESS" "SKYNET_ZA" "ZEEK_2_DOOR" "BLINKLASTMILE" "POSTA_UKR" "CHROBINSON" "CN_POST56" "COURANT_PLUS" "SCUDEX_EXPRESS" "SHIPENTEGRA" "B_TWO_C_EUROPE" "COPE" "IND_GATI" "CN_WISHPOST" "NACEX_ES" "TAQBIN_HK" "GLOBALTRANZ" "HKD" "BJSHOMEDELIVERY" "OMNIVA" "SUTTON" "PANTHER_REFERENCE" "SFCSERVICE" "LTL" "PARKNPARCEL" "SPRING_GDS" "ECEXPRESS" "INTERPARCEL_AU" "AGILITY" "XL_EXPRESS" "ADERONLINE" "DIRECTCOURIERS" "PLANZER" "SENDING" "NINJAVAN_WB" "NATIONWIDE_MY" "SENDIT" "GB_ARROW" "IND_GOJAVAS" "KPOST" "DHL_FREIGHT" "BLUECARE" "JINDOUYUN" "TRACKON" "GB_TUFFNELLS" "TRUMPCARD" "ETOTAL" "SFPLUS_WEBHOOK" "SEKOLOGISTICS" "HERMES_2MANN_HANDLING" "DPD_LOCAL_REF" "UDS" "ZA_SPECIALISED_FREIGHT" "THA_KERRY" "PRT_INT_SEUR" "BRA_CORREIOS" "NZ_NZ_POST" "CN_EQUICK" "MYS_EMS" "GB_NORSK" "ESP_MRW" "ESP_PACKLINK" "KANGAROO_MY" "RPX" "XDP_UK_REFERENCE" "NINJAVAN_MY" "ADICIONAL" "ROADBULL" "YAKIT" "MAILAMERICAS" "MIKROPAKKET" "DYNALOGIC" "DHL_ES" "DHL_PARCEL_NL" "DHL_GLOBAL_MAIL_ASIA" "DAWN_WING" "GENIKI_GR" "HERMESWORLD_UK" "ALPHAFAST" "BUYLOGIC" "EKART" "MEX_SENDA" "SFC_LOGISTICS" "POST_SERBIA" "IND_DELHIVERY" "DE_DPD_DELISTRACK" "RPD2MAN" "CN_SF_EXPRESS" "YANWEN" "MYS_SKYNET" "CORREOS_DE_MEXICO" "CBL_LOGISTICA" "MEX_ESTAFETA" "AU_AUSTRIAN_POST" "RINCOS" "NLD_DHL" "RUSSIAN_POST" "COURIERS_PLEASE" "POSTNORD_LOGISTICS" "FEDEX" "DPE_EXPRESS" "DPD" "ADSONE" "IDN_JNE" "THECOURIERGUY" "CNEXPS" "PRT_CHRONOPOST" "LANDMARK_GLOBAL" "IT_DHL_ECOMMERCE" "ESP_NACEX" "PRT_CTT" "BE_KIALA" "ASENDIA_UK" "GLOBAL_TNT" "POSTUR_IS" "EPARCEL_KR" "INPOST_PACZKOMATY" "IT_POSTE_ITALIA" "BE_BPOST" "PL_POCZTA_POLSKA" "MYS_MYS_POST" "SG_SG_POST" "THA_THAILAND_POST" "LEXSHIP" "FASTWAY_NZ" "DHL_AU" "COSTMETICSNOW" "PFLOGISTICS" "LOOMIS_EXPRESS" "GLS_ITALY" "LINE" "GEL_EXPRESS" "HUODULL" "NINJAVAN_SG" "JANIO" "AO_COURIER" "BRT_IT_SENDER_REF" "SAILPOST" "LALAMOVE" "NEWZEALAND_COURIERS" "ETOMARS" "VIRTRANSPORT" "WIZMO" "PALLETWAYS" "I_DIKA" "CFL_LOGISTICS" "GEMWORLDWIDE" "GLOBAL_EXPRESS" "LOGISTYX_TRANSGROUP" "WESTBANK_COURIER" "ARCO_SPEDIZIONI" "YDH_EXPRESS" "PARCELINKLOGISTICS" "CNDEXPRESS" "NOX_NIGHT_TIME_EXPRESS" "AERONET" "LTIANEXP" "INTEGRA2_FTP" "PARCELONE" "NOX_NACHTEXPRESS" "CN_CHINA_POST_EMS" "CHUKOU1" "GLS_SLOV" "ORANGE_DS" "JOOM_LOGIS" "AUS_STARTRACK" "DHL" "GB_APC" "BONDSCOURIERS" "JPN_JAPAN_POST" "USPS" "WINIT" "ARG_OCA" "TW_TAIWAN_POST" "DMM_NETWORK" "TNT" "BH_POSTA" "SWE_POSTNORD" "CA_CANADA_POST" "WISELOADS" "ASENDIA_HK" "NLD_GLS" "MEX_REDPACK" "JET_SHIP" "DE_DHL_EXPRESS" "NINJAVAN_THAI" "RABEN_GROUP" "ESP_ASM" "HRV_HRVATSKA" "GLOBAL_ESTES" "LTU_LIETUVOS" "BEL_DHL" "AU_AU_POST" "SPEEDEXCOURIER" "FR_COLIS" "ARAMEX" "DPEX" "MYS_AIRPAK" "CUCKOOEXPRESS" "DPD_POLAND" "NLD_POSTNL" "NIM_EXPRESS" "QUANTIUM" "SENDLE" "ESP_REDUR" "MATKAHUOLTO" "CPACKET" "POSTI" "HUNTER_EXPRESS" "CHOIR_EXP" "LEGION_EXPRESS" "AUSTRIAN_POST_EXPRESS" "GRUPO" "POSTA_RO" "INTERPARCEL_UK" "GLOBAL_ABF" "POSTEN_NORGE" "XPERT_DELIVERY" "DHL_REFR" "DHL_HK" "SKYNET_UAE" "GOJEK" "YODEL_INTNL" "JANCO" "YTO" "WISE_EXPRESS" "JTEXPRESS_VN" "FEDEX_INTL_MLSERV" "VAMOX" "AMS_GRP" "DHL_JP" "HRPARCEL" "GESWL" "BLUESTAR" "CDEK_TR" "DESCARTES" "DELTEC_UK" "DTDC_EXPRESS" "TOURLINE" "BH_WORLDWIDE" "OCS" "YINGNUO_LOGISTICS" "UPS" "TOLL" "PRT_SEUR" "DTDC_AU" "THA_DYNAMIC_LOGISTICS" "UBI_LOGISTICS" "FEDEX_CROSSBORDER" "A1POST" "TAZMANIAN_FREIGHT" "CJ_INT_MY" "SAIA_FREIGHT" "SG_QXPRESS" "NHANS_SOLUTIONS" "DPD_FR" "COORDINADORA" "ANDREANI" "DOORA" "INTERPARCEL_NZ" "PHL_JAMEXPRESS" "BEL_BELGIUM_POST" "US_APC" "IDN_POS" "FR_MONDIAL" "DE_DHL" "HK_RPX" "DHL_PIECEID" "VNPOST_EMS" "RRDONNELLEY" "DPD_DE" "DELCART_IN" "IMEXGLOBALSOLUTIONS" "ACOMMERCE" "EURODIS" "CANPAR" "GLS" "IND_ECOM" "ESP_ENVIALIA" "DHL_UK" "SMSA_EXPRESS" "TNT_FR" "DEX_I" "BUDBEE_WEBHOOK" "COPA_COURIER" "VNM_VIETNAM_POST" "DPD_HK" "TOLL_NZ" "ECHO" "FEDEX_FR" "BORDEREXPRESS" "MAILPLUS_JPN" "TNT_UK_REFR" "KEC" "DPD_RO" "TNT_JP" "TH_CJ" "EC_CN" "FASTWAY_UK" "FASTWAY_US" "GLS_DE" "GLS_ES" "GLS_FR" "MONDIAL_BE" "SGT_IT" "TNT_CN" "TNT_DE" "TNT_ES" "TNT_PL" "PARCELFORCE" "SWISS_POST" "TOLL_IPEC" "AIR_21" "AIRSPEED" "BERT" "BLUEDART" "COLLECTPLUS" "COURIERPLUS" "COURIER_POST" "DHL_GLOBAL_MAIL" "DPD_UK" "DELTEC_DE" "DEUTSCHE_DE" "DOTZOT" "ELTA_GR" "EMS_CN" "ECARGO" "ENSENDA" "FERCAM_IT" "FASTWAY_ZA" "FASTWAY_AU" "FIRST_LOGISITCS" "GEODIS" "GLOBEGISTICS" "GREYHOUND" "JETSHIP_MY" "LION_PARCEL" "AEROFLASH" "ONTRAC" "SAGAWA" "SIODEMKA" "STARTRACK" "TNT_AU" "TNT_IT" "TRANSMISSION" "YAMATO" "DHL_IT" "DHL_AT" "LOGISTICSWORLDWIDE_KR" "GLS_SPAIN" "AMAZON_UK_API" "DPD_FR_REFERENCE" "DHLPARCEL_UK" "MEGASAVE" "QUALITYPOST" "IDS_LOGISTICS" "JOYINGBOX" "PANTHER_ORDER_NUMBER" "WATKINS_SHEPARD" "FASTTRACK" "UP_EXPRESS" "ELOGISTICA" "ECOURIER" "CJ_PHILIPPINES" "SPEEDEX" "ORANGECONNEX" "TECOR" "SAEE" "GLS_ITALY_FTP" "DELIVERE" "YYCOM" "ADICIONAL_PT" "DKSH" "NIPPON_EXPRESS_FTP" "GOLS" "FUJEXP" "QTRACK" "OMLOGISTICS_API" "GDPHARM" "MISUMI_CN" "AIR_CANADA" "CITY56_WEBHOOK" "SAGAWA_API" "KEDAEX" "PGEON_API" "WEWORLDEXPRESS" "JT_LOGISTICS" "TRUSK" "VIAXPRESS" "DHL_SUPPLYCHAIN_ID" "ZUELLIGPHARMA_SFTP" "MEEST" "TOLL_PRIORITY" "MOTHERSHIP_API" "CAPITAL" "EUROPAKET_API" "HFD" "TOURLINE_REFERENCE" "GIO_ECOURIER" "CN_LOGISTICS" "PANDION" "BPOST_API" "PASSPORTSHIPPING" "PAKAJO" "DACHSER" "YUSEN_SFTP" "SHYPLITE" "XYY" "MWD" "FAXECARGO" "MAZET" "FIRST_LOGISTICS_API" "SPRINT_PACK" "HERMES_DE_FTP" "CONCISE" "KERRY_EXPRESS_TW_API" "EWE" "FASTDESPATCH" "ABCUSTOM_SFTP" "CHAZKI" "SHIPPIE" "GEODIS_API" "NAQEL_EXPRESS" "PAPA_WEBHOOK" "FORWARDAIR" "DIALOGO_LOGISTICA_API" "LALAMOVE_API" "TOMYDOOR" "KRONOS_WEBHOOK" "JTCARGO" "T_CAT" "CONCISE_WEBHOOK" "TELEPORT_WEBHOOK" "CUSTOMCO_API" "SPX_TH" "BOLLORE_LOGISTICS" "CLICKLINK_SFTP" "M3LOGISTICS" "VNPOST_API" "AXLEHIRE_FTP" "SHADOWFAX" "MYHERMES_UK_API" "DAIICHI" "MENSAJEROSURBANOS_API" "POLARSPEED" "IDEXPRESS_ID" "PAYO" "WHISTL_SFTP" "INTEX_DE" "TRANS2U" "PRODUCTCAREGROUP_SFTP" "BIGSMART" "EXPEDITORS_API_REF" "AITWORLDWIDE_API" "WORLDCOURIER" "QUIQUP" "AGEDISS_SFTP" "ANDREANI_API" "CRLEXPRESS" "SMARTCAT" "CROSSFLIGHT" "PROCARRIER" "DHL_REFERENCE_API" "SEINO_API" "WSPEXPRESS" "KRONOS" "TOTAL_EXPRESS_API" "PARCLL" "XPEDIGO" "STAR_TRACK_WEBHOOK" "GPOST" "UCS" "DMFGROUP" "COORDINADORA_API" "MARKEN" "NTL" "REDJEPAKKETJE" "ALLIED_EXPRESS_FTP" "MONDIALRELAY_ES" "NAEKO_FTP" "MHI" "SHIPPIFY" "MALCA_AMIT_API" "JTEXPRESS_SG_API" "DACHSER_WEB" "FLIGHTLG" "CAGO" "COM1EXPRESS" "TONAMI_FTP" "PACKFLEET" "PUROLATOR_INTERNATIONAL" "WINESHIPPING_WEBHOOK" "DHL_ES_SFTP" "PCHOME_API" "CESKAPOSTA_API" "GORUSH" "HOMERUNNER" "AMAZON_ORDER" "EFWNOW_API" "CBL_LOGISTICA_API" "NIMBUSPOST" "LOGWIN_LOGISTICS" "NOWLOG_API" "DPD_NL" "GODEPENDABLE" "ESDEX" "LOGISYSTEMS_SFTP" "EXPEDITORS" "SNTGLOBAL_API" "SHIPX" "QINTL_API" "PACKS" "POSTNL_INTERNATIONAL" "AMAZON_EMAIL_PUSH" "DHL_API" "SPX" "AXLEHIRE" "ICSCOURIER" "DIALOGO_LOGISTICA" "SHUNBANG_EXPRESS" "TCS_API" "SF_EXPRESS_CN" "PACKETA" "SIC_TELIWAY" "MONDIALRELAY_FR" "INTIME_FTP" "JD_EXPRESS" "FASTBOX" "PATHEON" "INDIA_POST" "TIPSA_REF" "ECOFREIGHT" "VOX" "DIRECTFREIGHT_AU_REF" "BESTTRANSPORT_SFTP" "AUSTRALIA_POST_API" "FRAGILEPAK_SFTP" "FLIPXP" "VALUE_WEBHOOK" "DAESHIN" "SHERPA" "MWD_API" "SMARTKARGO" "DNJ_EXPRESS" "GOPEOPLE" "MYSENDLE_API" "ARAMEX_API" "PIDGE" "THAIPARCELS" "PANTHER_REFERENCE_API" "POSTAPLUS" "BUFFALO" "U_ENVIOS" "ELITE_CO" "ROCHE_INTERNAL_SFTP" "DBSCHENKER_ICELAND" "TNT_FR_REFERENCE" "NEWGISTICSAPI" "GLOVO" "GWLOGIS_API" "SPREETAIL_API" "MOOVA" "PLYCONGROUP" "USPS_WEBHOOK" "REIMAGINEDELIVERY" "EDF_FTP" "DAO365" "BIOCAIR_FTP" "RANSA_WEBHOOK" "SHIPXPRES" "COURANT_PLUS_API" "SHIPA" "HOMELOGISTICS" "DX" "POSTE_ITALIANE_PACCOCELERE" "TOLL_WEBHOOK" "LCTBR_API" "DX_FREIGHT" "DHL_SFTP" "SHIPROCKET" "UBER_WEBHOOK" "STATOVERNIGHT" "BURD" "FASTSHIP" "IBVENTURE_WEBHOOK" "GATI_KWE_API" "CRYOPDP_FTP" "HUBBED" "TIPSA_API" "ARASKARGO" "THIJS_NL" "ATSHEALTHCARE_REFERENCE" "99MINUTOS" "HELLENIC_POST" "HSM_GLOBAL" "MNX" "NMTRANSFER" "LOGYSTO" "INDIA_POST_INT" "AMAZON_FBA_SWISHIP_IN" "SRT_TRANSPORT" "BOMI" "DELIVERR_SFTP" "HSDEXPRESS" "SIMPLETIRE_WEBHOOK" "HUNTER_EXPRESS_SFTP" "UPS_API" "WOOYOUNG_LOGISTICS_SFTP" "PHSE_API" "WISH_EMAIL_PUSH" "NORTHLINE" "MEDAFRICA" "DPD_AT_SFTP" "ANTERAJA" "DHL_GLOBAL_FORWARDING_API" "LBCEXPRESS_API" "SIMSGLOBAL" "CDLDELIVERS" "TYP" "TESTING_COURIER_WEBHOOK" "PANDAGO_API" "ROYAL_MAIL_FTP" "THUNDEREXPRESS" "SECRETLAB_WEBHOOK" "SETEL" "JD_WORLDWIDE" "DPD_RU_API" "ARGENTS_WEBHOOK" "POSTONE" "TUSKLOGISTICS" "RHENUS_UK_API" "TAQBIN_SG_API" "INNTRALOG_SFTP" "DAYROSS" "CORREOSEXPRESS_API" "INTERNATIONAL_SEUR_API" "YODEL_API" "HEROEXPRESS" "DHL_SUPPLYCHAIN_IN" "URGENT_CARGUS" "FRONTDOORCORP" "JTEXPRESS_PH" "PARCELSTARS_WEBHOOK" "DPD_SK_SFTP" "MOVIANTO" "OZEPARTS_SHIPPING" "KARGOMKOLAY" "TRUNKRS" "OMNIRPS_WEBHOOK" "CHILEXPRESS" "TESTING_COURIER" "JNE_API" "BJSHOMEDELIVERY_FTP" "DEXPRESS_WEBHOOK" "USPS_API" "TRANSVIRTUAL" "SOLISTICA_API" "CHIENVENTURE_WEBHOOK" "DPD_UK_SFTP" "INPOST_UK" "JAVIT" "ZTO_DOMESTIC" "DHL_GT_API" "CEVA_TRACKING" "KOMON_EXPRESS" "EASTWESTCOURIER_FTP" "DANNIAO" "SPECTRAN" "DELIVER_IT" "RELAISCOLIS" "GLS_SPAIN_API" "POSTPLUS" "AIRTERRA" "GIO_ECOURIER_API" "DPD_CH_SFTP" "FEDEX_API" "INTERSMARTTRANS" "HERMES_UK_SFTP" "EXELOT_FTP" "DHL_PA_API" "VIRTRANSPORT_SFTP" "WORLDNET" "INSTABOX_WEBHOOK" "KNG" "FLASHEXPRESS_WEBHOOK" "MAGYAR_POSTA_API" "WESHIP_API" "OHI_WEBHOOK" "MUDITA" "BLUEDART_API" "T_CAT_API" "ADS" "HERMES_IT" "FITZMARK_API" "POSTI_API" "SMSA_EXPRESS_WEBHOOK" "TAMERGROUP_WEBHOOK" "LIVRAPIDE" "NIPPON_EXPRESS" "BETTERTRUCKS" "FAN" "PB_USPSFLATS_FTP" "PARCELRIGHT" "ITHINKLOGISTICS" "KERRY_EXPRESS_TH_WEBHOOK" "ECOUTIER" "SHOWL" "BRT_IT_API" "RIXONHK_API" "DBSCHENKER_API" "ILYANGLOGIS" "MAIL_BOX_ETC" "WESHIP" "DHL_GLOBAL_MAIL_API" "ACTIVOS24_API" "ATSHEALTHCARE" "LUWJISTIK" "GW_WORLD" "FAIRSENDEN_API" "SERVIP_WEBHOOK" "SWISHIP" "TANET" "HOTSIN_CARGO" "DIREX" "HUANTONG" "IMILE_API" "AUEXPRESS" "NYTLOGISTICS" "DSV_REFERENCE" "NOVOFARMA_WEBHOOK" "AITWORLDWIDE_SFTP" "SHOPOLIVE" "FNF_ZA" "DHL_ECOMMERCE_GC" "FETCHR" "STARLINKS_API" "YYEXPRESS" "SERVIENTREGA" "HANJIN" "SPANISH_SEUR_FTP" "DX_B2B_CONNUM" "HELTHJEM_API" "INEXPOST" "A2B_BA" "RHENUS_GROUP" "SBERLOGISTICS_RU" "MALCA_AMIT" "PPL" "OSM_WORLDWIDE_SFTP" "ACILOGISTIX" "OPTIMACOURIER" "NOVA_POSHTA_API" "LOGGI" "YIFAN" "MYDYNALOGIC" "MORNINGLOBAL" "CONCISE_API" "FXTRAN" "DELIVERYOURPARCEL_ZA" "UPARCEL" "MOBI_BR" "LOGINEXT_WEBHOOK" "EMS" "SPEEDY" "ZOOM_RED" "NAVLUNGO" "CASTLEPARCELS" "WEEE" "PACKALY" "YUNHUIPOST" "YOUPARCEL" "LEMAN" "MOOVIN" "URB_IT" "MULTIENTREGAPANAMA" "JUSDASR" "DISCOUNTPOST" "RHENUS_UK" "SWISHIP_JP" "GLS_US" "SMTL" "EMEGA" "EXPRESSONE_SV" "HEPSIJET" "WELIVERY" "BRINGER" "EASYROUTES" "MRW" "RPM" "DPD_PRT" "GLS_ROMANIA" "LMPARCEL" "GTAGSM" "DOMINO" "ESHIPPER" "TRANSPAK" "XINDUS" "AOYUE" "EASYPARCEL" "EXPRESSONE" "SENDEO_KARGO" "SPEEDAF" "ETOWER" "GCX" "NINJAVAN_VN" "ALLEGRO" "JUMPPOINT" "SHIPGLOBAL_US" "KINISI" "OAKH" "AWEST" "BARSAN" "ENERGOLOGISTIC" "MADROOEX" "GOBOLT" "SWISS_UNIVERSAL_EXPRESS" "IORDIRECT" "XMSZM" "GLS_HUN" "SENDY" "BRAUNSEXPRESS" "GRANDSLAMEXPRESS" "XGS" "OTSCHILE" "PACK_UP" "PARCELSTARS" "TEAMEXPRESSLLC" "ASYADEXPRESS" "TDN" "EARLYBIRD" "CACESA" "PARCELJET" "MNG_KARGO" "SUPERPACKLINE" "SPEEDX" "VESYL" "SKYKING" "DIRMENSAJERIA" "NETLOGIXGROUP" "ZYOU" "JAWAR" "AGSYSTEMS" "GPS" "PTT_KARGO" "MAERGO" "ARIHANTCOURIER" "VTFE" "YUNANT" "URBIFY" "PACK_MAN" "LIEFERGRUN" "OBIBOX" "PAIKEDA" "SCOTTY" "INTELCOM_CA" "SWE" "ASENDIA" "DPD_AT" "RELAY" "ATA" "SKYEXPRESS_INTERNATIONAL" "SURAT_KARGO" "SGLINK" "FLEETOPTICSINC" "SHOPLINE" "PIGGYSHIP" "LOGOIX" "KOLAY_GELSIN" "ASSOCIATED_COURIERS" "UPS_CHECKER" "WINESHIPPING" "SPEDISCI" "FOURKITES" "ETONAS" "FINMILE" "UNIUNI" "RODONAVES" "INPOST_IT" "TFORCE_FREIGHT" "RICHMOM" "FRANCO" "ECPARCEL" "FEDEX_CHINA" "GOFO_EXPRESS" "SHIPBOB" "JERSEYPOST_ATLAS" "CORETRAILS" "RHENUS_ITALY" "JADLOG" "JITSU" "YANWEN_EXPRESS" "DASHLINK" "SEINO_SUPER_EXPRESS" "FLOSHIP" "METROSCG" "SENDPARCEL" "P2P" "CN_EXPRESS" "CIRROTRACK" "LAND_LOGISTICS" "VEHO" "MEDLINE" "VDTRACK" "SINO_SCM" "3PE_EXPRESS" "SWIFTX" "SFYDEXPRESS" "TOPTRANS" "OTHER"  
carrier_name_other
string  [ 1 .. 64 ] characters ^[\S\s]*$
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.


 
{
  • "tracking_number": "string",
  • "carrier": "DPD_RU",
  • "carrier_name_other": "string"
}
Tracker Status
The status of the item shipment.


string (Tracker Status) 
The status of the item shipment.


 Enum: "CANCELLED" "SHIPPED"  
"CANCELLED"
tracker_item
The details of the items in the shipment.


name
string  [ 1 .. 127 ] characters ^[\S\s]*$
The item name or title.


 
quantity
string  [ 1 .. 10 ] characters ^[1-9][0-9]{0,9}$
The item quantity. Must be a whole number.


 
sku
string  [ 1 .. 127 ] characters ^[\S\s]*$
The stock keeping unit (SKU) for the item. This can contain unicode characters.


 
url
string <uri>   [ 1 .. 2048 ] characters 
The URL to the item being purchased. Visible to buyer and used in buyer experiences.


 
image_url
string <uri>   [ 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.


 
object (universal_product_code) 
The Universal Product Code of the item.


 
{}
tracker_request
The tracking details of an order.


tracking_number
required
string  [ 1 .. 64 ] characters ^[\S\s]*$
The tracking number for the shipment. This property supports Unicode.


 
carrier
required
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.


 Enum: "DPD_RU" "BG_BULGARIAN_POST" "KR_KOREA_POST" "ZA_COURIERIT" "FR_EXAPAQ" "ARE_EMIRATES_POST" "GAC" "GEIS" "SF_EX" "PAGO" "MYHERMES" "DIAMOND_EUROGISTICS" "CORPORATECOURIERS_WEBHOOK" "BOND" "OMNIPARCEL" "SK_POSTA" "PUROLATOR" "FETCHR_WEBHOOK" "THEDELIVERYGROUP" "CELLO_SQUARE" "TARRIVE" "COLLIVERY" "MAINFREIGHT" "IND_FIRSTFLIGHT" "ACSWORLDWIDE" "AMSTAN" "OKAYPARCEL" "ENVIALIA_REFERENCE" "SEUR_ES" "CONTINENTAL" "FDSEXPRESS" "AMAZON_FBA_SWISHIP" "WYNGS" "DHL_ACTIVE_TRACING" "ZYLLEM" "RUSTON" "XPOST" "CORREOS_ES" "DHL_FR" "PAN_ASIA" "BRT_IT" "SRE_KOREA" "SPEEDEE" "TNT_UK" "VENIPAK" "SHREENANDANCOURIER" "CROSHOT" "NIPOST_NG" "EPST_GLBL" "NEWGISTICS" "POST_SLOVENIA" "JERSEY_POST" "BOMBINOEXP" "WMG" "XQ_EXPRESS" "FURDECO" "LHT_EXPRESS" "SOUTH_AFRICAN_POST_OFFICE" "SPOTON" "DIMERCO" "CYPRUS_POST_CYP" "ABCUSTOM" "IND_DELIVREE" "CN_BESTEXPRESS" "DX_SFTP" "PICKUPP_MYS" "FMX" "HELLMANN" "SHIP_IT_ASIA" "KERRY_ECOMMERCE" "FRETERAPIDO" "PITNEY_BOWES" "XPRESSEN_DK" "SEUR_SP_API" "DELIVERYONTIME" "JINSUNG" "TRANS_KARGO" "SWISHIP_DE" "IVOY_WEBHOOK" "AIRMEE_WEBHOOK" "DHL_BENELUX" "FIRSTMILE" "FASTWAY_IR" "HH_EXP" "MYS_MYPOST_ONLINE" "TNT_NL" "TIPSA" "TAQBIN_MY" "KGMHUB" "INTEXPRESS" "OVERSE_EXP" "ONECLICK" "ROADRUNNER_FREIGHT" "GLS_CROTIA" "MRW_FTP" "BLUEX" "DYLT" "DPD_IR" "SIN_GLBL" "TUFFNELLS_REFERENCE" "CJPACKET" "MILKMAN" "ASIGNA" "ONEWORLDEXPRESS" "ROYAL_MAIL" "VIA_EXPRESS" "TIGFREIGHT" "ZTO_EXPRESS" "TWO_GO" "IML" "INTEL_VALLEY" "EFS" "UK_UK_MAIL" "RAM" "ALLIEDEXPRESS" "APC_OVERNIGHT" "SHIPPIT" "TFM" "M_XPRESS" "HDB_BOX" "CLEVY_LINKS" "IBEONE" "FIEGE_NL" "KWE_GLOBAL" "CTC_EXPRESS" "AMAZON" "MORE_LINK" "JX" "EASY_MAIL" "ADUIEPYLE" "GB_PANTHER" "EXPRESSSALE" "SG_DETRACK" "TRUNKRS_WEBHOOK" "MATDESPATCH" "DICOM" "MBW" "KHM_CAMBODIA_POST" "SINOTRANS" "BRT_IT_PARCELID" "DHL_SUPPLY_CHAIN" "DHL_PL" "TOPYOU" "PALEXPRESS" "DHL_SG" "CN_WEDO" "FULFILLME" "DPD_DELISTRACK" "UPS_REFERENCE" "CARIBOU" "LOCUS_WEBHOOK" "DSV" "P2P_TRC" "DIRECTPARCELS" "NOVA_POSHTA_INT" "FEDEX_POLAND" "CN_JCEX" "FAR_INTERNATIONAL" "IDEXPRESS" "GANGBAO" "NEWAY" "POSTNL_INT_3_S" "RPX_ID" "DESIGNERTRANSPORT_WEBHOOK" "GLS_SLOVEN" "PARCELLED_IN" "GSI_EXPRESS" "CON_WAY" "BROUWER_TRANSPORT" "CPEX" "ISRAEL_POST" "DTDC_IN" "PTT_POST" "XDE_WEBHOOK" "TOLOS" "GIAO_HANG" "GEODIS_ESPACE" "MAGYAR_HU" "DOORDASH_WEBHOOK" "TIKI_ID" "CJ_HK_INTERNATIONAL" "STAR_TRACK_EXPRESS" "HELTHJEM" "SFB2C" "FREIGHTQUOTE" "LANDMARK_GLOBAL_REFERENCE" "PARCEL2GO" "DELNEXT" "RCL" "CGS_EXPRESS" "HK_POST" "SAP_EXPRESS" "PARCELPOST_SG" "HERMES" "IND_SAFEEXPRESS" "TOPHATTEREXPRESS" "MGLOBAL" "AVERITT" "LEADER" "_2EBOX" "SG_SPEEDPOST" "DBSCHENKER_SE" "ISR_POST_DOMESTIC" "BESTWAYPARCEL" "ASENDIA_DE" "NIGHTLINE_UK" "TAQBIN_SG" "TCK_EXPRESS" "ENDEAVOUR_DELIVERY" "NANJINGWOYUAN" "HEPPNER_FR" "EMPS_CN" "FONSEN" "PICKRR" "APC_OVERNIGHT_CONNUM" "STAR_TRACK_NEXT_FLIGHT" "DAJIN" "UPS_FREIGHT" "POSTA_PLUS" "CEVA" "ANSERX" "JS_EXPRESS" "PADTF" "UPS_MAIL_INNOVATIONS" "SYPOST" "AMAZON_SHIP_MCF" "YUSEN" "BRING" "SDA_IT" "GBA" "NEWEGGEXPRESS" "SPEEDCOURIERS_GR" "FORRUN" "PICKUP" "ECMS" "INTELIPOST" "FLASHEXPRESS" "CN_STO" "SEKO_SFTP" "HOME_DELIVERY_SOLUTIONS" "DPD_HGRY" "KERRYTTC_VN" "JOYING_BOX" "TOTAL_EXPRESS" "ZJS_EXPRESS" "STARKEN" "DEMANDSHIP" "CN_DPEX" "AUPOST_CN" "LOGISTERS" "GOGLOBALPOST" "GLS_CZ" "PAACK_WEBHOOK" "GRAB_WEBHOOK" "PARCELPOINT" "ICUMULUS" "DAIGLOBALTRACK" "GLOBAL_IPARCEL" "YURTICI_KARGO" "CN_PAYPAL_PACKAGE" "PARCEL_2_POST" "GLS_IT" "PIL_LOGISTICS" "HEPPNER" "GENERAL_OVERNIGHT" "HAPPY2POINT" "CHITCHATS" "SMOOTH" "CLE_LOGISTICS" "FIEGE" "MX_CARGO" "ZIINGFINALMILE" "DAYTON_FREIGHT" "TCS" "AEX" "HERMES_DE" "ROUTIFIC_WEBHOOK" "GLOBAVEND" "CJ_LOGISTICS" "PALLET_NETWORK" "RAF_PH" "UK_XDP" "PAPER_EXPRESS" "LA_POSTE_SUIVI" "PAQUETEXPRESS" "LIEFERY" "STRECK_TRANSPORT" "PONY_EXPRESS" "ALWAYS_EXPRESS" "GBS_BROKER" "CITYLINK_MY" "ALLJOY" "YODEL" "YODEL_DIR" "STONE3PL" "PARCELPAL_WEBHOOK" "DHL_ECOMERCE_ASA" "SIMPLYPOST" "KY_EXPRESS" "SHENZHEN" "US_LASERSHIP" "UC_EXPRE" "DIDADI" "CJ_KR" "DBSCHENKER_B2B" "MXE" "CAE_DELIVERS" "PFCEXPRESS" "WHISTL" "WEPOST" "DHL_PARCEL_ES" "DDEXPRESS" "ARAMEX_AU" "BNEED" "HK_TGX" "LATVIJAS_PASTS" "VIAEUROPE" "CORREO_UY" "CHRONOPOST_FR" "J_NET" "_6LS" "BLR_BELPOST" "BIRDSYSTEM" "DOBROPOST" "WAHANA_ID" "WEASHIP" "SONICTL" "KWT" "AFLLOG_FTP" "SKYNET_WORLDWIDE" "NOVA_POSHTA" "SEINO" "SZENDEX" "BPOST_INT" "DBSCHENKER_SV" "AO_DEUTSCHLAND" "EU_FLEET_SOLUTIONS" "PCFCORP" "LINKBRIDGE" "PRIMAMULTICIPTA" "COUREX" "ZAJIL_EXPRESS" "COLLECTCO" "JTEXPRESS" "FEDEX_UK" "USHIP" "PIXSELL" "SHIPTOR" "CDEK" "VNM_VIETTELPOST" "CJ_CENTURY" "GSO" "VIWO" "SKYBOX" "KERRYTJ" "NTLOGISTICS_VN" "SDH_SCM" "ZINC" "DPE_SOUTH_AFRC" "CESKA_CZ" "ACS_GR" "DEALERSEND" "JOCOM" "CSE" "TFORCE_FINALMILE" "SHIP_GATE" "SHIPTER" "NATIONAL_SAMEDAY" "YUNEXPRESS" "CAINIAO" "DMS_MATRIX" "DIRECTLOG" "ASENDIA_US" "_3JMSLOGISTICS" "LICCARDI_EXPRESS" "SKY_POSTAL" "CNWANGTONG" "POSTNORD_LOGISTICS_DK" "LOGISTIKA" "CELERITAS" "PRESSIODE" "SHREE_MARUTI" "LOGISTICSWORLDWIDE_HK" "EFEX" "LOTTE" "LONESTAR" "APRISAEXPRESS" "BEL_RS" "OSM_WORLDWIDE" "WESTGATE_GL" "FASTRACK" "DTD_EXPR" "ALFATREX" "PROMEDDELIVERY" "THABIT_LOGISTICS" "HCT_LOGISTICS" "CARRY_FLAP" "US_OLD_DOMINION" "ANICAM_BOX" "WANBEXPRESS" "AN_POST" "DPD_LOCAL" "STALLIONEXPRESS" "RAIDEREX" "SHOPFANS" "KYUNGDONG_PARCEL" "CHAMPION_LOGISTICS" "PICKUPP_SGP" "MORNING_EXPRESS" "NACEX" "THENILE_WEBHOOK" "HOLISOL" "LBCEXPRESS_FTP" "KURASI" "USF_REDDAWAY" "APG" "CN_BOXC" "ECOSCOOTING" "MAINWAY" "PAPERFLY" "HOUNDEXPRESS" "BOX_BERRY" "EP_BOX" "PLUS_LOG_UK" "FULFILLA" "ASE" "MAIL_PLUS" "XPO_LOGISTICS" "WNDIRECT" "CLOUDWISH_ASIA" "ZELERIS" "GIO_EXPRESS" "OCS_WORLDWIDE" "ARK_LOGISTICS" "AQUILINE" "PILOT_FREIGHT" "QWINTRY" "DANSKE_FRAGT" "CARRIERS" "AIR_CANADA_GLOBAL" "PRESIDENT_TRANS" "STEPFORWARDFS" "SKYNET_UK" "PITTOHIO" "CORREOS_EXPRESS" "RL_US" "DESTINY" "UK_YODEL" "COMET_TECH" "DHL_PARCEL_RU" "TNT_REFR" "SHREE_ANJANI_COURIER" "MIKROPAKKET_BE" "ETS_EXPRESS" "COLIS_PRIVE" "CN_YUNDA" "AAA_COOPER" "ROCKET_PARCEL" "_360LION" "PANDU" "PROFESSIONAL_COURIERS" "FLYTEXPRESS" "LOGISTICSWORLDWIDE_MY" "CORREOS_DE_ESPANA" "IMX" "FOUR_PX_EXPRESS" "XPRESSBEES" "PICKUPP_VNM" "STARTRACK_EXPRESS" "FR_COLISSIMO" "NACEX_SPAIN_REFERENCE" "DHL_SUPPLY_CHAIN_AU" "ESHIPPING" "SHREETIRUPATI" "HX_EXPRESS" "INDOPAKET" "CN_17POST" "K1_EXPRESS" "CJ_GLS" "MYS_GDEX" "NATIONEX" "ANJUN" "FARGOOD" "SMG_EXPRESS" "RZYEXPRESS" "SEFL" "TNT_CLICK_IT" "HDB" "HIPSHIPPER" "RPXLOGISTICS" "KUEHNE" "IT_NEXIVE" "PTS" "SWISS_POST_FTP" "FASTRK_SERV" "_4_72" "US_YRC" "POSTNL_INTL_3S" "ELIAN_POST" "CUBYN" "SAU_SAUDI_POST" "ABXEXPRESS_MY" "HUAHAN_EXPRESS" "ZES_EXPRESS" "ZEPTO_EXPRESS" "SKYNET_ZA" "ZEEK_2_DOOR" "BLINKLASTMILE" "POSTA_UKR" "CHROBINSON" "CN_POST56" "COURANT_PLUS" "SCUDEX_EXPRESS" "SHIPENTEGRA" "B_TWO_C_EUROPE" "COPE" "IND_GATI" "CN_WISHPOST" "NACEX_ES" "TAQBIN_HK" "GLOBALTRANZ" "HKD" "BJSHOMEDELIVERY" "OMNIVA" "SUTTON" "PANTHER_REFERENCE" "SFCSERVICE" "LTL" "PARKNPARCEL" "SPRING_GDS" "ECEXPRESS" "INTERPARCEL_AU" "AGILITY" "XL_EXPRESS" "ADERONLINE" "DIRECTCOURIERS" "PLANZER" "SENDING" "NINJAVAN_WB" "NATIONWIDE_MY" "SENDIT" "GB_ARROW" "IND_GOJAVAS" "KPOST" "DHL_FREIGHT" "BLUECARE" "JINDOUYUN" "TRACKON" "GB_TUFFNELLS" "TRUMPCARD" "ETOTAL" "SFPLUS_WEBHOOK" "SEKOLOGISTICS" "HERMES_2MANN_HANDLING" "DPD_LOCAL_REF" "UDS" "ZA_SPECIALISED_FREIGHT" "THA_KERRY" "PRT_INT_SEUR" "BRA_CORREIOS" "NZ_NZ_POST" "CN_EQUICK" "MYS_EMS" "GB_NORSK" "ESP_MRW" "ESP_PACKLINK" "KANGAROO_MY" "RPX" "XDP_UK_REFERENCE" "NINJAVAN_MY" "ADICIONAL" "ROADBULL" "YAKIT" "MAILAMERICAS" "MIKROPAKKET" "DYNALOGIC" "DHL_ES" "DHL_PARCEL_NL" "DHL_GLOBAL_MAIL_ASIA" "DAWN_WING" "GENIKI_GR" "HERMESWORLD_UK" "ALPHAFAST" "BUYLOGIC" "EKART" "MEX_SENDA" "SFC_LOGISTICS" "POST_SERBIA" "IND_DELHIVERY" "DE_DPD_DELISTRACK" "RPD2MAN" "CN_SF_EXPRESS" "YANWEN" "MYS_SKYNET" "CORREOS_DE_MEXICO" "CBL_LOGISTICA" "MEX_ESTAFETA" "AU_AUSTRIAN_POST" "RINCOS" "NLD_DHL" "RUSSIAN_POST" "COURIERS_PLEASE" "POSTNORD_LOGISTICS" "FEDEX" "DPE_EXPRESS" "DPD" "ADSONE" "IDN_JNE" "THECOURIERGUY" "CNEXPS" "PRT_CHRONOPOST" "LANDMARK_GLOBAL" "IT_DHL_ECOMMERCE" "ESP_NACEX" "PRT_CTT" "BE_KIALA" "ASENDIA_UK" "GLOBAL_TNT" "POSTUR_IS" "EPARCEL_KR" "INPOST_PACZKOMATY" "IT_POSTE_ITALIA" "BE_BPOST" "PL_POCZTA_POLSKA" "MYS_MYS_POST" "SG_SG_POST" "THA_THAILAND_POST" "LEXSHIP" "FASTWAY_NZ" "DHL_AU" "COSTMETICSNOW" "PFLOGISTICS" "LOOMIS_EXPRESS" "GLS_ITALY" "LINE" "GEL_EXPRESS" "HUODULL" "NINJAVAN_SG" "JANIO" "AO_COURIER" "BRT_IT_SENDER_REF" "SAILPOST" "LALAMOVE" "NEWZEALAND_COURIERS" "ETOMARS" "VIRTRANSPORT" "WIZMO" "PALLETWAYS" "I_DIKA" "CFL_LOGISTICS" "GEMWORLDWIDE" "GLOBAL_EXPRESS" "LOGISTYX_TRANSGROUP" "WESTBANK_COURIER" "ARCO_SPEDIZIONI" "YDH_EXPRESS" "PARCELINKLOGISTICS" "CNDEXPRESS" "NOX_NIGHT_TIME_EXPRESS" "AERONET" "LTIANEXP" "INTEGRA2_FTP" "PARCELONE" "NOX_NACHTEXPRESS" "CN_CHINA_POST_EMS" "CHUKOU1" "GLS_SLOV" "ORANGE_DS" "JOOM_LOGIS" "AUS_STARTRACK" "DHL" "GB_APC" "BONDSCOURIERS" "JPN_JAPAN_POST" "USPS" "WINIT" "ARG_OCA" "TW_TAIWAN_POST" "DMM_NETWORK" "TNT" "BH_POSTA" "SWE_POSTNORD" "CA_CANADA_POST" "WISELOADS" "ASENDIA_HK" "NLD_GLS" "MEX_REDPACK" "JET_SHIP" "DE_DHL_EXPRESS" "NINJAVAN_THAI" "RABEN_GROUP" "ESP_ASM" "HRV_HRVATSKA" "GLOBAL_ESTES" "LTU_LIETUVOS" "BEL_DHL" "AU_AU_POST" "SPEEDEXCOURIER" "FR_COLIS" "ARAMEX" "DPEX" "MYS_AIRPAK" "CUCKOOEXPRESS" "DPD_POLAND" "NLD_POSTNL" "NIM_EXPRESS" "QUANTIUM" "SENDLE" "ESP_REDUR" "MATKAHUOLTO" "CPACKET" "POSTI" "HUNTER_EXPRESS" "CHOIR_EXP" "LEGION_EXPRESS" "AUSTRIAN_POST_EXPRESS" "GRUPO" "POSTA_RO" "INTERPARCEL_UK" "GLOBAL_ABF" "POSTEN_NORGE" "XPERT_DELIVERY" "DHL_REFR" "DHL_HK" "SKYNET_UAE" "GOJEK" "YODEL_INTNL" "JANCO" "YTO" "WISE_EXPRESS" "JTEXPRESS_VN" "FEDEX_INTL_MLSERV" "VAMOX" "AMS_GRP" "DHL_JP" "HRPARCEL" "GESWL" "BLUESTAR" "CDEK_TR" "DESCARTES" "DELTEC_UK" "DTDC_EXPRESS" "TOURLINE" "BH_WORLDWIDE" "OCS" "YINGNUO_LOGISTICS" "UPS" "TOLL" "PRT_SEUR" "DTDC_AU" "THA_DYNAMIC_LOGISTICS" "UBI_LOGISTICS" "FEDEX_CROSSBORDER" "A1POST" "TAZMANIAN_FREIGHT" "CJ_INT_MY" "SAIA_FREIGHT" "SG_QXPRESS" "NHANS_SOLUTIONS" "DPD_FR" "COORDINADORA" "ANDREANI" "DOORA" "INTERPARCEL_NZ" "PHL_JAMEXPRESS" "BEL_BELGIUM_POST" "US_APC" "IDN_POS" "FR_MONDIAL" "DE_DHL" "HK_RPX" "DHL_PIECEID" "VNPOST_EMS" "RRDONNELLEY" "DPD_DE" "DELCART_IN" "IMEXGLOBALSOLUTIONS" "ACOMMERCE" "EURODIS" "CANPAR" "GLS" "IND_ECOM" "ESP_ENVIALIA" "DHL_UK" "SMSA_EXPRESS" "TNT_FR" "DEX_I" "BUDBEE_WEBHOOK" "COPA_COURIER" "VNM_VIETNAM_POST" "DPD_HK" "TOLL_NZ" "ECHO" "FEDEX_FR" "BORDEREXPRESS" "MAILPLUS_JPN" "TNT_UK_REFR" "KEC" "DPD_RO" "TNT_JP" "TH_CJ" "EC_CN" "FASTWAY_UK" "FASTWAY_US" "GLS_DE" "GLS_ES" "GLS_FR" "MONDIAL_BE" "SGT_IT" "TNT_CN" "TNT_DE" "TNT_ES" "TNT_PL" "PARCELFORCE" "SWISS_POST" "TOLL_IPEC" "AIR_21" "AIRSPEED" "BERT" "BLUEDART" "COLLECTPLUS" "COURIERPLUS" "COURIER_POST" "DHL_GLOBAL_MAIL" "DPD_UK" "DELTEC_DE" "DEUTSCHE_DE" "DOTZOT" "ELTA_GR" "EMS_CN" "ECARGO" "ENSENDA" "FERCAM_IT" "FASTWAY_ZA" "FASTWAY_AU" "FIRST_LOGISITCS" "GEODIS" "GLOBEGISTICS" "GREYHOUND" "JETSHIP_MY" "LION_PARCEL" "AEROFLASH" "ONTRAC" "SAGAWA" "SIODEMKA" "STARTRACK" "TNT_AU" "TNT_IT" "TRANSMISSION" "YAMATO" "DHL_IT" "DHL_AT" "LOGISTICSWORLDWIDE_KR" "GLS_SPAIN" "AMAZON_UK_API" "DPD_FR_REFERENCE" "DHLPARCEL_UK" "MEGASAVE" "QUALITYPOST" "IDS_LOGISTICS" "JOYINGBOX" "PANTHER_ORDER_NUMBER" "WATKINS_SHEPARD" "FASTTRACK" "UP_EXPRESS" "ELOGISTICA" "ECOURIER" "CJ_PHILIPPINES" "SPEEDEX" "ORANGECONNEX" "TECOR" "SAEE" "GLS_ITALY_FTP" "DELIVERE" "YYCOM" "ADICIONAL_PT" "DKSH" "NIPPON_EXPRESS_FTP" "GOLS" "FUJEXP" "QTRACK" "OMLOGISTICS_API" "GDPHARM" "MISUMI_CN" "AIR_CANADA" "CITY56_WEBHOOK" "SAGAWA_API" "KEDAEX" "PGEON_API" "WEWORLDEXPRESS" "JT_LOGISTICS" "TRUSK" "VIAXPRESS" "DHL_SUPPLYCHAIN_ID" "ZUELLIGPHARMA_SFTP" "MEEST" "TOLL_PRIORITY" "MOTHERSHIP_API" "CAPITAL" "EUROPAKET_API" "HFD" "TOURLINE_REFERENCE" "GIO_ECOURIER" "CN_LOGISTICS" "PANDION" "BPOST_API" "PASSPORTSHIPPING" "PAKAJO" "DACHSER" "YUSEN_SFTP" "SHYPLITE" "XYY" "MWD" "FAXECARGO" "MAZET" "FIRST_LOGISTICS_API" "SPRINT_PACK" "HERMES_DE_FTP" "CONCISE" "KERRY_EXPRESS_TW_API" "EWE" "FASTDESPATCH" "ABCUSTOM_SFTP" "CHAZKI" "SHIPPIE" "GEODIS_API" "NAQEL_EXPRESS" "PAPA_WEBHOOK" "FORWARDAIR" "DIALOGO_LOGISTICA_API" "LALAMOVE_API" "TOMYDOOR" "KRONOS_WEBHOOK" "JTCARGO" "T_CAT" "CONCISE_WEBHOOK" "TELEPORT_WEBHOOK" "CUSTOMCO_API" "SPX_TH" "BOLLORE_LOGISTICS" "CLICKLINK_SFTP" "M3LOGISTICS" "VNPOST_API" "AXLEHIRE_FTP" "SHADOWFAX" "MYHERMES_UK_API" "DAIICHI" "MENSAJEROSURBANOS_API" "POLARSPEED" "IDEXPRESS_ID" "PAYO" "WHISTL_SFTP" "INTEX_DE" "TRANS2U" "PRODUCTCAREGROUP_SFTP" "BIGSMART" "EXPEDITORS_API_REF" "AITWORLDWIDE_API" "WORLDCOURIER" "QUIQUP" "AGEDISS_SFTP" "ANDREANI_API" "CRLEXPRESS" "SMARTCAT" "CROSSFLIGHT" "PROCARRIER" "DHL_REFERENCE_API" "SEINO_API" "WSPEXPRESS" "KRONOS" "TOTAL_EXPRESS_API" "PARCLL" "XPEDIGO" "STAR_TRACK_WEBHOOK" "GPOST" "UCS" "DMFGROUP" "COORDINADORA_API" "MARKEN" "NTL" "REDJEPAKKETJE" "ALLIED_EXPRESS_FTP" "MONDIALRELAY_ES" "NAEKO_FTP" "MHI" "SHIPPIFY" "MALCA_AMIT_API" "JTEXPRESS_SG_API" "DACHSER_WEB" "FLIGHTLG" "CAGO" "COM1EXPRESS" "TONAMI_FTP" "PACKFLEET" "PUROLATOR_INTERNATIONAL" "WINESHIPPING_WEBHOOK" "DHL_ES_SFTP" "PCHOME_API" "CESKAPOSTA_API" "GORUSH" "HOMERUNNER" "AMAZON_ORDER" "EFWNOW_API" "CBL_LOGISTICA_API" "NIMBUSPOST" "LOGWIN_LOGISTICS" "NOWLOG_API" "DPD_NL" "GODEPENDABLE" "ESDEX" "LOGISYSTEMS_SFTP" "EXPEDITORS" "SNTGLOBAL_API" "SHIPX" "QINTL_API" "PACKS" "POSTNL_INTERNATIONAL" "AMAZON_EMAIL_PUSH" "DHL_API" "SPX" "AXLEHIRE" "ICSCOURIER" "DIALOGO_LOGISTICA" "SHUNBANG_EXPRESS" "TCS_API" "SF_EXPRESS_CN" "PACKETA" "SIC_TELIWAY" "MONDIALRELAY_FR" "INTIME_FTP" "JD_EXPRESS" "FASTBOX" "PATHEON" "INDIA_POST" "TIPSA_REF" "ECOFREIGHT" "VOX" "DIRECTFREIGHT_AU_REF" "BESTTRANSPORT_SFTP" "AUSTRALIA_POST_API" "FRAGILEPAK_SFTP" "FLIPXP" "VALUE_WEBHOOK" "DAESHIN" "SHERPA" "MWD_API" "SMARTKARGO" "DNJ_EXPRESS" "GOPEOPLE" "MYSENDLE_API" "ARAMEX_API" "PIDGE" "THAIPARCELS" "PANTHER_REFERENCE_API" "POSTAPLUS" "BUFFALO" "U_ENVIOS" "ELITE_CO" "ROCHE_INTERNAL_SFTP" "DBSCHENKER_ICELAND" "TNT_FR_REFERENCE" "NEWGISTICSAPI" "GLOVO" "GWLOGIS_API" "SPREETAIL_API" "MOOVA" "PLYCONGROUP" "USPS_WEBHOOK" "REIMAGINEDELIVERY" "EDF_FTP" "DAO365" "BIOCAIR_FTP" "RANSA_WEBHOOK" "SHIPXPRES" "COURANT_PLUS_API" "SHIPA" "HOMELOGISTICS" "DX" "POSTE_ITALIANE_PACCOCELERE" "TOLL_WEBHOOK" "LCTBR_API" "DX_FREIGHT" "DHL_SFTP" "SHIPROCKET" "UBER_WEBHOOK" "STATOVERNIGHT" "BURD" "FASTSHIP" "IBVENTURE_WEBHOOK" "GATI_KWE_API" "CRYOPDP_FTP" "HUBBED" "TIPSA_API" "ARASKARGO" "THIJS_NL" "ATSHEALTHCARE_REFERENCE" "99MINUTOS" "HELLENIC_POST" "HSM_GLOBAL" "MNX" "NMTRANSFER" "LOGYSTO" "INDIA_POST_INT" "AMAZON_FBA_SWISHIP_IN" "SRT_TRANSPORT" "BOMI" "DELIVERR_SFTP" "HSDEXPRESS" "SIMPLETIRE_WEBHOOK" "HUNTER_EXPRESS_SFTP" "UPS_API" "WOOYOUNG_LOGISTICS_SFTP" "PHSE_API" "WISH_EMAIL_PUSH" "NORTHLINE" "MEDAFRICA" "DPD_AT_SFTP" "ANTERAJA" "DHL_GLOBAL_FORWARDING_API" "LBCEXPRESS_API" "SIMSGLOBAL" "CDLDELIVERS" "TYP" "TESTING_COURIER_WEBHOOK" "PANDAGO_API" "ROYAL_MAIL_FTP" "THUNDEREXPRESS" "SECRETLAB_WEBHOOK" "SETEL" "JD_WORLDWIDE" "DPD_RU_API" "ARGENTS_WEBHOOK" "POSTONE" "TUSKLOGISTICS" "RHENUS_UK_API" "TAQBIN_SG_API" "INNTRALOG_SFTP" "DAYROSS" "CORREOSEXPRESS_API" "INTERNATIONAL_SEUR_API" "YODEL_API" "HEROEXPRESS" "DHL_SUPPLYCHAIN_IN" "URGENT_CARGUS" "FRONTDOORCORP" "JTEXPRESS_PH" "PARCELSTARS_WEBHOOK" "DPD_SK_SFTP" "MOVIANTO" "OZEPARTS_SHIPPING" "KARGOMKOLAY" "TRUNKRS" "OMNIRPS_WEBHOOK" "CHILEXPRESS" "TESTING_COURIER" "JNE_API" "BJSHOMEDELIVERY_FTP" "DEXPRESS_WEBHOOK" "USPS_API" "TRANSVIRTUAL" "SOLISTICA_API" "CHIENVENTURE_WEBHOOK" "DPD_UK_SFTP" "INPOST_UK" "JAVIT" "ZTO_DOMESTIC" "DHL_GT_API" "CEVA_TRACKING" "KOMON_EXPRESS" "EASTWESTCOURIER_FTP" "DANNIAO" "SPECTRAN" "DELIVER_IT" "RELAISCOLIS" "GLS_SPAIN_API" "POSTPLUS" "AIRTERRA" "GIO_ECOURIER_API" "DPD_CH_SFTP" "FEDEX_API" "INTERSMARTTRANS" "HERMES_UK_SFTP" "EXELOT_FTP" "DHL_PA_API" "VIRTRANSPORT_SFTP" "WORLDNET" "INSTABOX_WEBHOOK" "KNG" "FLASHEXPRESS_WEBHOOK" "MAGYAR_POSTA_API" "WESHIP_API" "OHI_WEBHOOK" "MUDITA" "BLUEDART_API" "T_CAT_API" "ADS" "HERMES_IT" "FITZMARK_API" "POSTI_API" "SMSA_EXPRESS_WEBHOOK" "TAMERGROUP_WEBHOOK" "LIVRAPIDE" "NIPPON_EXPRESS" "BETTERTRUCKS" "FAN" "PB_USPSFLATS_FTP" "PARCELRIGHT" "ITHINKLOGISTICS" "KERRY_EXPRESS_TH_WEBHOOK" "ECOUTIER" "SHOWL" "BRT_IT_API" "RIXONHK_API" "DBSCHENKER_API" "ILYANGLOGIS" "MAIL_BOX_ETC" "WESHIP" "DHL_GLOBAL_MAIL_API" "ACTIVOS24_API" "ATSHEALTHCARE" "LUWJISTIK" "GW_WORLD" "FAIRSENDEN_API" "SERVIP_WEBHOOK" "SWISHIP" "TANET" "HOTSIN_CARGO" "DIREX" "HUANTONG" "IMILE_API" "AUEXPRESS" "NYTLOGISTICS" "DSV_REFERENCE" "NOVOFARMA_WEBHOOK" "AITWORLDWIDE_SFTP" "SHOPOLIVE" "FNF_ZA" "DHL_ECOMMERCE_GC" "FETCHR" "STARLINKS_API" "YYEXPRESS" "SERVIENTREGA" "HANJIN" "SPANISH_SEUR_FTP" "DX_B2B_CONNUM" "HELTHJEM_API" "INEXPOST" "A2B_BA" "RHENUS_GROUP" "SBERLOGISTICS_RU" "MALCA_AMIT" "PPL" "OSM_WORLDWIDE_SFTP" "ACILOGISTIX" "OPTIMACOURIER" "NOVA_POSHTA_API" "LOGGI" "YIFAN" "MYDYNALOGIC" "MORNINGLOBAL" "CONCISE_API" "FXTRAN" "DELIVERYOURPARCEL_ZA" "UPARCEL" "MOBI_BR" "LOGINEXT_WEBHOOK" "EMS" "SPEEDY" "ZOOM_RED" "NAVLUNGO" "CASTLEPARCELS" "WEEE" "PACKALY" "YUNHUIPOST" "YOUPARCEL" "LEMAN" "MOOVIN" "URB_IT" "MULTIENTREGAPANAMA" "JUSDASR" "DISCOUNTPOST" "RHENUS_UK" "SWISHIP_JP" "GLS_US" "SMTL" "EMEGA" "EXPRESSONE_SV" "HEPSIJET" "WELIVERY" "BRINGER" "EASYROUTES" "MRW" "RPM" "DPD_PRT" "GLS_ROMANIA" "LMPARCEL" "GTAGSM" "DOMINO" "ESHIPPER" "TRANSPAK" "XINDUS" "AOYUE" "EASYPARCEL" "EXPRESSONE" "SENDEO_KARGO" "SPEEDAF" "ETOWER" "GCX" "NINJAVAN_VN" "ALLEGRO" "JUMPPOINT" "SHIPGLOBAL_US" "KINISI" "OAKH" "AWEST" "BARSAN" "ENERGOLOGISTIC" "MADROOEX" "GOBOLT" "SWISS_UNIVERSAL_EXPRESS" "IORDIRECT" "XMSZM" "GLS_HUN" "SENDY" "BRAUNSEXPRESS" "GRANDSLAMEXPRESS" "XGS" "OTSCHILE" "PACK_UP" "PARCELSTARS" "TEAMEXPRESSLLC" "ASYADEXPRESS" "TDN" "EARLYBIRD" "CACESA" "PARCELJET" "MNG_KARGO" "SUPERPACKLINE" "SPEEDX" "VESYL" "SKYKING" "DIRMENSAJERIA" "NETLOGIXGROUP" "ZYOU" "JAWAR" "AGSYSTEMS" "GPS" "PTT_KARGO" "MAERGO" "ARIHANTCOURIER" "VTFE" "YUNANT" "URBIFY" "PACK_MAN" "LIEFERGRUN" "OBIBOX" "PAIKEDA" "SCOTTY" "INTELCOM_CA" "SWE" "ASENDIA" "DPD_AT" "RELAY" "ATA" "SKYEXPRESS_INTERNATIONAL" "SURAT_KARGO" "SGLINK" "FLEETOPTICSINC" "SHOPLINE" "PIGGYSHIP" "LOGOIX" "KOLAY_GELSIN" "ASSOCIATED_COURIERS" "UPS_CHECKER" "WINESHIPPING" "SPEDISCI" "FOURKITES" "ETONAS" "FINMILE" "UNIUNI" "RODONAVES" "INPOST_IT" "TFORCE_FREIGHT" "RICHMOM" "FRANCO" "ECPARCEL" "FEDEX_CHINA" "GOFO_EXPRESS" "SHIPBOB" "JERSEYPOST_ATLAS" "CORETRAILS" "RHENUS_ITALY" "JADLOG" "JITSU" "YANWEN_EXPRESS" "DASHLINK" "SEINO_SUPER_EXPRESS" "FLOSHIP" "METROSCG" "SENDPARCEL" "P2P" "CN_EXPRESS" "CIRROTRACK" "LAND_LOGISTICS" "VEHO" "MEDLINE" "VDTRACK" "SINO_SCM" "3PE_EXPRESS" "SWIFTX" "SFYDEXPRESS" "TOPTRANS" "OTHER"  
carrier_name_other
string  [ 1 .. 64 ] characters ^[\S\s]*$
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.


 
capture_id
required
string  [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$
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.


 
Array of objects (tracker_item)   [ 0 .. 32767 ] items 
An array of details of items in the shipment.


 
{
  • "tracking_number": "string",
  • "carrier": "DPD_RU",
  • "carrier_name_other": "string",
  • "capture_id": "string",
  • "notify_payer": false,
  • "items": []
}
trustly
Information needed to pay using Trustly.


name
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
string (country_code-2)   = 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.


 
email
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
bic
string (BIC)   [ 8 .. 11 ] characters ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([...
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.


 
iban_last_chars
string (iban_last_chars)   [ 4 .. 34 ] characters ^.*[a-zA-Z0-9]{4}.*$
The last characters of the IBAN used to pay.


 
{
  • "name": "string",
  • "country_code": "string",
  • "email": "string",
  • "bic": "string",
  • "iban_last_chars": "string"
}
trustly_request
Information needed to pay using Trustly.


name
required
string (name)   [ 3 .. 300 ] characters ^[\S\s]*$
The full name representation like Mr J Smith.


 
country_code
required
string (country_code-2)   = 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.


 
email
required
string (email_address)   [ 3 .. 254 ] characters ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...
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.


 
object (experience_context_base) 
Customizes the payer experience during the approval process for the payment.


 
{
  • "name": "string",
  • "country_code": "string",
  • "email": "string",
  • "experience_context": {}
}
universal_product_code
The Universal Product Code of the item.


type
required
string (Universal Product Code Type) 
The Universal Product Code type.


 Enum: "UPC-A" "UPC-B" "UPC-C" "UPC-D" "UPC-E" "UPC-2" "UPC-5"  
code
required
string  [ 6 .. 17 ] characters ^[0-9]{0,17}$
The UPC product code of the item.


 
{
  • "type": "UPC-A",
  • "code": "string"
}
url
Describes the URL.


string <uri>  (url)   [ 0 .. 2147483647 ] characters 
Describes the URL.


 
"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 (store_in_vault_instruction) 
Defines how and when the payment source gets vaulted.


 Value: "ON_SUCCESS"  
{
  • "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 (vault_id)   [ 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.


 
"string"
vault_instruction_base
Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.


store_in_vault
string (store_in_vault_instruction) 
Defines how and when the payment source gets vaulted.


 Value: "ON_SUCCESS"  
{
  • "store_in_vault": "ON_SUCCESS"
}
vault_paypal_wallet_base
Resource consolidating common request and response attributes for vaulting PayPal Wallet.


store_in_vault
string (store_in_vault_instruction) 
Defines how and when the payment source gets vaulted.


 Value: "ON_SUCCESS"  
description
string  [ 1 .. 128 ] characters ^[\S\s]*$
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 (PayPal Payment Token Usage Pattern) 
Expected business/pricing model for the billing agreement.


 Enum: "IMMEDIATE" "DEFERRED" "RECURRING_PREPAID" "RECURRING_POSTPAID" "THRESHOLD_PREPAID" "THRESHOLD_POSTPAID" "SUBSCRIPTION_PREPAID" "SUBSCRIPTION_POSTPAID" "UNSCHEDULED_PREPAID" "UNSCHEDULED_POSTPAID" "INSTALLMENT_PREPAID" "INSTALLMENT_POSTPAID"  
object (shipping_detail) 
The shipping details.


 
usage_type
required
string (PayPal Payment Token Usage Type) 
The usage type associated with the PayPal payment token.


 Enum: "MERCHANT" "PLATFORM"  
customer_type
string (PayPal Payment Token Customer Type) 
 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: "CONSUMER" "BUSINESS"  
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.


 
{
  • "store_in_vault": "ON_SUCCESS",
  • "description": "string",
  • "usage_pattern": "IMMEDIATE",
  • "shipping": {
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "string"
      },
    • "email_address": "string",
    • "phone_number": {
      • "country_code": "str",
      • "national_number": "string",
      • "extension_number": "string"
      },
    • "type": "SHIPPING",
    • "options": [
      • {
        • "id": "string",
        • "label": "string",
        • "type": "SHIPPING",
        • "amount": {
          • "currency_code": "str",
          • "value": "string"
          },
        • "selected": true
        }
      ],
    • "address": {
      • "address_line_1": "string",
      • "address_line_2": "string",
      • "address_line_3": "string",
      • "admin_area_4": "string",
      • "admin_area_3": "string",
      • "admin_area_2": "string",
      • "admin_area_1": "string",
      • "postal_code": "string",
      • "country_code": "st",
      • "address_details": {
        • "street_number": "string",
        • "street_name": "string",
        • "street_type": "string",
        • "delivery_service": "string",
        • "building_name": "string",
        • "sub_building": "string"
        }
      }
    },
  • "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 ^[\S\s]*$
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status) 
The vault status.


 Enum: "VAULTED" "CREATED" "APPROVED"  
object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "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"
        }
      }
    ]
}
vault_Venmo_wallet_base
Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.


store_in_vault
required
string (store_in_vault_instruction) 
Defines how and when the payment source gets vaulted.


 Value: "ON_SUCCESS"  
description
string  [ 1 .. 128 ] characters ^[a-zA-Z0-9_'\-., :;\!?"]*$
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 (Venmo Payment Token Usage Pattern) 
Expected business/pricing model for the billing agreement.


 Enum: "IMMEDIATE" "DEFERRED" "RECURRING_PREPAID" "RECURRING_POSTPAID" "THRESHOLD_PREPAID" "THRESHOLD_POSTPAID"  
usage_type
required
string (Venmo Payment Token Usage Type) 
The usage type associated with the Venmo payment token.


 Enum: "MERCHANT" "PLATFORM"  
customer_type
string (Venmo Payment Token Customer Type) 
 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: "CONSUMER" "BUSINESS"  
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.


 
{
  • "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 ^[\S\s]*$
The PayPal-generated ID for the saved payment source.


 
status
string (Vault Status) 
The vault status.


 Enum: "VAULTED" "CREATED" "APPROVED"  
object (customer) 
This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.


 
Array of objects (Link Description)   [ 1 .. 10 ] items 
An array of request-related HATEOAS links.


 
{
  • "id": "string",
  • "status": "VAULTED",
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "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"
        }
      }
    ]
}
venmo_wallet_attributes
Additional attributes associated with the use of this Venmo Wallet.


object (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.


 
object (vault_Venmo_wallet_base) 
Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.


 
{
  • "customer": {
    • "id": "string",
    • "email_address": "string",
    • "phone": {
      • "phone_type": "FAX",
      • "phone_number": {
        • "national_number": "string"
        }
      },
    • "name": {
      • "prefix": "string",
      • "given_name": "string",
      • "surname": "string",
      • "middle_name": "string",
      • "suffix": "string",
      • "full_name": "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.


object (venmo_vault_response) 
The details about a saved venmo payment source.


 
{
  • "vault": {
    • "id": "string",
    • "status": "VAULTED",
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "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"
          }
        }
      ]
    }
}
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 (merchant_partner_customer_id)   [ 1 .. 22 ] characters ^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal.


 
email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
object (phone_with_type) 
The phone information.


 
object (Name) 
The name of the party.


 
{
  • "id": "string",
  • "email_address": "string",
  • "phone": {
    • "phone_type": "FAX",
    • "phone_number": {
      • "national_number": "string"
      }
    },
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "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
 Default:  "GET_FROM_FILE"
The location from which the shipping address is derived.


 Enum: "GET_FROM_FILE" "NO_SHIPPING" "SET_PROVIDED_ADDRESS"  
object (callback_configuration) 
CallBack Configuration that the merchant can provide to PayPal/Venmo.


 
user_action
string
 Default:  "CONTINUE"
Configures a Continue or Pay Now checkout flow.


 Enum: "CONTINUE" "PAY_NOW"  
{
  • "brand_name": "string",
  • "shipping_preference": "GET_FROM_FILE",
  • "order_update_callback_config": {},
  • "user_action": "CONTINUE"
}
venmo_wallet_request
Information needed to pay using Venmo.


vault_id
string (vault_id)   [ 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.


 
email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
object (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.


 
object (venmo_wallet_attributes) 
Additional attributes associated with the use of this Venmo Wallet.


 
{
  • "vault_id": "string",
  • "email_address": "string",
  • "experience_context": {
    • "brand_name": "string",
    • "shipping_preference": "GET_FROM_FILE",
    • "order_update_callback_config": {},
    • "user_action": "CONTINUE"
    },
  • "attributes": {
    • "customer": {
      • "id": "string",
      • "email_address": "string",
      • "phone": {
        • "phone_type": "FAX",
        • "phone_number": {
          • "national_number": "string"
          }
        },
      • "name": {
        • "prefix": "string",
        • "given_name": "string",
        • "surname": "string",
        • "middle_name": "string",
        • "suffix": "string",
        • "full_name": "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.


email_address
string (email)   [ 3 .. 254 ] characters ^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-...
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.


 
account_id
string (account_id-2)   = 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.


 
user_name
string  [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]*$
The Venmo user name chosen by the user, also know as a Venmo handle.


 
object (Name) 
The name of the party.


 
object (Phone Number) 
The phone number in its canonical international E.164 numbering plan format.


 
object (Portable Postal Address (Medium-Grained)) 
The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.


 
return_flow
string
 Default:  "AUTO"
Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the Venmo App.


 Enum: "AUTO" "MANUAL"  
object (venmo_wallet_attributes_response) 
Additional attributes associated with the use of a Venmo Wallet.


 
{
  • "email_address": "string",
  • "account_id": "string",
  • "user_name": "string",
  • "name": {
    • "prefix": "string",
    • "given_name": "string",
    • "surname": "string",
    • "middle_name": "string",
    • "suffix": "string",
    • "full_name": "string"
    },
  • "phone_number": {
    • "national_number": "string"
    },
  • "address": {
    • "address_line_1": "string",
    • "address_line_2": "string",
    • "address_line_3": "string",
    • "admin_area_4": "string",
    • "admin_area_3": "string",
    • "admin_area_2": "string",
    • "admin_area_1": "string",
    • "postal_code": "string",
    • "country_code": "st",
    • "address_details": {
      • "street_number": "string",
      • "street_name": "string",
      • "street_type": "string",
      • "delivery_service": "string",
      • "building_name": "string",
      • "sub_building": "string"
      }
    },
  • "return_flow": "AUTO",
  • "attributes": {
    • "vault": {
      • "id": "string",
      • "status": "VAULTED",
      • "customer": {
        • "id": "string",
        • "email_address": "string",
        • "phone": {
          • "phone_type": "FAX",
          • "phone_number": {
            • "national_number": "string"
            }
          },
        • "name": {
          • "prefix": "string",
          • "given_name": "string",
          • "surname": "string",
          • "middle_name": "string",
          • "suffix": "string",
          • "full_name": "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"
            }
          }
        ]
      }
    }
}