Note: For error handling and troubleshooting, see Orders v2 errors.", "tags": [ "orders" ], "security": [ { "Oauth2": [ "https://uri.paypal.com/services/payments/payment", "https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants" ] } ], "parameters": [ { "$ref": "#/components/parameters/paypal_request_id" }, { "name": "PayPal-Partner-Attribution-Id", "description": "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.", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 36, "pattern": "^[\\S\\s]*$" } }, { "$ref": "#/components/parameters/paypal_client_metadata_id" }, { "name": "Prefer", "description": "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.Prefer: return=representation request header. This header value is not the default.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
},
"examples": {
"samples_orders_create_samples_orders_create_authorize_single_step_paypal_with_vault_id_and_stored_credentials_usage_pattern": {
"summary": "Create and authorize an order for a PayPal wallet vaulted account holder passing a usage pattern indicator using stored credentials (Single Shot).",
"description": "Creates an order and authorizes payment with a PayPal wallet vault id as the payment source and a usage pattern (billing indicator) RECURRING_PREPAID passed using stored credentials.",
"value": {
"id": "8K832279M55989614",
"intent": "AUTHORIZE",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"email_address": "buyer@paypal.com",
"account_id": "XQHSN372NGSP2",
"account_status": "UNVERIFIED",
"name": {
"given_name": "Tom",
"surname": "Business"
},
"phone_number": {
"national_number": "8127081430"
},
"address": {
"country_code": "US"
},
"stored_credential": {
"payment_initiator": "MERCHANT",
"usage": "SUBSEQUENT",
"usage_pattern": "RECURRING_PREPAID"
}
}
},
"purchase_units": [
{
"reference_id": "default",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"payee": {
"email_address": "seller@paypal.com",
"merchant_id": "Q7C9N6S4YRQXG"
},
"shipping": {
"name": {
"full_name": "Tom Business"
},
"address": {
"address_line_1": "123 Fake St.",
"admin_area_2": "Baton Rouge",
"admin_area_1": "LA",
"postal_code": "70802",
"country_code": "US"
}
},
"payments": {
"authorizations": [
{
"status": "CREATED",
"id": "7X550106NA4440028",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"UNAUTHORIZED_TRANSACTION"
]
},
"expiration_time": "2024-06-05T18:46:54Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/7X550106NA4440028",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/7X550106NA4440028/capture",
"rel": "capture",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/7X550106NA4440028/void",
"rel": "void",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/8K832279M55989614",
"rel": "up",
"method": "GET"
}
],
"create_time": "2024-05-07T18:46:54Z",
"update_time": "2024-05-07T18:46:54Z"
}
]
}
}
],
"payer": {
"name": {
"given_name": "Tom",
"surname": "Business"
},
"email_address": "buyer@paypal.com",
"payer_id": "XQHSN372NGSP2",
"phone": {
"phone_number": {
"national_number": "8127081430"
}
},
"address": {
"country_code": "US"
}
},
"create_time": "2024-05-07T18:46:15Z",
"update_time": "2024-05-07T18:46:54Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/8K832279M55989614",
"rel": "self",
"method": "GET"
}
]
}
},
"samples_orders_create_samples_orders_create_orders_with_shipping_type_pickup_in_store": {
"summary": "Create Order - Buy Online Pickup In Store Shipping Type",
"description": "Creates an order with minimal parameters and contains the Buy Online Pickup in Store-related fields.",
"value": {
"id": "4SP74185RW2405200",
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "PUHF",
"amount": {
"currency_code": "USD",
"value": "50.00"
},
"payee": {
"email_address": "merchant@example.com"
},
"shipping": {
"address": {
"address_line_1": "123 Townsend St",
"address_line_2": "Floor 6",
"admin_area_2": "San Francisco",
"admin_area_1": "CA",
"postal_code": "94107",
"country_code": "US"
},
"type": "PICKUP_IN_STORE"
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=4SP74185RW2405200",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200/authorize",
"rel": "authorize",
"method": "POST"
}
],
"status": "CREATED"
}
},
"samples_orders_create_samples_orders_create_simple": {
"summary": "Create Order - Minimal Request and Response",
"description": "Creates an order with only required parameters. By default, uses the minimal representation.",
"value": {
"id": "5O190127TN364715T",
"status": "CREATED",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/capture",
"rel": "capture",
"method": "POST"
}
]
}
},
"samples_orders_create_create_orders_with_venmo_app_switch_pickup_in_store": {
"summary": "Create Order - Buy Online Pickup In Store Shipping Type",
"description": "Creates an order with venmo payment source and contains the Buy Online Pickup in Store-related fields.",
"value": {
"id": "4SP74185RW2405200",
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "PUHF",
"amount": {
"currency_code": "USD",
"value": "50.00"
},
"payee": {
"email_address": "merchant@example.com"
},
"shipping": {
"address": {
"address_line_1": "123 Townsend St",
"address_line_2": "Floor 6",
"admin_area_2": "San Francisco",
"admin_area_1": "CA",
"postal_code": "94107",
"country_code": "US"
},
"type": "PICKUP_IN_STORE"
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=4SP74185RW2405200",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200/authorize",
"rel": "authorize",
"method": "POST"
}
],
"status": "CREATED"
}
}
}
}
}
},
"202": {
"description": "The request has been accepted for processing, but the processing has not been completed yet. The server returns the HTTP `202 Accepted` status code to indicate that the request is valid and will be handled asynchronously.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
}
}
}
},
"400": {
"description": "Request is not well-formed, syntactically incorrect, or violates schema.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"error_samples_orders_create_error_samples_orders_create_400_bad_request": {
"summary": "Create Order - 400 Bad Request Error - Purchase Unit is Empty",
"description": "This code sample attempts to create an order with empty purchase units. The request fails.",
"value": {
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "10398537340c8",
"details": [
{
"field": "/purchase_units",
"value": "[]",
"location": "body",
"issue": "INVALID_ARRAY_MIN_ITEMS",
"description": "The number of items in an array parameter is too small."
}
],
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-INVALID_ARRAY_MIN_ITEMS",
"rel": "information_link"
}
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401_error_response"
},
"403": {
"$ref": "#/components/responses/403_error_response"
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"error_samples_orders_create_error_samples_orders_create_422_unprocessable_entity_missing_pickup_address": {
"summary": "Create Order - 422 Unprocessable Entity Error - Missing Pickup Address",
"description": "This code sample attempts to create an order but the shipping address is required and `shipping.type` is set to PICKUP_FROM_PERSON ",
"value": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"field": "/purchase_units/@reference_id=='PUHF'/shipping/address",
"issue": "MISSING_SHIPPING_ADDRESS",
"description": "The shipping address is required when `shipping_preference=SET_PROVIDED_ADDRESS`."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "f200264a4e02a",
"links": [
{
"href": "https://developer.paypal.com/api/rest/reference/orders/v2/errors/#MISSING_SHIPPING_ADDRESS",
"rel": "information_link",
"method": "GET"
}
]
}
}
}
}
}
},
"500": {
"$ref": "#/components/responses/500_error_response"
},
"default": {
"$ref": "#/components/responses/default_response"
}
},
"x-exampleFlows": [
{
"title": "Create Order - PayPal Wallet as Payment Source, Resulting in PAYER_ACTION_REQUIRED Response",
"description": "Creates a new order. API caller receives payer-action link.",
"parameter_examples": [
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_create_samples_orders_create_00_orders_create",
"response_example": "responses/200/content/application~1json/examples/samples_orders_create_samples_orders_create_00_orders_create"
},
{
"title": "Create and authorize an order for a PayPal wallet vaulted account holder passing a usage pattern indicator using stored credentials (Single Shot).",
"description": "Creates an order and authorizes payment with a PayPal wallet vault id as the payment source and a usage pattern (billing indicator) RECURRING_PREPAID passed using stored credentials.",
"parameter_examples": [
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_create_samples_orders_create_authorize_single_step_paypal_with_vault_id_and_stored_credentials_usage_pattern",
"response_example": "responses/201/content/application~1json/examples/samples_orders_create_samples_orders_create_authorize_single_step_paypal_with_vault_id_and_stored_credentials_usage_pattern"
},
{
"title": "Create Order - Minimal Request and Response",
"description": "Creates an order with only required parameters. By default, uses the minimal representation.",
"parameter_examples": [
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_create_samples_orders_create_simple",
"response_example": "responses/201/content/application~1json/examples/samples_orders_create_samples_orders_create_simple"
},
{
"title": "Create Order - Buy Online Pickup In Store Shipping Type",
"description": "Creates an order with minimal parameters and contains the Buy Online Pickup in Store-related fields.",
"parameter_examples": [
"parameters/@name=='Authorization'/examples/bearer",
"parameters/@name=='Prefer'/examples/samples_orders_create_samples_orders_create_orders_with_shipping_type_pickup_in_store"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_create_samples_orders_create_orders_with_shipping_type_pickup_in_store",
"response_example": "responses/201/content/application~1json/examples/samples_orders_create_samples_orders_create_orders_with_shipping_type_pickup_in_store"
},
{
"title": "Create Order - 400 Bad Request Error - Purchase Unit is Empty",
"description": "This code sample attempts to create an order with empty purchase units. The request fails.",
"parameter_examples": [
"parameters/@name=='Authorization'/examples/bearer",
"parameters/@name=='Prefer'/examples/samples_orders_create_samples_orders_create_order_mixed_cart_with_shipping_options_bwp_unknown_status"
],
"response_example": "responses/400/content/application~1json/examples/error_samples_orders_create_error_samples_orders_create_400_bad_request"
},
{
"title": "Create Order - 422 Unprocessable Entity Error - Missing Pickup Address",
"description": "This code sample attempts to create an order but the shipping address is required and `shipping.type` is set to PICKUP_FROM_PERSON ",
"parameter_examples": [
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/error_samples_orders_create_error_samples_orders_create_422_unprocessable_entity_missing_pickup_address",
"response_example": "responses/422/content/application~1json/examples/error_samples_orders_create_error_samples_orders_create_422_unprocessable_entity_missing_pickup_address"
},
{
"title": "Create Order - Buy Online Pickup In Store Shipping Type",
"description": "Creates an order with venmo payment source and contains the Buy Online Pickup in Store-related fields.",
"parameter_examples": [
"parameters/@name=='Prefer'/examples/samples_orders_create_create_orders_with_venmo_app_switch_pickup_in_store",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_create_create_orders_with_venmo_app_switch_pickup_in_store",
"response_example": "responses/201/content/application~1json/examples/samples_orders_create_create_orders_with_venmo_app_switch_pickup_in_store"
},
{
"title": "Create and Authorize an order with PayPal Wallet and App Switch with return, cancel and fallback app URLs",
"description": "Creates a new order and authorizes the payment using PayPal wallet with App Switch. Merchant provides separate return_app_url and cancel_app_url for native app redirection, which PayPal uses as-is without appending /success or /cancel.",
"parameter_examples": [
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_create_orders_create_authorize_paypal_wallet_app_switch_with_return_cancel_app_url",
"response_example": "responses/200/content/application~1json/examples/samples_orders_create_orders_create_authorize_paypal_wallet_app_switch_with_return_cancel_app_url"
},
{
"title": "Create and Authorize an order with PayPal Wallet where App Switch is Ineligible on a Low RAM Android Device",
"description": "Creates a new order with PayPal Wallet App Switch on a low RAM Android device (Samsung Galaxy A16 5G, SM-A166U, 4 GB total RAM). The merchant passes device metadata in device_info within app_switch_context. XOOS evaluates the device against the Elmo RAM threshold (default 400 MB) and model blocklist (SM-A166 prefix). The device fails both checks — available RAM is below the threshold and the model prefix is on the blocklist — so app_switch_eligibility is returned as false. The merchant must fall back to browser-based checkout using the returned payer-action URL.",
"parameter_examples": [
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_create_orders_create_paypal_wallet_app_switch_android_low_ram_device_blocked",
"response_example": "responses/200/content/application~1json/examples/samples_orders_create_orders_create_paypal_wallet_app_switch_android_low_ram_device_blocked"
}
]
}
},
"/v2/checkout/orders/{id}": {
"get": {
"operationId": "orders.get",
"summary": "Show order details",
"description": "Shows details for an order, by ID.Note: For error handling and troubleshooting, see Orders v2 errors.", "tags": [ "orders" ], "security": [ { "Oauth2": [ "https://uri.paypal.com/services/payments/payment", "https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants" ] } ], "parameters": [ { "name": "id", "description": "The ID of the order for which to show details.", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 36, "pattern": "^[A-Z0-9]+$" }, "examples": { "samples_orders_get_00_orders_get": { "summary": "Get Order - Show Order Details After Customer Approval", "description": "Shows order details immediately after customer approval.", "value": "5O190127TN364715T" } } }, { "$ref": "#/components/parameters/authorization" }, { "$ref": "#/components/parameters/paypal_auth_assertion" }, { "name": "fields", "description": "A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 2147483647, "pattern": "^[a-z_]*$" } } ], "responses": { "200": { "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that shows order details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" }, "examples": { "samples_orders_get_00_orders_get": { "summary": "Get Order - Show Order Details After Customer Approval", "description": "Shows order details immediately after customer approval.", "value": { "id": "5O190127TN364715T", "status": "APPROVED", "intent": "CAPTURE", "payment_source": { "paypal": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "account_id": "QYR5Z8XDVJNXQ" } }, "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "amount": { "currency_code": "USD", "value": "100.00" } } ], "payer": { "name": { "given_name": "John", "surname": "Doe" }, "email_address": "customer@example.com", "payer_id": "QYR5Z8XDVJNXQ" }, "create_time": "2018-04-01T21:18:49Z", "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" }, { "href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T", "rel": "approve", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "edit", "method": "PATCH" }, { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/capture", "rel": "capture", "method": "POST" } ] } } } } } }, "401": { "$ref": "#/components/responses/401_error_response" }, "403": { "$ref": "#/components/responses/403_error_response" }, "404": { "$ref": "#/components/responses/404_error_response" }, "500": { "$ref": "#/components/responses/500_error_response" }, "default": { "$ref": "#/components/responses/default_response" } }, "x-exampleFlows": [ { "title": "Get Order - Show Order Details After Customer Approval", "description": "Shows order details immediately after customer approval.", "parameter_examples": [ "parameters/@name=='id'/examples/samples_orders_get_00_orders_get", "parameters/@name=='Authorization'/examples/bearer" ], "response_example": "responses/200/content/application~1json/examples/samples_orders_get_00_orders_get" }, { "title": "Get Order - 404 Not Found Error - Order Not Found", "description": "This code sample attempts to show details for an order, by ID, but the request fails because the order is not found.", "parameter_examples": [ "parameters/@name=='id'/examples/samples_orders_get_00_orders_get" ], "response_example": "responses/404/content/application~1json/examples/generic" } ] }, "patch": { "operationId": "orders.patch", "summary": "Update order", "description": "Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.
\\\"/purchase_units/@reference_id=='default'/{attribute-or-object}\\\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.email_address | replace, add | |
purchase_units[].shipping.phone_number | replace, add | |
purchase_units[].shipping.options | replace, add | |
purchase_units[].shipping.address | replace, add | |
purchase_units[].shipping.type | replace, add | |
purchase_units[].soft_descriptor | replace, remove | |
purchase_units[].amount | replace | |
purchase_units[].items | replace, add, remove | |
purchase_units[].invoice_id | replace, add, remove | |
purchase_units[].payment_instruction | replace | |
purchase_units[].payment_instruction.disbursement_mode | replace | By default, disbursement_mode is INSTANT. |
purchase_units[].payment_instruction.payee_receivable_fx_rate_id | replace, add, remove | |
purchase_units[].payment_instruction.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.Note: For error handling and troubleshooting, see Orders v2 errors.", "tags": [ "orders" ], "security": [ { "Oauth2": [ "https://uri.paypal.com/services/payments/payment", "https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants" ] } ], "parameters": [ { "$ref": "#/components/parameters/paypal_request_id" }, { "name": "Prefer", "description": "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.Prefer: return=representation request header.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_authorize_response"
},
"examples": {
"samples_orders_authorize_00_orders_authorize": {
"summary": "Authorize Order - PayPal Wallet as Payment Source",
"description": "Authorize payment for an order after PayPal wallet approval. By default, uses the minimal representation.",
"value": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"account_id": "QYR5Z8XDVJNXQ"
}
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"payments": {
"authorizations": [
{
"id": "3C679366HH908993F",
"status": "CREATED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"expiration_time": "2021-10-08T23:37:39Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T/capture",
"rel": "capture",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T/void",
"rel": "void",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "up",
"method": "GET"
}
]
}
]
}
}
],
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"payer_id": "QYR5Z8XDVJNXQ"
},
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
},
"samples_orders_authorize_paypal_wallet_vault_id": {
"summary": "Authorize Order - PayPal Wallet Vault ID",
"description": "Authorizes payment for an order through a previously acquired vault id for a PayPal wallet. By default, uses the minimal representation.",
"value": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"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": {
"authorizations": [
{
"id": "0AW2184448108334S",
"status": "CREATED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"expiration_time": "2022-01-29T21:20:49Z",
"create_time": "2021-12-29T21:20:49Z",
"update_time": "2021-12-29T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/capture",
"rel": "capture",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/void",
"rel": "void",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/reauthorize",
"rel": "reauthorize",
"method": "POST"
}
]
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
}
}
}
},
"202": {
"description": "The request has been accepted for processing, but the processing has not been completed yet. The server returns the HTTP `202 Accepted` status code to indicate that the request is valid and will be handled asynchronously.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_authorize_response"
}
}
}
},
"207": {
"description": "The request was successfully processed, but the result contains mixed outcomes. When an order includes multiple purchase units, the server returns the HTTP `207 Multi-Status` code to indicate that one or more purchase units were processed successfully while others failed. The response body provides the processing result for each purchase unit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_authorize_response"
}
}
}
},
"400": {
"description": "Request is not well-formed, syntactically incorrect, or violates schema.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"401": {
"$ref": "#/components/responses/401_error_response"
},
"403": {
"$ref": "#/components/responses/403_error_response"
},
"404": {
"$ref": "#/components/responses/404_error_response"
},
"409": {
"description": "The request could not be completed due to a conflict with the current state of the resource. The HTTP `409 Conflict` status code is returned when the requested operation is not allowed because the order or one or more purchase units are in a state that prevents the operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"error_samples_orders_authorize_422_payer_action_required_cib_psd2_sca_ba_in_sc": {
"summary": "Authorize Order - 422 - Payer Action Required",
"description": "This code sample attempts to authorize payment for an order that was created by the api caller and the payment could not be processed due to PSD2 SCA compliance requirement.",
"value": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "PAYER_ACTION_REQUIRED",
"description": "Transaction cannot complete successfully, instruct the buyer to return to PayPal."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "f63fbc340a6ce",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-PAYER_ACTION_REQUIRED",
"rel": "information_link",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=9SY02093A2309081P",
"rel": "payer-action",
"method": "GET"
}
]
}
},
"error_samples_orders_authorize_422_unprocessable_entity_payment_denied": {
"summary": "Authorize Order - 422 Unprocessable Entity Error - Payment Denied",
"description": "This code sample attempts to authorize an order, but the payment is denied by PayPal. This can occur due to various reasons such as insufficient funds, expired card, incorrect payment information, or payment gateway issues.",
"value": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "PAYMENT_DENIED",
"description": "PayPal has declined to process this transaction."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "eb476257836d9",
"links": [
{
"href": "https://developer.paypal.com/docs/api/orders/v2/#error-PAYMENT_DENIED",
"rel": "information_link",
"method": "GET"
}
]
}
}
}
}
}
},
"500": {
"$ref": "#/components/responses/500_error_response"
},
"default": {
"$ref": "#/components/responses/default_response"
}
},
"x-exampleFlows": [
{
"title": "Authorize Order - PayPal Wallet as Payment Source",
"description": "Authorize payment for an order after PayPal wallet approval. By default, uses the minimal representation.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_authorize_00_orders_authorize",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/201/content/application~1json/examples/samples_orders_authorize_00_orders_authorize"
},
{
"title": "Authorize Order - Idempotent Response with PayPal Wallet",
"description": "Authorizes payment for an order with the same idempotency key. By default, uses the minimal representation.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_authorize_idempotent",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/200/content/application~1json/examples/samples_orders_authorize_idempotent"
},
{
"title": "Authorize Order - PayPal Wallet Vault ID",
"description": "Authorizes payment for an order through a previously acquired vault id for a PayPal wallet. By default, uses the minimal representation.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_authorize_paypal_wallet_vault_id",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_authorize_paypal_wallet_vault_id",
"response_example": "responses/201/content/application~1json/examples/samples_orders_authorize_paypal_wallet_vault_id"
},
{
"title": "Authorize Order - 403 Forbidden Error - Charity is not confirmed",
"description": "This code sample attempts to authorize a donation order, but charity is not confirmed.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_authorize_paypal_billing_agreement_id",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_authorize_paypal_billing_agreement_id",
"response_example": "responses/403/content/application~1json/examples/generic"
},
{
"title": "Authorize Order - 422 - Payer Action Required",
"description": "This code sample attempts to authorize payment for an order that was created by the api caller and the payment could not be processed due to PSD2 SCA compliance requirement.",
"parameter_examples": [
"parameters/@name=='id'/examples/error_samples_orders_authorize_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/error_samples_orders_authorize_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"response_example": "responses/422/content/application~1json/examples/error_samples_orders_authorize_422_payer_action_required_cib_psd2_sca_ba_in_sc"
},
{
"title": "Authorize Order - 422 Unprocessable Entity Error - Payment Denied",
"description": "This code sample attempts to authorize an order, but the payment is denied by PayPal. This can occur due to various reasons such as insufficient funds, expired card, incorrect payment information, or payment gateway issues.",
"parameter_examples": [
"parameters/@name=='id'/examples/error_samples_orders_authorize_422_unprocessable_entity_payment_denied",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/error_samples_orders_authorize_422_unprocessable_entity_payment_denied",
"response_example": "responses/422/content/application~1json/examples/error_samples_orders_authorize_422_unprocessable_entity_payment_denied"
}
]
}
},
"/v2/checkout/orders/{id}/capture": {
"post": {
"operationId": "orders.capture",
"summary": "Capture payment for order",
"description": "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.", "tags": [ "orders" ], "security": [ { "Oauth2": [ "https://uri.paypal.com/services/payments/payment", "https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants" ] } ], "parameters": [ { "$ref": "#/components/parameters/paypal_request_id" }, { "name": "Prefer", "description": "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.Prefer: return=representation request header.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
},
"examples": {
"samples_orders_capture_00_orders_capture": {
"summary": "Capture Order - PayPal Wallet as Payment Source",
"description": "Captures payment for an order after wallet approval. By default, uses the minimal representation.",
"value": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"account_id": "QYR5Z8XDVJNXQ"
}
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"shipping": {
"address": {
"address_line_1": "2211 N First Street",
"address_line_2": "Building 17",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95131",
"country_code": "US"
}
},
"payments": {
"captures": [
{
"id": "3C679366HH908993F",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"final_capture": true,
"disbursement_mode": "INSTANT",
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "100.00"
},
"paypal_fee": {
"currency_code": "USD",
"value": "3.00"
},
"net_amount": {
"currency_code": "USD",
"value": "97.00"
}
},
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F/refund",
"rel": "refund",
"method": "POST"
}
]
}
]
}
}
],
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"payer_id": "QYR5Z8XDVJNXQ"
},
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
},
"samples_orders_capture_vault_wallet": {
"summary": "Capture Order - Minimal Representation with PayPal Wallet Vault ID",
"description": "The partner captures payment for an order after PayPal Wallet approval. By default, uses the minimal representation.",
"value": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"attributes": {
"vault": {
"id": "m6yd4yw",
"status": "CREATED"
}
}
}
},
"purchase_units": [
{
"reference_id": "refernece_id_1001",
"shipping": {
"name": {
"full_name": "William Chris"
},
"address": {
"address_line_1": "500 Hillside Street",
"address_line_2": "#100",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95131",
"country_code": "US"
}
},
"payments": {
"captures": [
{
"id": "54986457XR262021N",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "31.01"
},
"final_capture": true,
"disbursement_mode": "INSTANT",
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "31.01"
},
"platform_fees": [
{
"amount": {
"currency_code": "USD",
"value": "10.01"
},
"payee": {
"merchant_id": "J8NCBBULP5JH2"
}
}
],
"net_amount": {
"currency_code": "USD",
"value": "21.00"
}
},
"invoice_id": "invoice_id_380358551C5240203",
"custom_id": "custom_id_1001",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/54986457XR262021N",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/54986457XR262021N/refund",
"rel": "refund",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/12645781RH9888226",
"rel": "up",
"method": "GET"
}
],
"create_time": "2020-06-08T23:11:34Z",
"update_time": "2020-06-08T23:11:34Z"
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/vault/payment-tokens/m6yd4yw",
"rel": "payment-token",
"method": "GET"
}
]
}
}
}
}
}
},
"202": {
"description": "The request has been accepted for processing, but the processing has not been completed yet. The server returns the HTTP `202 Accepted` status code to indicate that the request is valid and will be handled asynchronously.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
}
}
}
},
"207": {
"description": "The request was successfully processed, but the result contains mixed outcomes. When an order includes multiple purchase units, the server returns the HTTP `207 Multi-Status` code to indicate that one or more purchase units were processed successfully while others failed. The response body provides the processing result for each purchase unit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
}
}
}
},
"400": {
"description": "Request is not well-formed, syntactically incorrect, or violates schema.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"401": {
"$ref": "#/components/responses/401_error_response"
},
"403": {
"$ref": "#/components/responses/403_error_response"
},
"404": {
"$ref": "#/components/responses/404_error_response"
},
"409": {
"description": "The request could not be completed due to a conflict with the current state of the resource. The HTTP `409 Conflict` status code is returned when the requested operation is not allowed because the order or one or more purchase units are in a state that prevents the operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"error_samples_orders_capture_422_payer_action_required_cib_psd2_sca_ba_in_sc": {
"summary": "Capture Order - 422 - Payer Action Required",
"description": "This code sample attempts to capture payment for an order that was created by the api caller and the payment could not be processed due to PSD2 SCA compliance requirement.",
"value": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "PAYER_ACTION_REQUIRED",
"description": "Transaction cannot complete successfully, instruct the buyer to return to PayPal."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "f63fbc340a6ce",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-PAYER_ACTION_REQUIRED",
"rel": "information_link",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "payer-action",
"method": "GET"
}
]
}
},
"error_samples_orders_capture_422_unprocessable_entity": {
"summary": "Capture Order - 422 Unprocessable Entity Error - Action Does Not Match Intent",
"description": "This code sample attempts to capture payment for an order that was created with `intent=AUTHORIZE`. The operation is incorrect.",
"value": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"location": "body",
"issue": "ACTION_DOES_NOT_MATCH_INTENT",
"description": "The order was created with an intent of `AUTHORIZE`. To complete authorization, use `/v2/checkout/orders/{order_id}/authorize`. Or, alternately create an order with an intent of `CAPTURE`."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "90957fca61718",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-ACTION_DOES_NOT_MATCH_INTENT",
"rel": "information_link",
"method": "GET"
}
]
}
}
}
}
}
},
"500": {
"$ref": "#/components/responses/500_error_response"
},
"default": {
"$ref": "#/components/responses/default_response"
}
},
"x-exampleFlows": [
{
"title": "Capture Order - PayPal Wallet as Payment Source",
"description": "Captures payment for an order after wallet approval. By default, uses the minimal representation.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_capture_00_orders_capture",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/201/content/application~1json/examples/samples_orders_capture_00_orders_capture"
},
{
"title": "Capture Order - Idempotent Response with PayPal Wallet",
"description": "Captures payment for an order after wallet approval with the same idempotency key. By default, uses the minimal representation.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_capture_wallet_idempotent",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/200/content/application~1json/examples/samples_orders_capture_wallet_idempotent"
},
{
"title": "Capture Order - Minimal Representation with PayPal Wallet Vault ID",
"description": "The partner captures payment for an order after PayPal Wallet approval. By default, uses the minimal representation.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_capture_vault_wallet",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/201/content/application~1json/examples/samples_orders_capture_vault_wallet"
},
{
"title": "Capture Order - 403 Forbidden Error - Invalid Card Vault ID",
"description": "This code sample attempts to capture an order that was created with the `CAPTURE` intent but the card vault id can not be found. The request fails.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer",
"parameters/@name=='Prefer'/examples/samples_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"response_example": "responses/403/content/application~1json/examples/generic"
},
{
"title": "Capture Order - 404 Not Found Error - Resource Not Found",
"description": "This code sample attempts to capture an order but the specified order is not found. The request fails.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer",
"parameters/@name=='Prefer'/examples/samples_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"response_example": "responses/404/content/application~1json/examples/generic"
},
{
"title": "Capture Order - 422 - Payer Action Required",
"description": "This code sample attempts to capture payment for an order that was created by the api caller and the payment could not be processed due to PSD2 SCA compliance requirement.",
"parameter_examples": [
"parameters/@name=='id'/examples/error_samples_orders_capture_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/error_samples_orders_capture_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"response_example": "responses/422/content/application~1json/examples/error_samples_orders_capture_422_payer_action_required_cib_psd2_sca_ba_in_sc"
},
{
"title": "Capture Order - 422 Unprocessable Entity Error - Action Does Not Match Intent",
"description": "This code sample attempts to capture payment for an order that was created with `intent=AUTHORIZE`. The operation is incorrect.",
"parameter_examples": [
"parameters/@name=='id'/examples/error_samples_orders_capture_422_unprocessable_entity",
"parameters/@name=='PayPal-Request-Id'/examples/request_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/422/content/application~1json/examples/error_samples_orders_capture_422_unprocessable_entity"
}
]
}
},
"/v2/checkout/orders/{id}/track": {
"post": {
"operationId": "orders.track.create",
"summary": "Add tracking information for an Order.",
"description": "Adds tracking information for an Order.",
"tags": [
"orders"
],
"security": [
{
"Oauth2": [
"https://uri.paypal.com/services/payments/payment"
]
}
],
"parameters": [
{
"name": "id",
"description": "The ID of the order that the tracking information is associated with.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 36,
"pattern": "^[A-Z0-9]+$"
},
"examples": {
"samples_orders_track_create_complete_request": {
"summary": "Add Tracking to Order - Carrier Information and Items Breakdown",
"description": "Adds tracking information for a PayPal order.",
"value": "5O190127TN364715T"
},
"samples_orders_track_create_idempotent_complete_request": {
"summary": "Add Tracking to Order - Idempotent Response",
"description": "Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body.",
"value": "5O190127TN364715T"
},
"error_samples_orders_track_create_track_create_422_unprocessable_entity_invalid_capture_status": {
"summary": "Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status.",
"description": "This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid.",
"value": "5O190127TN364715T"
}
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/paypal_auth_assertion"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order_tracker_request"
},
"examples": {
"samples_orders_track_create_complete_request": {
"summary": "Add Tracking to Order - Carrier Information and Items Breakdown",
"description": "Adds tracking information for a PayPal order.",
"value": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX",
"notify_payer": false,
"items": [
{
"name": "T-Shirt",
"sku": "sku02",
"quantity": "1",
"upc": {
"type": "UPC-A",
"code": "012345678901"
},
"image_url": "https://www.example.com/example.jpg",
"url": "https://www.example.com/example"
}
]
}
},
"samples_orders_track_create_idempotent_complete_request": {
"summary": "Add Tracking to Order - Idempotent Response",
"description": "Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body.",
"value": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX",
"notify_payer": false,
"items": [
{
"name": "T-Shirt",
"sku": "sku01",
"quantity": "1",
"upc": {
"type": "UPC-A",
"code": "012345678901"
},
"image_url": "https://www.example.com/example.jpg",
"url": "https://www.example.com/example"
}
]
}
},
"error_samples_orders_track_create_track_create_422_unprocessable_entity_invalid_capture_status": {
"summary": "Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status.",
"description": "This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid.",
"value": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX"
}
}
}
}
}
},
"responses": {
"200": {
"description": "A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows tracker details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
},
"examples": {
"samples_orders_track_create_idempotent_complete_request": {
"summary": "Add Tracking to Order - Idempotent Response",
"description": "Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body.",
"value": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"items": [
{
"name": "Air Jordan Shoe",
"sku": "sku01",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
},
{
"name": "T-Shirt",
"sku": "sku02",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
}
],
"shipping": {
"trackers": [
{
"id": "8MC585209K746392H-443844607820",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "up",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820",
"rel": "edit",
"method": "PATCH"
}
],
"create_time": "2022-08-12T21:20:49Z",
"update_time": "2022-08-12T21:20:49Z"
}
]
},
"payments": {
"captures": [
{
"id": "8MC585209K746392H",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "NOT_ELIGIBLE"
},
"final_capture": true,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "100.00"
},
"paypal_fee": {
"currency_code": "USD",
"value": "3.00"
},
"net_amount": {
"currency_code": "USD",
"value": "97.00"
}
},
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund",
"rel": "refund",
"method": "POST"
}
]
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
}
}
}
},
"201": {
"description": "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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/order"
},
"examples": {
"samples_orders_track_create_complete_request": {
"summary": "Add Tracking to Order - Carrier Information and Items Breakdown",
"description": "Adds tracking information for a PayPal order.",
"value": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"items": [
{
"name": "Air Jordan Shoe",
"sku": "sku01",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
},
{
"name": "T-Shirt",
"sku": "sku02",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
}
],
"shipping": {
"trackers": [
{
"id": "8MC585209K746392H-443844607820",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "up",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820",
"rel": "edit",
"method": "PATCH"
}
],
"create_time": "2022-08-12T21:20:49Z",
"update_time": "2022-08-12T21:20:49Z"
}
]
},
"payments": {
"captures": [
{
"id": "8MC585209K746392H",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "NOT_ELIGIBLE"
},
"final_capture": true,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "100.00"
},
"paypal_fee": {
"currency_code": "USD",
"value": "3.00"
},
"net_amount": {
"currency_code": "USD",
"value": "97.00"
}
},
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund",
"rel": "refund",
"method": "POST"
}
]
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
}
}
}
},
"400": {
"description": "Request is not well-formed, syntactically incorrect, or violates schema.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"error_samples_orders_track_create_track_create_400_missing_parameter": {
"summary": "Add Tracking to Order - 400 Bad Request - Missing Required Parameter",
"description": "This code sample attempts to add tracking information for a PayPal order but required parameter capture id is not passed.",
"value": {
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "360ee42996992",
"details": [
{
"field": "/capture_id",
"issue": "MISSING_REQUIRED_PARAMETER",
"description": "A required field / parameter is missing.",
"location": "body"
}
],
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-MISSING_REQUIRED_PARAMETER",
"rel": "information_link"
}
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401_error_response"
},
"403": {
"$ref": "#/components/responses/403_error_response"
},
"404": {
"$ref": "#/components/responses/404_error_response"
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"error_samples_orders_track_create_track_create_422_unprocessable_entity_invalid_capture_status": {
"summary": "Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status.",
"description": "This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid.",
"value": {
"name": "UNPROCESSABLE_ENTITY",
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "360ee42996992",
"details": [
{
"issue": "CAPTURE_STATUS_NOT_VALID",
"description": "Invalid capture status. Tracker information can only be added to captures in `COMPLETED` state."
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/orders/v2/#error-CAPTURE_STATUS_NOT_VALID",
"rel": "information_link",
"method": "GET"
}
]
}
}
}
}
}
},
"500": {
"$ref": "#/components/responses/500_error_response"
},
"default": {
"$ref": "#/components/responses/default_response"
}
},
"x-exampleFlows": [
{
"title": "Add Tracking to Order - Carrier Information and Items Breakdown",
"description": "Adds tracking information for a PayPal order.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_track_create_complete_request",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_track_create_complete_request",
"response_example": "responses/201/content/application~1json/examples/samples_orders_track_create_complete_request"
},
{
"title": "Add Tracking to Order - Idempotent Response",
"description": "Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_track_create_idempotent_complete_request",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_track_create_idempotent_complete_request",
"response_example": "responses/200/content/application~1json/examples/samples_orders_track_create_idempotent_complete_request"
},
{
"title": "Add Tracking to Order - 400 Bad Request - Missing Required Parameter",
"description": "This code sample attempts to add tracking information for a PayPal order but required parameter capture id is not passed.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_track_create_idempotent_complete_request",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/400/content/application~1json/examples/error_samples_orders_track_create_track_create_400_missing_parameter"
},
{
"title": "Add Tracking to Order - 403 Forbidden - No Permission for the Order",
"description": "This code sample attempts to add tracking information for a Paypal Order, but the API caller does not have permission to act on this resource.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_track_create_idempotent_complete_request",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_track_create_idempotent_complete_request",
"response_example": "responses/403/content/application~1json/examples/generic"
},
{
"title": "Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status.",
"description": "This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid.",
"parameter_examples": [
"parameters/@name=='id'/examples/error_samples_orders_track_create_track_create_422_unprocessable_entity_invalid_capture_status",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/error_samples_orders_track_create_track_create_422_unprocessable_entity_invalid_capture_status",
"response_example": "responses/422/content/application~1json/examples/error_samples_orders_track_create_track_create_422_unprocessable_entity_invalid_capture_status"
},
{
"title": "Add Tracking to Order - 500 Internal Server Error",
"description": "This code sample attempts to add tracking information for a PayPal Order but the request fails due to an internal server error.",
"parameter_examples": [
"parameters/@name=='id'/examples/samples_orders_track_create_idempotent_complete_request",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/samples_orders_track_create_idempotent_complete_request",
"response_example": "responses/500/content/application~1json/examples/generic"
}
]
}
},
"/v2/checkout/orders/{id}/trackers/{tracker_id}": {
"patch": {
"operationId": "orders.trackers.patch",
"summary": "Update or cancel tracking information for an order",
"description": "Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:| Attribute | Op | Notes |
|---|---|---|
items | replace | Using replace op for items will replace the entire items object with the value sent in request. |
notify_payer | replace, add | |
status | replace | Only patching status to CANCELLED is currently supported. |
Note: Up to 64 characters are allowed before and 255 characters are allowed after the", "type": "string", "minLength": 3, "maxLength": 254, "pattern": "^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\]).*$" }, "account_id": { "title": "PayPal Account Identifier", "description": "The account identifier for a PayPal account.", "type": "string", "minLength": 13, "maxLength": 13, "pattern": "^[2-9A-HJ-NP-Z]{13}$" }, "payer_base": { "title": "payer_base", "description": "The customer who approves and pays for the order. The customer is also known as the payer.", "type": "object", "properties": { "email_address": { "allOf": [ { "$ref": "#/components/schemas/email" }, { "description": "The email address of the payer." } ] }, "payer_id": { "allOf": [ { "$ref": "#/components/schemas/account_id" }, { "description": "The PayPal-assigned ID for the payer.", "readOnly": true } ] } } }, "name": { "title": "Name", "description": "The name of the party.", "type": "object", "properties": { "prefix": { "description": "The prefix, or title, to the party's name.", "type": "string", "minLength": 0, "maxLength": 140, "pattern": "^[\\S\\s]*$" }, "given_name": { "description": "When the party is a person, the party's given, or first, name.", "type": "string", "minLength": 0, "maxLength": 140, "pattern": "^[\\S\\s]*$" }, "surname": { "description": "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.", "type": "string", "minLength": 0, "maxLength": 140, "pattern": "^[\\S\\s]*$" }, "middle_name": { "description": "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.", "type": "string", "minLength": 0, "maxLength": 140, "pattern": "^[\\S\\s]*$" }, "suffix": { "description": "The suffix for the party's name.", "type": "string", "minLength": 0, "maxLength": 140, "pattern": "^[\\S\\s]*$" }, "full_name": { "description": "When the party is a person, the party's full name.", "type": "string", "minLength": 0, "maxLength": 300, "pattern": "^[\\S\\s]*$" } } }, "phone_type": { "title": "Phone Type", "description": "The phone type.", "type": "string", "enum": [ "FAX", "HOME", "MOBILE", "OTHER", "PAGER" ], "oneOf": [ { "type": "string", "enum": [ "FAX" ], "description": "Fax number." }, { "type": "string", "enum": [ "HOME" ], "description": "Home phone number." }, { "type": "string", "enum": [ "MOBILE" ], "description": "Mobile phone number." }, { "type": "string", "enum": [ "OTHER" ], "description": "Other phone number." }, { "type": "string", "enum": [ "PAGER" ], "description": "Pager number." } ] }, "phone": { "title": "Phone", "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).", "type": "object", "required": [ "country_code", "national_number" ], "properties": { "country_code": { "title": "country_calling_code", "description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).", "type": "string", "minLength": 1, "maxLength": 3, "pattern": "^[0-9]{1,3}?$" }, "national_number": { "description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).", "type": "string", "minLength": 1, "maxLength": 14, "pattern": "^[0-9]{1,14}?$" }, "extension_number": { "description": "The extension number.", "type": "string", "minLength": 1, "maxLength": 15, "pattern": "^[0-9]{1,15}?$" } } }, "phone_with_type": { "title": "phone_with_type", "description": "The phone information.", "type": "object", "required": [ "phone_number" ], "properties": { "phone_type": { "$ref": "#/components/schemas/phone_type" }, "phone_number": { "allOf": [ { "$ref": "#/components/schemas/phone" }, { "description": "The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property." } ] } } }, "date_no_time": { "description": "The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). 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.", "type": "string", "minLength": 10, "maxLength": 10, "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$" }, "tax_info": { "title": "tax_info", "description": "The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required.", "type": "object", "required": [ "tax_id", "tax_id_type" ], "properties": { "tax_id": { "description": "The customer's tax ID value.", "type": "string", "minLength": 1, "maxLength": 14, "pattern": "^.*([a-zA-Z0-9]).*$" }, "tax_id_type": { "description": "The customer's tax ID type.", "type": "string", "enum": [ "BR_CPF", "BR_CNPJ" ], "oneOf": [ { "type": "string", "enum": [ "BR_CPF" ], "description": "The individual tax ID type, typically is 11 characters long." }, { "type": "string", "enum": [ "BR_CNPJ" ], "description": "The business tax ID type, typically is 14 characters long." } ] } } }, "country_code": { "description": "The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The country code for Great Britain is", "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^([A-Z]{2}|C2)$" }, "address_portable": { "title": "Portable Postal Address (Medium-Grained)", "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).", "type": "object", "required": [ "country_code" ], "properties": { "address_line_1": { "description": "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.", "type": "string", "minLength": 0, "maxLength": 300, "pattern": "^[\\S\\s]*$" }, "address_line_2": { "description": "The second line of the address, for example, a suite or apartment number.", "type": "string", "minLength": 0, "maxLength": 300, "pattern": "^[\\S\\s]*$" }, "address_line_3": { "description": "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.", "type": "string", "minLength": 0, "maxLength": 100, "pattern": "^[\\S\\s]*$" }, "admin_area_4": { "description": "The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is:GBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Craven House.",
"type": "string",
"minLength": 0,
"maxLength": 100,
"pattern": "^[\\S\\s]*$"
},
"sub_building": {
"description": "The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.",
"type": "string",
"minLength": 0,
"maxLength": 100,
"pattern": "^[\\S\\s]*$"
}
}
}
}
},
"country_code-2": {
"description": "The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.Note: The country code for Great Britain is", "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^([A-Z]{2}|C2)$" }, "payer": { "title": "payer", "description": "The customer who approves and pays for the order. The customer is also known as the payer.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/payer_base" }, { "type": "object", "properties": { "name": { "allOf": [ { "$ref": "#/components/schemas/name" }, { "description": "The name of the payer. Supports only the `given_name` and `surname` properties.", "not": { "anyOf": [ { "required": [ "prefix" ] }, { "required": [ "middle_name" ] }, { "required": [ "suffix" ] }, { "required": [ "alternate_full_name" ] }, { "required": [ "full_name" ] } ] } } ] }, "phone": { "allOf": [ { "$ref": "#/components/schemas/phone_with_type" }, { "description": "The phone number of the customer. Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. The `phone.phone_number` supports only `national_number`." } ] }, "birth_date": { "allOf": [ { "$ref": "#/components/schemas/date_no_time" }, { "description": "The birth date of the payer in `YYYY-MM-DD` format." } ] }, "tax_info": { "allOf": [ { "$ref": "#/components/schemas/tax_info" }, { "description": "The tax information of the payer. Required only for Brazilian payer's. Both `tax_id` and `tax_id_type` are required." } ] }, "address": { "allOf": [ { "$ref": "#/components/schemas/address_portable" }, { "description": "The address of the payer. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer.", "not": { "anyOf": [ { "required": [ "address_line_3" ] }, { "required": [ "admin_area_3" ] }, { "required": [ "admin_area_4" ] }, { "required": [ "address_details" ] } ] } } ] } } } ] }, "currency_code": { "description": "The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.", "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[\\S\\s]*$" }, "money": { "title": "Money", "description": "The currency and amount for a financial transaction, such as a balance or payment due.", "type": "object", "required": [ "currency_code", "value" ], "properties": { "currency_code": { "$ref": "#/components/schemas/currency_code" }, "value": { "description": "The value, which might be:GBand notUKas used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
item_total.value can not be a negative number."
}
]
},
"shipping": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The shipping fee for all items within a given `purchase_unit`. shipping.value can not be a negative number."
}
]
},
"handling": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The handling fee for all items within a given `purchase_unit`. handling.value can not be a negative number."
}
]
},
"tax_total": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The total tax for all items. Required if the request includes `purchase_units.items.tax`. Must equal the sum of `(items[].tax * items[].quantity)` for all items. tax_total.value can not be a negative number."
}
]
},
"insurance": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The insurance fee for all items within a given `purchase_unit`. insurance.value can not be a negative number."
}
]
},
"shipping_discount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The shipping discount for all items within a given `purchase_unit`. shipping_discount.value can not be a negative number."
}
]
},
"discount": {
"allOf": [
{
"$ref": "#/components/schemas/discount_with_breakdown"
},
{
"description": "The discount for all items within a given `purchase_unit`. discount.value can not be a negative number."
}
]
}
}
},
"amount_with_breakdown": {
"title": "amount_with_breakdown",
"description": "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.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).",
"type": "integer",
"minimum": 0,
"maximum": 999,
"default": 1
},
"sequence": {
"description": "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.",
"type": "integer",
"minimum": 1,
"maximum": 3,
"default": 1
},
"start_date": {
"allOf": [
{
"$ref": "#/components/schemas/date_no_time"
},
{
"description": "The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date."
}
]
}
}
},
"order_billing_plan": {
"title": "order_billing_plan",
"description": "Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation.",
"type": "object",
"required": [
"billing_cycles"
],
"properties": {
"billing_cycles": {
"description": "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.",
"type": "array",
"minItems": 1,
"maxItems": 3,
"items": {
"$ref": "#/components/schemas/billing_cycle"
}
},
"setup_fee": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The setup fee for the recurring plan. Ensure its part of the item amount."
}
]
},
"name": {
"description": "Name of the recurring plan.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^[A-Za-z0-9() +',.:-]+$"
}
}
},
"item_request": {
"title": "item_request",
"description": "The details for the items to be purchased.",
"type": "object",
"required": [
"name",
"quantity",
"unit_amount"
],
"properties": {
"name": {
"description": "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.", "type": "string", "minLength": 1, "maxLength": 3000, "pattern": "^[\\S\\s]*$" }, "unit_amount": { "allOf": [ { "$ref": "#/components/schemas/money" }, { "description": "The item price or rate per unit. If you specify
unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number."
}
]
},
"tax": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number."
}
]
},
"quantity": {
"description": "The item quantity. Must be a whole number.",
"type": "string",
"minLength": 0,
"maxLength": 10,
"pattern": "^[1-9][0-9]{0,9}$"
},
"description": {
"description": "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.", "type": "string", "minLength": 0, "maxLength": 4000, "pattern": "^[\\S\\s]*$" }, "sku": { "description": "The stock keeping unit (SKU) for the item.", "type": "string", "minLength": 0, "maxLength": 127, "pattern": "^[\\S\\s]*$" }, "url": { "description": "The URL to the item being purchased. Visible to buyer and used in buyer experiences.", "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "category": { "description": "The item category type.", "type": "string", "enum": [ "DIGITAL_GOODS", "PHYSICAL_GOODS", "DONATION" ], "oneOf": [ { "type": "string", "enum": [ "DIGITAL_GOODS" ], "description": "Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product." }, { "type": "string", "enum": [ "PHYSICAL_GOODS" ], "description": "A tangible item that can be shipped with proof of delivery." }, { "type": "string", "enum": [ "DONATION" ], "description": "A contribution or gift for which no good or service is exchanged, usually to a not for profit organization." } ] }, "image_url": { "description": "The URL of the item's image. Supported image formats: JPEG (.jpg, .jpeg), PNG (.png), GIF (.gif).", "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "upc": { "allOf": [ { "$ref": "#/components/schemas/universal_product_code" }, { "description": "The Universal Product Code of the item." } ] }, "billing_plan": { "$ref": "#/components/schemas/order_billing_plan" } } }, "email_address": { "description": "The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the", "type": "string", "minLength": 3, "maxLength": 254, "pattern": "^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])$" }, "shipping_type": { "title": "shipping_type", "description": "A classification for the method of purchase fulfillment.", "type": "string", "enum": [ "SHIPPING", "PICKUP", "PICKUP_IN_STORE", "PICKUP_FROM_PERSON" ], "default": "SHIPPING", "oneOf": [ { "type": "string", "enum": [ "SHIPPING" ], "description": "The payer intends to receive the items at a specified address." }, { "type": "string", "enum": [ "PICKUP" ], "description": "DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). " }, { "type": "string", "enum": [ "PICKUP_IN_STORE" ], "description": "The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, \"Buy Online, Pick-up in Store\". Seller protection is provided with this option." }, { "type": "string", "enum": [ "PICKUP_FROM_PERSON" ], "description": "The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, \"Buy Online, Pick-up in Person\". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment." } ] }, "date_time": { "description": "The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: The regular expression provides guidance but does not reject all invalid dates.", "type": "string", "minLength": 20, "maxLength": 64, "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$" }, "shipping_option": { "title": "shipping_option", "description": "The options that the payee or merchant offers to the payer to ship or pick up their items.", "type": "object", "required": [ "id", "label", "selected" ], "properties": { "id": { "description": "A unique ID that identifies a payer-selected shipping option.", "type": "string", "minLength": 0, "maxLength": 127, "pattern": "^[\\S\\s]*$" }, "label": { "description": "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", "minLength": 0, "maxLength": 127, "pattern": "^[\\S\\s]*$" }, "type": { "allOf": [ { "$ref": "#/components/schemas/shipping_type" }, { "description": "A classification for the method of purchase fulfillment." } ] }, "amount": { "allOf": [ { "$ref": "#/components/schemas/money" }, { "description": "The shipping cost for the selected option." } ] }, "selected": { "description": "If the API request sets `selected = true`, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the `shipping.options` in the PayPal Checkout experience. As part of the response if a `shipping.option` contains `selected=true`, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one `shipping.option` can be set to `selected=true`.", "type": "boolean" } } }, "shipping_detail": { "title": "shipping_detail", "description": "The shipping details.", "type": "object", "properties": { "name": { "allOf": [ { "$ref": "#/components/schemas/name" }, { "description": "The name of the person to whom to ship the items. Supports only the `full_name` property.", "not": { "anyOf": [ { "required": [ "prefix" ] }, { "required": [ "given_name" ] }, { "required": [ "surname" ] }, { "required": [ "middle_name" ] }, { "required": [ "suffix" ] }, { "required": [ "alternate_full_name" ] } ] } } ] }, "email_address": { "allOf": [ { "$ref": "#/components/schemas/email_address" }, { "description": "The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery." } ] }, "phone_number": { "allOf": [ { "$ref": "#/components/schemas/phone" }, { "description": "The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international [E.164 numbering plan](https://www.itu.int/rec/T-REC-E.164/en)]", "not": { "required": [ "extension_number" ] } } ] }, "type": { "title": "Fulfillment Type", "description": "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.", "type": "string", "enum": [ "SHIPPING", "PICKUP_IN_PERSON", "PICKUP_IN_STORE", "PICKUP_FROM_PERSON" ], "default": "SHIPPING", "oneOf": [ { "type": "string", "enum": [ "SHIPPING" ], "description": "The payer intends to receive the items at a specified address." }, { "type": "string", "enum": [ "PICKUP_IN_PERSON" ], "description": "DEPRECATED. Please use \"PICKUP_FROM_PERSON\" instead." }, { "type": "string", "enum": [ "PICKUP_IN_STORE" ], "description": "The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, \"Buy Online, Pick-up in Store\". Seller protection is provided with this option." }, { "type": "string", "enum": [ "PICKUP_FROM_PERSON" ], "description": "The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, \"Buy Online, Pick-up in Person\". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment." } ] }, "options": { "description": "An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.", "type": "array", "minItems": 0, "maxItems": 30, "items": { "allOf": [ { "$ref": "#/components/schemas/shipping_option" }, { "title": "shipping_option", "description": "The option that the payee or merchant offers to the payer to ship or pick up their items." } ] } }, "address": { "allOf": [ { "$ref": "#/components/schemas/address_portable" }, { "description": "The address of the person to whom to ship the items. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. `admin_area_1` is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.", "not": { "anyOf": [ { "required": [ "address_line_3" ] }, { "required": [ "admin_area_3" ] }, { "required": [ "admin_area_4" ] }, { "required": [ "address_details" ] } ] } } ] } } }, "level_2_card_processing_data": { "title": "level_2", "description": "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.", "type": "object", "properties": { "invoice_id": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^[\\w‘\\-.,\":;\\!?]*$" }, "tax_total": { "allOf": [ { "$ref": "#/components/schemas/money" }, { "description": "Use this field to break down the amount of tax included in the total purchase amount. The value provided here will not add to the total purchase amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates. \n Value, by country, is:\n\n UK. A county.\n US. A state.\n Canada. A province.\n Japan. A prefecture.\n Switzerland. A kanton.\n" } ] } } }, "item_without_category_tax_or_amount": { "title": "item", "description": "The details for the items to be purchased.", "type": "object", "required": [ "name", "quantity" ], "properties": { "name": { "description": "The item name or title.", "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^[\\S\\s]*$" }, "quantity": { "description": "The item quantity. Must be a whole number.", "type": "string", "minLength": 0, "maxLength": 10, "pattern": "^[1-9][0-9]{0,9}$" }, "description": { "description": "The detailed item description.", "type": "string", "minLength": 0, "maxLength": 2048, "pattern": "^[\\S\\s]*$" }, "sku": { "description": "The stock keeping unit (SKU) for the item.", "type": "string", "minLength": 0, "maxLength": 127, "pattern": "^[\\S\\s]*$" }, "url": { "description": "The URL to the item being purchased. Visible to buyer and used in buyer experiences.", "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "image_url": { "description": "The URL of the item's image. Supported image formats: JPEG (.jpg, .jpeg), PNG (.png), GIF (.gif).", "type": "string", "minLength": 1, "maxLength": 2048, "format": "uri" }, "upc": { "allOf": [ { "$ref": "#/components/schemas/universal_product_code" }, { "description": "The Universal Product Code of the item." } ] }, "billing_plan": { "$ref": "#/components/schemas/order_billing_plan" } } }, "line_item": { "title": "line_item", "description": "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.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/item_without_category_tax_or_amount" }, { "type": "object", "properties": { "unit_amount": { "allOf": [ { "$ref": "#/components/schemas/money" }, { "description": "The item price or rate per unit. Must equal
unit_amount * quantity for all items. unit_amount.value can not be a negative number."
}
]
},
"tax": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The item tax for each unit. Must equal tax * quantity for all items. tax.value can not be a negative number."
}
]
},
"commodity_code": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 12,
"pattern": "^[a-zA-Z0-9_'.-]*$"
},
"discount_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative."
}
]
},
"total_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number."
}
]
},
"unit_of_measure": {
"description": "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).",
"type": "string",
"minLength": 1,
"maxLength": 12,
"pattern": "^[a-zA-Z0-9_'.-]*$"
}
}
}
]
},
"level_3_card_processing_data": {
"title": "level_3",
"description": "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.",
"type": "object",
"properties": {
"shipping_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "Use this field to break down the shipping cost included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative."
}
]
},
"duty_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "Use this field to break down the duty amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative."
}
]
},
"discount_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative."
}
]
},
"shipping_address": {
"allOf": [
{
"$ref": "#/components/schemas/address_portable"
},
{
"description": "The address of the person to whom to ship the items. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties.",
"not": {
"anyOf": [
{
"required": [
"address_line_3"
]
},
{
"required": [
"admin_area_3"
]
},
{
"required": [
"admin_area_4"
]
},
{
"required": [
"address_details"
]
}
]
}
}
]
},
"ships_from_postal_code": {
"description": "Use this field to specify the postal code of the shipping location.",
"type": "string",
"minLength": 1,
"maxLength": 60,
"pattern": "^[a-zA-Z0-9_'.-]*$"
},
"line_items": {
"description": "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.",
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/line_item"
},
{
"title": "line_item"
}
]
}
}
}
},
"card_supplementary_data": {
"title": "card_supplementary_data",
"description": "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.",
"type": "object",
"properties": {
"level_2": {
"$ref": "#/components/schemas/level_2_card_processing_data"
},
"level_3": {
"$ref": "#/components/schemas/level_3_card_processing_data"
}
}
},
"ip_address": {
"title": "IP Address",
"description": "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.",
"type": "string",
"minLength": 7,
"maxLength": 39,
"pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\\-]*[A-Za-z0-9])$|^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$"
},
"participant_metadata": {
"title": "participant_metadata",
"description": "Profile information of the sender or receiver.",
"type": "object",
"properties": {
"ip_address": {
"allOf": [
{
"$ref": "#/components/schemas/ip_address"
},
{
"description": "The consumer's IP address, which can be represented in either IPv4 or IPv6 format."
}
]
}
}
},
"risk_supplementary_data": {
"title": "risk_supplementary_data",
"description": "Additional information necessary to evaluate the risk profile of a transaction.",
"type": "object",
"properties": {
"customer": {
"$ref": "#/components/schemas/participant_metadata"
}
}
},
"supplementary_data": {
"title": "supplementary_data",
"description": "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.",
"type": "object",
"properties": {
"card": {
"allOf": [
{
"$ref": "#/components/schemas/card_supplementary_data"
},
{
"description": "Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout."
}
]
},
"risk": {
"allOf": [
{
"$ref": "#/components/schemas/risk_supplementary_data"
},
{
"description": "Merchants and partners can add additional customer parameters that can help with better fraud protection and reduced risk for unbranded card payments."
}
]
}
}
},
"purchase_unit_request": {
"title": "Purchase Unit Request",
"description": "The purchase unit request. Includes required information for the payment contract.",
"type": "object",
"required": [
"amount"
],
"properties": {
"reference_id": {
"description": "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`.",
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\S\\s]*$"
},
"amount": {
"allOf": [
{
"$ref": "#/components/schemas/amount_with_breakdown"
},
{
"description": "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.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.", "type": "string", "minLength": 1, "maxLength": 3000, "pattern": "^[\\S\\s]*$" }, "custom_id": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\S\\s]*$" }, "invoice_id": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^[\\S\\s]*$" }, "soft_descriptor": { "description": "
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.
PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptorNote: 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/editThe
PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement. PAYPAL *.Janes Gift.800-123-1234.PAYPAL * Janes Gift 80.",
"type": "string",
"minLength": 1,
"maxLength": 1000,
"pattern": "^[\\S\\s]*$"
},
"items": {
"description": "An array of items that the customer purchases from the merchant.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/item_request"
},
{
"title": "item",
"description": "The item."
}
]
}
},
"shipping": {
"allOf": [
{
"$ref": "#/components/schemas/shipping_detail"
},
{
"description": "The name and address of the person to whom to ship the items."
}
]
},
"supplementary_data": {
"allOf": [
{
"$ref": "#/components/schemas/supplementary_data"
},
{
"description": "Contains Supplementary Data."
}
]
}
}
},
"language": {
"description": "The [language tag](https://tools.ietf.org/html/bcp47#section-2) 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](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).",
"type": "string",
"minLength": 2,
"maxLength": 10,
"pattern": "^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$"
},
"url": {
"description": "Describes the URL.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"format": "uri"
},
"experience_context_base": {
"title": "experience_context_base",
"description": "Customizes the payer experience during the approval process for the payment.",
"type": "object",
"properties": {
"brand_name": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^.*$"
},
"locale": {
"allOf": [
{
"$ref": "#/components/schemas/language"
},
{
"description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`."
}
]
},
"shipping_preference": {
"description": "The location from which the shipping address is derived.",
"type": "string",
"enum": [
"GET_FROM_FILE",
"NO_SHIPPING",
"SET_PROVIDED_ADDRESS"
],
"default": "GET_FROM_FILE",
"oneOf": [
{
"type": "string",
"enum": [
"GET_FROM_FILE"
],
"description": "Get the customer-provided shipping address on the PayPal site."
},
{
"type": "string",
"enum": [
"NO_SHIPPING"
],
"description": "Redacts the shipping address from the PayPal site. Recommended for digital goods."
},
{
"type": "string",
"enum": [
"SET_PROVIDED_ADDRESS"
],
"description": "Merchant sends the shipping address using purchase_units.shipping.address. The customer cannot change this address on the PayPal site."
}
]
},
"return_url": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The URL where the customer is redirected after the customer approves the payment.",
"format": "uri"
}
]
},
"cancel_url": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The URL where the customer is redirected after the customer cancels the payment.",
"format": "uri"
}
]
}
}
},
"instrument_id": {
"description": "The identifier of the instrument.",
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z0-9-_.+=]+$"
},
"date_year_month": {
"description": "The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
"type": "string",
"minLength": 7,
"maxLength": 7,
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$"
},
"card_brand": {
"title": "card_brand",
"description": "The card network or brand. Applies to credit, debit, gift, and payment cards.",
"type": "string",
"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"
],
"oneOf": [
{
"type": "string",
"enum": [
"VISA"
],
"description": "Visa card."
},
{
"type": "string",
"enum": [
"MASTERCARD"
],
"description": "Mastercard card."
},
{
"type": "string",
"enum": [
"DISCOVER"
],
"description": "Discover card."
},
{
"type": "string",
"enum": [
"AMEX"
],
"description": "American Express card."
},
{
"type": "string",
"enum": [
"SOLO"
],
"description": "Solo debit card."
},
{
"type": "string",
"enum": [
"JCB"
],
"description": "Japan Credit Bureau card."
},
{
"type": "string",
"enum": [
"STAR"
],
"description": "Military Star card."
},
{
"type": "string",
"enum": [
"DELTA"
],
"description": "Delta Airlines card."
},
{
"type": "string",
"enum": [
"SWITCH"
],
"description": "Switch credit card."
},
{
"type": "string",
"enum": [
"MAESTRO"
],
"description": "Maestro credit card."
},
{
"type": "string",
"enum": [
"CB_NATIONALE"
],
"description": "Carte Bancaire (CB) credit card."
},
{
"type": "string",
"enum": [
"CONFIGOGA"
],
"description": "Configoga credit card."
},
{
"type": "string",
"enum": [
"CONFIDIS"
],
"description": "Confidis credit card."
},
{
"type": "string",
"enum": [
"ELECTRON"
],
"description": "Visa Electron credit card."
},
{
"type": "string",
"enum": [
"CETELEM"
],
"description": "Cetelem credit card."
},
{
"type": "string",
"enum": [
"CHINA_UNION_PAY"
],
"description": "China union pay credit card."
},
{
"type": "string",
"enum": [
"DINERS"
],
"description": "The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services."
},
{
"type": "string",
"enum": [
"ELO"
],
"description": "The Brazilian Elo card payment network."
},
{
"type": "string",
"enum": [
"HIPER"
],
"description": "The Hiper - Ingenico ePayment network."
},
{
"type": "string",
"enum": [
"HIPERCARD"
],
"description": "The Brazilian Hipercard payment network that's widely accepted in the retail market."
},
{
"type": "string",
"enum": [
"RUPAY"
],
"description": "The RuPay payment network."
},
{
"type": "string",
"enum": [
"GE"
],
"description": "The GE Credit Union 3Point card payment network."
},
{
"type": "string",
"enum": [
"SYNCHRONY"
],
"description": "The Synchrony Financial (SYF) payment network."
},
{
"type": "string",
"enum": [
"EFTPOS"
],
"description": "The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network."
},
{
"type": "string",
"enum": [
"CARTE_BANCAIRE"
],
"description": "The Carte Bancaire payment network."
},
{
"type": "string",
"enum": [
"STAR_ACCESS"
],
"description": "The Star Access payment network."
},
{
"type": "string",
"enum": [
"PULSE"
],
"description": "The Pulse payment network."
},
{
"type": "string",
"enum": [
"NYCE"
],
"description": "The NYCE payment network."
},
{
"type": "string",
"enum": [
"ACCEL"
],
"description": "The Accel payment network."
},
{
"type": "string",
"enum": [
"UNKNOWN"
],
"description": "UNKNOWN payment network."
}
]
},
"card_type": {
"title": "card_type",
"description": "Type of card. i.e Credit, Debit and so on.",
"type": "string",
"enum": [
"CREDIT",
"DEBIT",
"PREPAID",
"STORE",
"UNKNOWN"
],
"oneOf": [
{
"type": "string",
"enum": [
"CREDIT"
],
"description": "A credit card."
},
{
"type": "string",
"enum": [
"DEBIT"
],
"description": "A debit card."
},
{
"type": "string",
"enum": [
"PREPAID"
],
"description": "A Prepaid card."
},
{
"type": "string",
"enum": [
"STORE"
],
"description": "A store card."
},
{
"type": "string",
"enum": [
"UNKNOWN"
],
"description": "Card type cannot be determined."
}
]
},
"eci_flag": {
"description": "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.",
"type": "string",
"enum": [
"MASTERCARD_NON_3D_SECURE_TRANSACTION",
"MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION",
"MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION",
"FULLY_AUTHENTICATED_TRANSACTION",
"ATTEMPTED_AUTHENTICATION_TRANSACTION",
"NON_3D_SECURE_TRANSACTION"
],
"oneOf": [
{
"type": "string",
"enum": [
"MASTERCARD_NON_3D_SECURE_TRANSACTION"
],
"description": "Mastercard non-3-D Secure transaction."
},
{
"type": "string",
"enum": [
"MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION"
],
"description": "Mastercard attempted authentication transaction."
},
{
"type": "string",
"enum": [
"MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION"
],
"description": "Mastercard fully authenticated transaction."
},
{
"type": "string",
"enum": [
"FULLY_AUTHENTICATED_TRANSACTION"
],
"description": "VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction."
},
{
"type": "string",
"enum": [
"ATTEMPTED_AUTHENTICATION_TRANSACTION"
],
"description": "VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction."
},
{
"type": "string",
"enum": [
"NON_3D_SECURE_TRANSACTION"
],
"description": "VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction."
}
]
},
"enrolled": {
"description": "Status of Authentication eligibility.",
"type": "string",
"enum": [
"Y",
"N",
"U",
"B"
],
"oneOf": [
{
"type": "string",
"enum": [
"Y"
],
"description": "Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl."
},
{
"type": "string",
"enum": [
"N"
],
"description": "No. The bank is not participating in 3-D Secure protocol."
},
{
"type": "string",
"enum": [
"U"
],
"description": "Unavailable. The DS or ACS is not available for authentication at the time of the request."
},
{
"type": "string",
"enum": [
"B"
],
"description": "Bypass. The merchant authentication rule is triggered to bypass authentication."
}
]
},
"pares_status": {
"description": "Transactions status result identifier. The outcome of the issuer's authentication.",
"type": "string",
"enum": [
"Y",
"N",
"U",
"A",
"C",
"R",
"D",
"I"
],
"oneOf": [
{
"type": "string",
"enum": [
"Y"
],
"description": "Successful authentication."
},
{
"type": "string",
"enum": [
"N"
],
"description": "Failed authentication / account not verified / transaction denied."
},
{
"type": "string",
"enum": [
"U"
],
"description": "Unable to complete authentication."
},
{
"type": "string",
"enum": [
"A"
],
"description": "Successful attempts transaction."
},
{
"type": "string",
"enum": [
"C"
],
"description": "Challenge required for authentication."
},
{
"type": "string",
"enum": [
"R"
],
"description": "Authentication rejected (merchant must not submit for authorization)."
},
{
"type": "string",
"enum": [
"D"
],
"description": "Challenge required; decoupled authentication confirmed."
},
{
"type": "string",
"enum": [
"I"
],
"description": "Informational only; 3DS requestor challenge preference acknowledged."
}
]
},
"merchant_partner_customer_id": {
"title": "merchant_partner_customer_id",
"description": "The unique ID for a customer generated by PayPal.",
"type": "string",
"minLength": 1,
"maxLength": 22,
"pattern": "^[0-9a-zA-Z_-]+$"
},
"phone_number": {
"title": "Phone Number Format Including Country and National Code",
"description": "A structured representation of a phone number conforming to the international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en),including both country_code and national_number fields.",
"type": "object",
"required": [
"country_code",
"national_number"
],
"properties": {
"country_code": {
"title": "country_calling_code",
"description": "The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).",
"type": "string",
"minLength": 1,
"maxLength": 3,
"pattern": "^[0-9]{1,3}?$"
},
"national_number": {
"description": "The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).",
"type": "string",
"minLength": 1,
"maxLength": 14,
"pattern": "^[0-9]{1,14}?$"
}
}
},
"customer": {
"title": "customer",
"description": "This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.",
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/merchant_partner_customer_id"
},
"email_address": {
"allOf": [
{
"$ref": "#/components/schemas/email"
},
{
"description": "Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants."
}
]
},
"phone": {
"allOf": [
{
"$ref": "#/components/schemas/phone_with_type"
},
{
"description": "The phone number of the customer as provided to the merchant or on file with the merchant. The `phone.phone_number` supports only `national_number`."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/name"
},
{
"description": "The full name of the customer as provided to the merchant or on file with the merchant.",
"not": {
"anyOf": [
{
"required": [
"prefix"
]
},
{
"required": [
"middle_name"
]
},
{
"required": [
"suffix"
]
},
{
"required": [
"alternate_full_name"
]
},
{
"required": [
"full_name"
]
}
]
}
}
]
}
}
},
"card_customer": {
"title": "card_customer",
"description": "The details about a customer in PayPal's system of record.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"type": "object",
"properties": {
"merchant_customer_id": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[0-9a-zA-Z-_.^*$@#]+$"
}
}
}
]
},
"store_in_vault_instruction": {
"title": "store_in_vault_instruction",
"description": "Defines how and when the payment source gets vaulted.",
"type": "string",
"enum": [
"ON_SUCCESS"
],
"oneOf": [
{
"type": "string",
"enum": [
"ON_SUCCESS"
],
"description": "Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful."
}
]
},
"vault_instruction_base": {
"title": "vault_instruction_base",
"description": "Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.",
"type": "object",
"properties": {
"store_in_vault": {
"$ref": "#/components/schemas/store_in_vault_instruction"
}
}
},
"card_verification": {
"title": "Card Verification",
"description": "The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).",
"type": "object",
"properties": {
"method": {
"title": "card_verification",
"description": "The method used for card verification.",
"type": "string",
"enum": [
"SCA_ALWAYS",
"SCA_WHEN_REQUIRED",
"3D_SECURE",
"AVS_CVV"
],
"default": "SCA_WHEN_REQUIRED",
"oneOf": [
{
"type": "string",
"enum": [
"SCA_ALWAYS"
],
"description": "Selecting this option will attempt to force a strong customer authentication for the authorization/transaction. In countries where SCA has been defined and implemented it will result in a contingency and HATEOAS link being returned. The API caller should redirect the payer to that link so that they can authenticate themselves against their issuing bank or other entity. As noted, the HATEOAS link is only available in all regions where strong authentication is supported, (e.g. in European countries where 3DS is live). Merchants can use this setting as an additional layer of security if they choose to. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response."
},
{
"type": "string",
"enum": [
"SCA_WHEN_REQUIRED"
],
"description": "This is the default. When an authorization or transaction is attempted this option will return a contingency and HATEOAS link only when local regulations require strong customer authentication, (e.g. 3DS in countries and use cases where it is mandated). The API caller should redirect the payer to the link so that they can authenticate themselves. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response."
},
{
"type": "string",
"enum": [
"3D_SECURE"
],
"description": "The contingency surfaced as an additional security layer that helps prevent unauthorized card-not-present transactions and protects the merchant from exposure to fraud. DEPRECATED see SCA_ALWAYS."
},
{
"type": "string",
"enum": [
"AVS_CVV"
],
"description": "Places a temporary hold on the card to ensure its validity. This process protects the merchant from exposure to fraud. This verification method will confirm that the address information or CVV included matches what the issuing bank has on file for the associated card, ensuring that only authorized card users are able to make purchases from you. DEPRECATED see SCA_ALWAYS."
}
]
}
}
},
"card_attributes": {
"title": "card_attributes",
"description": "Additional attributes associated with the use of this card.",
"type": "object",
"properties": {
"customer": {
"$ref": "#/components/schemas/card_customer"
},
"vault": {
"allOf": [
{
"$ref": "#/components/schemas/vault_instruction_base"
},
{
"description": "Instruction to vault the card based on the specified strategy."
}
]
},
"verification": {
"allOf": [
{
"$ref": "#/components/schemas/card_verification"
},
{
"description": "Instruction to optionally verify the card based on the specified strategy."
}
]
}
}
},
"card": {
"title": "card",
"description": "The payment card to use to fund a payment. Can be a credit or debit card.",
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/instrument_id"
},
{
"description": "The PayPal-generated ID for the card.",
"readOnly": true
}
]
},
"name": {
"description": "The card holder's name as it appears on the card.",
"type": "string",
"minLength": 1,
"maxLength": 300,
"pattern": "^.{1,300}$"
},
"number": {
"description": "The primary account number (PAN) for the payment card.",
"type": "string",
"minLength": 13,
"maxLength": 19,
"pattern": "^[0-9]{13,19}$"
},
"expiry": {
"allOf": [
{
"$ref": "#/components/schemas/date_year_month"
},
{
"description": "The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6) For example: 2028-04"
}
]
},
"security_code": {
"description": "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`.",
"type": "string",
"minLength": 3,
"maxLength": 4,
"pattern": "^[0-9]{3,4}$"
},
"last_digits": {
"description": "The last digits of the payment card.",
"type": "string",
"minLength": 2,
"maxLength": 4,
"pattern": "^[0-9]{2,4}$",
"readOnly": true
},
"card_type": {
"allOf": [
{
"$ref": "#/components/schemas/card_brand"
},
{
"description": "The card brand or network. Typically used in the response. DEPRECATED| See |
|---|
| type |
Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.", "type": "object", "allOf": [ { "allOf": [ { "$ref": "#/components/schemas/card" }, { "not": { "anyOf": [ { "required": [ "id" ] }, { "required": [ "last_digits" ] }, { "required": [ "card_type" ] }, { "required": [ "type" ] }, { "required": [ "brand" ] } ] } } ] }, { "type": "object", "properties": { "vault_id": { "allOf": [ { "$ref": "#/components/schemas/vault_id" }, { "description": "The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server." } ] }, "single_use_token": { "allOf": [ { "$ref": "#/components/schemas/single_use_token" }, { "description": "The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing." } ] }, "stored_credential": { "$ref": "#/components/schemas/card_stored_credential" }, "network_token": { "allOf": [ { "$ref": "#/components/schemas/network_token_request" }, { "description": "A 3rd party network token refers to a network token that the merchant provisions from and vaults with an external TSP (Token Service Provider) other than PayPal." } ] }, "experience_context": { "allOf": [ { "$ref": "#/components/schemas/card_experience_context" }, {} ] } } } ] }, "token": { "title": "token", "description": "The tokenized payment source to fund a payment.", "type": "object", "required": [ "id", "type" ], "properties": { "id": { "description": "The PayPal-generated ID for the token.", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[0-9a-zA-Z_-]+$" }, "type": { "description": "The tokenization method that generated the ID.", "type": "string", "enum": [ "BILLING_AGREEMENT" ], "oneOf": [ { "type": "string", "enum": [ "BILLING_AGREEMENT" ], "description": "The PayPal billing agreement ID. References an approved recurring payment for goods or services." } ] } } }, "v3_vault_instruction_base": { "title": "v3_vault_instruction_base", "description": "Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.", "type": "object", "required": [ "store_in_vault" ], "properties": { "store_in_vault": { "$ref": "#/components/schemas/store_in_vault_instruction" } } }, "payee_payment_method_preference": { "title": "payee_payment_method_preference", "description": "The merchant-preferred payment methods.", "type": "string", "enum": [ "UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED" ], "default": "UNRESTRICTED", "oneOf": [ { "type": "string", "enum": [ "UNRESTRICTED" ], "description": "Accepts any type of payment from the customer." }, { "type": "string", "enum": [ "IMMEDIATE_PAYMENT_REQUIRED" ], "description": "Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status." } ] }, "paypal_wallet_customer": { "title": "paypal_wallet_customer", "description": "The details about a customer in PayPal's system of record.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/customer" }, { "type": "object", "properties": { "merchant_customer_id": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[0-9a-zA-Z-_.^*$@#]+$" } } } ] }, "account_id-2": { "description": "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.", "type": "string", "minLength": 13, "maxLength": 13, "pattern": "^[2-9A-HJ-NP-Z]{13}$" }, "vault_paypal_wallet_base": { "title": "vault_paypal_wallet_base", "description": "Resource consolidating common request and response attributes for vaulting PayPal Wallet.", "type": "object", "required": [ "usage_type" ], "allOf": [ { "$ref": "#/components/schemas/vault_instruction_base" }, { "type": "object", "properties": { "description": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\S\\s]*$" }, "usage_pattern": { "title": "PayPal Payment Token Usage Pattern", "description": "Expected business/pricing model for the billing agreement.", "type": "string", "enum": [ "IMMEDIATE", "DEFERRED", "RECURRING_PREPAID", "RECURRING_POSTPAID", "THRESHOLD_PREPAID", "THRESHOLD_POSTPAID", "SUBSCRIPTION_PREPAID", "SUBSCRIPTION_POSTPAID", "UNSCHEDULED_PREPAID", "UNSCHEDULED_POSTPAID", "INSTALLMENT_PREPAID", "INSTALLMENT_POSTPAID" ], "oneOf": [ { "type": "string", "enum": [ "IMMEDIATE" ], "description": "On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency." }, { "type": "string", "enum": [ "DEFERRED" ], "description": "Pay after use, non-recurring post-paid, variable amount, irregular frequency." }, { "type": "string", "enum": [ "RECURRING_PREPAID" ], "description": "Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered." }, { "type": "string", "enum": [ "RECURRING_POSTPAID" ], "description": "Pay on a fixed date based on usage or consumption after the goods/service is delivered." }, { "type": "string", "enum": [ "THRESHOLD_PREPAID" ], "description": "Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered." }, { "type": "string", "enum": [ "THRESHOLD_POSTPAID" ], "description": "Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered." }, { "type": "string", "enum": [ "SUBSCRIPTION_PREPAID" ], "description": "Subscription plan where the \"amount due\" and the \"billing frequency\" are fixed, and there is no defined duration with the payment due before the good/service is delivered." }, { "type": "string", "enum": [ "SUBSCRIPTION_POSTPAID" ], "description": "Subscription plan where the \"amount due\" and the \"billing frequency\" are fixed, and there is no defined duration with the payment due after the goods/services are delivered." }, { "type": "string", "enum": [ "UNSCHEDULED_PREPAID" ], "description": "Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but \"amount due\" and \"frequency\" can vary. Inclusive of automatic reload plans." }, { "type": "string", "enum": [ "UNSCHEDULED_POSTPAID" ], "description": "Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but \"amount due\" and \"frequency\" can vary. Inclusive of automatic reload plans." }, { "type": "string", "enum": [ "INSTALLMENT_PREPAID" ], "description": "Merchant-managed installment plan when the \"amount\" to be paid and the \"billing frequency\" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered." }, { "type": "string", "enum": [ "INSTALLMENT_POSTPAID" ], "description": "Merchant-managed installment plan when the \"amount\" to be paid and the \"billing frequency\" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered." } ] }, "shipping": { "allOf": [ { "$ref": "#/components/schemas/shipping_detail" }, { "description": "The shipping address for the Payer.", "not": { "required": [ "options" ] } } ] }, "usage_type": { "title": "PayPal Payment Token Usage Type", "description": "The usage type associated with the PayPal payment token.", "type": "string", "enum": [ "MERCHANT", "PLATFORM" ], "oneOf": [ { "type": "string", "enum": [ "MERCHANT" ], "description": "The PayPal Payment Token will be used for future transaction directly with a merchant." }, { "type": "string", "enum": [ "PLATFORM" ], "description": "The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants." } ] }, "customer_type": { "title": "PayPal Payment Token Customer Type", "description": "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.", "type": "string", "enum": [ "CONSUMER", "BUSINESS" ], "default": "CONSUMER", "oneOf": [ { "type": "string", "enum": [ "CONSUMER" ], "description": "The customer vaulting the PayPal payment token is a consumer on the merchant / platform." }, { "type": "string", "enum": [ "BUSINESS" ], "description": "The customer vaulting the PayPal payment token is a business on merchant / platform." } ] }, "permit_multiple_payment_tokens": { "description": "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.", "type": "boolean", "default": false } } } ] }, "charge_pattern": { "description": "Expected business/pricing model for the billing agreement.", "type": "string", "enum": [ "IMMEDIATE", "DEFERRED", "RECURRING_PREPAID", "RECURRING_POSTPAID", "THRESHOLD_PREPAID", "THRESHOLD_POSTPAID", "SUBSCRIPTION_PREPAID", "SUBSCRIPTION_POSTPAID", "UNSCHEDULED_PREPAID", "UNSCHEDULED_POSTPAID", "INSTALLMENT_PREPAID", "INSTALLMENT_POSTPAID" ], "oneOf": [ { "type": "string", "enum": [ "IMMEDIATE" ], "description": "On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency." }, { "type": "string", "enum": [ "DEFERRED" ], "description": "Pay after use, non-recurring post-paid, variable amount, irregular frequency." }, { "type": "string", "enum": [ "RECURRING_PREPAID" ], "description": "Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered." }, { "type": "string", "enum": [ "RECURRING_POSTPAID" ], "description": "Pay on a fixed date based on usage or consumption after the goods/service is delivered." }, { "type": "string", "enum": [ "THRESHOLD_PREPAID" ], "description": "Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered." }, { "type": "string", "enum": [ "THRESHOLD_POSTPAID" ], "description": "Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered." }, { "type": "string", "enum": [ "SUBSCRIPTION_PREPAID" ], "description": "Subscription plan where the \"amount due\" and the \"billing frequency\" are fixed, and there is no defined duration with the payment due before the good/service is delivered." }, { "type": "string", "enum": [ "SUBSCRIPTION_POSTPAID" ], "description": "Subscription plan where the \"amount due\" and the \"billing frequency\" are fixed, and there is no defined duration with the payment due after the goods/services are delivered." }, { "type": "string", "enum": [ "UNSCHEDULED_PREPAID" ], "description": "Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but \"amount due\" and \"frequency\" can vary. Inclusive of automatic reload plans." }, { "type": "string", "enum": [ "UNSCHEDULED_POSTPAID" ], "description": "Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but \"amount due\" and \"frequency\" can vary. Inclusive of automatic reload plans." }, { "type": "string", "enum": [ "INSTALLMENT_PREPAID" ], "description": "Merchant-managed installment plan when the \"amount\" to be paid and the \"billing frequency\" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered." }, { "type": "string", "enum": [ "INSTALLMENT_POSTPAID" ], "description": "Merchant-managed installment plan when the \"amount\" to be paid and the \"billing frequency\" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered." } ] }, "paypal_wallet_attributes": { "title": "paypal_wallet_attributes", "description": "Additional attributes associated with the use of this PayPal Wallet.", "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/paypal_wallet_customer" }, "vault": { "allOf": [ { "$ref": "#/components/schemas/vault_paypal_wallet_base" }, { "description": "Attributes used to provide the instructions during vaulting of the PayPal Wallet.", "not": { "required": [ "shipping" ] } } ] } } }, "native_app_context": { "title": "App Switch Preferences on Native App", "description": "Merchant provided, buyer's native app preferences to app switch to the PayPal consumer app.", "type": "object", "properties": { "return_app_url": { "allOf": [ { "$ref": "#/components/schemas/url" }, { "description": "The universal URL of the merchant's native app to which PayPal redirects the buyer after the buyer approves the payment." } ] }, "cancel_app_url": { "allOf": [ { "$ref": "#/components/schemas/url" }, { "description": "The universal URL of the merchant's native app to which PayPal redirects the buyer after the buyer cancels the payment." } ] }, "os_type": { "description": "Operating System type of the device that the buyer is using.", "type": "string", "enum": [ "ANDROID", "IOS", "OTHER" ], "oneOf": [ { "type": "string", "enum": [ "ANDROID" ], "description": "Google Android OS." }, { "type": "string", "enum": [ "IOS" ], "description": "Apple OS typically found in Apple mobile devices." }, { "type": "string", "enum": [ "OTHER" ], "description": "Any other OS type." } ] }, "os_version": { "description": "Operating System version of the device that the buyer is using.", "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^.*$" } } }, "mobile_web_context": { "title": "Mobile Web App Switch Context", "description": "Buyer's mobile web browser context to app switch to the PayPal consumer app.", "type": "object", "properties": { "return_flow": { "description": "Merchant preference on how the buyer can navigate back to merchant website post approving the transaction on the PayPal App.", "type": "string", "enum": [ "AUTO", "MANUAL" ], "default": "AUTO", "readOnly": true, "oneOf": [ { "type": "string", "enum": [ "AUTO" ], "description": "After payment approval in the PayPal App, buyer will automatically be redirected to the merchant website." }, { "type": "string", "enum": [ "MANUAL" ], "description": "After payment approval in the PayPal App, buyer will be asked to manually navigate back to the merchant website where they started the transaction from. The buyer is shown a message like 'Return to Merchant' to return to the source where the transaction actually started." } ] }, "buyer_user_agent": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 512, "pattern": "^.*$" } } }, "app_switch_context": { "title": "Merchant App Switch Details & Preferences", "description": "Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app.", "type": "object", "properties": { "native_app": { "$ref": "#/components/schemas/native_app_context" }, "mobile_web": { "$ref": "#/components/schemas/mobile_web_context" } } }, "billing_agreement_id": { "title": "billing_agreement_id", "description": "The PayPal billing agreement ID. References an approved recurring payment for goods or services.", "type": "string", "minLength": 2, "maxLength": 128, "pattern": "^[a-zA-Z0-9-]+$" }, "callback_configuration": { "title": "callback_configuration", "description": "CallBack Configuration that the merchant can provide to PayPal/Venmo.", "type": "object", "required": [ "callback_events", "callback_url" ], "properties": { "callback_events": { "description": "An array of callback events merchant can subscribe to for the corresponding callback url.", "type": "array", "minItems": 1, "maxItems": 5, "uniqueItems": true, "items": { "title": "callback events", "description": "CallBack event.", "type": "string", "enum": [ "SHIPPING_ADDRESS", "SHIPPING_OPTIONS" ], "oneOf": [ { "type": "string", "enum": [ "SHIPPING_ADDRESS" ], "description": "When Buyer changes or selects the shipping address on the PayPal/Venmo buyer approval flow , PayPal/Venmo will call merchant with the callback URL to update order totals." }, { "type": "string", "enum": [ "SHIPPING_OPTIONS" ], "description": "When Buyer changes or selects the shipping options on the PayPal/Venmo buyer approval flow , PayPal/Venmo will call merchant with the callback URL to update order totals." } ] } }, "callback_url": { "description": "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.", "type": "string", "minLength": 10, "maxLength": 2040, "format": "uri" } } }, "paypal_wallet_experience_context": { "title": "paypal_wallet_experience_context", "description": "Customizes the payer experience during the approval process for payment with PayPal.
*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*.
Note: Partners and Marketplaces might configure", "type": "object", "properties": { "brand_name": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^.*$" }, "locale": { "allOf": [ { "$ref": "#/components/schemas/language" }, { "description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`." } ] }, "shipping_preference": { "description": "The location from which the shipping address is derived.", "type": "string", "enum": [ "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS" ], "default": "GET_FROM_FILE", "oneOf": [ { "type": "string", "enum": [ "GET_FROM_FILE" ], "description": "Get the customer-provided shipping address on the PayPal site." }, { "type": "string", "enum": [ "NO_SHIPPING" ], "description": "Removes the shipping address information from the API response and the Paypal site. However, the shipping.phone_number and shipping.email_address fields will still be returned to allow for digital goods delivery." }, { "type": "string", "enum": [ "SET_PROVIDED_ADDRESS" ], "description": "Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages." } ] }, "contact_preference": { "description": "The preference to display the contact information (buyer’s shipping email & phone number) on PayPal's checkout for easy merchant-buyer communication.", "type": "string", "enum": [ "NO_CONTACT_INFO", "UPDATE_CONTACT_INFO", "RETAIN_CONTACT_INFO" ], "default": "NO_CONTACT_INFO", "oneOf": [ { "type": "string", "enum": [ "NO_CONTACT_INFO" ], "description": "The merchant can opt out of showing buyer's contact information on PayPal checkout." }, { "type": "string", "enum": [ "UPDATE_CONTACT_INFO" ], "description": "The merchant allows buyer to add or update shipping contact information on the PayPal checkout. Please ensure to use this updated information returned in shipping.email_address and shipping.phone_number to contact your buyers." }, { "type": "string", "enum": [ "RETAIN_CONTACT_INFO" ], "description": "The buyer can only see but can not override merchant passed contact information (shipping.email_address and shipping.phone_number) on PayPal checkout. NOTE: If you don't pass the contact information, the behavior is the same as NO_CONTACT_INFO preference." } ] }, "return_url": { "allOf": [ { "$ref": "#/components/schemas/url" }, { "description": "The URL where the customer will be redirected upon approving a payment.", "format": "uri" } ] }, "cancel_url": { "allOf": [ { "$ref": "#/components/schemas/url" }, { "description": "The URL where the customer will be redirected upon cancelling the payment approval.", "format": "uri" } ] }, "app_switch_context": { "allOf": [ { "$ref": "#/components/schemas/app_switch_context" }, { "description": "Merchants can use this to switch buyers from their website/application to the PayPal consumer app to review and approve the transaction." } ] }, "landing_page": { "description": "The type of landing page to show on the PayPal site for customer checkout.", "type": "string", "enum": [ "LOGIN", "GUEST_CHECKOUT", "NO_PREFERENCE", "BILLING" ], "default": "NO_PREFERENCE", "oneOf": [ { "type": "string", "enum": [ "LOGIN" ], "description": "When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment." }, { "type": "string", "enum": [ "GUEST_CHECKOUT" ], "description": "When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase. This option has previously been also called as 'BILLING'" }, { "type": "string", "enum": [ "NO_PREFERENCE" ], "description": "When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal." }, { "type": "string", "enum": [ "BILLING" ], "description": "DEPRECATED - please use GUEST_CHECKOUT. All implementations of 'BILLING' will be routed to 'GUEST_CHECKOUT'. When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase." } ] }, "user_action": { "description": "Configures a Continue or Pay Now checkout flow.", "type": "string", "enum": [ "CONTINUE", "PAY_NOW" ], "default": "CONTINUE", "oneOf": [ { "type": "string", "enum": [ "CONTINUE" ], "description": "After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment." }, { "type": "string", "enum": [ "PAY_NOW" ], "description": "After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now." } ] }, "payment_method_preference": { "description": "The merchant-preferred payment methods.", "type": "string", "enum": [ "UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED" ], "default": "UNRESTRICTED", "oneOf": [ { "type": "string", "enum": [ "UNRESTRICTED" ], "description": "Accepts any type of payment from the customer." }, { "type": "string", "enum": [ "IMMEDIATE_PAYMENT_REQUIRED" ], "description": "Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status." } ] }, "order_update_callback_config": { "allOf": [ { "$ref": "#/components/schemas/callback_configuration" }, { "description": "Merchant provided Order Update callback configuration for PayPal Wallet.PayPal will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when `shipping.type` is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'." } ] } } }, "paypal_wallet_stored_credential": { "title": "paypal_wallet_stored_credential", "description": "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.", "type": "object", "required": [ "payment_initiator" ], "properties": { "payment_initiator": { "$ref": "#/components/schemas/payment_initiator" }, "charge_pattern": { "allOf": [ { "$ref": "#/components/schemas/charge_pattern" }, { "description": "DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern instead. DEPRECATEDbrand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
| See |
|---|
| usage_pattern |
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.",
"type": "object",
"properties": {
"brand_name": {
"description": "The business name of the merchant. The pattern is defined by an external party and supports Unicode.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^.*$"
},
"shipping_preference": {
"description": "The location from which the shipping address is derived.",
"type": "string",
"enum": [
"GET_FROM_FILE",
"NO_SHIPPING",
"SET_PROVIDED_ADDRESS"
],
"default": "GET_FROM_FILE",
"oneOf": [
{
"type": "string",
"enum": [
"GET_FROM_FILE"
],
"description": "Get the customer-provided shipping address on the PayPal site."
},
{
"type": "string",
"enum": [
"NO_SHIPPING"
],
"description": "Redacts the shipping address from the PayPal site. Recommended for digital goods."
},
{
"type": "string",
"enum": [
"SET_PROVIDED_ADDRESS"
],
"description": "Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages."
}
]
},
"order_update_callback_config": {
"allOf": [
{
"$ref": "#/components/schemas/callback_configuration"
},
{
"description": "Merchant provided Order Update callback configuration for Venmo Wallet.Venmo will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when `shipping.type` is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'."
}
]
},
"user_action": {
"description": "Configures a Continue or Pay Now checkout flow.",
"type": "string",
"enum": [
"CONTINUE",
"PAY_NOW"
],
"default": "CONTINUE",
"oneOf": [
{
"type": "string",
"enum": [
"CONTINUE"
],
"description": "After you redirect the customer to the Venmo payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment."
},
{
"type": "string",
"enum": [
"PAY_NOW"
],
"description": "After you redirect the customer to the Venmo payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now."
}
]
}
}
},
"venmo_wallet_customer": {
"title": "venmo_wallet_customer",
"description": "This object represents a merchant’s customer, allowing them to store contact details, and track all payments associated with the same customer.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"type": "object"
}
]
},
"vault_venmo_wallet_base": {
"title": "vault_Venmo_wallet_base",
"description": "Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.",
"type": "object",
"required": [
"usage_type"
],
"allOf": [
{
"$ref": "#/components/schemas/v3_vault_instruction_base"
},
{
"type": "object",
"properties": {
"description": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-zA-Z0-9_'\\-., :;\\!?\"]*$"
},
"usage_pattern": {
"title": "Venmo Payment Token Usage Pattern",
"description": "Expected business/pricing model for the billing agreement.",
"type": "string",
"enum": [
"IMMEDIATE",
"DEFERRED",
"RECURRING_PREPAID",
"RECURRING_POSTPAID",
"THRESHOLD_PREPAID",
"THRESHOLD_POSTPAID"
],
"oneOf": [
{
"type": "string",
"enum": [
"IMMEDIATE"
],
"description": "On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency."
},
{
"type": "string",
"enum": [
"DEFERRED"
],
"description": "Pay after use, non-recurring post-paid, variable amount, irregular frequency."
},
{
"type": "string",
"enum": [
"RECURRING_PREPAID"
],
"description": "Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered."
},
{
"type": "string",
"enum": [
"RECURRING_POSTPAID"
],
"description": "Pay on a fixed date based on usage or consumption after the goods/service is delivered."
},
{
"type": "string",
"enum": [
"THRESHOLD_PREPAID"
],
"description": "Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered."
},
{
"type": "string",
"enum": [
"THRESHOLD_POSTPAID"
],
"description": "Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered."
}
]
},
"usage_type": {
"title": "Venmo Payment Token Usage Type",
"description": "The usage type associated with the Venmo payment token.",
"type": "string",
"enum": [
"MERCHANT",
"PLATFORM"
],
"oneOf": [
{
"type": "string",
"enum": [
"MERCHANT"
],
"description": "The Venmo Payment Token will be used for future transaction directly with a merchant."
},
{
"type": "string",
"enum": [
"PLATFORM"
],
"description": "The Venmo Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants."
}
]
},
"customer_type": {
"title": "Venmo Payment Token Customer Type",
"description": "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.",
"type": "string",
"enum": [
"CONSUMER",
"BUSINESS"
],
"default": "CONSUMER",
"oneOf": [
{
"type": "string",
"enum": [
"CONSUMER"
],
"description": "The customer vaulting the Venmo payment token is a consumer on the merchant / platform."
},
{
"type": "string",
"enum": [
"BUSINESS"
],
"description": "The customer vaulting the Venmo payment token is a business on merchant / platform."
}
]
},
"permit_multiple_payment_tokens": {
"description": "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.",
"type": "boolean",
"default": false
}
}
}
]
},
"venmo_wallet_attributes": {
"title": "venmo_wallet_attributes",
"description": "Additional attributes associated with the use of this Venmo Wallet.",
"type": "object",
"properties": {
"customer": {
"$ref": "#/components/schemas/venmo_wallet_customer"
},
"vault": {
"allOf": [
{
"$ref": "#/components/schemas/vault_venmo_wallet_base"
},
{
"description": "Attributes used to provide the instructions during vaulting of the Venmo Wallet."
}
]
}
}
},
"venmo_wallet_request": {
"title": "venmo_wallet_request",
"description": "Information needed to pay using Venmo.",
"type": "object",
"properties": {
"vault_id": {
"allOf": [
{
"$ref": "#/components/schemas/vault_id"
},
{
"description": "The PayPal-generated ID for the saved Venmo wallet payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions."
}
]
},
"email_address": {
"allOf": [
{
"$ref": "#/components/schemas/email"
},
{
"description": "The email address of the payer."
}
]
},
"experience_context": {
"$ref": "#/components/schemas/venmo_wallet_experience_context"
},
"attributes": {
"allOf": [
{
"$ref": "#/components/schemas/venmo_wallet_attributes"
},
{
"description": "Additional attributes associated with the use of this wallet."
}
]
}
}
},
"crypto_account_holder_name": {
"title": "crypto_account_holder_name",
"description": "Crypto account holder name.",
"type": "object",
"required": [
"given_name",
"surname"
],
"properties": {
"prefix": {
"description": "The prefix, or title, to the account holder's name.",
"type": "string",
"minLength": 1,
"maxLength": 140,
"pattern": "^[\\S\\s]*$"
},
"given_name": {
"description": "When the account holder is a person, the account holder's given, or first, name.",
"type": "string",
"minLength": 1,
"maxLength": 140,
"pattern": "^[\\S\\s]*$"
},
"surname": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 140,
"pattern": "^[\\S\\s]*$"
},
"middle_name": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 140,
"pattern": "^[\\S\\s]*$"
}
}
},
"experience_context_base_without_brand_shipping": {
"title": "experience_context_base",
"description": "Customizes the payer experience during the approval process for the payment.",
"type": "object",
"required": [
"cancel_url",
"return_url"
],
"properties": {
"locale": {
"allOf": [
{
"$ref": "#/components/schemas/language"
},
{
"description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`."
}
]
},
"return_url": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The URL where the customer is redirected after the customer approves the payment.",
"format": "uri"
}
]
},
"cancel_url": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The URL where the customer is redirected after the customer cancels the payment.",
"format": "uri"
}
]
}
}
},
"crypto_request": {
"title": "crypto_request",
"description": "Crypto payment used to fund the transaction.",
"type": "object",
"required": [
"country_code",
"experience_context",
"name"
],
"properties": {
"country_code": {
"allOf": [
{
"$ref": "#/components/schemas/country_code"
},
{
"description": "The two-character ISO 3166-1 purchase country code."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/crypto_account_holder_name"
},
{
"description": "The name of the account holder associated with Crypto wallet."
}
]
},
"experience_context": {
"allOf": [
{
"$ref": "#/components/schemas/experience_context_base_without_brand_shipping"
},
{
"description": "Customizes the payer experience during the approval process for the payment."
}
]
}
}
},
"payment_source": {
"title": "payment_source",
"description": "The payment source definition.",
"type": "object",
"properties": {
"card": {
"$ref": "#/components/schemas/card_request"
},
"token": {
"$ref": "#/components/schemas/token"
},
"paypal": {
"allOf": [
{
"$ref": "#/components/schemas/paypal_wallet"
},
{
"description": "Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting."
}
]
},
"bancontact": {
"allOf": [
{
"$ref": "#/components/schemas/bancontact_request"
},
{
"title": "bancontact",
"description": "Bancontact is the most popular online payment in Belgium. [More Details](https://www.bancontact.com/)."
}
]
},
"blik": {
"allOf": [
{
"$ref": "#/components/schemas/blik_request"
},
{
"title": "blik",
"description": "BLIK is a mobile payment system, created by Polish Payment Standard in order to allow millions of users to pay in shops, payout cash in ATMs and make online purchases and payments. [More Details](https://blikmobile.pl/)."
}
]
},
"eps": {
"allOf": [
{
"$ref": "#/components/schemas/eps_request"
},
{
"title": "eps",
"description": "The eps transfer is an online payment method developed by many Austrian banks. [More Details](https://www.eps-ueberweisung.at/)."
}
]
},
"giropay": {
"allOf": [
{
"$ref": "#/components/schemas/giropay_request"
},
{
"title": "giropay",
"description": "Giropay is an Internet payment System in Germany, based on online banking. [More Details](https://giropay.de/)."
}
]
},
"ideal": {
"allOf": [
{
"$ref": "#/components/schemas/ideal_request"
},
{
"title": "ideal",
"description": "The Dutch payment method iDEAL is an online payment method that enables consumers to pay online through their own bank. [More Details](https://www.ideal.nl/)."
}
]
},
"mybank": {
"allOf": [
{
"$ref": "#/components/schemas/mybank_request"
},
{
"title": "mybank",
"description": "MyBank is an e-authorisation solution which enables safe digital payments and identity authentication through a consumer’s own online banking portal or mobile application. [More Details](https://www.mybank.eu/)."
}
]
},
"p24": {
"allOf": [
{
"$ref": "#/components/schemas/p24_request"
},
{
"title": "p24",
"description": "P24 (Przelewy24) is a secure and fast online bank transfer service linked to all the major banks in Poland. [More Details](https://www.przelewy24.pl/)."
}
]
},
"sofort": {
"allOf": [
{
"$ref": "#/components/schemas/sofort_request"
},
{
"title": "sofort",
"description": "SOFORT Banking is a real-time bank transfer payment method that buyers use to transfer funds directly to merchants from their bank accounts. [More Details](https://www.klarna.com/sofort/)."
}
]
},
"trustly": {
"allOf": [
{
"$ref": "#/components/schemas/trustly_request"
},
{
"title": "trustly",
"description": "Trustly is a payment method that allows customers to shop and pay from their bank account. [More Details](https://www.trustly.net/)."
}
]
},
"apple_pay": {
"allOf": [
{
"$ref": "#/components/schemas/apple_pay_request"
},
{
"title": "applepay",
"description": "ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native."
}
]
},
"google_pay": {
"allOf": [
{
"$ref": "#/components/schemas/google_pay_request"
},
{
"title": "googlepay",
"description": "Google Pay payment source, allows buyer to pay using Google Pay."
}
]
},
"venmo": {
"allOf": [
{
"$ref": "#/components/schemas/venmo_wallet_request"
},
{
"title": "venmo",
"description": "Information needed to indicate that Venmo is being used to fund the payment."
}
]
},
"crypto": {
"allOf": [
{
"$ref": "#/components/schemas/crypto_request"
},
{
"title": "crypto",
"description": "Indicates that Crypto Wallet is the payment source."
}
]
}
}
},
"payment_method": {
"title": "payment_method",
"description": "The customer and merchant payment preferences.",
"type": "object",
"properties": {
"payee_preferred": {
"$ref": "#/components/schemas/payee_payment_method_preference"
},
"standard_entry_class_code": {
"description": "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.",
"type": "string",
"enum": [
"TEL",
"WEB",
"CCD",
"PPD"
],
"default": "WEB",
"oneOf": [
{
"type": "string",
"enum": [
"TEL"
],
"description": "The API caller (merchant/partner) accepts authorization and payment information from a consumer over the telephone."
},
{
"type": "string",
"enum": [
"WEB"
],
"description": "The API caller (merchant/partner) accepts Debit transactions from a consumer on their website."
},
{
"type": "string",
"enum": [
"CCD"
],
"description": "Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company transfers or invoice payments to suppliers)."
},
{
"type": "string",
"enum": [
"PPD"
],
"description": "Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account holder, and usually initiated by a company. These are usually recurring debits (such as insurance premiums)."
}
]
}
}
},
"stored_payment_source": {
"title": "stored_payment_source",
"description": "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).Note: Partners and Marketplaces might configure", "type": "object", "properties": { "brand_name": { "description": "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.", "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^[\\S\\s]*$" }, "locale": { "allOf": [ { "$ref": "#/components/schemas/language" }, { "description": "DEPRECATED. The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`. The fields in `application_context` are now available in the `experience_context` object under the `payment_source` which supports them (eg. `payment_source.paypal.experience_context.locale`). Please specify this field in the `experience_context` object instead of the `application_context` object." } ] }, "landing_page": { "title": "Order Application Context Landing Page", "description": "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. DEPRECATEDbrand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
| See | Since Version |
|---|---|
| payment_source.paypal.experience_context.landing_page | 2.9 |
| See | Since Version |
|---|---|
| payment_source.paypal.experience_context.shipping_preference | 2.9 |
| See | Since Version |
|---|---|
| payment_source.card.stored_credential | 2.9 |
| See | Since Version |
|---|---|
| payment_source.paypal | 2.9 |
unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number."
}
]
},
"tax": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number."
}
]
},
"quantity": {
"description": "The item quantity. Must be a whole number.",
"type": "string",
"minLength": 0,
"maxLength": 10,
"pattern": "^[1-9][0-9]{0,9}$"
},
"description": {
"description": "The detailed item description.",
"type": "string",
"minLength": 0,
"maxLength": 2048,
"pattern": "^[\\S\\s]*$"
},
"sku": {
"description": "The stock keeping unit (SKU) for the item.",
"type": "string",
"minLength": 0,
"maxLength": 127,
"pattern": "^[\\S\\s]*$"
},
"url": {
"description": "The URL to the item being purchased. Visible to buyer and used in buyer experiences.",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"format": "uri"
},
"category": {
"description": "The item category type.",
"type": "string",
"enum": [
"DIGITAL_GOODS",
"PHYSICAL_GOODS",
"DONATION"
],
"oneOf": [
{
"type": "string",
"enum": [
"DIGITAL_GOODS"
],
"description": "Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product."
},
{
"type": "string",
"enum": [
"PHYSICAL_GOODS"
],
"description": "A tangible item that can be shipped with proof of delivery."
},
{
"type": "string",
"enum": [
"DONATION"
],
"description": "A contribution or gift for which no good or service is exchanged, usually to a not for profit organization."
}
]
},
"image_url": {
"description": "The URL of the item's image. Supported image formats: JPEG (.jpg, .jpeg), PNG (.png), GIF (.gif).",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"format": "uri"
},
"upc": {
"allOf": [
{
"$ref": "#/components/schemas/universal_product_code"
},
{
"description": "The Universal Product Code of the item."
}
]
},
"billing_plan": {
"$ref": "#/components/schemas/order_billing_plan"
}
}
},
"tracker_status": {
"title": "Tracker Status",
"description": "The status of the item shipment.",
"type": "string",
"enum": [
"CANCELLED",
"SHIPPED"
],
"oneOf": [
{
"type": "string",
"enum": [
"CANCELLED"
],
"description": "The shipment was cancelled and the tracking number no longer applies."
},
{
"type": "string",
"enum": [
"SHIPPED"
],
"description": "The merchant has assigned a tracking number to the items being shipped from the Order. This does not correspond to the carrier's actual status for the shipment. The latest status of the parcel must be retrieved from the carrier."
}
]
},
"tracker_item": {
"title": "tracker_item",
"description": "The details of the items in the shipment.",
"type": "object",
"properties": {
"name": {
"description": "The item name or title.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^[\\S\\s]*$"
},
"quantity": {
"description": "The item quantity. Must be a whole number.",
"type": "string",
"minLength": 1,
"maxLength": 10,
"pattern": "^[1-9][0-9]{0,9}$"
},
"sku": {
"description": "The stock keeping unit (SKU) for the item. This can contain unicode characters.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^[\\S\\s]*$"
},
"url": {
"description": "The URL to the item being purchased. Visible to buyer and used in buyer experiences.",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"format": "uri"
},
"image_url": {
"description": "The URL of the item's image. Supported image formats: JPEG (.jpg, .jpeg), PNG (.png), GIF (.gif).",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"format": "uri"
},
"upc": {
"allOf": [
{
"$ref": "#/components/schemas/universal_product_code"
},
{
"description": "The Universal Product Code of the item."
}
]
}
}
},
"link_schema-2": {
"title": "Link Schema",
"description": "The request data or link target.",
"type": "object",
"properties": {
"additionalItems": {
"title": "additional_items",
"description": "Any additional items.",
"type": "object"
},
"dependencies": {
"title": "Dependencies",
"description": "Any Dependencies.",
"type": "object"
},
"items": {
"title": "Items",
"description": "An item.",
"type": "object"
},
"definitions": {
"title": "Definitions",
"description": "Definitions.",
"type": "object"
},
"patternProperties": {
"title": "pattern_properties",
"description": "The pattern properties.",
"type": "object"
},
"properties": {
"title": "Properties",
"description": "Properties.",
"type": "object"
},
"allOf": {
"title": "all_of",
"description": "An array of sub-schemas. The data must validate against all sub-schemas.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"title": "all_of_item",
"description": "A sub-schema against which the data must validate.",
"type": "object"
}
},
"anyOf": {
"title": "any_of",
"description": "An array of sub-schemas. The data must validate against one or more sub-schemas.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"title": "any_of_item",
"description": "A sub-schema against which the data must validate.",
"type": "object"
}
},
"oneOf": {
"title": "one_of",
"description": "An array of sub-schemas. The data must validate against one sub-schema.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"title": "one_of_item",
"description": "A sub-schema against which the data must validate.",
"type": "object"
}
},
"not": {
"title": "Not",
"description": "Not.",
"type": "object"
},
"links": {
"description": "An array of links.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"title": "link",
"description": "A link.",
"type": "object",
"readOnly": true
}
},
"fragmentResolution": {
"title": "fragment_resolution",
"description": "The fragment resolution.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
},
"media": {
"title": "Media",
"description": "The media type and context-encoding scheme.",
"type": "object",
"properties": {
"type": {
"description": "The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
},
"binaryEncoding": {
"title": "binary_encoding",
"description": "The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
}
}
},
"pathStart": {
"title": "path_start",
"description": "To apply this schema to the instances' URIs, start the URIs with this value.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"format": "uri"
}
}
},
"link_description-2": {
"title": "Link Description",
"description": "The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information.",
"type": "object",
"required": [
"href",
"rel"
],
"properties": {
"href": {
"description": "The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
},
"rel": {
"description": "The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
},
"method": {
"description": "The HTTP method required to make the related call.",
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"HEAD",
"CONNECT",
"OPTIONS",
"PATCH"
],
"oneOf": [
{
"type": "string",
"enum": [
"GET"
],
"description": "The HTTP GET method."
},
{
"type": "string",
"enum": [
"POST"
],
"description": "The HTTP POST method."
},
{
"type": "string",
"enum": [
"PUT"
],
"description": "The HTTP PUT method."
},
{
"type": "string",
"enum": [
"DELETE"
],
"description": "The HTTP DELETE method."
},
{
"type": "string",
"enum": [
"HEAD"
],
"description": "The HTTP HEAD method."
},
{
"type": "string",
"enum": [
"CONNECT"
],
"description": "The HTTP CONNECT method."
},
{
"type": "string",
"enum": [
"OPTIONS"
],
"description": "The HTTP OPTIONS method."
},
{
"type": "string",
"enum": [
"PATCH"
],
"description": "The HTTP PATCH method."
}
]
},
"title": {
"description": "The link title.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
},
"mediaType": {
"title": "media_type",
"description": "The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
},
"encType": {
"title": "enc_type",
"description": "The media type in which to submit the request data.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"default": "application/json"
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/link_schema-2"
},
{
"description": "The schema that describes the request data."
}
]
},
"targetSchema": {
"allOf": [
{
"$ref": "#/components/schemas/link_schema-2"
},
{
"title": "target_schema",
"description": "The schema that describes the link target."
}
]
}
}
},
"tracker": {
"title": "tracker",
"description": "The tracking response on creation of tracker.",
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"id": {
"description": "The tracker id.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"status": {
"$ref": "#/components/schemas/tracker_status"
},
"items": {
"description": "An array of details of items in the shipment.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/tracker_item"
},
{
"title": "tracker_item",
"description": "Items in a shipment."
}
]
}
},
"links": {
"description": "An array of request-related HATEOAS links.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/link_description-2"
},
{
"title": "link_description",
"description": "A request-related [HATEOAS link](/api/rest/responses/#hateoas-links)."
}
]
}
}
}
},
{
"$ref": "#/components/schemas/activity_timestamps"
}
]
},
"shipping_with_tracking_details": {
"title": "shipping_with_tracking_details",
"description": "The order shipping details.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shipping_detail"
},
{
"type": "object",
"properties": {
"phone_number": {
"allOf": [
{
"$ref": "#/components/schemas/phone_with_national_required_and_country_code"
},
{
"description": "The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.",
"not": {
"required": [
"extension_number"
]
}
}
]
},
"trackers": {
"description": "An array of trackers for a transaction.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"$ref": "#/components/schemas/tracker"
}
}
}
}
]
},
"authorization_status_details": {
"title": "authorization_status_details",
"description": "The details of the authorized payment status.",
"type": "object",
"properties": {
"reason": {
"title": "Authorization Incomplete Reason",
"description": "The reason why the authorized status is `PENDING`.",
"type": "string",
"enum": [
"PENDING_REVIEW",
"DECLINED_BY_RISK_FRAUD_FILTERS"
],
"oneOf": [
{
"type": "string",
"enum": [
"PENDING_REVIEW"
],
"description": "Authorization is pending manual review."
},
{
"type": "string",
"enum": [
"DECLINED_BY_RISK_FRAUD_FILTERS"
],
"description": "Risk Filter set by the payee failed for the transaction."
}
]
}
}
},
"authorization_status": {
"title": "authorization_status",
"description": "The status fields and status details for an authorized payment.",
"type": "object",
"properties": {
"status": {
"title": "Authorization Status",
"description": "The status for the authorized payment.",
"type": "string",
"enum": [
"CREATED",
"CAPTURED",
"DENIED",
"PARTIALLY_CAPTURED",
"VOIDED",
"PENDING"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"CREATED"
],
"description": "The authorized payment is created. No captured payments have been made for this authorized payment."
},
{
"type": "string",
"enum": [
"CAPTURED"
],
"description": "The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment."
},
{
"type": "string",
"enum": [
"DENIED"
],
"description": "PayPal cannot authorize funds for this authorized payment."
},
{
"type": "string",
"enum": [
"PARTIALLY_CAPTURED"
],
"description": "A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment."
},
{
"type": "string",
"enum": [
"VOIDED"
],
"description": "The authorized payment was voided. No more captured payments can be made against this authorized payment."
},
{
"type": "string",
"enum": [
"PENDING"
],
"description": "The created authorization is in pending state. For more information, see status.details."
}
]
},
"status_details": {
"allOf": [
{
"$ref": "#/components/schemas/authorization_status_details"
},
{
"description": "The details of the authorized order pending status.",
"readOnly": true
}
]
}
}
},
"seller_protection": {
"title": "seller_protection",
"description": "The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).",
"type": "object",
"properties": {
"status": {
"title": "Seller Protection Status",
"description": "Indicates whether the transaction is eligible for seller protection. For information, see [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).",
"type": "string",
"enum": [
"ELIGIBLE",
"PARTIALLY_ELIGIBLE",
"NOT_ELIGIBLE"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"ELIGIBLE"
],
"description": "Your PayPal balance remains intact if the customer claims that they did not receive an item or the account holder claims that they did not authorize the payment."
},
{
"type": "string",
"enum": [
"PARTIALLY_ELIGIBLE"
],
"description": "Your PayPal balance remains intact if the customer claims that they did not receive an item."
},
{
"type": "string",
"enum": [
"NOT_ELIGIBLE"
],
"description": "This transaction is not eligible for seller protection."
}
]
},
"dispute_categories": {
"description": "An array of conditions that are covered for the transaction.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"title": "dispute_category",
"description": "The condition that is covered for the transaction.",
"type": "string",
"enum": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
],
"oneOf": [
{
"type": "string",
"enum": [
"ITEM_NOT_RECEIVED"
],
"description": "The payer paid for an item that they did not receive."
},
{
"type": "string",
"enum": [
"UNAUTHORIZED_TRANSACTION"
],
"description": "The payer did not authorize the payment."
}
]
}
}
}
},
"authorization": {
"title": "authorization",
"description": "The authorized payment transaction.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/authorization_status"
},
{
"type": "object",
"properties": {
"id": {
"description": "The PayPal-generated ID for the authorized payment.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"amount": {
"allOf": [
{
"$ref": "#/components/schemas/amount_with_breakdown"
},
{
"description": "The amount for this authorized payment.",
"readOnly": true
}
]
},
"invoice_id": {
"description": "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.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"custom_id": {
"description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
"type": "string",
"minLength": 0,
"maxLength": 255,
"pattern": "^[\\S\\s]*$"
},
"network_transaction_reference": {
"allOf": [
{
"$ref": "#/components/schemas/network_transaction"
}
]
},
"seller_protection": {
"allOf": [
{
"$ref": "#/components/schemas/seller_protection"
},
{
"readOnly": true
}
]
},
"expiration_time": {
"allOf": [
{
"$ref": "#/components/schemas/date_time"
},
{
"description": "The date and time when the authorized payment expires, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
"readOnly": true
}
]
},
"links": {
"description": "An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/link_description-2"
},
{
"title": "link_description"
}
]
}
}
}
},
{
"$ref": "#/components/schemas/activity_timestamps"
}
]
},
"processor_response": {
"title": "processor_response",
"description": "The processor response information for payment requests, such as direct credit card transactions.",
"type": "object",
"properties": {
"avs_code": {
"description": "The address verification code for Visa, Discover, Mastercard, or American Express transactions.",
"type": "string",
"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"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"A"
],
"description": "For Visa, Mastercard, or Discover transactions, the address matches but the zip code does not match. For American Express transactions, the card holder address is correct."
},
{
"type": "string",
"enum": [
"B"
],
"description": "For Visa, Mastercard, or Discover transactions, the address matches. International A."
},
{
"type": "string",
"enum": [
"C"
],
"description": "For Visa, Mastercard, or Discover transactions, no values match. International N."
},
{
"type": "string",
"enum": [
"D"
],
"description": "For Visa, Mastercard, or Discover transactions, the address and postal code match. International X."
},
{
"type": "string",
"enum": [
"E"
],
"description": "For Visa, Mastercard, or Discover transactions, not allowed for Internet or phone transactions. For American Express card holder, the name is incorrect but the address and postal code match."
},
{
"type": "string",
"enum": [
"F"
],
"description": "For Visa, Mastercard, or Discover transactions, the address and postal code match. UK-specific X. For American Express card holder, the name is incorrect but the address matches."
},
{
"type": "string",
"enum": [
"G"
],
"description": "For Visa, Mastercard, or Discover transactions, global is unavailable. Nothing matches."
},
{
"type": "string",
"enum": [
"I"
],
"description": "For Visa, Mastercard, or Discover transactions, international is unavailable. Not applicable."
},
{
"type": "string",
"enum": [
"M"
],
"description": "For Visa, Mastercard, or Discover transactions, the address and postal code match. For American Express card holder, the name, address, and postal code match."
},
{
"type": "string",
"enum": [
"N"
],
"description": "For Visa, Mastercard, or Discover transactions, nothing matches. For American Express card holder, the address and postal code are both incorrect."
},
{
"type": "string",
"enum": [
"P"
],
"description": "For Visa, Mastercard, or Discover transactions, postal international Z. Postal code only."
},
{
"type": "string",
"enum": [
"R"
],
"description": "For Visa, Mastercard, or Discover transactions, re-try the request. For American Express, the system is unavailable."
},
{
"type": "string",
"enum": [
"S"
],
"description": "For Visa, Mastercard, Discover, or American Express, the service is not supported."
},
{
"type": "string",
"enum": [
"U"
],
"description": "For Visa, Mastercard, or Discover transactions, the service is unavailable. For American Express, information is not available. For Maestro, the address is not checked or the acquirer had no response. The service is not available."
},
{
"type": "string",
"enum": [
"W"
],
"description": "For Visa, Mastercard, or Discover transactions, whole ZIP code. For American Express, the card holder name, address, and postal code are all incorrect."
},
{
"type": "string",
"enum": [
"X"
],
"description": "For Visa, Mastercard, or Discover transactions, exact match of the address and the nine-digit ZIP code. For American Express, the card holder name, address, and postal code are all incorrect."
},
{
"type": "string",
"enum": [
"Y"
],
"description": "For Visa, Mastercard, or Discover transactions, the address and five-digit ZIP code match. For American Express, the card holder address and postal code are both correct."
},
{
"type": "string",
"enum": [
"Z"
],
"description": "For Visa, Mastercard, or Discover transactions, the five-digit ZIP code matches but no address. For American Express, only the card holder postal code is correct."
},
{
"type": "string",
"enum": [
"Null"
],
"description": "For Maestro, no AVS response was obtained."
},
{
"type": "string",
"enum": [
"0"
],
"description": "For Maestro, all address information matches."
},
{
"type": "string",
"enum": [
"1"
],
"description": "For Maestro, none of the address information matches."
},
{
"type": "string",
"enum": [
"2"
],
"description": "For Maestro, part of the address information matches."
},
{
"type": "string",
"enum": [
"3"
],
"description": "For Maestro, the merchant did not provide AVS information. It was not processed."
},
{
"type": "string",
"enum": [
"4"
],
"description": "For Maestro, the address was not checked or the acquirer had no response. The service is not available."
}
]
},
"cvv_code": {
"description": "The card verification value code for for Visa, Discover, Mastercard, or American Express.",
"type": "string",
"enum": [
"E",
"I",
"M",
"N",
"P",
"S",
"U",
"X",
"All others",
"0",
"1",
"2",
"3",
"4"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"E"
],
"description": "For Visa, Mastercard, Discover, or American Express, error - unrecognized or unknown response."
},
{
"type": "string",
"enum": [
"I"
],
"description": "For Visa, Mastercard, Discover, or American Express, invalid or null."
},
{
"type": "string",
"enum": [
"M"
],
"description": "For Visa, Mastercard, Discover, or American Express, the CVV2/CSC matches."
},
{
"type": "string",
"enum": [
"N"
],
"description": "For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does not match."
},
{
"type": "string",
"enum": [
"P"
],
"description": "For Visa, Mastercard, Discover, or American Express, it was not processed."
},
{
"type": "string",
"enum": [
"S"
],
"description": "For Visa, Mastercard, Discover, or American Express, the service is not supported."
},
{
"type": "string",
"enum": [
"U"
],
"description": "For Visa, Mastercard, Discover, or American Express, unknown - the issuer is not certified."
},
{
"type": "string",
"enum": [
"X"
],
"description": "For Visa, Mastercard, Discover, or American Express, no response. For Maestro, the service is not available."
},
{
"type": "string",
"enum": [
"All others"
],
"description": "For Visa, Mastercard, Discover, or American Express, error."
},
{
"type": "string",
"enum": [
"0"
],
"description": "For Maestro, the CVV2 matched."
},
{
"type": "string",
"enum": [
"1"
],
"description": "For Maestro, the CVV2 did not match."
},
{
"type": "string",
"enum": [
"2"
],
"description": "For Maestro, the merchant has not implemented CVV2 code handling."
},
{
"type": "string",
"enum": [
"3"
],
"description": "For Maestro, the merchant has indicated that CVV2 is not present on card."
},
{
"type": "string",
"enum": [
"4"
],
"description": "For Maestro, the service is not available."
}
]
},
"response_code": {
"description": "Processor response code for the non-PayPal payment processor errors.",
"type": "string",
"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"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"0000"
],
"description": "APPROVED."
},
{
"type": "string",
"enum": [
"00N7"
],
"description": "CVV2_FAILURE_POSSIBLE_RETRY_WITH_CVV."
},
{
"type": "string",
"enum": [
"0100"
],
"description": "REFERRAL."
},
{
"type": "string",
"enum": [
"0390"
],
"description": "ACCOUNT_NOT_FOUND."
},
{
"type": "string",
"enum": [
"0500"
],
"description": "DO_NOT_HONOR."
},
{
"type": "string",
"enum": [
"0580"
],
"description": "UNAUTHORIZED_TRANSACTION."
},
{
"type": "string",
"enum": [
"0800"
],
"description": "BAD_RESPONSE_REVERSAL_REQUIRED."
},
{
"type": "string",
"enum": [
"0880"
],
"description": "CRYPTOGRAPHIC_FAILURE."
},
{
"type": "string",
"enum": [
"0890"
],
"description": "UNACCEPTABLE_PIN."
},
{
"type": "string",
"enum": [
"0960"
],
"description": "SYSTEM_MALFUNCTION."
},
{
"type": "string",
"enum": [
"0R00"
],
"description": "CANCELLED_PAYMENT."
},
{
"type": "string",
"enum": [
"1000"
],
"description": "PARTIAL_AUTHORIZATION."
},
{
"type": "string",
"enum": [
"10BR"
],
"description": "ISSUER_REJECTED."
},
{
"type": "string",
"enum": [
"1300"
],
"description": "INVALID_DATA_FORMAT."
},
{
"type": "string",
"enum": [
"1310"
],
"description": "INVALID_AMOUNT."
},
{
"type": "string",
"enum": [
"1312"
],
"description": "INVALID_TRANSACTION_CARD_ISSUER_ACQUIRER."
},
{
"type": "string",
"enum": [
"1317"
],
"description": "INVALID_CAPTURE_DATE."
},
{
"type": "string",
"enum": [
"1320"
],
"description": "INVALID_CURRENCY_CODE."
},
{
"type": "string",
"enum": [
"1330"
],
"description": "INVALID_ACCOUNT."
},
{
"type": "string",
"enum": [
"1335"
],
"description": "INVALID_ACCOUNT_RECURRING."
},
{
"type": "string",
"enum": [
"1340"
],
"description": "INVALID_TERMINAL."
},
{
"type": "string",
"enum": [
"1350"
],
"description": "INVALID_MERCHANT."
},
{
"type": "string",
"enum": [
"1352"
],
"description": "RESTRICTED_OR_INACTIVE_ACCOUNT."
},
{
"type": "string",
"enum": [
"1360"
],
"description": "BAD_PROCESSING_CODE."
},
{
"type": "string",
"enum": [
"1370"
],
"description": "INVALID_MCC."
},
{
"type": "string",
"enum": [
"1380"
],
"description": "INVALID_EXPIRATION."
},
{
"type": "string",
"enum": [
"1382"
],
"description": "INVALID_CARD_VERIFICATION_VALUE."
},
{
"type": "string",
"enum": [
"1384"
],
"description": "INVALID_LIFE_CYCLE_OF_TRANSACTION."
},
{
"type": "string",
"enum": [
"1390"
],
"description": "INVALID_ORDER."
},
{
"type": "string",
"enum": [
"1393"
],
"description": "TRANSACTION_CANNOT_BE_COMPLETED."
},
{
"type": "string",
"enum": [
"5100"
],
"description": "GENERIC_DECLINE."
},
{
"type": "string",
"enum": [
"5110"
],
"description": "CVV2_FAILURE."
},
{
"type": "string",
"enum": [
"5120"
],
"description": "INSUFFICIENT_FUNDS."
},
{
"type": "string",
"enum": [
"5130"
],
"description": "INVALID_PIN."
},
{
"type": "string",
"enum": [
"5135"
],
"description": "DECLINED_PIN_TRY_EXCEEDED."
},
{
"type": "string",
"enum": [
"5140"
],
"description": "CARD_CLOSED."
},
{
"type": "string",
"enum": [
"5150"
],
"description": "PICKUP_CARD_SPECIAL_CONDITIONS. Try using another card. Do not retry the same card."
},
{
"type": "string",
"enum": [
"5160"
],
"description": "UNAUTHORIZED_USER."
},
{
"type": "string",
"enum": [
"5170"
],
"description": "AVS_FAILURE."
},
{
"type": "string",
"enum": [
"5180"
],
"description": "INVALID_OR_RESTRICTED_CARD. Try using another card. Do not retry the same card."
},
{
"type": "string",
"enum": [
"5190"
],
"description": "SOFT_AVS."
},
{
"type": "string",
"enum": [
"5200"
],
"description": "DUPLICATE_TRANSACTION."
},
{
"type": "string",
"enum": [
"5210"
],
"description": "INVALID_TRANSACTION."
},
{
"type": "string",
"enum": [
"5400"
],
"description": "EXPIRED_CARD."
},
{
"type": "string",
"enum": [
"5500"
],
"description": "INCORRECT_PIN_REENTER."
},
{
"type": "string",
"enum": [
"5650"
],
"description": "DECLINED_SCA_REQUIRED."
},
{
"type": "string",
"enum": [
"5700"
],
"description": "TRANSACTION_NOT_PERMITTED. Outside of scope of accepted business."
},
{
"type": "string",
"enum": [
"5710"
],
"description": "TX_ATTEMPTS_EXCEED_LIMIT."
},
{
"type": "string",
"enum": [
"5800"
],
"description": "REVERSAL_REJECTED."
},
{
"type": "string",
"enum": [
"5900"
],
"description": "INVALID_ISSUE."
},
{
"type": "string",
"enum": [
"5910"
],
"description": "ISSUER_NOT_AVAILABLE_NOT_RETRIABLE."
},
{
"type": "string",
"enum": [
"5920"
],
"description": "ISSUER_NOT_AVAILABLE_RETRIABLE."
},
{
"type": "string",
"enum": [
"5930"
],
"description": "CARD_NOT_ACTIVATED."
},
{
"type": "string",
"enum": [
"5950"
],
"description": "DECLINED_DUE_TO_UPDATED_ACCOUNT. External decline as an updated card has been issued."
},
{
"type": "string",
"enum": [
"6300"
],
"description": "ACCOUNT_NOT_ON_FILE."
},
{
"type": "string",
"enum": [
"7600"
],
"description": "APPROVED_NON_CAPTURE."
},
{
"type": "string",
"enum": [
"7700"
],
"description": "ERROR_3DS."
},
{
"type": "string",
"enum": [
"7710"
],
"description": "AUTHENTICATION_FAILED."
},
{
"type": "string",
"enum": [
"7800"
],
"description": "BIN_ERROR."
},
{
"type": "string",
"enum": [
"7900"
],
"description": "PIN_ERROR."
},
{
"type": "string",
"enum": [
"8000"
],
"description": "PROCESSOR_SYSTEM_ERROR."
},
{
"type": "string",
"enum": [
"8010"
],
"description": "HOST_KEY_ERROR."
},
{
"type": "string",
"enum": [
"8020"
],
"description": "CONFIGURATION_ERROR."
},
{
"type": "string",
"enum": [
"8030"
],
"description": "UNSUPPORTED_OPERATION."
},
{
"type": "string",
"enum": [
"8100"
],
"description": "FATAL_COMMUNICATION_ERROR."
},
{
"type": "string",
"enum": [
"8110"
],
"description": "RETRIABLE_COMMUNICATION_ERROR."
},
{
"type": "string",
"enum": [
"8220"
],
"description": "SYSTEM_UNAVAILABLE."
},
{
"type": "string",
"enum": [
"9100"
],
"description": "DECLINED_PLEASE_RETRY. Retry."
},
{
"type": "string",
"enum": [
"9500"
],
"description": "SUSPECTED_FRAUD. Try using another card. Do not retry the same card."
},
{
"type": "string",
"enum": [
"9510"
],
"description": "SECURITY_VIOLATION."
},
{
"type": "string",
"enum": [
"9520"
],
"description": "LOST_OR_STOLEN. Try using another card. Do not retry the same card."
},
{
"type": "string",
"enum": [
"9530"
],
"description": "HOLD_CALL_CENTER. The merchant must call the number on the back of the card. POS scenario."
},
{
"type": "string",
"enum": [
"9540"
],
"description": "REFUSED_CARD."
},
{
"type": "string",
"enum": [
"9600"
],
"description": "UNRECOGNIZED_RESPONSE_CODE."
},
{
"type": "string",
"enum": [
"PCNR"
],
"description": "CONTINGENCIES_NOT_RESOLVED."
},
{
"type": "string",
"enum": [
"PCVV"
],
"description": "CVV_FAILURE."
},
{
"type": "string",
"enum": [
"PP06"
],
"description": "ACCOUNT_CLOSED. A previously open account is now closed"
},
{
"type": "string",
"enum": [
"PPRN"
],
"description": "REATTEMPT_NOT_PERMITTED."
},
{
"type": "string",
"enum": [
"PPAD"
],
"description": "BILLING_ADDRESS."
},
{
"type": "string",
"enum": [
"PPAB"
],
"description": "ACCOUNT_BLOCKED_BY_ISSUER."
},
{
"type": "string",
"enum": [
"PPAE"
],
"description": "AMEX_DISABLED."
},
{
"type": "string",
"enum": [
"PPAG"
],
"description": "ADULT_GAMING_UNSUPPORTED."
},
{
"type": "string",
"enum": [
"PPAI"
],
"description": "AMOUNT_INCOMPATIBLE."
},
{
"type": "string",
"enum": [
"PPAR"
],
"description": "AUTH_RESULT."
},
{
"type": "string",
"enum": [
"PPAU"
],
"description": "MCC_CODE."
},
{
"type": "string",
"enum": [
"PPAV"
],
"description": "ARC_AVS."
},
{
"type": "string",
"enum": [
"PPAX"
],
"description": "AMOUNT_EXCEEDED."
},
{
"type": "string",
"enum": [
"PPBG"
],
"description": "BAD_GAMING."
},
{
"type": "string",
"enum": [
"PPC2"
],
"description": "ARC_CVV."
},
{
"type": "string",
"enum": [
"PPCE"
],
"description": "CE_REGISTRATION_INCOMPLETE."
},
{
"type": "string",
"enum": [
"PPCO"
],
"description": "COUNTRY."
},
{
"type": "string",
"enum": [
"PPCR"
],
"description": "CREDIT_ERROR."
},
{
"type": "string",
"enum": [
"PPCT"
],
"description": "CARD_TYPE_UNSUPPORTED."
},
{
"type": "string",
"enum": [
"PPCU"
],
"description": "CURRENCY_USED_INVALID."
},
{
"type": "string",
"enum": [
"PPD3"
],
"description": "SECURE_ERROR_3DS."
},
{
"type": "string",
"enum": [
"PPDC"
],
"description": "DCC_UNSUPPORTED."
},
{
"type": "string",
"enum": [
"PPDI"
],
"description": "DINERS_REJECT."
},
{
"type": "string",
"enum": [
"PPDV"
],
"description": "AUTH_MESSAGE."
},
{
"type": "string",
"enum": [
"PPDT"
],
"description": "DECLINE_THRESHOLD_BREACH."
},
{
"type": "string",
"enum": [
"PPEF"
],
"description": "EXPIRED_FUNDING_INSTRUMENT."
},
{
"type": "string",
"enum": [
"PPEL"
],
"description": "EXCEEDS_FREQUENCY_LIMIT."
},
{
"type": "string",
"enum": [
"PPER"
],
"description": "INTERNAL_SYSTEM_ERROR."
},
{
"type": "string",
"enum": [
"PPEX"
],
"description": "EXPIRY_DATE."
},
{
"type": "string",
"enum": [
"PPFE"
],
"description": "FUNDING_SOURCE_ALREADY_EXISTS."
},
{
"type": "string",
"enum": [
"PPFI"
],
"description": "INVALID_FUNDING_INSTRUMENT."
},
{
"type": "string",
"enum": [
"PPFR"
],
"description": "RESTRICTED_FUNDING_INSTRUMENT."
},
{
"type": "string",
"enum": [
"PPFV"
],
"description": "FIELD_VALIDATION_FAILED."
},
{
"type": "string",
"enum": [
"PPGR"
],
"description": "GAMING_REFUND_ERROR."
},
{
"type": "string",
"enum": [
"PPH1"
],
"description": "H1_ERROR."
},
{
"type": "string",
"enum": [
"PPIF"
],
"description": "IDEMPOTENCY_FAILURE."
},
{
"type": "string",
"enum": [
"PPII"
],
"description": "INVALID_INPUT_FAILURE."
},
{
"type": "string",
"enum": [
"PPIM"
],
"description": "ID_MISMATCH."
},
{
"type": "string",
"enum": [
"PPIT"
],
"description": "INVALID_TRACE_ID."
},
{
"type": "string",
"enum": [
"PPLR"
],
"description": "LATE_REVERSAL."
},
{
"type": "string",
"enum": [
"PPLS"
],
"description": "LARGE_STATUS_CODE."
},
{
"type": "string",
"enum": [
"PPMB"
],
"description": "MISSING_BUSINESS_RULE_OR_DATA."
},
{
"type": "string",
"enum": [
"PPMC"
],
"description": "BLOCKED_Mastercard."
},
{
"type": "string",
"enum": [
"PPMD"
],
"description": "DEPRECATED The PPMD value has been deprecated."
},
{
"type": "string",
"enum": [
"PPNC"
],
"description": "NOT_SUPPORTED_NRC."
},
{
"type": "string",
"enum": [
"PPNL"
],
"description": "EXCEEDS_NETWORK_FREQUENCY_LIMIT."
},
{
"type": "string",
"enum": [
"PPNM"
],
"description": "NO_MID_FOUND."
},
{
"type": "string",
"enum": [
"PPNT"
],
"description": "NETWORK_ERROR."
},
{
"type": "string",
"enum": [
"PPPH"
],
"description": "NO_PHONE_FOR_DCC_TRANSACTION."
},
{
"type": "string",
"enum": [
"PPPI"
],
"description": "INVALID_PRODUCT."
},
{
"type": "string",
"enum": [
"PPPM"
],
"description": "INVALID_PAYMENT_METHOD."
},
{
"type": "string",
"enum": [
"PPQC"
],
"description": "QUASI_CASH_UNSUPPORTED."
},
{
"type": "string",
"enum": [
"PPRE"
],
"description": "UNSUPPORT_REFUND_ON_PENDING_BC."
},
{
"type": "string",
"enum": [
"PPRF"
],
"description": "INVALID_PARENT_TRANSACTION_STATUS."
},
{
"type": "string",
"enum": [
"PPRR"
],
"description": "MERCHANT_NOT_REGISTERED."
},
{
"type": "string",
"enum": [
"PPS0"
],
"description": "BANKAUTH_ROW_MISMATCH."
},
{
"type": "string",
"enum": [
"PPS1"
],
"description": "BANKAUTH_ROW_SETTLED."
},
{
"type": "string",
"enum": [
"PPS2"
],
"description": "BANKAUTH_ROW_VOIDED."
},
{
"type": "string",
"enum": [
"PPS3"
],
"description": "BANKAUTH_EXPIRED."
},
{
"type": "string",
"enum": [
"PPS4"
],
"description": "CURRENCY_MISMATCH."
},
{
"type": "string",
"enum": [
"PPS5"
],
"description": "CREDITCARD_MISMATCH."
},
{
"type": "string",
"enum": [
"PPS6"
],
"description": "AMOUNT_MISMATCH."
},
{
"type": "string",
"enum": [
"PPSC"
],
"description": "ARC_SCORE."
},
{
"type": "string",
"enum": [
"PPSD"
],
"description": "STATUS_DESCRIPTION."
},
{
"type": "string",
"enum": [
"PPSE"
],
"description": "AMEX_DENIED."
},
{
"type": "string",
"enum": [
"PPTE"
],
"description": "VERIFICATION_TOKEN_EXPIRED."
},
{
"type": "string",
"enum": [
"PPTF"
],
"description": "INVALID_TRACE_REFERENCE."
},
{
"type": "string",
"enum": [
"PPTI"
],
"description": "INVALID_TRANSACTION_ID."
},
{
"type": "string",
"enum": [
"PPTR"
],
"description": "VERIFICATION_TOKEN_REVOKED."
},
{
"type": "string",
"enum": [
"PPTT"
],
"description": "TRANSACTION_TYPE_UNSUPPORTED."
},
{
"type": "string",
"enum": [
"PPTV"
],
"description": "INVALID_VERIFICATION_TOKEN."
},
{
"type": "string",
"enum": [
"PPUA"
],
"description": "USER_NOT_AUTHORIZED."
},
{
"type": "string",
"enum": [
"PPUC"
],
"description": "CURRENCY_CODE_UNSUPPORTED."
},
{
"type": "string",
"enum": [
"PPUE"
],
"description": "UNSUPPORT_ENTITY."
},
{
"type": "string",
"enum": [
"PPUI"
],
"description": "UNSUPPORT_INSTALLMENT."
},
{
"type": "string",
"enum": [
"PPUP"
],
"description": "UNSUPPORT_POS_FLAG."
},
{
"type": "string",
"enum": [
"PPUR"
],
"description": "UNSUPPORTED_REVERSAL."
},
{
"type": "string",
"enum": [
"PPVC"
],
"description": "VALIDATE_CURRENCY."
},
{
"type": "string",
"enum": [
"PPVE"
],
"description": "VALIDATION_ERROR."
},
{
"type": "string",
"enum": [
"PPVT"
],
"description": "VIRTUAL_TERMINAL_UNSUPPORTED."
}
]
},
"payment_advice_code": {
"description": "The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.",
"type": "string",
"enum": [
"01",
"02",
"03",
"04",
"21",
"22",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"40",
"43"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"01"
],
"description": "For Mastercard, expired card account upgrade or portfolio sale conversion. Obtain new account information before next billing cycle."
},
{
"type": "string",
"enum": [
"02"
],
"description": "For Mastercard, over credit limit or insufficient funds. Retry the transaction 72 hours later. For Visa, the card holder wants to stop only one specific payment in the recurring payment relationship. The merchant must NOT resubmit the same transaction. The merchant can continue the billing process in the subsequent billing period."
},
{
"type": "string",
"enum": [
"03"
],
"description": "For Mastercard, account closed as fraudulent. Obtain another type of payment from customer due to account being closed or fraud. Possible reason: Account closed as fraudulent. For Visa, the card holder wants to stop all recurring payment transactions for a specific merchant. Stop recurring payment requests."
},
{
"type": "string",
"enum": [
"04"
],
"description": "For Mastercard, token requirements not fulfilled for this token type."
},
{
"type": "string",
"enum": [
"21"
],
"description": "For Mastercard, the card holder has been unsuccessful at canceling recurring payment through merchant. Stop recurring payment requests. For Visa, all recurring payments were canceled for the card number requested. Stop recurring payment requests."
},
{
"type": "string",
"enum": [
"22"
],
"description": "For Mastercard, merchant does not qualify for product code."
},
{
"type": "string",
"enum": [
"24"
],
"description": "For Mastercard, retry after 1 hour."
},
{
"type": "string",
"enum": [
"25"
],
"description": "For Mastercard, retry after 24 hours."
},
{
"type": "string",
"enum": [
"26"
],
"description": "For Mastercard, retry after 2 days."
},
{
"type": "string",
"enum": [
"27"
],
"description": "For Mastercard, retry after 4 days."
},
{
"type": "string",
"enum": [
"28"
],
"description": "For Mastercard, retry after 6 days."
},
{
"type": "string",
"enum": [
"29"
],
"description": "For Mastercard, retry after 8 days."
},
{
"type": "string",
"enum": [
"30"
],
"description": "For Mastercard, retry after 10 days ."
},
{
"type": "string",
"enum": [
"40"
],
"description": "For Mastercard, consumer non-reloadable prepaid card."
},
{
"type": "string",
"enum": [
"43"
],
"description": "For Mastercard, consumer multi-use virtual card number."
}
]
}
}
},
"authorization_with_additional_data": {
"title": "authorization_with_additional_data",
"description": "The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/authorization"
},
{
"type": "object",
"properties": {
"processor_response": {
"allOf": [
{
"$ref": "#/components/schemas/processor_response"
},
{
"description": "The processor response for card transactions.",
"readOnly": true
}
]
}
}
}
]
},
"capture_status_details": {
"title": "capture_status_details",
"description": "The details of the captured payment status.",
"type": "object",
"properties": {
"reason": {
"title": "Capture Incomplete Reason",
"description": "The reason why the captured payment status is `PENDING` or `DENIED`.",
"type": "string",
"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"
],
"oneOf": [
{
"type": "string",
"enum": [
"BUYER_COMPLAINT"
],
"description": "The payer initiated a dispute for this captured payment with PayPal."
},
{
"type": "string",
"enum": [
"CHARGEBACK"
],
"description": "The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment."
},
{
"type": "string",
"enum": [
"ECHECK"
],
"description": "The payer paid by an eCheck that has not yet cleared."
},
{
"type": "string",
"enum": [
"INTERNATIONAL_WITHDRAWAL"
],
"description": "Visit your online account. In your **Account Overview**, accept and deny this payment."
},
{
"type": "string",
"enum": [
"OTHER"
],
"description": "No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal."
},
{
"type": "string",
"enum": [
"PENDING_REVIEW"
],
"description": "The captured payment is pending manual review."
},
{
"type": "string",
"enum": [
"RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION"
],
"description": "The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee."
},
{
"type": "string",
"enum": [
"REFUNDED"
],
"description": "The captured funds were refunded."
},
{
"type": "string",
"enum": [
"TRANSACTION_APPROVED_AWAITING_FUNDING"
],
"description": "The payer must send the funds for this captured payment. This code generally appears for manual EFTs."
},
{
"type": "string",
"enum": [
"UNILATERAL"
],
"description": "The payee does not have a PayPal account."
},
{
"type": "string",
"enum": [
"VERIFICATION_REQUIRED"
],
"description": "The payee's PayPal account is not verified."
},
{
"type": "string",
"enum": [
"DECLINED_BY_RISK_FRAUD_FILTERS"
],
"description": "Risk Filter set by the payee failed for the transaction."
}
]
}
}
},
"capture_status": {
"title": "capture_status",
"description": "The status and status details of a captured payment.",
"type": "object",
"properties": {
"status": {
"title": "Capture Status",
"description": "The status of the captured payment.",
"type": "string",
"enum": [
"COMPLETED",
"DECLINED",
"PARTIALLY_REFUNDED",
"PENDING",
"REFUNDED",
"FAILED"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"COMPLETED"
],
"description": "The funds for this captured payment were credited to the payee's PayPal account."
},
{
"type": "string",
"enum": [
"DECLINED"
],
"description": "The funds could not be captured."
},
{
"type": "string",
"enum": [
"PARTIALLY_REFUNDED"
],
"description": "An amount less than this captured payment's amount was partially refunded to the payer."
},
{
"type": "string",
"enum": [
"PENDING"
],
"description": "The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details."
},
{
"type": "string",
"enum": [
"REFUNDED"
],
"description": "An amount greater than or equal to this captured payment's amount was refunded to the payer."
},
{
"type": "string",
"enum": [
"FAILED"
],
"description": "There was an error while capturing payment."
}
]
},
"status_details": {
"allOf": [
{
"$ref": "#/components/schemas/capture_status_details"
},
{
"description": "The details of the captured payment status.",
"readOnly": true
}
]
}
}
},
"exchange_rate": {
"title": "exchange_rate",
"description": "The exchange rate that determines the amount to convert from one currency to another currency.",
"type": "object",
"readOnly": true,
"properties": {
"source_currency": {
"allOf": [
{
"$ref": "#/components/schemas/currency_code"
},
{
"description": "The source currency from which to convert an amount."
}
]
},
"target_currency": {
"allOf": [
{
"$ref": "#/components/schemas/currency_code"
},
{
"description": "The target currency to which to convert an amount."
}
]
},
"value": {
"description": "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.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
}
}
},
"seller_receivable_breakdown": {
"title": "Seller Receivable Breakdown",
"description": "The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.",
"type": "object",
"required": [
"gross_amount"
],
"properties": {
"gross_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The amount for this captured payment in the currency of the transaction."
}
]
},
"paypal_fee": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The applicable fee for this captured payment in the currency of the transaction."
}
]
},
"paypal_fee_in_receivable_currency": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The applicable fee for this captured payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example 'CNY'."
}
]
},
"net_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee minus the platform_fees."
}
]
},
"receivable_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. The amount is computed as net_amount times exchange_rate."
}
]
},
"exchange_rate": {
"allOf": [
{
"$ref": "#/components/schemas/exchange_rate"
},
{
"description": "The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds."
}
]
},
"platform_fees": {
"description": "An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.",
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/platform_fee"
},
{
"title": "platform_fee"
}
]
}
}
}
},
"capture": {
"title": "capture",
"description": "A captured payment.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/capture_status"
},
{
"type": "object",
"properties": {
"id": {
"description": "The PayPal-generated ID for the captured payment.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"amount": {
"allOf": [
{
"$ref": "#/components/schemas/amount_with_breakdown"
},
{
"description": "The amount for this captured payment.",
"readOnly": true
}
]
},
"invoice_id": {
"description": "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.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"custom_id": {
"description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
"type": "string",
"minLength": 0,
"maxLength": 255,
"pattern": "^[\\S\\s]*$"
},
"network_transaction_reference": {
"allOf": [
{
"$ref": "#/components/schemas/network_transaction"
}
]
},
"seller_protection": {
"allOf": [
{
"$ref": "#/components/schemas/seller_protection"
},
{
"readOnly": true
}
]
},
"final_capture": {
"description": "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.",
"type": "boolean",
"default": false,
"readOnly": true
},
"seller_receivable_breakdown": {
"allOf": [
{
"$ref": "#/components/schemas/seller_receivable_breakdown"
},
{
"readOnly": true
}
]
},
"disbursement_mode": {
"allOf": [
{
"$ref": "#/components/schemas/disbursement_mode"
}
]
},
"links": {
"description": "An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/link_description-2"
},
{
"title": "link_description"
}
]
}
},
"processor_response": {
"allOf": [
{
"$ref": "#/components/schemas/processor_response"
},
{
"description": "An object that provides additional processor information for a direct credit card transaction."
}
]
}
}
},
{
"allOf": [
{
"$ref": "#/components/schemas/activity_timestamps"
}
]
}
]
},
"refund_status_details": {
"title": "refund_status_details",
"description": "The details of the refund status.",
"type": "object",
"properties": {
"reason": {
"title": "Refund Incomplete Reason",
"description": "The reason why the refund has the `PENDING` or `FAILED` status.",
"type": "string",
"enum": [
"ECHECK"
],
"oneOf": [
{
"type": "string",
"enum": [
"ECHECK"
],
"description": "The customer's account is funded through an eCheck, which has not yet cleared."
}
]
}
}
},
"refund_status": {
"title": "refund_status",
"description": "The refund status with details.",
"type": "object",
"properties": {
"status": {
"title": "Refund Status With Details",
"description": "The status of the refund.",
"type": "string",
"enum": [
"CANCELLED",
"FAILED",
"PENDING",
"COMPLETED"
],
"readOnly": true,
"oneOf": [
{
"type": "string",
"enum": [
"CANCELLED"
],
"description": "The refund was cancelled."
},
{
"type": "string",
"enum": [
"FAILED"
],
"description": "The refund could not be processed."
},
{
"type": "string",
"enum": [
"PENDING"
],
"description": "The refund is pending. For more information, see status_details.reason."
},
{
"type": "string",
"enum": [
"COMPLETED"
],
"description": "The funds for this transaction were debited to the customer's account."
}
]
},
"status_details": {
"allOf": [
{
"$ref": "#/components/schemas/refund_status_details"
},
{
"description": "The details of the refund status.",
"readOnly": true
}
]
}
}
},
"service_fee_type": {
"title": "service_fee_type",
"description": "Any service fee that is associated with the transaction.",
"type": "string",
"enum": [
"DUTY_FEE"
],
"oneOf": [
{
"type": "string",
"enum": [
"DUTY_FEE"
],
"description": "The duty fee associated with Smart Duty features."
}
]
},
"service_fee": {
"title": "service_fee",
"description": "Any service fee that is associated with the transaction.",
"type": "object",
"properties": {
"amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The service fee amount for the transaction."
}
]
},
"service_fee_type": {
"allOf": [
{
"$ref": "#/components/schemas/service_fee_type"
},
{
"description": "The type of service fee."
}
]
},
"id": {
"description": "The service fee ID.",
"type": "string",
"minLength": 1,
"maxLength": 32,
"pattern": "^[A-Z0-9_]+$"
}
}
},
"net_amount_breakdown_item": {
"title": "net_amount_breakdown",
"description": "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.",
"type": "object",
"properties": {
"payable_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The net amount debited from the merchant's PayPal account.",
"readOnly": true
}
]
},
"converted_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The converted payable amount.",
"readOnly": true
}
]
},
"exchange_rate": {
"allOf": [
{
"$ref": "#/components/schemas/exchange_rate"
},
{
"description": "The exchange rate that determines the amount that was debited from the merchant's PayPal account.",
"readOnly": true
}
]
}
}
},
"buyer_context": {
"title": "Buyer Context",
"description": "The buyer context for the refund transaction.",
"type": "object",
"properties": {
"transaction_id": {
"description": "The PayPal generated transaction ID associated with the buyer's refund.",
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[0-9a-zA-Z_-]+$",
"readOnly": true
},
"transaction_details_url": {
"description": "The URL for the buyer to view the transaction details.",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"format": "uri",
"readOnly": true
},
"transaction_create_time": {
"allOf": [
{
"$ref": "#/components/schemas/date_time"
},
{
"description": "The date and time when the buyer's refund transaction was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
"readOnly": true
}
]
},
"transaction_update_time": {
"allOf": [
{
"$ref": "#/components/schemas/date_time"
},
{
"description": "The date and time when the buyer's refund transaction was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).",
"readOnly": true
}
]
}
}
},
"refund": {
"title": "refund",
"description": "The refund information.",
"type": "object",
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/refund_status"
}
]
},
{
"title": "Refund Properties",
"description": "The detailed properties of the refund transaction, including identifiers, amounts, breakdowns, and associated metadata.",
"type": "object",
"properties": {
"id": {
"description": "The PayPal-generated ID for the refund.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The amount that the payee refunded to the payer.",
"readOnly": true
}
]
},
"invoice_id": {
"description": "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.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"custom_id": {
"description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[A-Za-z0-9-_.,]*$"
},
"acquirer_reference_number": {
"description": "Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.",
"type": "string",
"minLength": 1,
"maxLength": 36,
"pattern": "^[a-zA-Z0-9]+$"
},
"note_to_payer": {
"description": "The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"seller_payable_breakdown": {
"title": "Seller Payable Breakdown",
"description": "The breakdown of the refund.",
"type": "object",
"readOnly": true,
"properties": {
"gross_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The amount that the payee refunded to the payer.",
"readOnly": true
}
]
},
"paypal_fee": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The PayPal fee that was refunded to the payer in the currency of the transaction. This fee might not match the PayPal fee that the payee paid when the payment was captured.",
"readOnly": true
}
]
},
"paypal_fee_in_receivable_currency": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The PayPal fee that was refunded to the payer in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.",
"readOnly": true
}
]
},
"net_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The net amount that the payee's account is debited in the transaction currency. The net amount is calculated as gross_amount minus paypal_fee minus platform_fees.",
"readOnly": true
}
]
},
"net_amount_in_receivable_currency": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The net amount that the payee's account is debited in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.",
"readOnly": true
}
]
},
"platform_fees": {
"description": "An array of platform or partner fees, commissions, or brokerage fees for the refund.",
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/platform_fee"
},
{
"title": "platform_fee"
}
]
}
},
"service_fees": {
"description": "This indicates the details of the portion of service fees refunded.",
"type": "array",
"minItems": 1,
"maxItems": 1,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/service_fee"
},
{
"title": "service_fee",
"not": {
"required": [
"id"
]
}
}
]
}
},
"net_amount_breakdown": {
"description": "An array of breakdown values for the net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the payee holds their funds.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/net_amount_breakdown_item"
},
{
"title": "net_amount_breakdown_item"
}
]
}
},
"total_refunded_amount": {
"allOf": [
{
"$ref": "#/components/schemas/money"
},
{
"description": "The total amount refunded from the original capture to date. For example, if a payer makes a $100 purchase and was refunded $20 a week ago and was refunded $30 in this refund, the `gross_amount` is $30 for this refund and the `total_refunded_amount` is $50."
}
]
}
}
},
"payer": {
"allOf": [
{
"$ref": "#/components/schemas/payee_base"
},
{
"description": "The details associated with the merchant for this transaction.",
"readOnly": true
}
]
},
"buyer_context": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_context"
},
{
"description": "The buyer context for the refund transaction.",
"readOnly": true
}
]
},
"links": {
"description": "An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/link_description-2"
},
{
"title": "link_description"
}
]
}
}
}
},
{
"allOf": [
{
"$ref": "#/components/schemas/activity_timestamps"
}
]
}
]
},
"payment_collection": {
"title": "Payment Collection",
"description": "The collection of payments, or transactions, for a purchase unit in an order. For example, authorized payments, captured payments, and refunds.",
"type": "object",
"properties": {
"authorizations": {
"description": "An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/authorization_with_additional_data"
},
{
"title": "authorizations",
"description": "The authorized payment for a purchase unit."
}
]
}
},
"captures": {
"description": "An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/capture"
},
{
"title": "capture",
"description": "The captured payment for a purchase unit."
}
]
}
},
"refunds": {
"description": "An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/refund"
},
{
"title": "refund",
"description": "A refund for a purchase unit."
}
]
}
}
}
},
"purchase_unit": {
"title": "Purchase Unit",
"description": "The purchase unit details. Used to capture required information for the payment contract.",
"type": "object",
"properties": {
"reference_id": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\S\\s]*$"
},
"amount": {
"$ref": "#/components/schemas/amount_with_breakdown"
},
"payee": {
"allOf": [
{
"$ref": "#/components/schemas/payee"
},
{
"description": "The merchant who receives payment for this transaction."
}
]
},
"payment_instruction": {
"$ref": "#/components/schemas/payment_instruction"
},
"description": {
"description": "The purchase description.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^[\\S\\s]*$"
},
"custom_id": {
"description": "The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.",
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[\\S\\s]*$"
},
"invoice_id": {
"description": "The API caller-provided external invoice ID for this order.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^[\\S\\s]*$"
},
"id": {
"description": "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.",
"type": "string",
"minLength": 1,
"maxLength": 19,
"pattern": "^[\\S\\s]*$"
},
"soft_descriptor": {
"description": "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.final_capture = true for all purchase units within the order."
},
{
"type": "string",
"enum": [
"APPROVED"
],
"description": "The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on."
},
{
"type": "string",
"enum": [
"VOIDED"
],
"description": "All purchase units in the order are voided."
},
{
"type": "string",
"enum": [
"COMPLETED"
],
"description": "The intent of the order was completed and a `payments` resource was created. Important: Check the payment status in `purchase_units[].payments.captures[].status` before fulfilling the order. A completed order can indicate a payment was authorized, an authorized payment was captured, or a payment was declined."
},
{
"type": "string",
"enum": [
"PAYER_ACTION_REQUIRED"
],
"description": "The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the \"rel\":\"payer-action\" HATEOAS link returned as part of the response prior to authorizing or capturing the order. Some payment sources may not return a payer-action HATEOAS link (eg. MB WAY). For these payment sources the payer-action is managed by the scheme itself (eg. through SMS, email, in-app notification, etc)."
}
]
},
"order": {
"title": "Order",
"description": "The order details.",
"type": "object",
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/activity_timestamps"
},
{
"title": "activity_timestamps"
}
]
},
{
"type": "object",
"title": "Order",
"description": "The order details.",
"properties": {
"id": {
"description": "The ID of the order.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"payment_source": {
"allOf": [
{
"$ref": "#/components/schemas/payment_source_response"
}
]
},
"intent": {
"allOf": [
{
"$ref": "#/components/schemas/checkout_payment_intent"
}
]
},
"processing_instruction": {
"$ref": "#/components/schemas/processing_instruction"
},
"payer": {
"allOf": [
{
"$ref": "#/components/schemas/payer"
},
{
"description": "DEPRECATED. The customer is also known as the payer. The Payer object was intended to only be used with the `payment_source.paypal` object. In order to make this design more clear, the details in the `payer` object are now available under `payment_source.paypal`. Please use `payment_source.paypal`. DEPRECATED| See | Since Version |
|---|---|
| payment_source.paypal | 2.9 |
value parameter defines the value to add. For more information, see 4.1. add."
},
{
"type": "string",
"enum": [
"remove"
],
"description": "Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove."
},
{
"type": "string",
"enum": [
"replace"
],
"description": "Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace."
},
{
"type": "string",
"enum": [
"move"
],
"description": "Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move."
},
{
"type": "string",
"enum": [
"copy"
],
"description": "Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy."
},
{
"type": "string",
"enum": [
"test"
],
"description": "Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:| Type | Considered equal if both values |
|---|---|
| strings | Contain the same number of Unicode characters and their code points are byte-by-byte equal. |
| numbers | Are numerically equal. |
| arrays | Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules. |
| objects | Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules). |
literals (false, true, and null) | Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant. |
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": {
"description": "The JSON Pointer to the target document location from which to move the value. Required for the move operation.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$"
}
}
},
"patch_request": {
"title": "Patch Request",
"description": "An array of JSON patch objects to apply partial updates to resources.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/patch"
},
{
"title": "patch"
}
]
}
},
"order_confirm_application_context": {
"title": "Order Confirm Application Context",
"description": "Customizes the payer confirmation experience.",
"type": "object",
"properties": {
"brand_name": {
"description": "Label to present to your payer as part of the PayPal hosted web experience.",
"type": "string",
"minLength": 1,
"maxLength": 127,
"pattern": "^[\\S\\s]*$"
},
"locale": {
"allOf": [
{
"$ref": "#/components/schemas/language"
},
{
"description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE`, `th-TH`, `zh-CN`, `zh-HK`, or `zh-TW`."
}
]
},
"return_url": {
"description": "The URL where the customer is redirected after the customer approves the payment.",
"type": "string",
"minLength": 10,
"maxLength": 4000,
"format": "uri"
},
"cancel_url": {
"description": "The URL where the customer is redirected after the customer cancels the payment.",
"type": "string",
"minLength": 10,
"maxLength": 4000,
"format": "uri"
},
"stored_payment_source": {
"$ref": "#/components/schemas/stored_payment_source"
}
}
},
"confirm_order_request": {
"title": "confirm_order_request",
"description": "Payer confirms the intent to pay for the Order using the provided payment source.",
"type": "object",
"required": [
"payment_source"
],
"properties": {
"payment_source": {
"$ref": "#/components/schemas/payment_source"
},
"processing_instruction": {
"$ref": "#/components/schemas/processing_instruction"
},
"application_context": {
"$ref": "#/components/schemas/order_confirm_application_context"
}
}
},
"order_authorize_request": {
"title": "Order Authorize Request",
"description": "The authorization of an order request.",
"type": "object",
"properties": {
"payment_source": {
"allOf": [
{
"$ref": "#/components/schemas/payment_source"
},
{
"description": "The source of payment for the order, which can be a token or a card. Use this object only if you have not redirected the user after order creation to approve the payment. In such cases, the user-selected payment method in the PayPal flow is implicitly used.",
"not": {
"anyOf": [
{
"required": [
"afterpay"
]
},
{
"required": [
"alipay"
]
},
{
"required": [
"bancomatpay"
]
},
{
"required": [
"bancontact"
]
},
{
"required": [
"blik"
]
},
{
"required": [
"blik_pay_later"
]
},
{
"required": [
"bizum"
]
},
{
"required": [
"boletobancario"
]
},
{
"required": [
"crypto"
]
},
{
"required": [
"dragonpay"
]
},
{
"required": [
"eps"
]
},
{
"required": [
"estonia_banks"
]
},
{
"required": [
"fiuu_cash"
]
},
{
"required": [
"floa_pay"
]
},
{
"required": [
"fpx"
]
},
{
"required": [
"giropay"
]
},
{
"required": [
"gopay"
]
},
{
"required": [
"grabpay"
]
},
{
"required": [
"ideal"
]
},
{
"required": [
"klarna"
]
},
{
"required": [
"latvia_banks"
]
},
{
"required": [
"lithuania_banks"
]
},
{
"required": [
"mbway"
]
},
{
"required": [
"multibanco"
]
},
{
"required": [
"mybank"
]
},
{
"required": [
"oxxo"
]
},
{
"required": [
"paysafecard"
]
},
{
"required": [
"paysera"
]
},
{
"required": [
"payu"
]
},
{
"required": [
"pay_upon_invoice"
]
},
{
"required": [
"pix_international"
]
},
{
"required": [
"p24"
]
},
{
"required": [
"safetypay"
]
},
{
"required": [
"satispay"
]
},
{
"required": [
"skrill"
]
},
{
"required": [
"scalapay"
]
},
{
"required": [
"swish"
]
},
{
"required": [
"sofort"
]
},
{
"required": [
"thailand_banks"
]
},
{
"required": [
"trustly"
]
},
{
"required": [
"verkkopankki"
]
},
{
"required": [
"wechatpay"
]
},
{
"required": [
"wero"
]
},
{
"required": [
"zip"
]
},
{
"required": [
"doku"
]
},
{
"required": [
"alfamart"
]
},
{
"required": [
"indomaret"
]
},
{
"required": [
"indonesia_banks"
]
},
{
"required": [
"jenius_pay"
]
},
{
"required": [
"kredivo"
]
},
{
"required": [
"linkaja"
]
},
{
"required": [
"ovo"
]
}
]
}
}
]
}
}
},
"order_authorize_response": {
"title": "Order Authorize Response",
"description": "The order authorize response.",
"type": "object",
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/activity_timestamps"
},
{
"title": "activity_timestamps"
}
]
},
{
"type": "object",
"title": "Order Authorize Response",
"description": "The order authorize response.",
"properties": {
"id": {
"description": "The ID of the order.",
"type": "string",
"minLength": 0,
"maxLength": 2147483647,
"pattern": "^[\\S\\s]*$",
"readOnly": true
},
"payment_source": {
"allOf": [
{
"$ref": "#/components/schemas/payment_source_response"
},
{
"not": {
"anyOf": [
{
"required": [
"alipay"
]
},
{
"required": [
"bancomatpay"
]
},
{
"required": [
"bancontact"
]
},
{
"required": [
"blik"
]
},
{
"required": [
"boletobancario"
]
},
{
"required": [
"eps"
]
},
{
"required": [
"giropay"
]
},
{
"required": [
"grabpay"
]
},
{
"required": [
"ideal"
]
},
{
"required": [
"mbway"
]
},
{
"required": [
"multibanco"
]
},
{
"required": [
"mybank"
]
},
{
"required": [
"oxxo"
]
},
{
"required": [
"payu"
]
},
{
"required": [
"pay_upon_invoice"
]
},
{
"required": [
"p24"
]
},
{
"required": [
"safetypay"
]
},
{
"required": [
"satispay"
]
},
{
"required": [
"swish"
]
},
{
"required": [
"sofort"
]
},
{
"required": [
"trustly"
]
},
{
"required": [
"verkkopankki"
]
},
{
"required": [
"wechatpay"
]
}
]
}
}
]
},
"intent": {
"allOf": [
{
"$ref": "#/components/schemas/checkout_payment_intent"
}
]
},
"processing_instruction": {
"$ref": "#/components/schemas/processing_instruction"
},
"payer": {
"allOf": [
{
"$ref": "#/components/schemas/payer"
}
]
},
"purchase_units": {
"description": "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.",
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/purchase_unit"
},
{
"title": "purchase_unit",
"description": "A purchase unit. Establishes a contract between a customer and merchant."
}
]
}
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/order_status"
},
{
"readOnly": true
}
]
},
"links": {
"description": "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.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"readOnly": true,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/link_description-2"
},
{
"title": "link_description",
"description": "A request-related [HATEOAS link](/api/rest/responses/#hateoas-links). To complete payer approval, use the `approve` link with the `GET` method."
}
]
}
}
}
}
]
},
"order_capture_request": {
"title": "Order Capture Request",
"description": "Completes an capture payment for an order.",
"type": "object",
"properties": {
"payment_source": {
"allOf": [
{
"$ref": "#/components/schemas/payment_source"
},
{
"not": {
"anyOf": [
{
"required": [
"afterpay"
]
},
{
"required": [
"bancontact"
]
},
{
"required": [
"blik"
]
},
{
"required": [
"bizum"
]
},
{
"required": [
"blik_pay_later"
]
},
{
"required": [
"crypto"
]
},
{
"required": [
"dragonpay"
]
},
{
"required": [
"eps"
]
},
{
"required": [
"estonia_banks"
]
},
{
"required": [
"fiuu_cash"
]
},
{
"required": [
"floa_pay"
]
},
{
"required": [
"fpx"
]
},
{
"required": [
"giropay"
]
},
{
"required": [
"gopay"
]
},
{
"required": [
"ideal"
]
},
{
"required": [
"klarna"
]
},
{
"required": [
"latvia_banks"
]
},
{
"required": [
"lithuania_banks"
]
},
{
"required": [
"mybank"
]
},
{
"required": [
"paysafecard"
]
},
{
"required": [
"pix_international"
]
},
{
"required": [
"p24"
]
},
{
"required": [
"skrill"
]
},
{
"required": [
"paysera"
]
},
{
"required": [
"scalapay"
]
},
{
"required": [
"sofort"
]
},
{
"required": [
"swish"
]
},
{
"required": [
"thailand_banks"
]
},
{
"required": [
"trustly"
]
},
{
"required": [
"wero"
]
},
{
"required": [
"zip"
]
},
{
"required": [
"doku"
]
},
{
"required": [
"alfamart"
]
},
{
"required": [
"indomaret"
]
},
{
"required": [
"indonesia_banks"
]
},
{
"required": [
"jenius_pay"
]
},
{
"required": [
"kredivo"
]
},
{
"required": [
"linkaja"
]
},
{
"required": [
"ovo"
]
}
]
}
}
]
}
}
},
"shipment_carrier": {
"title": "carrier",
"description": "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.",
"type": "string",
"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",
"PINAG",
"ONTIME",
"MOBELSERVICES",
"PAACK",
"URVAAM",
"SPX_PH",
"SPX_VN",
"STREAM",
"FIRSTLOGISTICS",
"WMGDELIVERY",
"EMILE",
"BFE_EXPRESS",
"CASTLERS",
"EMIRO",
"AMAZON_ES",
"SKYNETWORLDWIDE_IN",
"GOFOEXPRESS_IT",
"RUNFORINT",
"GOFOEXPRESS_FR",
"EASY_EXPRESS",
"AMAZON_MCF",
"THENILE",
"MGCARGO",
"TOOEXPRESS",
"ESPOIRER",
"MAXOPTRA",
"CHAMPAGNE_LOGISTICS",
"DRAGONSTARCURIER",
"GOFOEXPRESS_NL",
"PERI_LOGISTICS",
"SAMEDAY",
"VERTCHEZVOUS",
"ORLENPACZKA",
"RHENUS_CH",
"BESTFULFILLPACKET",
"PROCARRIER_RETURNS",
"BASIC_SHIPPING",
"PRECISION_DELIVERIES",
"OTHER"
],
"oneOf": [
{
"type": "string",
"enum": [
"DPD_RU"
],
"description": "DPD Russia."
},
{
"type": "string",
"enum": [
"BG_BULGARIAN_POST"
],
"description": "Bulgarian Posts."
},
{
"type": "string",
"enum": [
"KR_KOREA_POST"
],
"description": "Koreapost (www.koreapost.go.kr)."
},
{
"type": "string",
"enum": [
"ZA_COURIERIT"
],
"description": "Courier IT."
},
{
"type": "string",
"enum": [
"FR_EXAPAQ"
],
"description": "DPD France (formerly exapaq)."
},
{
"type": "string",
"enum": [
"ARE_EMIRATES_POST"
],
"description": "Emirates Post."
},
{
"type": "string",
"enum": [
"GAC"
],
"description": "GAC."
},
{
"type": "string",
"enum": [
"GEIS"
],
"description": "Geis CZ."
},
{
"type": "string",
"enum": [
"SF_EX"
],
"description": "SF Express."
},
{
"type": "string",
"enum": [
"PAGO"
],
"description": "Pago Logistics."
},
{
"type": "string",
"enum": [
"MYHERMES"
],
"description": "MyHermes UK."
},
{
"type": "string",
"enum": [
"DIAMOND_EUROGISTICS"
],
"description": "Diamond Eurogistics Limited."
},
{
"type": "string",
"enum": [
"CORPORATECOURIERS_WEBHOOK"
],
"description": "Corporate Couriers."
},
{
"type": "string",
"enum": [
"BOND"
],
"description": "Bond courier."
},
{
"type": "string",
"enum": [
"OMNIPARCEL"
],
"description": "Omni Parcel."
},
{
"type": "string",
"enum": [
"SK_POSTA"
],
"description": "Slovenska pošta."
},
{
"type": "string",
"enum": [
"PUROLATOR"
],
"description": "purolator."
},
{
"type": "string",
"enum": [
"FETCHR_WEBHOOK"
],
"description": "Mena 360 (Fetchr)."
},
{
"type": "string",
"enum": [
"THEDELIVERYGROUP"
],
"description": "TDG – The Delivery Group."
},
{
"type": "string",
"enum": [
"CELLO_SQUARE"
],
"description": "Cello Square."
},
{
"type": "string",
"enum": [
"TARRIVE"
],
"description": "TONDA GLOBAL."
},
{
"type": "string",
"enum": [
"COLLIVERY"
],
"description": "MDS Collivery Pty (Ltd)."
},
{
"type": "string",
"enum": [
"MAINFREIGHT"
],
"description": "Mainfreight."
},
{
"type": "string",
"enum": [
"IND_FIRSTFLIGHT"
],
"description": "First Flight Couriers."
},
{
"type": "string",
"enum": [
"ACSWORLDWIDE"
],
"description": "ACS Worldwide Express."
},
{
"type": "string",
"enum": [
"AMSTAN"
],
"description": "Amstan Logistics."
},
{
"type": "string",
"enum": [
"OKAYPARCEL"
],
"description": "OkayParcel."
},
{
"type": "string",
"enum": [
"ENVIALIA_REFERENCE"
],
"description": "Envialia Reference."
},
{
"type": "string",
"enum": [
"SEUR_ES"
],
"description": "Seur Spain."
},
{
"type": "string",
"enum": [
"CONTINENTAL"
],
"description": "Continental."
},
{
"type": "string",
"enum": [
"FDSEXPRESS"
],
"description": "FDSEXPRESS."
},
{
"type": "string",
"enum": [
"AMAZON_FBA_SWISHIP"
],
"description": "Swiship UK."
},
{
"type": "string",
"enum": [
"WYNGS"
],
"description": "Wyngs."
},
{
"type": "string",
"enum": [
"DHL_ACTIVE_TRACING"
],
"description": "DHL Active Tracing."
},
{
"type": "string",
"enum": [
"ZYLLEM"
],
"description": "Zyllem."
},
{
"type": "string",
"enum": [
"RUSTON"
],
"description": "Ruston."
},
{
"type": "string",
"enum": [
"XPOST"
],
"description": "Xpost.ph."
},
{
"type": "string",
"enum": [
"CORREOS_ES"
],
"description": "correos Express (www.correos.es)."
},
{
"type": "string",
"enum": [
"DHL_FR"
],
"description": "DHL France (www.dhl.com)."
},
{
"type": "string",
"enum": [
"PAN_ASIA"
],
"description": "Pan-Asia International."
},
{
"type": "string",
"enum": [
"BRT_IT"
],
"description": "BRT couriers Italy (www.brt.it)."
},
{
"type": "string",
"enum": [
"SRE_KOREA"
],
"description": "SRE Korea (www.srekorea.co.kr)."
},
{
"type": "string",
"enum": [
"SPEEDEE"
],
"description": "Spee-Dee Delivery."
},
{
"type": "string",
"enum": [
"TNT_UK"
],
"description": "TNT UK Limited (www.tnt.com)."
},
{
"type": "string",
"enum": [
"VENIPAK"
],
"description": "Venipak."
},
{
"type": "string",
"enum": [
"SHREENANDANCOURIER"
],
"description": "SHREE NANDAN COURIER."
},
{
"type": "string",
"enum": [
"CROSHOT"
],
"description": "Croshot."
},
{
"type": "string",
"enum": [
"NIPOST_NG"
],
"description": "NIpost (www.nipost.gov.ng)."
},
{
"type": "string",
"enum": [
"EPST_GLBL"
],
"description": "ePost Global."
},
{
"type": "string",
"enum": [
"NEWGISTICS"
],
"description": "Newgistics."
},
{
"type": "string",
"enum": [
"POST_SLOVENIA"
],
"description": "Post of Slovenia."
},
{
"type": "string",
"enum": [
"JERSEY_POST"
],
"description": "Jersey Post."
},
{
"type": "string",
"enum": [
"BOMBINOEXP"
],
"description": "Bombino Express Pvt."
},
{
"type": "string",
"enum": [
"WMG"
],
"description": "WMG Delivery."
},
{
"type": "string",
"enum": [
"XQ_EXPRESS"
],
"description": "XQ Express."
},
{
"type": "string",
"enum": [
"FURDECO"
],
"description": "Furdeco."
},
{
"type": "string",
"enum": [
"LHT_EXPRESS"
],
"description": "LHT Express."
},
{
"type": "string",
"enum": [
"SOUTH_AFRICAN_POST_OFFICE"
],
"description": "South African Post Office."
},
{
"type": "string",
"enum": [
"SPOTON"
],
"description": "SPOTON Logistics Pvt Ltd."
},
{
"type": "string",
"enum": [
"DIMERCO"
],
"description": "Dimerco Express Group."
},
{
"type": "string",
"enum": [
"CYPRUS_POST_CYP"
],
"description": "cyprus post."
},
{
"type": "string",
"enum": [
"ABCUSTOM"
],
"description": "AB Custom Group."
},
{
"type": "string",
"enum": [
"IND_DELIVREE"
],
"description": "deliverE."
},
{
"type": "string",
"enum": [
"CN_BESTEXPRESS"
],
"description": "Best Express."
},
{
"type": "string",
"enum": [
"DX_SFTP"
],
"description": "DX (SFTP)."
},
{
"type": "string",
"enum": [
"PICKUPP_MYS"
],
"description": "PICK UPP."
},
{
"type": "string",
"enum": [
"FMX"
],
"description": "FMX."
},
{
"type": "string",
"enum": [
"HELLMANN"
],
"description": "Hellmann Worldwide Logistics."
},
{
"type": "string",
"enum": [
"SHIP_IT_ASIA"
],
"description": "Ship It Asia."
},
{
"type": "string",
"enum": [
"KERRY_ECOMMERCE"
],
"description": "Kerry eCommerce."
},
{
"type": "string",
"enum": [
"FRETERAPIDO"
],
"description": "Frete Rapido."
},
{
"type": "string",
"enum": [
"PITNEY_BOWES"
],
"description": "Pitney Bowes."
},
{
"type": "string",
"enum": [
"XPRESSEN_DK"
],
"description": "Xpressen courier."
},
{
"type": "string",
"enum": [
"SEUR_SP_API"
],
"description": "Spanish Seur API."
},
{
"type": "string",
"enum": [
"DELIVERYONTIME"
],
"description": "DELIVERYONTIME LOGISTICS PVT LTD."
},
{
"type": "string",
"enum": [
"JINSUNG"
],
"description": "JINSUNG TRADING."
},
{
"type": "string",
"enum": [
"TRANS_KARGO"
],
"description": "Trans Kargo Internasional."
},
{
"type": "string",
"enum": [
"SWISHIP_DE"
],
"description": "Swiship DE."
},
{
"type": "string",
"enum": [
"IVOY_WEBHOOK"
],
"description": "Ivoy courier."
},
{
"type": "string",
"enum": [
"AIRMEE_WEBHOOK"
],
"description": "Airmee couriers."
},
{
"type": "string",
"enum": [
"DHL_BENELUX"
],
"description": "dhl benelux."
},
{
"type": "string",
"enum": [
"FIRSTMILE"
],
"description": "FirstMile."
},
{
"type": "string",
"enum": [
"FASTWAY_IR"
],
"description": "Fastway Ireland."
},
{
"type": "string",
"enum": [
"HH_EXP"
],
"description": "Hua Han Logistics."
},
{
"type": "string",
"enum": [
"MYS_MYPOST_ONLINE"
],
"description": "Mypostonline."
},
{
"type": "string",
"enum": [
"TNT_NL"
],
"description": "THT Netherland."
},
{
"type": "string",
"enum": [
"TIPSA"
],
"description": "TIPSA courier."
},
{
"type": "string",
"enum": [
"TAQBIN_MY"
],
"description": "TAQBIN Malaysia."
},
{
"type": "string",
"enum": [
"KGMHUB"
],
"description": "KGM Hub."
},
{
"type": "string",
"enum": [
"INTEXPRESS"
],
"description": "Internet Express."
},
{
"type": "string",
"enum": [
"OVERSE_EXP"
],
"description": "Overseas Express."
},
{
"type": "string",
"enum": [
"ONECLICK"
],
"description": "One click delivery services."
},
{
"type": "string",
"enum": [
"ROADRUNNER_FREIGHT"
],
"description": "Roadbull Logistics."
},
{
"type": "string",
"enum": [
"GLS_CROTIA"
],
"description": "GLS Croatia."
},
{
"type": "string",
"enum": [
"MRW_FTP"
],
"description": "MRW courier."
},
{
"type": "string",
"enum": [
"BLUEX"
],
"description": "Blue Express."
},
{
"type": "string",
"enum": [
"DYLT"
],
"description": "Daylight Transport."
},
{
"type": "string",
"enum": [
"DPD_IR"
],
"description": "DPD Ireland."
},
{
"type": "string",
"enum": [
"SIN_GLBL"
],
"description": "Sin Global Express."
},
{
"type": "string",
"enum": [
"TUFFNELLS_REFERENCE"
],
"description": "Tuffnells Parcels Express- Reference."
},
{
"type": "string",
"enum": [
"CJPACKET"
],
"description": "CJ Packet."
},
{
"type": "string",
"enum": [
"MILKMAN"
],
"description": "Milkman courier."
},
{
"type": "string",
"enum": [
"ASIGNA"
],
"description": "ASIGNA courier."
},
{
"type": "string",
"enum": [
"ONEWORLDEXPRESS"
],
"description": "One World Express."
},
{
"type": "string",
"enum": [
"ROYAL_MAIL"
],
"description": "RoyalShipments."
},
{
"type": "string",
"enum": [
"VIA_EXPRESS"
],
"description": "Viaxpress."
},
{
"type": "string",
"enum": [
"TIGFREIGHT"
],
"description": "TIG Freight."
},
{
"type": "string",
"enum": [
"ZTO_EXPRESS"
],
"description": "ZTO Express."
},
{
"type": "string",
"enum": [
"TWO_GO"
],
"description": "2GO Courier."
},
{
"type": "string",
"enum": [
"IML"
],
"description": "IML courier."
},
{
"type": "string",
"enum": [
"INTEL_VALLEY"
],
"description": "Intel-Valley Supply chain (ShenZhen) Co. Ltd."
},
{
"type": "string",
"enum": [
"EFS"
],
"description": "EFS (E-commerce Fulfillment Service)."
},
{
"type": "string",
"enum": [
"UK_UK_MAIL"
],
"description": "UK mail (ukmail.com)."
},
{
"type": "string",
"enum": [
"RAM"
],
"description": "RAM courier."
},
{
"type": "string",
"enum": [
"ALLIEDEXPRESS"
],
"description": "Allied Express."
},
{
"type": "string",
"enum": [
"APC_OVERNIGHT"
],
"description": "APC overnight (apc-overnight.com)."
},
{
"type": "string",
"enum": [
"SHIPPIT"
],
"description": "Shippit."
},
{
"type": "string",
"enum": [
"TFM"
],
"description": "TFM Xpress."
},
{
"type": "string",
"enum": [
"M_XPRESS"
],
"description": "M Xpress Sdn Bhd."
},
{
"type": "string",
"enum": [
"HDB_BOX"
],
"description": "Haidaibao (BOX)."
},
{
"type": "string",
"enum": [
"CLEVY_LINKS"
],
"description": "Clevy Links."
},
{
"type": "string",
"enum": [
"IBEONE"
],
"description": "Beone Logistics."
},
{
"type": "string",
"enum": [
"FIEGE_NL"
],
"description": "Fiege Netherlands."
},
{
"type": "string",
"enum": [
"KWE_GLOBAL"
],
"description": "KWE Global."
},
{
"type": "string",
"enum": [
"CTC_EXPRESS"
],
"description": "CTC Express."
},
{
"type": "string",
"enum": [
"AMAZON"
],
"description": "Amazon Shipping."
},
{
"type": "string",
"enum": [
"MORE_LINK"
],
"description": "Morelink."
},
{
"type": "string",
"enum": [
"JX"
],
"description": "JX courier."
},
{
"type": "string",
"enum": [
"EASY_MAIL"
],
"description": "Easy Mail."
},
{
"type": "string",
"enum": [
"ADUIEPYLE"
],
"description": "A Duie Pyle."
},
{
"type": "string",
"enum": [
"GB_PANTHER"
],
"description": "Panther."
},
{
"type": "string",
"enum": [
"EXPRESSSALE"
],
"description": "Expresssale."
},
{
"type": "string",
"enum": [
"SG_DETRACK"
],
"description": "Detrack."
},
{
"type": "string",
"enum": [
"TRUNKRS_WEBHOOK"
],
"description": "Trunkrs courier."
},
{
"type": "string",
"enum": [
"MATDESPATCH"
],
"description": "Matdespatch."
},
{
"type": "string",
"enum": [
"DICOM"
],
"description": "GLS Logistic Systems Canada Ltd./Dicom."
},
{
"type": "string",
"enum": [
"MBW"
],
"description": "MBW Courier Inc.."
},
{
"type": "string",
"enum": [
"KHM_CAMBODIA_POST"
],
"description": "Cambodia Post."
},
{
"type": "string",
"enum": [
"SINOTRANS"
],
"description": "Sinotrans."
},
{
"type": "string",
"enum": [
"BRT_IT_PARCELID"
],
"description": "BRT Bartolini(Parcel ID)."
},
{
"type": "string",
"enum": [
"DHL_SUPPLY_CHAIN"
],
"description": "DHL Supply Chain APAC."
},
{
"type": "string",
"enum": [
"DHL_PL"
],
"description": "DHL Poland."
},
{
"type": "string",
"enum": [
"TOPYOU"
],
"description": "TopYou."
},
{
"type": "string",
"enum": [
"PALEXPRESS"
],
"description": "PAL Express Limited."
},
{
"type": "string",
"enum": [
"DHL_SG"
],
"description": "dhl Singapore."
},
{
"type": "string",
"enum": [
"CN_WEDO"
],
"description": "WeDo Logistics."
},
{
"type": "string",
"enum": [
"FULFILLME"
],
"description": "Fulfillme."
},
{
"type": "string",
"enum": [
"DPD_DELISTRACK"
],
"description": "DPD delistrack."
},
{
"type": "string",
"enum": [
"UPS_REFERENCE"
],
"description": "UPS Reference."
},
{
"type": "string",
"enum": [
"CARIBOU"
],
"description": "Caribou."
},
{
"type": "string",
"enum": [
"LOCUS_WEBHOOK"
],
"description": "Locus courier."
},
{
"type": "string",
"enum": [
"DSV"
],
"description": "DSV courier."
},
{
"type": "string",
"enum": [
"P2P_TRC"
],
"description": "P2P TrakPak."
},
{
"type": "string",
"enum": [
"DIRECTPARCELS"
],
"description": "Direct Parcels."
},
{
"type": "string",
"enum": [
"NOVA_POSHTA_INT"
],
"description": "Nova Poshta (International)."
},
{
"type": "string",
"enum": [
"FEDEX_POLAND"
],
"description": "FedEx® Poland Domestic."
},
{
"type": "string",
"enum": [
"CN_JCEX"
],
"description": "JCEX courier."
},
{
"type": "string",
"enum": [
"FAR_INTERNATIONAL"
],
"description": "FAR international."
},
{
"type": "string",
"enum": [
"IDEXPRESS"
],
"description": "IDEX courier."
},
{
"type": "string",
"enum": [
"GANGBAO"
],
"description": "GANGBAO Supplychain."
},
{
"type": "string",
"enum": [
"NEWAY"
],
"description": "Neway Transport."
},
{
"type": "string",
"enum": [
"POSTNL_INT_3_S"
],
"description": "PostNL International."
},
{
"type": "string",
"enum": [
"RPX_ID"
],
"description": "RPX Indonesia."
},
{
"type": "string",
"enum": [
"DESIGNERTRANSPORT_WEBHOOK"
],
"description": "Designer Transport."
},
{
"type": "string",
"enum": [
"GLS_SLOVEN"
],
"description": "GLS Slovenia."
},
{
"type": "string",
"enum": [
"PARCELLED_IN"
],
"description": "Parcelled.in."
},
{
"type": "string",
"enum": [
"GSI_EXPRESS"
],
"description": "GSI EXPRESS."
},
{
"type": "string",
"enum": [
"CON_WAY"
],
"description": "Con-way Freight."
},
{
"type": "string",
"enum": [
"BROUWER_TRANSPORT"
],
"description": "Brouwer Transport en Logistiek."
},
{
"type": "string",
"enum": [
"CPEX"
],
"description": "Captain Express International."
},
{
"type": "string",
"enum": [
"ISRAEL_POST"
],
"description": "Israel Post."
},
{
"type": "string",
"enum": [
"DTDC_IN"
],
"description": "DTDC India."
},
{
"type": "string",
"enum": [
"PTT_POST"
],
"description": "PTT Post."
},
{
"type": "string",
"enum": [
"XDE_WEBHOOK"
],
"description": "Ximex Delivery Express."
},
{
"type": "string",
"enum": [
"TOLOS"
],
"description": "Tolos courier."
},
{
"type": "string",
"enum": [
"GIAO_HANG"
],
"description": "Giao hàng nhanh."
},
{
"type": "string",
"enum": [
"GEODIS_ESPACE"
],
"description": "Geodis E-space."
},
{
"type": "string",
"enum": [
"MAGYAR_HU"
],
"description": "Magyar Post."
},
{
"type": "string",
"enum": [
"DOORDASH_WEBHOOK"
],
"description": "DoorDash."
},
{
"type": "string",
"enum": [
"TIKI_ID"
],
"description": "Tiki shipment."
},
{
"type": "string",
"enum": [
"CJ_HK_INTERNATIONAL"
],
"description": "CJ Logistics International(Hong Kong)."
},
{
"type": "string",
"enum": [
"STAR_TRACK_EXPRESS"
],
"description": "Star Track Express."
},
{
"type": "string",
"enum": [
"HELTHJEM"
],
"description": "Helthjem."
},
{
"type": "string",
"enum": [
"SFB2C"
],
"description": "SF International."
},
{
"type": "string",
"enum": [
"FREIGHTQUOTE"
],
"description": "Freightquote by C.H. Robinson."
},
{
"type": "string",
"enum": [
"LANDMARK_GLOBAL_REFERENCE"
],
"description": "Landmark Global Reference."
},
{
"type": "string",
"enum": [
"PARCEL2GO"
],
"description": "Parcel2Go."
},
{
"type": "string",
"enum": [
"DELNEXT"
],
"description": "Delnext."
},
{
"type": "string",
"enum": [
"RCL"
],
"description": "Red Carpet Logistics."
},
{
"type": "string",
"enum": [
"CGS_EXPRESS"
],
"description": "CGS Express."
},
{
"type": "string",
"enum": [
"HK_POST"
],
"description": "Hongkong Post (www.hongkongpost.hk)."
},
{
"type": "string",
"enum": [
"SAP_EXPRESS"
],
"description": "SAP EXPRESS."
},
{
"type": "string",
"enum": [
"PARCELPOST_SG"
],
"description": "Parcel Post Singapore."
},
{
"type": "string",
"enum": [
"HERMES"
],
"description": "HermesWorld UK."
},
{
"type": "string",
"enum": [
"IND_SAFEEXPRESS"
],
"description": "Safexpress."
},
{
"type": "string",
"enum": [
"TOPHATTEREXPRESS"
],
"description": "Tophatter Express."
},
{
"type": "string",
"enum": [
"MGLOBAL"
],
"description": "PT MGLOBAL LOGISTICS INDONESIA."
},
{
"type": "string",
"enum": [
"AVERITT"
],
"description": "Averitt Express."
},
{
"type": "string",
"enum": [
"LEADER"
],
"description": "leader."
},
{
"type": "string",
"enum": [
"_2EBOX"
],
"description": "2ebox courier."
},
{
"type": "string",
"enum": [
"SG_SPEEDPOST"
],
"description": "Singapore Speedpost."
},
{
"type": "string",
"enum": [
"DBSCHENKER_SE"
],
"description": "DB Schenker (www.dbschenker.com)."
},
{
"type": "string",
"enum": [
"ISR_POST_DOMESTIC"
],
"description": "Israel Post Domestic."
},
{
"type": "string",
"enum": [
"BESTWAYPARCEL"
],
"description": "Best Way Parcel."
},
{
"type": "string",
"enum": [
"ASENDIA_DE"
],
"description": "asendia_de."
},
{
"type": "string",
"enum": [
"NIGHTLINE_UK"
],
"description": "nightline_uk."
},
{
"type": "string",
"enum": [
"TAQBIN_SG"
],
"description": "taqbin_sg."
},
{
"type": "string",
"enum": [
"TCK_EXPRESS"
],
"description": "TCK Express."
},
{
"type": "string",
"enum": [
"ENDEAVOUR_DELIVERY"
],
"description": "Endeavour Delivery."
},
{
"type": "string",
"enum": [
"NANJINGWOYUAN"
],
"description": "Nanjing Woyuan."
},
{
"type": "string",
"enum": [
"HEPPNER_FR"
],
"description": "Heppner France."
},
{
"type": "string",
"enum": [
"EMPS_CN"
],
"description": "EMPS Express."
},
{
"type": "string",
"enum": [
"FONSEN"
],
"description": "Fonsen Logistics."
},
{
"type": "string",
"enum": [
"PICKRR"
],
"description": "Pickrr."
},
{
"type": "string",
"enum": [
"APC_OVERNIGHT_CONNUM"
],
"description": "APC Overnight Consignment."
},
{
"type": "string",
"enum": [
"STAR_TRACK_NEXT_FLIGHT"
],
"description": "Star Track Next Flight."
},
{
"type": "string",
"enum": [
"DAJIN"
],
"description": "Shanghai Aqrum Chemical Logistics Co.Ltd."
},
{
"type": "string",
"enum": [
"UPS_FREIGHT"
],
"description": "UPS Freight."
},
{
"type": "string",
"enum": [
"POSTA_PLUS"
],
"description": "Posta Plus."
},
{
"type": "string",
"enum": [
"CEVA"
],
"description": "CEVA LOGISTICS."
},
{
"type": "string",
"enum": [
"ANSERX"
],
"description": "ANSERX courier."
},
{
"type": "string",
"enum": [
"JS_EXPRESS"
],
"description": "JS EXPRESS."
},
{
"type": "string",
"enum": [
"PADTF"
],
"description": "padtf.com."
},
{
"type": "string",
"enum": [
"UPS_MAIL_INNOVATIONS"
],
"description": "UPS Mail Innovations."
},
{
"type": "string",
"enum": [
"SYPOST"
],
"description": "Sunyou Post."
},
{
"type": "string",
"enum": [
"AMAZON_SHIP_MCF"
],
"description": "Amazon Shipping + Amazon MCF."
},
{
"type": "string",
"enum": [
"YUSEN"
],
"description": "Yusen Logistics."
},
{
"type": "string",
"enum": [
"BRING"
],
"description": "Bring."
},
{
"type": "string",
"enum": [
"SDA_IT"
],
"description": "SDA Italy."
},
{
"type": "string",
"enum": [
"GBA"
],
"description": "GBA Services Ltd."
},
{
"type": "string",
"enum": [
"NEWEGGEXPRESS"
],
"description": "Newegg Express."
},
{
"type": "string",
"enum": [
"SPEEDCOURIERS_GR"
],
"description": "Speed Couriers."
},
{
"type": "string",
"enum": [
"FORRUN"
],
"description": "forrun Pvt Ltd (Arpatech Venture)."
},
{
"type": "string",
"enum": [
"PICKUP"
],
"description": "Pickupp."
},
{
"type": "string",
"enum": [
"ECMS"
],
"description": "ECMS International Logistics Co.."
},
{
"type": "string",
"enum": [
"INTELIPOST"
],
"description": "Intelipost (TMS for LATAM)."
},
{
"type": "string",
"enum": [
"FLASHEXPRESS"
],
"description": "Flash Express."
},
{
"type": "string",
"enum": [
"CN_STO"
],
"description": "STO Express."
},
{
"type": "string",
"enum": [
"SEKO_SFTP"
],
"description": "SEKO Worldwide."
},
{
"type": "string",
"enum": [
"HOME_DELIVERY_SOLUTIONS"
],
"description": "Home Delivery Solutions Ltd."
},
{
"type": "string",
"enum": [
"DPD_HGRY"
],
"description": "DPD Hungary."
},
{
"type": "string",
"enum": [
"KERRYTTC_VN"
],
"description": "Kerry Express (Vietnam) Co Ltd."
},
{
"type": "string",
"enum": [
"JOYING_BOX"
],
"description": "Joying Box."
},
{
"type": "string",
"enum": [
"TOTAL_EXPRESS"
],
"description": "Total Express."
},
{
"type": "string",
"enum": [
"ZJS_EXPRESS"
],
"description": "ZJS International."
},
{
"type": "string",
"enum": [
"STARKEN"
],
"description": "STARKEN couriers."
},
{
"type": "string",
"enum": [
"DEMANDSHIP"
],
"description": "DemandShip."
},
{
"type": "string",
"enum": [
"CN_DPEX"
],
"description": "DPEX."
},
{
"type": "string",
"enum": [
"AUPOST_CN"
],
"description": "AuPost China."
},
{
"type": "string",
"enum": [
"LOGISTERS"
],
"description": "Logisters."
},
{
"type": "string",
"enum": [
"GOGLOBALPOST"
],
"description": "Global Post."
},
{
"type": "string",
"enum": [
"GLS_CZ"
],
"description": "GLS Czech Republic."
},
{
"type": "string",
"enum": [
"PAACK_WEBHOOK"
],
"description": "Paack courier."
},
{
"type": "string",
"enum": [
"GRAB_WEBHOOK"
],
"description": "Grab courier."
},
{
"type": "string",
"enum": [
"PARCELPOINT"
],
"description": "Parcelpoint."
},
{
"type": "string",
"enum": [
"ICUMULUS"
],
"description": "iCumulus."
},
{
"type": "string",
"enum": [
"DAIGLOBALTRACK"
],
"description": "DAI Post."
},
{
"type": "string",
"enum": [
"GLOBAL_IPARCEL"
],
"description": "i-parcel."
},
{
"type": "string",
"enum": [
"YURTICI_KARGO"
],
"description": "Yurtici Kargo."
},
{
"type": "string",
"enum": [
"CN_PAYPAL_PACKAGE"
],
"description": "PayPal Package."
},
{
"type": "string",
"enum": [
"PARCEL_2_POST"
],
"description": "Parcel To Post."
},
{
"type": "string",
"enum": [
"GLS_IT"
],
"description": "GLS Italy."
},
{
"type": "string",
"enum": [
"PIL_LOGISTICS"
],
"description": "PIL Logistics (China) Co.."
},
{
"type": "string",
"enum": [
"HEPPNER"
],
"description": "Heppner Internationale Spedition GmbH & Co.."
},
{
"type": "string",
"enum": [
"GENERAL_OVERNIGHT"
],
"description": "Go!Express and logistics."
},
{
"type": "string",
"enum": [
"HAPPY2POINT"
],
"description": "Happy 2ThePoint."
},
{
"type": "string",
"enum": [
"CHITCHATS"
],
"description": "Chit Chats."
},
{
"type": "string",
"enum": [
"SMOOTH"
],
"description": "Smooth Couriers."
},
{
"type": "string",
"enum": [
"CLE_LOGISTICS"
],
"description": "CL E-Logistics Solutions Limited."
},
{
"type": "string",
"enum": [
"FIEGE"
],
"description": "Fiege Logistics."
},
{
"type": "string",
"enum": [
"MX_CARGO"
],
"description": "M&X cargo."
},
{
"type": "string",
"enum": [
"ZIINGFINALMILE"
],
"description": "Ziing Final Mile Inc."
},
{
"type": "string",
"enum": [
"DAYTON_FREIGHT"
],
"description": "Dayton Freight."
},
{
"type": "string",
"enum": [
"TCS"
],
"description": "TCS courier."
},
{
"type": "string",
"enum": [
"AEX"
],
"description": "AEX Group."
},
{
"type": "string",
"enum": [
"HERMES_DE"
],
"description": "Hermes Germany."
},
{
"type": "string",
"enum": [
"ROUTIFIC_WEBHOOK"
],
"description": "Routific."
},
{
"type": "string",
"enum": [
"GLOBAVEND"
],
"description": "Globavend."
},
{
"type": "string",
"enum": [
"CJ_LOGISTICS"
],
"description": "CJ Logistics International."
},
{
"type": "string",
"enum": [
"PALLET_NETWORK"
],
"description": "The Pallet Network."
},
{
"type": "string",
"enum": [
"RAF_PH"
],
"description": "RAF Philippines."
},
{
"type": "string",
"enum": [
"UK_XDP"
],
"description": "XDP Express."
},
{
"type": "string",
"enum": [
"PAPER_EXPRESS"
],
"description": "Paper Express."
},
{
"type": "string",
"enum": [
"LA_POSTE_SUIVI"
],
"description": "La Poste."
},
{
"type": "string",
"enum": [
"PAQUETEXPRESS"
],
"description": "Paquetexpress."
},
{
"type": "string",
"enum": [
"LIEFERY"
],
"description": "liefery."
},
{
"type": "string",
"enum": [
"STRECK_TRANSPORT"
],
"description": "Streck Transport."
},
{
"type": "string",
"enum": [
"PONY_EXPRESS"
],
"description": "Pony express."
},
{
"type": "string",
"enum": [
"ALWAYS_EXPRESS"
],
"description": "Always Express."
},
{
"type": "string",
"enum": [
"GBS_BROKER"
],
"description": "GBS-Broker."
},
{
"type": "string",
"enum": [
"CITYLINK_MY"
],
"description": "City-Link Express."
},
{
"type": "string",
"enum": [
"ALLJOY"
],
"description": "ALLJOY SUPPLY CHAIN."
},
{
"type": "string",
"enum": [
"YODEL"
],
"description": "yodel."
},
{
"type": "string",
"enum": [
"YODEL_DIR"
],
"description": "Yodel Direct."
},
{
"type": "string",
"enum": [
"STONE3PL"
],
"description": "STONE3PL."
},
{
"type": "string",
"enum": [
"PARCELPAL_WEBHOOK"
],
"description": "ParcelPal."
},
{
"type": "string",
"enum": [
"DHL_ECOMERCE_ASA"
],
"description": "DHL eCommerce Asia (API)."
},
{
"type": "string",
"enum": [
"SIMPLYPOST"
],
"description": "J&T Express Singapore."
},
{
"type": "string",
"enum": [
"KY_EXPRESS"
],
"description": "Kua Yue Express."
},
{
"type": "string",
"enum": [
"SHENZHEN"
],
"description": "shenzhen 1st International Logistics(Group)Co."
},
{
"type": "string",
"enum": [
"US_LASERSHIP"
],
"description": "LaserShip."
},
{
"type": "string",
"enum": [
"UC_EXPRE"
],
"description": "ucexpress."
},
{
"type": "string",
"enum": [
"DIDADI"
],
"description": "DIDADI Logistics tech."
},
{
"type": "string",
"enum": [
"CJ_KR"
],
"description": "CJ Korea Express."
},
{
"type": "string",
"enum": [
"DBSCHENKER_B2B"
],
"description": "DB Schenker B2B."
},
{
"type": "string",
"enum": [
"MXE"
],
"description": "MXE Express."
},
{
"type": "string",
"enum": [
"CAE_DELIVERS"
],
"description": "CAE Delivers."
},
{
"type": "string",
"enum": [
"PFCEXPRESS"
],
"description": "PFC Express."
},
{
"type": "string",
"enum": [
"WHISTL"
],
"description": "Whistl."
},
{
"type": "string",
"enum": [
"WEPOST"
],
"description": "WePost Sdn Bhd."
},
{
"type": "string",
"enum": [
"DHL_PARCEL_ES"
],
"description": "DHL parcel Spain(www.dhl.com)."
},
{
"type": "string",
"enum": [
"DDEXPRESS"
],
"description": "DD Express Courier."
},
{
"type": "string",
"enum": [
"ARAMEX_AU"
],
"description": "Aramex Australia (formerly Fastway AU)."
},
{
"type": "string",
"enum": [
"BNEED"
],
"description": "Bneed courier."
},
{
"type": "string",
"enum": [
"HK_TGX"
],
"description": "Kerry Express Hong Kong."
},
{
"type": "string",
"enum": [
"LATVIJAS_PASTS"
],
"description": "Latvijas Pasts."
},
{
"type": "string",
"enum": [
"VIAEUROPE"
],
"description": "ViaEurope."
},
{
"type": "string",
"enum": [
"CORREO_UY"
],
"description": "Correo Uruguayo."
},
{
"type": "string",
"enum": [
"CHRONOPOST_FR"
],
"description": "Chronopost france (www.chronopost.fr)."
},
{
"type": "string",
"enum": [
"J_NET"
],
"description": "J-Net."
},
{
"type": "string",
"enum": [
"_6LS"
],
"description": "6ls.com."
},
{
"type": "string",
"enum": [
"BLR_BELPOST"
],
"description": "Belpost."
},
{
"type": "string",
"enum": [
"BIRDSYSTEM"
],
"description": "BirdSystem."
},
{
"type": "string",
"enum": [
"DOBROPOST"
],
"description": "DobroPost."
},
{
"type": "string",
"enum": [
"WAHANA_ID"
],
"description": "Wahana express (www.wahana.com)."
},
{
"type": "string",
"enum": [
"WEASHIP"
],
"description": "Weaship."
},
{
"type": "string",
"enum": [
"SONICTL"
],
"description": "Sonic Transportation & Logistics."
},
{
"type": "string",
"enum": [
"KWT"
],
"description": "Shenzhen Jinghuada Logistics Co.."
},
{
"type": "string",
"enum": [
"AFLLOG_FTP"
],
"description": "AFL LOGISTICS."
},
{
"type": "string",
"enum": [
"SKYNET_WORLDWIDE"
],
"description": "SkyNet Worldwide Express."
},
{
"type": "string",
"enum": [
"NOVA_POSHTA"
],
"description": "Nova Poshta (novaposhta.ua)."
},
{
"type": "string",
"enum": [
"SEINO"
],
"description": "Seino."
},
{
"type": "string",
"enum": [
"SZENDEX"
],
"description": "SZENDEX."
},
{
"type": "string",
"enum": [
"BPOST_INT"
],
"description": "Bpost international."
},
{
"type": "string",
"enum": [
"DBSCHENKER_SV"
],
"description": "DB Schenker Sweden."
},
{
"type": "string",
"enum": [
"AO_DEUTSCHLAND"
],
"description": "AO Deutschland."
},
{
"type": "string",
"enum": [
"EU_FLEET_SOLUTIONS"
],
"description": "EU Fleet Solutions."
},
{
"type": "string",
"enum": [
"PCFCORP"
],
"description": "PCF Final Mile."
},
{
"type": "string",
"enum": [
"LINKBRIDGE"
],
"description": "Link Bridge(BeiJing)international logistics co.."
},
{
"type": "string",
"enum": [
"PRIMAMULTICIPTA"
],
"description": "PT Prima Multi Cipta."
},
{
"type": "string",
"enum": [
"COUREX"
],
"description": "Urbanfox."
},
{
"type": "string",
"enum": [
"ZAJIL_EXPRESS"
],
"description": "Zajil Express Company."
},
{
"type": "string",
"enum": [
"COLLECTCO"
],
"description": "CollectCo."
},
{
"type": "string",
"enum": [
"JTEXPRESS"
],
"description": "J&T EXPRESS MALAYSIA."
},
{
"type": "string",
"enum": [
"FEDEX_UK"
],
"description": "FedEx® UK."
},
{
"type": "string",
"enum": [
"USHIP"
],
"description": "uShip courier."
},
{
"type": "string",
"enum": [
"PIXSELL"
],
"description": "PIXSELL LOGISTICS."
},
{
"type": "string",
"enum": [
"SHIPTOR"
],
"description": "Shiptor."
},
{
"type": "string",
"enum": [
"CDEK"
],
"description": "CDEK courier."
},
{
"type": "string",
"enum": [
"VNM_VIETTELPOST"
],
"description": "ViettelPost."
},
{
"type": "string",
"enum": [
"CJ_CENTURY"
],
"description": "CJ Century."
},
{
"type": "string",
"enum": [
"GSO"
],
"description": "GSO(GLS-USA)."
},
{
"type": "string",
"enum": [
"VIWO"
],
"description": "VIWO IoT."
},
{
"type": "string",
"enum": [
"SKYBOX"
],
"description": "SKYBOX."
},
{
"type": "string",
"enum": [
"KERRYTJ"
],
"description": "Kerry TJ Logistics."
},
{
"type": "string",
"enum": [
"NTLOGISTICS_VN"
],
"description": "Nhat Tin Logistics."
},
{
"type": "string",
"enum": [
"SDH_SCM"
],
"description": "lightning monkey."
},
{
"type": "string",
"enum": [
"ZINC"
],
"description": "Zinc courier."
},
{
"type": "string",
"enum": [
"DPE_SOUTH_AFRC"
],
"description": "DPE South Africa."
},
{
"type": "string",
"enum": [
"CESKA_CZ"
],
"description": "Czech Post."
},
{
"type": "string",
"enum": [
"ACS_GR"
],
"description": "ACS Courier."
},
{
"type": "string",
"enum": [
"DEALERSEND"
],
"description": "DealerSend."
},
{
"type": "string",
"enum": [
"JOCOM"
],
"description": "Jocom."
},
{
"type": "string",
"enum": [
"CSE"
],
"description": "CSE courier."
},
{
"type": "string",
"enum": [
"TFORCE_FINALMILE"
],
"description": "TForce Final Mile."
},
{
"type": "string",
"enum": [
"SHIP_GATE"
],
"description": "ShipGate."
},
{
"type": "string",
"enum": [
"SHIPTER"
],
"description": "SHIPTER."
},
{
"type": "string",
"enum": [
"NATIONAL_SAMEDAY"
],
"description": "National Sameday."
},
{
"type": "string",
"enum": [
"YUNEXPRESS"
],
"description": "YunExpress."
},
{
"type": "string",
"enum": [
"CAINIAO"
],
"description": "AliExpress Standard Shipping."
},
{
"type": "string",
"enum": [
"DMS_MATRIX"
],
"description": "DMSMatrix."
},
{
"type": "string",
"enum": [
"DIRECTLOG"
],
"description": "Directlog (www.directlog.com.br)."
},
{
"type": "string",
"enum": [
"ASENDIA_US"
],
"description": "Asendia USA."
},
{
"type": "string",
"enum": [
"_3JMSLOGISTICS"
],
"description": "3JMS Logistics."
},
{
"type": "string",
"enum": [
"LICCARDI_EXPRESS"
],
"description": "LICCARDI EXPRESS COURIER."
},
{
"type": "string",
"enum": [
"SKY_POSTAL"
],
"description": "SkyPostal."
},
{
"type": "string",
"enum": [
"CNWANGTONG"
],
"description": "cnwangtong."
},
{
"type": "string",
"enum": [
"POSTNORD_LOGISTICS_DK"
],
"description": "ostnord denmark."
},
{
"type": "string",
"enum": [
"LOGISTIKA"
],
"description": "Logistika."
},
{
"type": "string",
"enum": [
"CELERITAS"
],
"description": "Celeritas Transporte."
},
{
"type": "string",
"enum": [
"PRESSIODE"
],
"description": "Pressio."
},
{
"type": "string",
"enum": [
"SHREE_MARUTI"
],
"description": "Shree Maruti Courier Services Pvt Ltd."
},
{
"type": "string",
"enum": [
"LOGISTICSWORLDWIDE_HK"
],
"description": "Logistic Worldwide Express (LWE Honkong)."
},
{
"type": "string",
"enum": [
"EFEX"
],
"description": "eFEx (E-Commerce Fulfillment & Express)."
},
{
"type": "string",
"enum": [
"LOTTE"
],
"description": "Lotte Global Logistics."
},
{
"type": "string",
"enum": [
"LONESTAR"
],
"description": "Lone Star Overnight."
},
{
"type": "string",
"enum": [
"APRISAEXPRESS"
],
"description": "Aprisa Express."
},
{
"type": "string",
"enum": [
"BEL_RS"
],
"description": "BEL North Russia."
},
{
"type": "string",
"enum": [
"OSM_WORLDWIDE"
],
"description": "OSM Worldwide."
},
{
"type": "string",
"enum": [
"WESTGATE_GL"
],
"description": "Westgate Global."
},
{
"type": "string",
"enum": [
"FASTRACK"
],
"description": "Fasttrack."
},
{
"type": "string",
"enum": [
"DTD_EXPR"
],
"description": "DTD Express."
},
{
"type": "string",
"enum": [
"ALFATREX"
],
"description": "AlfaTrex."
},
{
"type": "string",
"enum": [
"PROMEDDELIVERY"
],
"description": "ProMed Delivery."
},
{
"type": "string",
"enum": [
"THABIT_LOGISTICS"
],
"description": "Thabit Logistics."
},
{
"type": "string",
"enum": [
"HCT_LOGISTICS"
],
"description": "HCT LOGISTICS CO.LTD.."
},
{
"type": "string",
"enum": [
"CARRY_FLAP"
],
"description": "Carry-Flap Co.."
},
{
"type": "string",
"enum": [
"US_OLD_DOMINION"
],
"description": "Old Dominion Freight Line."
},
{
"type": "string",
"enum": [
"ANICAM_BOX"
],
"description": "ANICAM BOX EXPRESS."
},
{
"type": "string",
"enum": [
"WANBEXPRESS"
],
"description": "WanbExpress."
},
{
"type": "string",
"enum": [
"AN_POST"
],
"description": "An Post."
},
{
"type": "string",
"enum": [
"DPD_LOCAL"
],
"description": "DPD Local."
},
{
"type": "string",
"enum": [
"STALLIONEXPRESS"
],
"description": "Stallion Express."
},
{
"type": "string",
"enum": [
"RAIDEREX"
],
"description": "RaidereX."
},
{
"type": "string",
"enum": [
"SHOPFANS"
],
"description": "ShopfansRU LLC."
},
{
"type": "string",
"enum": [
"KYUNGDONG_PARCEL"
],
"description": "Kyungdong Parcel."
},
{
"type": "string",
"enum": [
"CHAMPION_LOGISTICS"
],
"description": "Champion Logistics."
},
{
"type": "string",
"enum": [
"PICKUPP_SGP"
],
"description": "PICK UPP (Singapore)."
},
{
"type": "string",
"enum": [
"MORNING_EXPRESS"
],
"description": "Morning Express."
},
{
"type": "string",
"enum": [
"NACEX"
],
"description": "NACEX."
},
{
"type": "string",
"enum": [
"THENILE_WEBHOOK"
],
"description": "SortHub courier."
},
{
"type": "string",
"enum": [
"HOLISOL"
],
"description": "Holisol."
},
{
"type": "string",
"enum": [
"LBCEXPRESS_FTP"
],
"description": "LBC EXPRESS INC.."
},
{
"type": "string",
"enum": [
"KURASI"
],
"description": "KURASI."
},
{
"type": "string",
"enum": [
"USF_REDDAWAY"
],
"description": "USF Reddaway."
},
{
"type": "string",
"enum": [
"APG"
],
"description": "APG eCommerce Solutions."
},
{
"type": "string",
"enum": [
"CN_BOXC"
],
"description": "BoxC courier."
},
{
"type": "string",
"enum": [
"ECOSCOOTING"
],
"description": "ECOSCOOTING."
},
{
"type": "string",
"enum": [
"MAINWAY"
],
"description": "Mainway."
},
{
"type": "string",
"enum": [
"PAPERFLY"
],
"description": "Paperfly Private Limited."
},
{
"type": "string",
"enum": [
"HOUNDEXPRESS"
],
"description": "Hound Express."
},
{
"type": "string",
"enum": [
"BOX_BERRY"
],
"description": "Boxberry courier."
},
{
"type": "string",
"enum": [
"EP_BOX"
],
"description": "EP-Box courier."
},
{
"type": "string",
"enum": [
"PLUS_LOG_UK"
],
"description": "Plus UK Logistics."
},
{
"type": "string",
"enum": [
"FULFILLA"
],
"description": "Fulfilla."
},
{
"type": "string",
"enum": [
"ASE"
],
"description": "ASE KARGO."
},
{
"type": "string",
"enum": [
"MAIL_PLUS"
],
"description": "MailPlus."
},
{
"type": "string",
"enum": [
"XPO_LOGISTICS"
],
"description": "XPO logistics."
},
{
"type": "string",
"enum": [
"WNDIRECT"
],
"description": "wnDirect."
},
{
"type": "string",
"enum": [
"CLOUDWISH_ASIA"
],
"description": "Cloudwish Asia."
},
{
"type": "string",
"enum": [
"ZELERIS"
],
"description": "Zeleris."
},
{
"type": "string",
"enum": [
"GIO_EXPRESS"
],
"description": "Gio Express."
},
{
"type": "string",
"enum": [
"OCS_WORLDWIDE"
],
"description": "OCS WORLDWIDE."
},
{
"type": "string",
"enum": [
"ARK_LOGISTICS"
],
"description": "ARK Logistics."
},
{
"type": "string",
"enum": [
"AQUILINE"
],
"description": "Aquiline."
},
{
"type": "string",
"enum": [
"PILOT_FREIGHT"
],
"description": "Pilot Freight Services."
},
{
"type": "string",
"enum": [
"QWINTRY"
],
"description": "Qwintry Logistics."
},
{
"type": "string",
"enum": [
"DANSKE_FRAGT"
],
"description": "Danske Fragtaend."
},
{
"type": "string",
"enum": [
"CARRIERS"
],
"description": "Carriers courier."
},
{
"type": "string",
"enum": [
"AIR_CANADA_GLOBAL"
],
"description": "Rivo (Air canada)."
},
{
"type": "string",
"enum": [
"PRESIDENT_TRANS"
],
"description": "PRESIDENT TRANSNET CORP."
},
{
"type": "string",
"enum": [
"STEPFORWARDFS"
],
"description": "STEP FORWARD FREIGHT SERVICE CO LTD."
},
{
"type": "string",
"enum": [
"SKYNET_UK"
],
"description": "Skynet UK."
},
{
"type": "string",
"enum": [
"PITTOHIO"
],
"description": "PITT OHIO."
},
{
"type": "string",
"enum": [
"CORREOS_EXPRESS"
],
"description": "Correos Express."
},
{
"type": "string",
"enum": [
"RL_US"
],
"description": "RL Carriers."
},
{
"type": "string",
"enum": [
"DESTINY"
],
"description": "Destiny Transportation."
},
{
"type": "string",
"enum": [
"UK_YODEL"
],
"description": "Yodel (www.yodel.co.uk)."
},
{
"type": "string",
"enum": [
"COMET_TECH"
],
"description": "CometTech."
},
{
"type": "string",
"enum": [
"DHL_PARCEL_RU"
],
"description": "DHL Parcel Russia."
},
{
"type": "string",
"enum": [
"TNT_REFR"
],
"description": "TNT Reference."
},
{
"type": "string",
"enum": [
"SHREE_ANJANI_COURIER"
],
"description": "Shree Anjani Courier."
},
{
"type": "string",
"enum": [
"MIKROPAKKET_BE"
],
"description": "Mikropakket Belgium."
},
{
"type": "string",
"enum": [
"ETS_EXPRESS"
],
"description": "RETS express."
},
{
"type": "string",
"enum": [
"COLIS_PRIVE"
],
"description": "Colis Privé."
},
{
"type": "string",
"enum": [
"CN_YUNDA"
],
"description": "Yunda Express."
},
{
"type": "string",
"enum": [
"AAA_COOPER"
],
"description": "AAA Cooper."
},
{
"type": "string",
"enum": [
"ROCKET_PARCEL"
],
"description": "Rocket Parcel International."
},
{
"type": "string",
"enum": [
"_360LION"
],
"description": "360 Lion Express."
},
{
"type": "string",
"enum": [
"PANDU"
],
"description": "PANDU."
},
{
"type": "string",
"enum": [
"PROFESSIONAL_COURIERS"
],
"description": "PROFESSIONAL COURIERS."
},
{
"type": "string",
"enum": [
"FLYTEXPRESS"
],
"description": "FLYTEXPRESS."
},
{
"type": "string",
"enum": [
"LOGISTICSWORLDWIDE_MY"
],
"description": "LOGISTICSWORLDWIDE MY."
},
{
"type": "string",
"enum": [
"CORREOS_DE_ESPANA"
],
"description": "CORREOS DE ESPANA."
},
{
"type": "string",
"enum": [
"IMX"
],
"description": "IMX."
},
{
"type": "string",
"enum": [
"FOUR_PX_EXPRESS"
],
"description": "FOUR PX EXPRESS."
},
{
"type": "string",
"enum": [
"XPRESSBEES"
],
"description": "XPRESSBEES."
},
{
"type": "string",
"enum": [
"PICKUPP_VNM"
],
"description": "pickupp_vnm."
},
{
"type": "string",
"enum": [
"STARTRACK_EXPRESS"
],
"description": "startrack_express."
},
{
"type": "string",
"enum": [
"FR_COLISSIMO"
],
"description": "fr_colissimo."
},
{
"type": "string",
"enum": [
"NACEX_SPAIN_REFERENCE"
],
"description": "nacex_spain_reference."
},
{
"type": "string",
"enum": [
"DHL_SUPPLY_CHAIN_AU"
],
"description": "dhl_supply_chain_au."
},
{
"type": "string",
"enum": [
"ESHIPPING"
],
"description": "Eshipping."
},
{
"type": "string",
"enum": [
"SHREETIRUPATI"
],
"description": "SHREE TIRUPATI COURIER SERVICES PVT. LTD.."
},
{
"type": "string",
"enum": [
"HX_EXPRESS"
],
"description": "HX Express."
},
{
"type": "string",
"enum": [
"INDOPAKET"
],
"description": "INDOPAKET."
},
{
"type": "string",
"enum": [
"CN_17POST"
],
"description": "17 Post Service."
},
{
"type": "string",
"enum": [
"K1_EXPRESS"
],
"description": "K1 Express."
},
{
"type": "string",
"enum": [
"CJ_GLS"
],
"description": "CJ GLS."
},
{
"type": "string",
"enum": [
"MYS_GDEX"
],
"description": "GDEX courier."
},
{
"type": "string",
"enum": [
"NATIONEX"
],
"description": "Nationex courier."
},
{
"type": "string",
"enum": [
"ANJUN"
],
"description": "Anjun couriers."
},
{
"type": "string",
"enum": [
"FARGOOD"
],
"description": "FarGood."
},
{
"type": "string",
"enum": [
"SMG_EXPRESS"
],
"description": "SMG Direct."
},
{
"type": "string",
"enum": [
"RZYEXPRESS"
],
"description": "RZY Express."
},
{
"type": "string",
"enum": [
"SEFL"
],
"description": "Southeastern Freight Lines."
},
{
"type": "string",
"enum": [
"TNT_CLICK_IT"
],
"description": "TNT-Click Italy."
},
{
"type": "string",
"enum": [
"HDB"
],
"description": "Haidaibao."
},
{
"type": "string",
"enum": [
"HIPSHIPPER"
],
"description": "Hipshipper."
},
{
"type": "string",
"enum": [
"RPXLOGISTICS"
],
"description": "RPX Logistics."
},
{
"type": "string",
"enum": [
"KUEHNE"
],
"description": "Kuehne + Nagel."
},
{
"type": "string",
"enum": [
"IT_NEXIVE"
],
"description": "Nexive (TNT Post Italy)."
},
{
"type": "string",
"enum": [
"PTS"
],
"description": "PTS courier."
},
{
"type": "string",
"enum": [
"SWISS_POST_FTP"
],
"description": "Swiss Post FTP."
},
{
"type": "string",
"enum": [
"FASTRK_SERV"
],
"description": "Fastrak Services."
},
{
"type": "string",
"enum": [
"_4_72"
],
"description": "4-72 Entregando."
},
{
"type": "string",
"enum": [
"US_YRC"
],
"description": "YRC courier."
},
{
"type": "string",
"enum": [
"POSTNL_INTL_3S"
],
"description": "PostNL International 3S."
},
{
"type": "string",
"enum": [
"ELIAN_POST"
],
"description": "Yilian (Elian) Supply Chain."
},
{
"type": "string",
"enum": [
"CUBYN"
],
"description": "Cubyn."
},
{
"type": "string",
"enum": [
"SAU_SAUDI_POST"
],
"description": "Saudi Post."
},
{
"type": "string",
"enum": [
"ABXEXPRESS_MY"
],
"description": "ABX Express."
},
{
"type": "string",
"enum": [
"HUAHAN_EXPRESS"
],
"description": "HUAHANG EXPRESS."
},
{
"type": "string",
"enum": [
"ZES_EXPRESS"
],
"description": "Eshun international Logistic."
},
{
"type": "string",
"enum": [
"ZEPTO_EXPRESS"
],
"description": "ZeptoExpress."
},
{
"type": "string",
"enum": [
"SKYNET_ZA"
],
"description": "Skynet World Wide Express South Africa."
},
{
"type": "string",
"enum": [
"ZEEK_2_DOOR"
],
"description": "Zeek2Door."
},
{
"type": "string",
"enum": [
"BLINKLASTMILE"
],
"description": "Blink."
},
{
"type": "string",
"enum": [
"POSTA_UKR"
],
"description": "UkrPoshta."
},
{
"type": "string",
"enum": [
"CHROBINSON"
],
"description": "C.H. Robinson Worldwide."
},
{
"type": "string",
"enum": [
"CN_POST56"
],
"description": "Post56."
},
{
"type": "string",
"enum": [
"COURANT_PLUS"
],
"description": "Courant Plus."
},
{
"type": "string",
"enum": [
"SCUDEX_EXPRESS"
],
"description": "Scudex Express."
},
{
"type": "string",
"enum": [
"SHIPENTEGRA"
],
"description": "ShipEntegra."
},
{
"type": "string",
"enum": [
"B_TWO_C_EUROPE"
],
"description": "B2C courier Europe."
},
{
"type": "string",
"enum": [
"COPE"
],
"description": "Cope Sensitive Freight."
},
{
"type": "string",
"enum": [
"IND_GATI"
],
"description": "Gati-KWE."
},
{
"type": "string",
"enum": [
"CN_WISHPOST"
],
"description": "WishPost."
},
{
"type": "string",
"enum": [
"NACEX_ES"
],
"description": "NACEX Spain."
},
{
"type": "string",
"enum": [
"TAQBIN_HK"
],
"description": "TAQBIN Hong Kong."
},
{
"type": "string",
"enum": [
"GLOBALTRANZ"
],
"description": "GlobalTranz."
},
{
"type": "string",
"enum": [
"HKD"
],
"description": "Qingdao HKD International Logistics."
},
{
"type": "string",
"enum": [
"BJSHOMEDELIVERY"
],
"description": "BJS Distribution courier."
},
{
"type": "string",
"enum": [
"OMNIVA"
],
"description": "Omniva."
},
{
"type": "string",
"enum": [
"SUTTON"
],
"description": "Sutton Transport."
},
{
"type": "string",
"enum": [
"PANTHER_REFERENCE"
],
"description": "Panther Reference."
},
{
"type": "string",
"enum": [
"SFCSERVICE"
],
"description": "SFC Service."
},
{
"type": "string",
"enum": [
"LTL"
],
"description": "LTL COURIER."
},
{
"type": "string",
"enum": [
"PARKNPARCEL"
],
"description": "Park N Parcel."
},
{
"type": "string",
"enum": [
"SPRING_GDS"
],
"description": "Spring GDS."
},
{
"type": "string",
"enum": [
"ECEXPRESS"
],
"description": "ECexpress."
},
{
"type": "string",
"enum": [
"INTERPARCEL_AU"
],
"description": "Interparcel Australia."
},
{
"type": "string",
"enum": [
"AGILITY"
],
"description": "Agility."
},
{
"type": "string",
"enum": [
"XL_EXPRESS"
],
"description": "XL Express."
},
{
"type": "string",
"enum": [
"ADERONLINE"
],
"description": "Ader couriers."
},
{
"type": "string",
"enum": [
"DIRECTCOURIERS"
],
"description": "Direct Couriers."
},
{
"type": "string",
"enum": [
"PLANZER"
],
"description": "Planzer Group."
},
{
"type": "string",
"enum": [
"SENDING"
],
"description": "Sending Transporte Urgente y Comunicacion."
},
{
"type": "string",
"enum": [
"NINJAVAN_WB"
],
"description": "Ninjavan Webhook."
},
{
"type": "string",
"enum": [
"NATIONWIDE_MY"
],
"description": "Nationwide Express Courier Services Bhd (www.nationwide.com.my)."
},
{
"type": "string",
"enum": [
"SENDIT"
],
"description": "Sendit."
},
{
"type": "string",
"enum": [
"GB_ARROW"
],
"description": "Arrow XL."
},
{
"type": "string",
"enum": [
"IND_GOJAVAS"
],
"description": "GoJavas."
},
{
"type": "string",
"enum": [
"KPOST"
],
"description": "Korea Post."
},
{
"type": "string",
"enum": [
"DHL_FREIGHT"
],
"description": "DHL Freight."
},
{
"type": "string",
"enum": [
"BLUECARE"
],
"description": "Bluecare Express Ltd."
},
{
"type": "string",
"enum": [
"JINDOUYUN"
],
"description": "jindouyun courier."
},
{
"type": "string",
"enum": [
"TRACKON"
],
"description": "Trackon Couriers Pvt. Ltd."
},
{
"type": "string",
"enum": [
"GB_TUFFNELLS"
],
"description": "Tuffnells Parcels Express."
},
{
"type": "string",
"enum": [
"TRUMPCARD"
],
"description": "TRUMPCARD LLC."
},
{
"type": "string",
"enum": [
"ETOTAL"
],
"description": "eTotal Solution Limited."
},
{
"type": "string",
"enum": [
"SFPLUS_WEBHOOK"
],
"description": "Zeek courier."
},
{
"type": "string",
"enum": [
"SEKOLOGISTICS"
],
"description": "SEKO Logistics."
},
{
"type": "string",
"enum": [
"HERMES_2MANN_HANDLING"
],
"description": "Hermes Einrichtungs Service GmbH & Co. KG."
},
{
"type": "string",
"enum": [
"DPD_LOCAL_REF"
],
"description": "DPD Local reference."
},
{
"type": "string",
"enum": [
"UDS"
],
"description": "United Delivery Service."
},
{
"type": "string",
"enum": [
"ZA_SPECIALISED_FREIGHT"
],
"description": "Specialised Freight."
},
{
"type": "string",
"enum": [
"THA_KERRY"
],
"description": "Kerry Express Thailand."
},
{
"type": "string",
"enum": [
"PRT_INT_SEUR"
],
"description": "SEUR International."
},
{
"type": "string",
"enum": [
"BRA_CORREIOS"
],
"description": "Correios Brazil."
},
{
"type": "string",
"enum": [
"NZ_NZ_POST"
],
"description": "New Zealand Post."
},
{
"type": "string",
"enum": [
"CN_EQUICK"
],
"description": "Equick China."
},
{
"type": "string",
"enum": [
"MYS_EMS"
],
"description": "Malaysia Post EMS / Pos Laju."
},
{
"type": "string",
"enum": [
"GB_NORSK"
],
"description": "Norsk Global."
},
{
"type": "string",
"enum": [
"ESP_MRW"
],
"description": "MRW spain."
},
{
"type": "string",
"enum": [
"ESP_PACKLINK"
],
"description": "Packlink."
},
{
"type": "string",
"enum": [
"KANGAROO_MY"
],
"description": "Kangaroo Worldwide Express."
},
{
"type": "string",
"enum": [
"RPX"
],
"description": "RPX Online."
},
{
"type": "string",
"enum": [
"XDP_UK_REFERENCE"
],
"description": "XDP Express Reference."
},
{
"type": "string",
"enum": [
"NINJAVAN_MY"
],
"description": "ninja van (www.ninjavan.co)."
},
{
"type": "string",
"enum": [
"ADICIONAL"
],
"description": "Adicional Logistics."
},
{
"type": "string",
"enum": [
"ROADBULL"
],
"description": "Red Carpet Logistics."
},
{
"type": "string",
"enum": [
"YAKIT"
],
"description": "Yakit courier."
},
{
"type": "string",
"enum": [
"MAILAMERICAS"
],
"description": "MailAmericas."
},
{
"type": "string",
"enum": [
"MIKROPAKKET"
],
"description": "Mikropakket."
},
{
"type": "string",
"enum": [
"DYNALOGIC"
],
"description": "Dynamic Logistics."
},
{
"type": "string",
"enum": [
"DHL_ES"
],
"description": "DHL Spain(www.dhl.com)."
},
{
"type": "string",
"enum": [
"DHL_PARCEL_NL"
],
"description": "DHL Parcel NL."
},
{
"type": "string",
"enum": [
"DHL_GLOBAL_MAIL_ASIA"
],
"description": "DHL Global Mail Asia (www.dhl.com)."
},
{
"type": "string",
"enum": [
"DAWN_WING"
],
"description": "Dawn Wing."
},
{
"type": "string",
"enum": [
"GENIKI_GR"
],
"description": "Geniki Taxydromiki."
},
{
"type": "string",
"enum": [
"HERMESWORLD_UK"
],
"description": "hermesworld_uk."
},
{
"type": "string",
"enum": [
"ALPHAFAST"
],
"description": "Alphafast (www.alphafast.com)."
},
{
"type": "string",
"enum": [
"BUYLOGIC"
],
"description": "buylogic."
},
{
"type": "string",
"enum": [
"EKART"
],
"description": "Ekart logistics (ekartlogistics.com)."
},
{
"type": "string",
"enum": [
"MEX_SENDA"
],
"description": "mexico senda express."
},
{
"type": "string",
"enum": [
"SFC_LOGISTICS"
],
"description": "SFC."
},
{
"type": "string",
"enum": [
"POST_SERBIA"
],
"description": "Posta Serbia."
},
{
"type": "string",
"enum": [
"IND_DELHIVERY"
],
"description": "Delhivery India."
},
{
"type": "string",
"enum": [
"DE_DPD_DELISTRACK"
],
"description": "DPD Germany."
},
{
"type": "string",
"enum": [
"RPD2MAN"
],
"description": "RPD2man Deliveries."
},
{
"type": "string",
"enum": [
"CN_SF_EXPRESS"
],
"description": "SF Express (www.sf-express.com)."
},
{
"type": "string",
"enum": [
"YANWEN"
],
"description": "Yanwen Logistics."
},
{
"type": "string",
"enum": [
"MYS_SKYNET"
],
"description": "Skynet Malaysia."
},
{
"type": "string",
"enum": [
"CORREOS_DE_MEXICO"
],
"description": "correos mexico."
},
{
"type": "string",
"enum": [
"CBL_LOGISTICA"
],
"description": "CBL Logistica."
},
{
"type": "string",
"enum": [
"MEX_ESTAFETA"
],
"description": "Estafeta (www.estafeta.com)."
},
{
"type": "string",
"enum": [
"AU_AUSTRIAN_POST"
],
"description": "Austrian Post (Registered)."
},
{
"type": "string",
"enum": [
"RINCOS"
],
"description": "Rincos."
},
{
"type": "string",
"enum": [
"NLD_DHL"
],
"description": "DHL Netherland."
},
{
"type": "string",
"enum": [
"RUSSIAN_POST"
],
"description": "Russian post."
},
{
"type": "string",
"enum": [
"COURIERS_PLEASE"
],
"description": "CouriersPlease (couriersplease.com.au)."
},
{
"type": "string",
"enum": [
"POSTNORD_LOGISTICS"
],
"description": "PostNord Logistics."
},
{
"type": "string",
"enum": [
"FEDEX"
],
"description": "Fedex."
},
{
"type": "string",
"enum": [
"DPE_EXPRESS"
],
"description": "DPE Express."
},
{
"type": "string",
"enum": [
"DPD"
],
"description": "DPD."
},
{
"type": "string",
"enum": [
"ADSONE"
],
"description": "ADSone."
},
{
"type": "string",
"enum": [
"IDN_JNE"
],
"description": "JNE Express (Jalur Nugraha Ekakurir)."
},
{
"type": "string",
"enum": [
"THECOURIERGUY"
],
"description": "The Courier Guy."
},
{
"type": "string",
"enum": [
"CNEXPS"
],
"description": "CNE Express."
},
{
"type": "string",
"enum": [
"PRT_CHRONOPOST"
],
"description": "Chronopost Portugal."
},
{
"type": "string",
"enum": [
"LANDMARK_GLOBAL"
],
"description": "Landmark Global."
},
{
"type": "string",
"enum": [
"IT_DHL_ECOMMERCE"
],
"description": "DHL International."
},
{
"type": "string",
"enum": [
"ESP_NACEX"
],
"description": "NACEX Spain."
},
{
"type": "string",
"enum": [
"PRT_CTT"
],
"description": "CTT Portugal."
},
{
"type": "string",
"enum": [
"BE_KIALA"
],
"description": "Kiala."
},
{
"type": "string",
"enum": [
"ASENDIA_UK"
],
"description": "Asendia UK."
},
{
"type": "string",
"enum": [
"GLOBAL_TNT"
],
"description": "TNT global."
},
{
"type": "string",
"enum": [
"POSTUR_IS"
],
"description": "Iceland Post."
},
{
"type": "string",
"enum": [
"EPARCEL_KR"
],
"description": "eParcel Korea."
},
{
"type": "string",
"enum": [
"INPOST_PACZKOMATY"
],
"description": "InPost Paczkomaty."
},
{
"type": "string",
"enum": [
"IT_POSTE_ITALIA"
],
"description": "Poste italiane (www.poste.it)."
},
{
"type": "string",
"enum": [
"BE_BPOST"
],
"description": "Bpost (www.bpost.be)."
},
{
"type": "string",
"enum": [
"PL_POCZTA_POLSKA"
],
"description": "Poczta Polska (www.poczta-polska.pl)."
},
{
"type": "string",
"enum": [
"MYS_MYS_POST"
],
"description": "Malaysia Post."
},
{
"type": "string",
"enum": [
"SG_SG_POST"
],
"description": "Singapore Post."
},
{
"type": "string",
"enum": [
"THA_THAILAND_POST"
],
"description": "Thailand Post (www.thailandpost.co.th)."
},
{
"type": "string",
"enum": [
"LEXSHIP"
],
"description": "LexShip."
},
{
"type": "string",
"enum": [
"FASTWAY_NZ"
],
"description": "Fastway New Zealand."
},
{
"type": "string",
"enum": [
"DHL_AU"
],
"description": "DHL Supply Chain Australia."
},
{
"type": "string",
"enum": [
"COSTMETICSNOW"
],
"description": "Cosmetics Now."
},
{
"type": "string",
"enum": [
"PFLOGISTICS"
],
"description": "PFL."
},
{
"type": "string",
"enum": [
"LOOMIS_EXPRESS"
],
"description": "Loomis Express."
},
{
"type": "string",
"enum": [
"GLS_ITALY"
],
"description": "GLS Italy."
},
{
"type": "string",
"enum": [
"LINE"
],
"description": "Line Clear Express & Logistics Sdn Bhd."
},
{
"type": "string",
"enum": [
"GEL_EXPRESS"
],
"description": "Gel Express Logistik."
},
{
"type": "string",
"enum": [
"HUODULL"
],
"description": "Huodull."
},
{
"type": "string",
"enum": [
"NINJAVAN_SG"
],
"description": "Ninja van Singapore."
},
{
"type": "string",
"enum": [
"JANIO"
],
"description": "Janio Asia."
},
{
"type": "string",
"enum": [
"AO_COURIER"
],
"description": "AO Logistics."
},
{
"type": "string",
"enum": [
"BRT_IT_SENDER_REF"
],
"description": "BRT Bartolini(Sender Reference)."
},
{
"type": "string",
"enum": [
"SAILPOST"
],
"description": "SAILPOST."
},
{
"type": "string",
"enum": [
"LALAMOVE"
],
"description": "Lalamove."
},
{
"type": "string",
"enum": [
"NEWZEALAND_COURIERS"
],
"description": "NEW ZEALAND COURIERS."
},
{
"type": "string",
"enum": [
"ETOMARS"
],
"description": "Etomars."
},
{
"type": "string",
"enum": [
"VIRTRANSPORT"
],
"description": "VIR Transport."
},
{
"type": "string",
"enum": [
"WIZMO"
],
"description": "Wizmo."
},
{
"type": "string",
"enum": [
"PALLETWAYS"
],
"description": "Palletways."
},
{
"type": "string",
"enum": [
"I_DIKA"
],
"description": "i-dika."
},
{
"type": "string",
"enum": [
"CFL_LOGISTICS"
],
"description": "CFL Logistics."
},
{
"type": "string",
"enum": [
"GEMWORLDWIDE"
],
"description": "GEM Worldwide."
},
{
"type": "string",
"enum": [
"GLOBAL_EXPRESS"
],
"description": "Tai Wan Global Business."
},
{
"type": "string",
"enum": [
"LOGISTYX_TRANSGROUP"
],
"description": "Transgroup courier."
},
{
"type": "string",
"enum": [
"WESTBANK_COURIER"
],
"description": "West Bank Courier."
},
{
"type": "string",
"enum": [
"ARCO_SPEDIZIONI"
],
"description": "Arco Spedizioni SP."
},
{
"type": "string",
"enum": [
"YDH_EXPRESS"
],
"description": "YDH express."
},
{
"type": "string",
"enum": [
"PARCELINKLOGISTICS"
],
"description": "Parcelink Logistics."
},
{
"type": "string",
"enum": [
"CNDEXPRESS"
],
"description": "CND Express."
},
{
"type": "string",
"enum": [
"NOX_NIGHT_TIME_EXPRESS"
],
"description": "NOX NightTimeExpress."
},
{
"type": "string",
"enum": [
"AERONET"
],
"description": "Aeronet couriers."
},
{
"type": "string",
"enum": [
"LTIANEXP"
],
"description": "LTIAN EXP."
},
{
"type": "string",
"enum": [
"INTEGRA2_FTP"
],
"description": "Integra2."
},
{
"type": "string",
"enum": [
"PARCELONE"
],
"description": "PARCEL ONE."
},
{
"type": "string",
"enum": [
"NOX_NACHTEXPRESS"
],
"description": "Innight Express Germany GmbH (nox NachtExpress)."
},
{
"type": "string",
"enum": [
"CN_CHINA_POST_EMS"
],
"description": "China Post."
},
{
"type": "string",
"enum": [
"CHUKOU1"
],
"description": "Chukou1."
},
{
"type": "string",
"enum": [
"GLS_SLOV"
],
"description": "GLS General Logistics Systems Slovakia s.r.o.."
},
{
"type": "string",
"enum": [
"ORANGE_DS"
],
"description": "OrangeDS (Orange Distribution Solutions Inc)."
},
{
"type": "string",
"enum": [
"JOOM_LOGIS"
],
"description": "Joom Logistics."
},
{
"type": "string",
"enum": [
"AUS_STARTRACK"
],
"description": "StarTrack (startrack.com.au)."
},
{
"type": "string",
"enum": [
"DHL"
],
"description": "dhl Global."
},
{
"type": "string",
"enum": [
"GB_APC"
],
"description": "APC postal logistics germany."
},
{
"type": "string",
"enum": [
"BONDSCOURIERS"
],
"description": "Bonds Courier Service (bondscouriers.com.au)."
},
{
"type": "string",
"enum": [
"JPN_JAPAN_POST"
],
"description": "Japan Post."
},
{
"type": "string",
"enum": [
"USPS"
],
"description": "United States Postal Service."
},
{
"type": "string",
"enum": [
"WINIT"
],
"description": "WinIt."
},
{
"type": "string",
"enum": [
"ARG_OCA"
],
"description": "OCA Argentina."
},
{
"type": "string",
"enum": [
"TW_TAIWAN_POST"
],
"description": "Taiwan Post."
},
{
"type": "string",
"enum": [
"DMM_NETWORK"
],
"description": "DMM Network."
},
{
"type": "string",
"enum": [
"TNT"
],
"description": "TNT Express."
},
{
"type": "string",
"enum": [
"BH_POSTA"
],
"description": "BH Posta (www.posta.ba)."
},
{
"type": "string",
"enum": [
"SWE_POSTNORD"
],
"description": "Postnord sweden."
},
{
"type": "string",
"enum": [
"CA_CANADA_POST"
],
"description": "Canada Post."
},
{
"type": "string",
"enum": [
"WISELOADS"
],
"description": "Wiseloads."
},
{
"type": "string",
"enum": [
"ASENDIA_HK"
],
"description": "Asendia HonKong."
},
{
"type": "string",
"enum": [
"NLD_GLS"
],
"description": "GLS Netherland."
},
{
"type": "string",
"enum": [
"MEX_REDPACK"
],
"description": "Redpack."
},
{
"type": "string",
"enum": [
"JET_SHIP"
],
"description": "Jet-Ship Worldwide."
},
{
"type": "string",
"enum": [
"DE_DHL_EXPRESS"
],
"description": "DHL Express."
},
{
"type": "string",
"enum": [
"NINJAVAN_THAI"
],
"description": "Ninja van Thai."
},
{
"type": "string",
"enum": [
"RABEN_GROUP"
],
"description": "Raben Group."
},
{
"type": "string",
"enum": [
"ESP_ASM"
],
"description": "ASM(GLS Spain)."
},
{
"type": "string",
"enum": [
"HRV_HRVATSKA"
],
"description": "Hrvatska posta."
},
{
"type": "string",
"enum": [
"GLOBAL_ESTES"
],
"description": "Estes Express Lines."
},
{
"type": "string",
"enum": [
"LTU_LIETUVOS"
],
"description": "Lietuvos pastas."
},
{
"type": "string",
"enum": [
"BEL_DHL"
],
"description": "DHL Benelux."
},
{
"type": "string",
"enum": [
"AU_AU_POST"
],
"description": "Australia Post."
},
{
"type": "string",
"enum": [
"SPEEDEXCOURIER"
],
"description": "SPEEDEX couriers."
},
{
"type": "string",
"enum": [
"FR_COLIS"
],
"description": "Colissimo."
},
{
"type": "string",
"enum": [
"ARAMEX"
],
"description": "Aramex."
},
{
"type": "string",
"enum": [
"DPEX"
],
"description": "DPEX (www.dpex.com)."
},
{
"type": "string",
"enum": [
"MYS_AIRPAK"
],
"description": "Airpak Express."
},
{
"type": "string",
"enum": [
"CUCKOOEXPRESS"
],
"description": "Cuckoo Express."
},
{
"type": "string",
"enum": [
"DPD_POLAND"
],
"description": "DPD Poland."
},
{
"type": "string",
"enum": [
"NLD_POSTNL"
],
"description": "PostNL International."
},
{
"type": "string",
"enum": [
"NIM_EXPRESS"
],
"description": "Nim Express."
},
{
"type": "string",
"enum": [
"QUANTIUM"
],
"description": "Quantium."
},
{
"type": "string",
"enum": [
"SENDLE"
],
"description": "Sendle."
},
{
"type": "string",
"enum": [
"ESP_REDUR"
],
"description": "Redur Spain."
},
{
"type": "string",
"enum": [
"MATKAHUOLTO"
],
"description": "Matkahuolto."
},
{
"type": "string",
"enum": [
"CPACKET"
],
"description": "Cpacket couriers."
},
{
"type": "string",
"enum": [
"POSTI"
],
"description": "Posti courier."
},
{
"type": "string",
"enum": [
"HUNTER_EXPRESS"
],
"description": "Hunter Express."
},
{
"type": "string",
"enum": [
"CHOIR_EXP"
],
"description": "Choir Express Indonesia."
},
{
"type": "string",
"enum": [
"LEGION_EXPRESS"
],
"description": "Legion Express."
},
{
"type": "string",
"enum": [
"AUSTRIAN_POST_EXPRESS"
],
"description": "austrian post."
},
{
"type": "string",
"enum": [
"GRUPO"
],
"description": "Grupo ampm."
},
{
"type": "string",
"enum": [
"POSTA_RO"
],
"description": "Post Roman (www.posta-romana.ro)."
},
{
"type": "string",
"enum": [
"INTERPARCEL_UK"
],
"description": "Interparcel UK."
},
{
"type": "string",
"enum": [
"GLOBAL_ABF"
],
"description": "ABF Freight."
},
{
"type": "string",
"enum": [
"POSTEN_NORGE"
],
"description": "Posten Norge (www.posten.no)."
},
{
"type": "string",
"enum": [
"XPERT_DELIVERY"
],
"description": "Xpert Delivery."
},
{
"type": "string",
"enum": [
"DHL_REFR"
],
"description": "DHl (Reference number)."
},
{
"type": "string",
"enum": [
"DHL_HK"
],
"description": "DHL HonKong."
},
{
"type": "string",
"enum": [
"SKYNET_UAE"
],
"description": "SKYNET UAE."
},
{
"type": "string",
"enum": [
"GOJEK"
],
"description": "Gojek."
},
{
"type": "string",
"enum": [
"YODEL_INTNL"
],
"description": "Yodel International."
},
{
"type": "string",
"enum": [
"JANCO"
],
"description": "Janco Ecommerce."
},
{
"type": "string",
"enum": [
"YTO"
],
"description": "YTO Express."
},
{
"type": "string",
"enum": [
"WISE_EXPRESS"
],
"description": "Wise Express."
},
{
"type": "string",
"enum": [
"JTEXPRESS_VN"
],
"description": "J&T Express Vietnam."
},
{
"type": "string",
"enum": [
"FEDEX_INTL_MLSERV"
],
"description": "FedEx International MailService."
},
{
"type": "string",
"enum": [
"VAMOX"
],
"description": "VAMOX."
},
{
"type": "string",
"enum": [
"AMS_GRP"
],
"description": "AMS Group."
},
{
"type": "string",
"enum": [
"DHL_JP"
],
"description": "DHL Japan."
},
{
"type": "string",
"enum": [
"HRPARCEL"
],
"description": "HR Parcel."
},
{
"type": "string",
"enum": [
"GESWL"
],
"description": "GESWL Express."
},
{
"type": "string",
"enum": [
"BLUESTAR"
],
"description": "Blue Star."
},
{
"type": "string",
"enum": [
"CDEK_TR"
],
"description": "CDEK TR."
},
{
"type": "string",
"enum": [
"DESCARTES"
],
"description": "Innovel courier."
},
{
"type": "string",
"enum": [
"DELTEC_UK"
],
"description": "Deltec Courier."
},
{
"type": "string",
"enum": [
"DTDC_EXPRESS"
],
"description": "DTDC express."
},
{
"type": "string",
"enum": [
"TOURLINE"
],
"description": "tourline."
},
{
"type": "string",
"enum": [
"BH_WORLDWIDE"
],
"description": "B&H Worldwide."
},
{
"type": "string",
"enum": [
"OCS"
],
"description": "OCS ANA Group."
},
{
"type": "string",
"enum": [
"YINGNUO_LOGISTICS"
],
"description": "Yingnuo logistics."
},
{
"type": "string",
"enum": [
"UPS"
],
"description": "United Parcel Service."
},
{
"type": "string",
"enum": [
"TOLL"
],
"description": "Toll IPEC."
},
{
"type": "string",
"enum": [
"PRT_SEUR"
],
"description": "SEUR portugal."
},
{
"type": "string",
"enum": [
"DTDC_AU"
],
"description": "DTDC Australia."
},
{
"type": "string",
"enum": [
"THA_DYNAMIC_LOGISTICS"
],
"description": "Dynamic Logistics."
},
{
"type": "string",
"enum": [
"UBI_LOGISTICS"
],
"description": "UBI Smart Parcel."
},
{
"type": "string",
"enum": [
"FEDEX_CROSSBORDER"
],
"description": "FedEx Cross Border."
},
{
"type": "string",
"enum": [
"A1POST"
],
"description": "A1Post."
},
{
"type": "string",
"enum": [
"TAZMANIAN_FREIGHT"
],
"description": "Tazmanian Freight Systems."
},
{
"type": "string",
"enum": [
"CJ_INT_MY"
],
"description": "CJ International malaysia."
},
{
"type": "string",
"enum": [
"SAIA_FREIGHT"
],
"description": "Saia LTL Freight."
},
{
"type": "string",
"enum": [
"SG_QXPRESS"
],
"description": "Qxpress."
},
{
"type": "string",
"enum": [
"NHANS_SOLUTIONS"
],
"description": "Nhans Solutions."
},
{
"type": "string",
"enum": [
"DPD_FR"
],
"description": "DPD France."
},
{
"type": "string",
"enum": [
"COORDINADORA"
],
"description": "Coordinadora."
},
{
"type": "string",
"enum": [
"ANDREANI"
],
"description": "Grupo logistico Andreani."
},
{
"type": "string",
"enum": [
"DOORA"
],
"description": "Doora Logistics."
},
{
"type": "string",
"enum": [
"INTERPARCEL_NZ"
],
"description": "Interparcel New Zealand."
},
{
"type": "string",
"enum": [
"PHL_JAMEXPRESS"
],
"description": "Jam Express Philippines."
},
{
"type": "string",
"enum": [
"BEL_BELGIUM_POST"
],
"description": "bel_belgium_post."
},
{
"type": "string",
"enum": [
"US_APC"
],
"description": "us_apc."
},
{
"type": "string",
"enum": [
"IDN_POS"
],
"description": "idn_pos."
},
{
"type": "string",
"enum": [
"FR_MONDIAL"
],
"description": "fr_mondial."
},
{
"type": "string",
"enum": [
"DE_DHL"
],
"description": "DE DHL."
},
{
"type": "string",
"enum": [
"HK_RPX"
],
"description": "hk_rpx."
},
{
"type": "string",
"enum": [
"DHL_PIECEID"
],
"description": "dhl_pieceid."
},
{
"type": "string",
"enum": [
"VNPOST_EMS"
],
"description": "vnpost_ems."
},
{
"type": "string",
"enum": [
"RRDONNELLEY"
],
"description": "rrdonnelley."
},
{
"type": "string",
"enum": [
"DPD_DE"
],
"description": "dpd_de."
},
{
"type": "string",
"enum": [
"DELCART_IN"
],
"description": "delcart_in."
},
{
"type": "string",
"enum": [
"IMEXGLOBALSOLUTIONS"
],
"description": "imexglobalsolutions."
},
{
"type": "string",
"enum": [
"ACOMMERCE"
],
"description": "ACOMMERCE."
},
{
"type": "string",
"enum": [
"EURODIS"
],
"description": "eurodis."
},
{
"type": "string",
"enum": [
"CANPAR"
],
"description": "CANPAR."
},
{
"type": "string",
"enum": [
"GLS"
],
"description": "GLS."
},
{
"type": "string",
"enum": [
"IND_ECOM"
],
"description": "Ecom Express."
},
{
"type": "string",
"enum": [
"ESP_ENVIALIA"
],
"description": "Envialia."
},
{
"type": "string",
"enum": [
"DHL_UK"
],
"description": "dhl UK."
},
{
"type": "string",
"enum": [
"SMSA_EXPRESS"
],
"description": "SMSA Express."
},
{
"type": "string",
"enum": [
"TNT_FR"
],
"description": "TNT France."
},
{
"type": "string",
"enum": [
"DEX_I"
],
"description": "DEX-I courier."
},
{
"type": "string",
"enum": [
"BUDBEE_WEBHOOK"
],
"description": "Budbee courier."
},
{
"type": "string",
"enum": [
"COPA_COURIER"
],
"description": "Copa Airlines Courier."
},
{
"type": "string",
"enum": [
"VNM_VIETNAM_POST"
],
"description": "Vietnam Post."
},
{
"type": "string",
"enum": [
"DPD_HK"
],
"description": "DPD HongKong."
},
{
"type": "string",
"enum": [
"TOLL_NZ"
],
"description": "Toll New Zealand."
},
{
"type": "string",
"enum": [
"ECHO"
],
"description": "Echo courier."
},
{
"type": "string",
"enum": [
"FEDEX_FR"
],
"description": "FedEx® Freight."
},
{
"type": "string",
"enum": [
"BORDEREXPRESS"
],
"description": "Border Express."
},
{
"type": "string",
"enum": [
"MAILPLUS_JPN"
],
"description": "MailPlus (Japan)."
},
{
"type": "string",
"enum": [
"TNT_UK_REFR"
],
"description": "TNT UK Reference."
},
{
"type": "string",
"enum": [
"KEC"
],
"description": "KEC courier."
},
{
"type": "string",
"enum": [
"DPD_RO"
],
"description": "DPD Romania."
},
{
"type": "string",
"enum": [
"TNT_JP"
],
"description": "TNT_JP."
},
{
"type": "string",
"enum": [
"TH_CJ"
],
"description": "TH_CJ."
},
{
"type": "string",
"enum": [
"EC_CN"
],
"description": "EC_CN."
},
{
"type": "string",
"enum": [
"FASTWAY_UK"
],
"description": "FASTWAY_UK."
},
{
"type": "string",
"enum": [
"FASTWAY_US"
],
"description": "FASTWAY_US."
},
{
"type": "string",
"enum": [
"GLS_DE"
],
"description": "GLS_DE."
},
{
"type": "string",
"enum": [
"GLS_ES"
],
"description": "GLS_ES."
},
{
"type": "string",
"enum": [
"GLS_FR"
],
"description": "GLS_FR."
},
{
"type": "string",
"enum": [
"MONDIAL_BE"
],
"description": "MONDIAL_BE."
},
{
"type": "string",
"enum": [
"SGT_IT"
],
"description": "SGT_IT."
},
{
"type": "string",
"enum": [
"TNT_CN"
],
"description": "TNT_CN."
},
{
"type": "string",
"enum": [
"TNT_DE"
],
"description": "TNT_DE."
},
{
"type": "string",
"enum": [
"TNT_ES"
],
"description": "TNT_ES."
},
{
"type": "string",
"enum": [
"TNT_PL"
],
"description": "TNT_PL."
},
{
"type": "string",
"enum": [
"PARCELFORCE"
],
"description": "PARCELFORCE."
},
{
"type": "string",
"enum": [
"SWISS_POST"
],
"description": "SWISS POST."
},
{
"type": "string",
"enum": [
"TOLL_IPEC"
],
"description": "TOLL IPEC."
},
{
"type": "string",
"enum": [
"AIR_21"
],
"description": "AIR 21."
},
{
"type": "string",
"enum": [
"AIRSPEED"
],
"description": "AIRSPEED."
},
{
"type": "string",
"enum": [
"BERT"
],
"description": "BERT."
},
{
"type": "string",
"enum": [
"BLUEDART"
],
"description": "BLUEDART."
},
{
"type": "string",
"enum": [
"COLLECTPLUS"
],
"description": "COLLECTPLUS."
},
{
"type": "string",
"enum": [
"COURIERPLUS"
],
"description": "COURIERPLUS."
},
{
"type": "string",
"enum": [
"COURIER_POST"
],
"description": "COURIER POST."
},
{
"type": "string",
"enum": [
"DHL_GLOBAL_MAIL"
],
"description": "dhl_global_mail."
},
{
"type": "string",
"enum": [
"DPD_UK"
],
"description": "dpd_uk."
},
{
"type": "string",
"enum": [
"DELTEC_DE"
],
"description": "DELTEC DE."
},
{
"type": "string",
"enum": [
"DEUTSCHE_DE"
],
"description": "deutsche_de."
},
{
"type": "string",
"enum": [
"DOTZOT"
],
"description": "DOTZOT."
},
{
"type": "string",
"enum": [
"ELTA_GR"
],
"description": "elta_gr."
},
{
"type": "string",
"enum": [
"EMS_CN"
],
"description": "ems_cn."
},
{
"type": "string",
"enum": [
"ECARGO"
],
"description": "ECARGO."
},
{
"type": "string",
"enum": [
"ENSENDA"
],
"description": "ENSENDA."
},
{
"type": "string",
"enum": [
"FERCAM_IT"
],
"description": "fercam_it."
},
{
"type": "string",
"enum": [
"FASTWAY_ZA"
],
"description": "fastway_za."
},
{
"type": "string",
"enum": [
"FASTWAY_AU"
],
"description": "fastway_au."
},
{
"type": "string",
"enum": [
"FIRST_LOGISITCS"
],
"description": "first_logisitcs."
},
{
"type": "string",
"enum": [
"GEODIS"
],
"description": "GEODIS."
},
{
"type": "string",
"enum": [
"GLOBEGISTICS"
],
"description": "GLOBEGISTICS."
},
{
"type": "string",
"enum": [
"GREYHOUND"
],
"description": "GREYHOUND."
},
{
"type": "string",
"enum": [
"JETSHIP_MY"
],
"description": "jetship_my."
},
{
"type": "string",
"enum": [
"LION_PARCEL"
],
"description": "LION PARCEL."
},
{
"type": "string",
"enum": [
"AEROFLASH"
],
"description": "AEROFLASH."
},
{
"type": "string",
"enum": [
"ONTRAC"
],
"description": "ONTRAC."
},
{
"type": "string",
"enum": [
"SAGAWA"
],
"description": "SAGAWA."
},
{
"type": "string",
"enum": [
"SIODEMKA"
],
"description": "SIODEMKA."
},
{
"type": "string",
"enum": [
"STARTRACK"
],
"description": "startrack."
},
{
"type": "string",
"enum": [
"TNT_AU"
],
"description": "tnt_au."
},
{
"type": "string",
"enum": [
"TNT_IT"
],
"description": "tnt_it."
},
{
"type": "string",
"enum": [
"TRANSMISSION"
],
"description": "TRANSMISSION."
},
{
"type": "string",
"enum": [
"YAMATO"
],
"description": "YAMATO."
},
{
"type": "string",
"enum": [
"DHL_IT"
],
"description": "dhl_it."
},
{
"type": "string",
"enum": [
"DHL_AT"
],
"description": "dhl_at."
},
{
"type": "string",
"enum": [
"LOGISTICSWORLDWIDE_KR"
],
"description": "LOGISTICSWORLDWIDE KR."
},
{
"type": "string",
"enum": [
"GLS_SPAIN"
],
"description": "gls_spain."
},
{
"type": "string",
"enum": [
"AMAZON_UK_API"
],
"description": "amazon_uk_api."
},
{
"type": "string",
"enum": [
"DPD_FR_REFERENCE"
],
"description": "dpd_fr_reference."
},
{
"type": "string",
"enum": [
"DHLPARCEL_UK"
],
"description": "dhlparcel_uk."
},
{
"type": "string",
"enum": [
"MEGASAVE"
],
"description": "megasave."
},
{
"type": "string",
"enum": [
"QUALITYPOST"
],
"description": "qualitypost."
},
{
"type": "string",
"enum": [
"IDS_LOGISTICS"
],
"description": "ids_logistics."
},
{
"type": "string",
"enum": [
"JOYINGBOX"
],
"description": "joyingbox."
},
{
"type": "string",
"enum": [
"PANTHER_ORDER_NUMBER"
],
"description": "panther_order_number."
},
{
"type": "string",
"enum": [
"WATKINS_SHEPARD"
],
"description": "watkins_shepard."
},
{
"type": "string",
"enum": [
"FASTTRACK"
],
"description": "fasttrack."
},
{
"type": "string",
"enum": [
"UP_EXPRESS"
],
"description": "up_express."
},
{
"type": "string",
"enum": [
"ELOGISTICA"
],
"description": "elogistica."
},
{
"type": "string",
"enum": [
"ECOURIER"
],
"description": "ecourier."
},
{
"type": "string",
"enum": [
"CJ_PHILIPPINES"
],
"description": "cj_philippines."
},
{
"type": "string",
"enum": [
"SPEEDEX"
],
"description": "speedex."
},
{
"type": "string",
"enum": [
"ORANGECONNEX"
],
"description": "orangeconnex."
},
{
"type": "string",
"enum": [
"TECOR"
],
"description": "tecor."
},
{
"type": "string",
"enum": [
"SAEE"
],
"description": "saee."
},
{
"type": "string",
"enum": [
"GLS_ITALY_FTP"
],
"description": "gls_italy_ftp."
},
{
"type": "string",
"enum": [
"DELIVERE"
],
"description": "delivere."
},
{
"type": "string",
"enum": [
"YYCOM"
],
"description": "yycom."
},
{
"type": "string",
"enum": [
"ADICIONAL_PT"
],
"description": "Adicional Logistics."
},
{
"type": "string",
"enum": [
"DKSH"
],
"description": "DKSH."
},
{
"type": "string",
"enum": [
"NIPPON_EXPRESS_FTP"
],
"description": "Nippon Express."
},
{
"type": "string",
"enum": [
"GOLS"
],
"description": "GO Logistics & Storage."
},
{
"type": "string",
"enum": [
"FUJEXP"
],
"description": "FUJIE EXPRESS."
},
{
"type": "string",
"enum": [
"QTRACK"
],
"description": "QTrack."
},
{
"type": "string",
"enum": [
"OMLOGISTICS_API"
],
"description": "OM LOGISTICS LTD."
},
{
"type": "string",
"enum": [
"GDPHARM"
],
"description": "GDPharm Logistics."
},
{
"type": "string",
"enum": [
"MISUMI_CN"
],
"description": "MISUMI Group Inc.."
},
{
"type": "string",
"enum": [
"AIR_CANADA"
],
"description": "Rivo."
},
{
"type": "string",
"enum": [
"CITY56_WEBHOOK"
],
"description": "City Express."
},
{
"type": "string",
"enum": [
"SAGAWA_API"
],
"description": "Sagawa."
},
{
"type": "string",
"enum": [
"KEDAEX"
],
"description": "KedaEX."
},
{
"type": "string",
"enum": [
"PGEON_API"
],
"description": "Pgeon."
},
{
"type": "string",
"enum": [
"WEWORLDEXPRESS"
],
"description": "We World Express."
},
{
"type": "string",
"enum": [
"JT_LOGISTICS"
],
"description": "J&T International logistics."
},
{
"type": "string",
"enum": [
"TRUSK"
],
"description": "Trusk France."
},
{
"type": "string",
"enum": [
"VIAXPRESS"
],
"description": "ViaXpress."
},
{
"type": "string",
"enum": [
"DHL_SUPPLYCHAIN_ID"
],
"description": "DHL Supply Chain Indonesia."
},
{
"type": "string",
"enum": [
"ZUELLIGPHARMA_SFTP"
],
"description": "Zuellig Pharma Korea."
},
{
"type": "string",
"enum": [
"MEEST"
],
"description": "Meest."
},
{
"type": "string",
"enum": [
"TOLL_PRIORITY"
],
"description": "Toll Priority."
},
{
"type": "string",
"enum": [
"MOTHERSHIP_API"
],
"description": "Mothership."
},
{
"type": "string",
"enum": [
"CAPITAL"
],
"description": "Capital Transport."
},
{
"type": "string",
"enum": [
"EUROPAKET_API"
],
"description": "Europacket+."
},
{
"type": "string",
"enum": [
"HFD"
],
"description": "HFD."
},
{
"type": "string",
"enum": [
"TOURLINE_REFERENCE"
],
"description": "Tourline Express."
},
{
"type": "string",
"enum": [
"GIO_ECOURIER"
],
"description": "GIO Express Inc."
},
{
"type": "string",
"enum": [
"CN_LOGISTICS"
],
"description": "CN Logistics."
},
{
"type": "string",
"enum": [
"PANDION"
],
"description": "Pandion."
},
{
"type": "string",
"enum": [
"BPOST_API"
],
"description": "Bpost API."
},
{
"type": "string",
"enum": [
"PASSPORTSHIPPING"
],
"description": "Passport Shipping."
},
{
"type": "string",
"enum": [
"PAKAJO"
],
"description": "Pakajo World."
},
{
"type": "string",
"enum": [
"DACHSER"
],
"description": "DACHSER."
},
{
"type": "string",
"enum": [
"YUSEN_SFTP"
],
"description": "Yusen Logistics."
},
{
"type": "string",
"enum": [
"SHYPLITE"
],
"description": "Shypmax."
},
{
"type": "string",
"enum": [
"XYY"
],
"description": "Xingyunyi Logistics."
},
{
"type": "string",
"enum": [
"MWD"
],
"description": "Metropolitan Warehouse & Delivery."
},
{
"type": "string",
"enum": [
"FAXECARGO"
],
"description": "Faxe Cargo."
},
{
"type": "string",
"enum": [
"MAZET"
],
"description": "Groupe Mazet."
},
{
"type": "string",
"enum": [
"FIRST_LOGISTICS_API"
],
"description": "First Logistics."
},
{
"type": "string",
"enum": [
"SPRINT_PACK"
],
"description": "SPRINT PACK."
},
{
"type": "string",
"enum": [
"HERMES_DE_FTP"
],
"description": "Hermes Germany."
},
{
"type": "string",
"enum": [
"CONCISE"
],
"description": "Concise."
},
{
"type": "string",
"enum": [
"KERRY_EXPRESS_TW_API"
],
"description": "Kerry Express TaiWan."
},
{
"type": "string",
"enum": [
"EWE"
],
"description": "EWE Global Express."
},
{
"type": "string",
"enum": [
"FASTDESPATCH"
],
"description": "Fast Despatch Logistics Limited."
},
{
"type": "string",
"enum": [
"ABCUSTOM_SFTP"
],
"description": "AB Custom Group."
},
{
"type": "string",
"enum": [
"CHAZKI"
],
"description": "Chazki."
},
{
"type": "string",
"enum": [
"SHIPPIE"
],
"description": "Shippie."
},
{
"type": "string",
"enum": [
"GEODIS_API"
],
"description": "GEODIS - Distribution & Express."
},
{
"type": "string",
"enum": [
"NAQEL_EXPRESS"
],
"description": "Naqel Express."
},
{
"type": "string",
"enum": [
"PAPA_WEBHOOK"
],
"description": "Papa."
},
{
"type": "string",
"enum": [
"FORWARDAIR"
],
"description": "Forward Air."
},
{
"type": "string",
"enum": [
"DIALOGO_LOGISTICA_API"
],
"description": "Dialogo Logistica."
},
{
"type": "string",
"enum": [
"LALAMOVE_API"
],
"description": "Lalamove."
},
{
"type": "string",
"enum": [
"TOMYDOOR"
],
"description": "Tomydoor."
},
{
"type": "string",
"enum": [
"KRONOS_WEBHOOK"
],
"description": "Kronos Express."
},
{
"type": "string",
"enum": [
"JTCARGO"
],
"description": "J&T CARGO."
},
{
"type": "string",
"enum": [
"T_CAT"
],
"description": "T-cat."
},
{
"type": "string",
"enum": [
"CONCISE_WEBHOOK"
],
"description": "Concise."
},
{
"type": "string",
"enum": [
"TELEPORT_WEBHOOK"
],
"description": "Teleport."
},
{
"type": "string",
"enum": [
"CUSTOMCO_API"
],
"description": "The Custom Companies."
},
{
"type": "string",
"enum": [
"SPX_TH"
],
"description": "Shopee Xpress."
},
{
"type": "string",
"enum": [
"BOLLORE_LOGISTICS"
],
"description": "Bollore Logistics."
},
{
"type": "string",
"enum": [
"CLICKLINK_SFTP"
],
"description": "ClickLink."
},
{
"type": "string",
"enum": [
"M3LOGISTICS"
],
"description": "M3 Logistics."
},
{
"type": "string",
"enum": [
"VNPOST_API"
],
"description": "Vietnam Post."
},
{
"type": "string",
"enum": [
"AXLEHIRE_FTP"
],
"description": "Axlehire."
},
{
"type": "string",
"enum": [
"SHADOWFAX"
],
"description": "Shadowfax."
},
{
"type": "string",
"enum": [
"MYHERMES_UK_API"
],
"description": "EVRi."
},
{
"type": "string",
"enum": [
"DAIICHI"
],
"description": "Daiichi Freight System Inc."
},
{
"type": "string",
"enum": [
"MENSAJEROSURBANOS_API"
],
"description": "Mensajeros Urbanos."
},
{
"type": "string",
"enum": [
"POLARSPEED"
],
"description": "PolarSpeed Inc."
},
{
"type": "string",
"enum": [
"IDEXPRESS_ID"
],
"description": "iDexpress Indonesia."
},
{
"type": "string",
"enum": [
"PAYO"
],
"description": "Payo."
},
{
"type": "string",
"enum": [
"WHISTL_SFTP"
],
"description": "Whistl."
},
{
"type": "string",
"enum": [
"INTEX_DE"
],
"description": "INTEX Paketdienst GmbH."
},
{
"type": "string",
"enum": [
"TRANS2U"
],
"description": "Trans2u."
},
{
"type": "string",
"enum": [
"PRODUCTCAREGROUP_SFTP"
],
"description": "Product Care Services Limited."
},
{
"type": "string",
"enum": [
"BIGSMART"
],
"description": "Big Smart."
},
{
"type": "string",
"enum": [
"EXPEDITORS_API_REF"
],
"description": "Expeditors API Reference."
},
{
"type": "string",
"enum": [
"AITWORLDWIDE_API"
],
"description": "AIT."
},
{
"type": "string",
"enum": [
"WORLDCOURIER"
],
"description": "World Courier."
},
{
"type": "string",
"enum": [
"QUIQUP"
],
"description": "Quiqup."
},
{
"type": "string",
"enum": [
"AGEDISS_SFTP"
],
"description": "Agediss."
},
{
"type": "string",
"enum": [
"ANDREANI_API"
],
"description": "Andreani."
},
{
"type": "string",
"enum": [
"CRLEXPRESS"
],
"description": "CRL Express."
},
{
"type": "string",
"enum": [
"SMARTCAT"
],
"description": "SMARTCAT."
},
{
"type": "string",
"enum": [
"CROSSFLIGHT"
],
"description": "Crossflight Limited."
},
{
"type": "string",
"enum": [
"PROCARRIER"
],
"description": "Pro Carrier."
},
{
"type": "string",
"enum": [
"DHL_REFERENCE_API"
],
"description": "DHL (Reference number)."
},
{
"type": "string",
"enum": [
"SEINO_API"
],
"description": "Seino."
},
{
"type": "string",
"enum": [
"WSPEXPRESS"
],
"description": "WSP Express."
},
{
"type": "string",
"enum": [
"KRONOS"
],
"description": "Kronos Express."
},
{
"type": "string",
"enum": [
"TOTAL_EXPRESS_API"
],
"description": "Total Express."
},
{
"type": "string",
"enum": [
"PARCLL"
],
"description": "PARCLL."
},
{
"type": "string",
"enum": [
"XPEDIGO"
],
"description": "Xpedigo."
},
{
"type": "string",
"enum": [
"STAR_TRACK_WEBHOOK"
],
"description": "StarTrack."
},
{
"type": "string",
"enum": [
"GPOST"
],
"description": "Georgian Post."
},
{
"type": "string",
"enum": [
"UCS"
],
"description": "UCS."
},
{
"type": "string",
"enum": [
"DMFGROUP"
],
"description": "DMF."
},
{
"type": "string",
"enum": [
"COORDINADORA_API"
],
"description": "Coordinadora."
},
{
"type": "string",
"enum": [
"MARKEN"
],
"description": "Marken."
},
{
"type": "string",
"enum": [
"NTL"
],
"description": "NTL logistics."
},
{
"type": "string",
"enum": [
"REDJEPAKKETJE"
],
"description": "Red je Pakketje."
},
{
"type": "string",
"enum": [
"ALLIED_EXPRESS_FTP"
],
"description": "Allied Express (FTP)."
},
{
"type": "string",
"enum": [
"MONDIALRELAY_ES"
],
"description": "Mondial Relay Spain(Punto Pack)."
},
{
"type": "string",
"enum": [
"NAEKO_FTP"
],
"description": "Naeko Logistics."
},
{
"type": "string",
"enum": [
"MHI"
],
"description": "Mhi."
},
{
"type": "string",
"enum": [
"SHIPPIFY"
],
"description": "Shippify, Inc."
},
{
"type": "string",
"enum": [
"MALCA_AMIT_API"
],
"description": "Malca Amit."
},
{
"type": "string",
"enum": [
"JTEXPRESS_SG_API"
],
"description": "J&T Express Singapore."
},
{
"type": "string",
"enum": [
"DACHSER_WEB"
],
"description": "DACHSER."
},
{
"type": "string",
"enum": [
"FLIGHTLG"
],
"description": "Flight Logistics Group."
},
{
"type": "string",
"enum": [
"CAGO"
],
"description": "Cago."
},
{
"type": "string",
"enum": [
"COM1EXPRESS"
],
"description": "ComOne Express."
},
{
"type": "string",
"enum": [
"TONAMI_FTP"
],
"description": "Tonami."
},
{
"type": "string",
"enum": [
"PACKFLEET"
],
"description": "PACKFLEET."
},
{
"type": "string",
"enum": [
"PUROLATOR_INTERNATIONAL"
],
"description": "Purolator International."
},
{
"type": "string",
"enum": [
"WINESHIPPING_WEBHOOK"
],
"description": "Wineshipping."
},
{
"type": "string",
"enum": [
"DHL_ES_SFTP"
],
"description": "DHL Spain Domestic."
},
{
"type": "string",
"enum": [
"PCHOME_API"
],
"description": "網家速配股份有限公司."
},
{
"type": "string",
"enum": [
"CESKAPOSTA_API"
],
"description": "Czech Post."
},
{
"type": "string",
"enum": [
"GORUSH"
],
"description": "Go Rush."
},
{
"type": "string",
"enum": [
"HOMERUNNER"
],
"description": "HomeRunner."
},
{
"type": "string",
"enum": [
"AMAZON_ORDER"
],
"description": "Amazon order."
},
{
"type": "string",
"enum": [
"EFWNOW_API"
],
"description": "Estes Forwarding Worldwide."
},
{
"type": "string",
"enum": [
"CBL_LOGISTICA_API"
],
"description": "CBL Logistica (API)."
},
{
"type": "string",
"enum": [
"NIMBUSPOST"
],
"description": "NimbusPost."
},
{
"type": "string",
"enum": [
"LOGWIN_LOGISTICS"
],
"description": "Logwin Logistics."
},
{
"type": "string",
"enum": [
"NOWLOG_API"
],
"description": "Sequoialog."
},
{
"type": "string",
"enum": [
"DPD_NL"
],
"description": "DPD Netherlands."
},
{
"type": "string",
"enum": [
"GODEPENDABLE"
],
"description": "Dependable Supply Chain Services."
},
{
"type": "string",
"enum": [
"ESDEX"
],
"description": "Top Ideal Express."
},
{
"type": "string",
"enum": [
"LOGISYSTEMS_SFTP"
],
"description": "Kiitäjät."
},
{
"type": "string",
"enum": [
"EXPEDITORS"
],
"description": "Expeditors."
},
{
"type": "string",
"enum": [
"SNTGLOBAL_API"
],
"description": "Snt Global Etrax."
},
{
"type": "string",
"enum": [
"SHIPX"
],
"description": "ShipX."
},
{
"type": "string",
"enum": [
"QINTL_API"
],
"description": "Quickstat Courier LLC."
},
{
"type": "string",
"enum": [
"PACKS"
],
"description": "Packs."
},
{
"type": "string",
"enum": [
"POSTNL_INTERNATIONAL"
],
"description": "PostNL International."
},
{
"type": "string",
"enum": [
"AMAZON_EMAIL_PUSH"
],
"description": "Amazon."
},
{
"type": "string",
"enum": [
"DHL_API"
],
"description": "DHL."
},
{
"type": "string",
"enum": [
"SPX"
],
"description": "Shopee Express."
},
{
"type": "string",
"enum": [
"AXLEHIRE"
],
"description": "AxleHire."
},
{
"type": "string",
"enum": [
"ICSCOURIER"
],
"description": "ICS COURIER."
},
{
"type": "string",
"enum": [
"DIALOGO_LOGISTICA"
],
"description": "Dialogo Logistica."
},
{
"type": "string",
"enum": [
"SHUNBANG_EXPRESS"
],
"description": "ShunBang Express."
},
{
"type": "string",
"enum": [
"TCS_API"
],
"description": "TCS."
},
{
"type": "string",
"enum": [
"SF_EXPRESS_CN"
],
"description": "SF Express China."
},
{
"type": "string",
"enum": [
"PACKETA"
],
"description": "Packeta."
},
{
"type": "string",
"enum": [
"SIC_TELIWAY"
],
"description": "Teliway SIC Express."
},
{
"type": "string",
"enum": [
"MONDIALRELAY_FR"
],
"description": "Mondial Relay France."
},
{
"type": "string",
"enum": [
"INTIME_FTP"
],
"description": "InTime."
},
{
"type": "string",
"enum": [
"JD_EXPRESS"
],
"description": "京东物流."
},
{
"type": "string",
"enum": [
"FASTBOX"
],
"description": "Fastbox."
},
{
"type": "string",
"enum": [
"PATHEON"
],
"description": "Patheon Logistics."
},
{
"type": "string",
"enum": [
"INDIA_POST"
],
"description": "India Post Domestic."
},
{
"type": "string",
"enum": [
"TIPSA_REF"
],
"description": "Tipsa Reference."
},
{
"type": "string",
"enum": [
"ECOFREIGHT"
],
"description": "Eco Freight."
},
{
"type": "string",
"enum": [
"VOX"
],
"description": "VOX SOLUCION EMPRESARIAL SRL."
},
{
"type": "string",
"enum": [
"DIRECTFREIGHT_AU_REF"
],
"description": "Direct Freight Express."
},
{
"type": "string",
"enum": [
"BESTTRANSPORT_SFTP"
],
"description": "Best Transport."
},
{
"type": "string",
"enum": [
"AUSTRALIA_POST_API"
],
"description": "Australia Post."
},
{
"type": "string",
"enum": [
"FRAGILEPAK_SFTP"
],
"description": "FragilePAK."
},
{
"type": "string",
"enum": [
"FLIPXP"
],
"description": "FlipXpress."
},
{
"type": "string",
"enum": [
"VALUE_WEBHOOK"
],
"description": "Value Logistics."
},
{
"type": "string",
"enum": [
"DAESHIN"
],
"description": "Daeshin."
},
{
"type": "string",
"enum": [
"SHERPA"
],
"description": "Sherpa."
},
{
"type": "string",
"enum": [
"MWD_API"
],
"description": "Metropolitan Warehouse & Delivery."
},
{
"type": "string",
"enum": [
"SMARTKARGO"
],
"description": "SmartKargo."
},
{
"type": "string",
"enum": [
"DNJ_EXPRESS"
],
"description": "DNJ Express."
},
{
"type": "string",
"enum": [
"GOPEOPLE"
],
"description": "Go People."
},
{
"type": "string",
"enum": [
"MYSENDLE_API"
],
"description": "mySendle."
},
{
"type": "string",
"enum": [
"ARAMEX_API"
],
"description": "Aramex."
},
{
"type": "string",
"enum": [
"PIDGE"
],
"description": "Pidge."
},
{
"type": "string",
"enum": [
"THAIPARCELS"
],
"description": "TP Logistic."
},
{
"type": "string",
"enum": [
"PANTHER_REFERENCE_API"
],
"description": "Panther Reference."
},
{
"type": "string",
"enum": [
"POSTAPLUS"
],
"description": "Posta Plus."
},
{
"type": "string",
"enum": [
"BUFFALO"
],
"description": "BUFFALO."
},
{
"type": "string",
"enum": [
"U_ENVIOS"
],
"description": "U-ENVIOS."
},
{
"type": "string",
"enum": [
"ELITE_CO"
],
"description": "Elite Express."
},
{
"type": "string",
"enum": [
"ROCHE_INTERNAL_SFTP"
],
"description": "Roche Internal Courier."
},
{
"type": "string",
"enum": [
"DBSCHENKER_ICELAND"
],
"description": "DB Schenker Iceland."
},
{
"type": "string",
"enum": [
"TNT_FR_REFERENCE"
],
"description": "TNT France Reference."
},
{
"type": "string",
"enum": [
"NEWGISTICSAPI"
],
"description": "Newgistics API."
},
{
"type": "string",
"enum": [
"GLOVO"
],
"description": "Glovo."
},
{
"type": "string",
"enum": [
"GWLOGIS_API"
],
"description": "G.I.G."
},
{
"type": "string",
"enum": [
"SPREETAIL_API"
],
"description": "Spreetail."
},
{
"type": "string",
"enum": [
"MOOVA"
],
"description": "Moova."
},
{
"type": "string",
"enum": [
"PLYCONGROUP"
],
"description": "Plycon Transportation Group."
},
{
"type": "string",
"enum": [
"USPS_WEBHOOK"
],
"description": "USPS Informed Visibility - Webhook."
},
{
"type": "string",
"enum": [
"REIMAGINEDELIVERY"
],
"description": "maergo."
},
{
"type": "string",
"enum": [
"EDF_FTP"
],
"description": "Eurodifarm."
},
{
"type": "string",
"enum": [
"DAO365"
],
"description": "DAO365."
},
{
"type": "string",
"enum": [
"BIOCAIR_FTP"
],
"description": "BioCair."
},
{
"type": "string",
"enum": [
"RANSA_WEBHOOK"
],
"description": "Ransa."
},
{
"type": "string",
"enum": [
"SHIPXPRES"
],
"description": "SHIPXPRESS."
},
{
"type": "string",
"enum": [
"COURANT_PLUS_API"
],
"description": "Courant Plus."
},
{
"type": "string",
"enum": [
"SHIPA"
],
"description": "SHIPA."
},
{
"type": "string",
"enum": [
"HOMELOGISTICS"
],
"description": "Home Logistics."
},
{
"type": "string",
"enum": [
"DX"
],
"description": "DX."
},
{
"type": "string",
"enum": [
"POSTE_ITALIANE_PACCOCELERE"
],
"description": "Poste Italiane Paccocelere."
},
{
"type": "string",
"enum": [
"TOLL_WEBHOOK"
],
"description": "Toll Group."
},
{
"type": "string",
"enum": [
"LCTBR_API"
],
"description": "LCT do Brasil."
},
{
"type": "string",
"enum": [
"DX_FREIGHT"
],
"description": "DX Freight."
},
{
"type": "string",
"enum": [
"DHL_SFTP"
],
"description": "DHL Express."
},
{
"type": "string",
"enum": [
"SHIPROCKET"
],
"description": "Shiprocket X."
},
{
"type": "string",
"enum": [
"UBER_WEBHOOK"
],
"description": "Uber."
},
{
"type": "string",
"enum": [
"STATOVERNIGHT"
],
"description": "Stat Overnight."
},
{
"type": "string",
"enum": [
"BURD"
],
"description": "Burd Delivery."
},
{
"type": "string",
"enum": [
"FASTSHIP"
],
"description": "Fastship Express."
},
{
"type": "string",
"enum": [
"IBVENTURE_WEBHOOK"
],
"description": "IB Venture."
},
{
"type": "string",
"enum": [
"GATI_KWE_API"
],
"description": "Gati-KWE."
},
{
"type": "string",
"enum": [
"CRYOPDP_FTP"
],
"description": "CryoPDP."
},
{
"type": "string",
"enum": [
"HUBBED"
],
"description": "HUBBED."
},
{
"type": "string",
"enum": [
"TIPSA_API"
],
"description": "Tipsa API."
},
{
"type": "string",
"enum": [
"ARASKARGO"
],
"description": "Aras Cargo."
},
{
"type": "string",
"enum": [
"THIJS_NL"
],
"description": "Thijs Logistiek."
},
{
"type": "string",
"enum": [
"ATSHEALTHCARE_REFERENCE"
],
"description": "ATS Healthcare."
},
{
"type": "string",
"enum": [
"99MINUTOS"
],
"description": "99minutos."
},
{
"type": "string",
"enum": [
"HELLENIC_POST"
],
"description": "Hellenic (Greece) Post."
},
{
"type": "string",
"enum": [
"HSM_GLOBAL"
],
"description": "HSM Global."
},
{
"type": "string",
"enum": [
"MNX"
],
"description": "MNX."
},
{
"type": "string",
"enum": [
"NMTRANSFER"
],
"description": "N&M Transfer Co., Inc.."
},
{
"type": "string",
"enum": [
"LOGYSTO"
],
"description": "Logysto."
},
{
"type": "string",
"enum": [
"INDIA_POST_INT"
],
"description": "India Post International."
},
{
"type": "string",
"enum": [
"AMAZON_FBA_SWISHIP_IN"
],
"description": "Swiship IN."
},
{
"type": "string",
"enum": [
"SRT_TRANSPORT"
],
"description": "SRT Transport."
},
{
"type": "string",
"enum": [
"BOMI"
],
"description": "Bomi Group."
},
{
"type": "string",
"enum": [
"DELIVERR_SFTP"
],
"description": "Deliverr."
},
{
"type": "string",
"enum": [
"HSDEXPRESS"
],
"description": "HSDEXPRESS."
},
{
"type": "string",
"enum": [
"SIMPLETIRE_WEBHOOK"
],
"description": "SimpleTire."
},
{
"type": "string",
"enum": [
"HUNTER_EXPRESS_SFTP"
],
"description": "Hunter Express."
},
{
"type": "string",
"enum": [
"UPS_API"
],
"description": "UPS."
},
{
"type": "string",
"enum": [
"WOOYOUNG_LOGISTICS_SFTP"
],
"description": "WOO YOUNG LOGISTICS CO.,LTD.."
},
{
"type": "string",
"enum": [
"PHSE_API"
],
"description": "PHSE."
},
{
"type": "string",
"enum": [
"WISH_EMAIL_PUSH"
],
"description": "Wish."
},
{
"type": "string",
"enum": [
"NORTHLINE"
],
"description": "Northline."
},
{
"type": "string",
"enum": [
"MEDAFRICA"
],
"description": "Med Africa Logistics."
},
{
"type": "string",
"enum": [
"DPD_AT_SFTP"
],
"description": "DPD Austria."
},
{
"type": "string",
"enum": [
"ANTERAJA"
],
"description": "Anteraja."
},
{
"type": "string",
"enum": [
"DHL_GLOBAL_FORWARDING_API"
],
"description": "DHL Global Forwarding API."
},
{
"type": "string",
"enum": [
"LBCEXPRESS_API"
],
"description": "LBC EXPRESS INC.."
},
{
"type": "string",
"enum": [
"SIMSGLOBAL"
],
"description": "Sims Global."
},
{
"type": "string",
"enum": [
"CDLDELIVERS"
],
"description": "CDL Last Mile."
},
{
"type": "string",
"enum": [
"TYP"
],
"description": "TYP."
},
{
"type": "string",
"enum": [
"TESTING_COURIER_WEBHOOK"
],
"description": "Testing Courier."
},
{
"type": "string",
"enum": [
"PANDAGO_API"
],
"description": "Pandago."
},
{
"type": "string",
"enum": [
"ROYAL_MAIL_FTP"
],
"description": "Royal Mail."
},
{
"type": "string",
"enum": [
"THUNDEREXPRESS"
],
"description": "Thunder Express Australia."
},
{
"type": "string",
"enum": [
"SECRETLAB_WEBHOOK"
],
"description": "Secretlab."
},
{
"type": "string",
"enum": [
"SETEL"
],
"description": "Setel Express."
},
{
"type": "string",
"enum": [
"JD_WORLDWIDE"
],
"description": "JD Worldwide."
},
{
"type": "string",
"enum": [
"DPD_RU_API"
],
"description": "DPD Russia."
},
{
"type": "string",
"enum": [
"ARGENTS_WEBHOOK"
],
"description": "Argents Express Group."
},
{
"type": "string",
"enum": [
"POSTONE"
],
"description": "Post ONE."
},
{
"type": "string",
"enum": [
"TUSKLOGISTICS"
],
"description": "Tusk Logistics."
},
{
"type": "string",
"enum": [
"RHENUS_UK_API"
],
"description": "Rhenus Logistics UK."
},
{
"type": "string",
"enum": [
"TAQBIN_SG_API"
],
"description": "Yamato Singapore."
},
{
"type": "string",
"enum": [
"INNTRALOG_SFTP"
],
"description": "Inntralog GmbH."
},
{
"type": "string",
"enum": [
"DAYROSS"
],
"description": "Day & Ross."
},
{
"type": "string",
"enum": [
"CORREOSEXPRESS_API"
],
"description": "Correos Express (API)."
},
{
"type": "string",
"enum": [
"INTERNATIONAL_SEUR_API"
],
"description": "International Seur API."
},
{
"type": "string",
"enum": [
"YODEL_API"
],
"description": "Yodel API."
},
{
"type": "string",
"enum": [
"HEROEXPRESS"
],
"description": "Hero Express."
},
{
"type": "string",
"enum": [
"DHL_SUPPLYCHAIN_IN"
],
"description": "DHL supply chain India."
},
{
"type": "string",
"enum": [
"URGENT_CARGUS"
],
"description": "Urgent Cargus."
},
{
"type": "string",
"enum": [
"FRONTDOORCORP"
],
"description": "FRONTdoor Collective."
},
{
"type": "string",
"enum": [
"JTEXPRESS_PH"
],
"description": "J&T Express Philippines."
},
{
"type": "string",
"enum": [
"PARCELSTARS_WEBHOOK"
],
"description": "Parcelstars."
},
{
"type": "string",
"enum": [
"DPD_SK_SFTP"
],
"description": "DPD Slovakia."
},
{
"type": "string",
"enum": [
"MOVIANTO"
],
"description": "Movianto."
},
{
"type": "string",
"enum": [
"OZEPARTS_SHIPPING"
],
"description": "Ozeparts Shipping."
},
{
"type": "string",
"enum": [
"KARGOMKOLAY"
],
"description": "KargomKolay (CargoMini)."
},
{
"type": "string",
"enum": [
"TRUNKRS"
],
"description": "Trunkrs."
},
{
"type": "string",
"enum": [
"OMNIRPS_WEBHOOK"
],
"description": "Omni Returns."
},
{
"type": "string",
"enum": [
"CHILEXPRESS"
],
"description": "Chile Express."
},
{
"type": "string",
"enum": [
"TESTING_COURIER"
],
"description": "Testing Courier."
},
{
"type": "string",
"enum": [
"JNE_API"
],
"description": "JNE (API)."
},
{
"type": "string",
"enum": [
"BJSHOMEDELIVERY_FTP"
],
"description": "BJS Distribution, Storage & Couriers - FTP."
},
{
"type": "string",
"enum": [
"DEXPRESS_WEBHOOK"
],
"description": "D Express."
},
{
"type": "string",
"enum": [
"USPS_API"
],
"description": "USPS API."
},
{
"type": "string",
"enum": [
"TRANSVIRTUAL"
],
"description": "TransVirtual."
},
{
"type": "string",
"enum": [
"SOLISTICA_API"
],
"description": "solistica."
},
{
"type": "string",
"enum": [
"CHIENVENTURE_WEBHOOK"
],
"description": "Chienventure."
},
{
"type": "string",
"enum": [
"DPD_UK_SFTP"
],
"description": "DPD UK."
},
{
"type": "string",
"enum": [
"INPOST_UK"
],
"description": "InPost."
},
{
"type": "string",
"enum": [
"JAVIT"
],
"description": "Javit."
},
{
"type": "string",
"enum": [
"ZTO_DOMESTIC"
],
"description": "ZTO Express China."
},
{
"type": "string",
"enum": [
"DHL_GT_API"
],
"description": "DHL Global Forwarding Guatemala."
},
{
"type": "string",
"enum": [
"CEVA_TRACKING"
],
"description": "CEVA Package."
},
{
"type": "string",
"enum": [
"KOMON_EXPRESS"
],
"description": "Komon Express."
},
{
"type": "string",
"enum": [
"EASTWESTCOURIER_FTP"
],
"description": "East West Courier Pte Ltd."
},
{
"type": "string",
"enum": [
"DANNIAO"
],
"description": "Danniao."
},
{
"type": "string",
"enum": [
"SPECTRAN"
],
"description": "Spectran."
},
{
"type": "string",
"enum": [
"DELIVER_IT"
],
"description": "Deliver-iT."
},
{
"type": "string",
"enum": [
"RELAISCOLIS"
],
"description": "Relais Colis."
},
{
"type": "string",
"enum": [
"GLS_SPAIN_API"
],
"description": "GLS Spain."
},
{
"type": "string",
"enum": [
"POSTPLUS"
],
"description": "PostPlus."
},
{
"type": "string",
"enum": [
"AIRTERRA"
],
"description": "Airterra."
},
{
"type": "string",
"enum": [
"GIO_ECOURIER_API"
],
"description": "GIO Express Ecourier."
},
{
"type": "string",
"enum": [
"DPD_CH_SFTP"
],
"description": "DPD Switzerland."
},
{
"type": "string",
"enum": [
"FEDEX_API"
],
"description": "FedEx®."
},
{
"type": "string",
"enum": [
"INTERSMARTTRANS"
],
"description": "INTERSMARTTRANS & SOLUTIONS SL."
},
{
"type": "string",
"enum": [
"HERMES_UK_SFTP"
],
"description": "Hermes UK."
},
{
"type": "string",
"enum": [
"EXELOT_FTP"
],
"description": "Exelot Ltd.."
},
{
"type": "string",
"enum": [
"DHL_PA_API"
],
"description": "DHL GLOBAL FORWARDING PANAMÁ."
},
{
"type": "string",
"enum": [
"VIRTRANSPORT_SFTP"
],
"description": "Vir Transport."
},
{
"type": "string",
"enum": [
"WORLDNET"
],
"description": "Worldnet Logistics."
},
{
"type": "string",
"enum": [
"INSTABOX_WEBHOOK"
],
"description": "Instabox."
},
{
"type": "string",
"enum": [
"KNG"
],
"description": "Keuhne + Nagel Global."
},
{
"type": "string",
"enum": [
"FLASHEXPRESS_WEBHOOK"
],
"description": "Flash Express."
},
{
"type": "string",
"enum": [
"MAGYAR_POSTA_API"
],
"description": "Magyar Posta."
},
{
"type": "string",
"enum": [
"WESHIP_API"
],
"description": "WeShip."
},
{
"type": "string",
"enum": [
"OHI_WEBHOOK"
],
"description": "Ohi."
},
{
"type": "string",
"enum": [
"MUDITA"
],
"description": "MUDITA."
},
{
"type": "string",
"enum": [
"BLUEDART_API"
],
"description": "Bluedart."
},
{
"type": "string",
"enum": [
"T_CAT_API"
],
"description": "T-cat."
},
{
"type": "string",
"enum": [
"ADS"
],
"description": "ADS Express."
},
{
"type": "string",
"enum": [
"HERMES_IT"
],
"description": "HR Parcel."
},
{
"type": "string",
"enum": [
"FITZMARK_API"
],
"description": "FitzMark."
},
{
"type": "string",
"enum": [
"POSTI_API"
],
"description": "Posti API."
},
{
"type": "string",
"enum": [
"SMSA_EXPRESS_WEBHOOK"
],
"description": "SMSA Express."
},
{
"type": "string",
"enum": [
"TAMERGROUP_WEBHOOK"
],
"description": "Tamer Logistics."
},
{
"type": "string",
"enum": [
"LIVRAPIDE"
],
"description": "Livrapide."
},
{
"type": "string",
"enum": [
"NIPPON_EXPRESS"
],
"description": "Nippon Express."
},
{
"type": "string",
"enum": [
"BETTERTRUCKS"
],
"description": "Better Trucks."
},
{
"type": "string",
"enum": [
"FAN"
],
"description": "FAN COURIER EXPRESS."
},
{
"type": "string",
"enum": [
"PB_USPSFLATS_FTP"
],
"description": "USPS Flats (Pitney Bowes)."
},
{
"type": "string",
"enum": [
"PARCELRIGHT"
],
"description": "Parcel Right."
},
{
"type": "string",
"enum": [
"ITHINKLOGISTICS"
],
"description": "iThink Logistics."
},
{
"type": "string",
"enum": [
"KERRY_EXPRESS_TH_WEBHOOK"
],
"description": "Kerry Logistics."
},
{
"type": "string",
"enum": [
"ECOUTIER"
],
"description": "eCoutier."
},
{
"type": "string",
"enum": [
"SHOWL"
],
"description": "SENHONG INTERNATIONAL LOGISTICS."
},
{
"type": "string",
"enum": [
"BRT_IT_API"
],
"description": "BRT Bartolini API."
},
{
"type": "string",
"enum": [
"RIXONHK_API"
],
"description": "Rixon Logistics."
},
{
"type": "string",
"enum": [
"DBSCHENKER_API"
],
"description": "DB Schenker."
},
{
"type": "string",
"enum": [
"ILYANGLOGIS"
],
"description": "Ilyang logistics."
},
{
"type": "string",
"enum": [
"MAIL_BOX_ETC"
],
"description": "Mail Boxes Etc.."
},
{
"type": "string",
"enum": [
"WESHIP"
],
"description": "WeShip."
},
{
"type": "string",
"enum": [
"DHL_GLOBAL_MAIL_API"
],
"description": "DHL eCommerce Solutions."
},
{
"type": "string",
"enum": [
"ACTIVOS24_API"
],
"description": "Activos24."
},
{
"type": "string",
"enum": [
"ATSHEALTHCARE"
],
"description": "ATS Healthcare."
},
{
"type": "string",
"enum": [
"LUWJISTIK"
],
"description": "Luwjistik."
},
{
"type": "string",
"enum": [
"GW_WORLD"
],
"description": "Gebrüder Weiss."
},
{
"type": "string",
"enum": [
"FAIRSENDEN_API"
],
"description": "fairsenden."
},
{
"type": "string",
"enum": [
"SERVIP_WEBHOOK"
],
"description": "SerVIP."
},
{
"type": "string",
"enum": [
"SWISHIP"
],
"description": "Swiship."
},
{
"type": "string",
"enum": [
"TANET"
],
"description": "Transport Ambientales."
},
{
"type": "string",
"enum": [
"HOTSIN_CARGO"
],
"description": "SHENZHEN HOTSIN CARGO INT'L FORWARDING CO.,LTD."
},
{
"type": "string",
"enum": [
"DIREX"
],
"description": "Direx."
},
{
"type": "string",
"enum": [
"HUANTONG"
],
"description": "HuanTong."
},
{
"type": "string",
"enum": [
"IMILE_API"
],
"description": "iMile."
},
{
"type": "string",
"enum": [
"AUEXPRESS"
],
"description": "Au Express."
},
{
"type": "string",
"enum": [
"NYTLOGISTICS"
],
"description": "NYT SUPPLY CHAIN LOGISTICS Co.,LTD."
},
{
"type": "string",
"enum": [
"DSV_REFERENCE"
],
"description": "DSV Futurewave."
},
{
"type": "string",
"enum": [
"NOVOFARMA_WEBHOOK"
],
"description": "Novofarma."
},
{
"type": "string",
"enum": [
"AITWORLDWIDE_SFTP"
],
"description": "AIT."
},
{
"type": "string",
"enum": [
"SHOPOLIVE"
],
"description": "Olive."
},
{
"type": "string",
"enum": [
"FNF_ZA"
],
"description": "Fast & Furious."
},
{
"type": "string",
"enum": [
"DHL_ECOMMERCE_GC"
],
"description": "DHL eCommerce Greater China."
},
{
"type": "string",
"enum": [
"FETCHR"
],
"description": "Fetchr."
},
{
"type": "string",
"enum": [
"STARLINKS_API"
],
"description": "Starlinks Global."
},
{
"type": "string",
"enum": [
"YYEXPRESS"
],
"description": "YYEXPRESS."
},
{
"type": "string",
"enum": [
"SERVIENTREGA"
],
"description": "Servientrega."
},
{
"type": "string",
"enum": [
"HANJIN"
],
"description": "HanJin."
},
{
"type": "string",
"enum": [
"SPANISH_SEUR_FTP"
],
"description": "Spanish Seur."
},
{
"type": "string",
"enum": [
"DX_B2B_CONNUM"
],
"description": "DX (B2B)."
},
{
"type": "string",
"enum": [
"HELTHJEM_API"
],
"description": "Helthjem."
},
{
"type": "string",
"enum": [
"INEXPOST"
],
"description": "Inexpost."
},
{
"type": "string",
"enum": [
"A2B_BA"
],
"description": "A2B Express Logistics."
},
{
"type": "string",
"enum": [
"RHENUS_GROUP"
],
"description": "Rhenus Logistics."
},
{
"type": "string",
"enum": [
"SBERLOGISTICS_RU"
],
"description": "Sber Logistics."
},
{
"type": "string",
"enum": [
"MALCA_AMIT"
],
"description": "Malca-Amit."
},
{
"type": "string",
"enum": [
"PPL"
],
"description": "Professional Parcel Logistics."
},
{
"type": "string",
"enum": [
"OSM_WORLDWIDE_SFTP"
],
"description": "OSM Worldwide."
},
{
"type": "string",
"enum": [
"ACILOGISTIX"
],
"description": "ACI Logistix."
},
{
"type": "string",
"enum": [
"OPTIMACOURIER"
],
"description": "Optima Courier."
},
{
"type": "string",
"enum": [
"NOVA_POSHTA_API"
],
"description": "Nova Poshta API."
},
{
"type": "string",
"enum": [
"LOGGI"
],
"description": "Loggi."
},
{
"type": "string",
"enum": [
"YIFAN"
],
"description": "YiFan Express."
},
{
"type": "string",
"enum": [
"MYDYNALOGIC"
],
"description": "My DynaLogic."
},
{
"type": "string",
"enum": [
"MORNINGLOBAL"
],
"description": "Morning Global."
},
{
"type": "string",
"enum": [
"CONCISE_API"
],
"description": "Concise."
},
{
"type": "string",
"enum": [
"FXTRAN"
],
"description": "Falcon Express."
},
{
"type": "string",
"enum": [
"DELIVERYOURPARCEL_ZA"
],
"description": "Deliver Your Parcel."
},
{
"type": "string",
"enum": [
"UPARCEL"
],
"description": "uParcel."
},
{
"type": "string",
"enum": [
"MOBI_BR"
],
"description": "Mobi Logistica."
},
{
"type": "string",
"enum": [
"LOGINEXT_WEBHOOK"
],
"description": "T&W Delivery."
},
{
"type": "string",
"enum": [
"EMS"
],
"description": "EMS."
},
{
"type": "string",
"enum": [
"SPEEDY"
],
"description": "Speedy."
},
{
"type": "string",
"enum": [
"ZOOM_RED"
],
"description": "Zoom."
},
{
"type": "string",
"enum": [
"NAVLUNGO"
],
"description": "Navlungo."
},
{
"type": "string",
"enum": [
"CASTLEPARCELS"
],
"description": "Castle Parcels."
},
{
"type": "string",
"enum": [
"WEEE"
],
"description": "Weee."
},
{
"type": "string",
"enum": [
"PACKALY"
],
"description": "Packaly."
},
{
"type": "string",
"enum": [
"YUNHUIPOST"
],
"description": "Yunhuipost."
},
{
"type": "string",
"enum": [
"YOUPARCEL"
],
"description": "YouParcel."
},
{
"type": "string",
"enum": [
"LEMAN"
],
"description": "Leman."
},
{
"type": "string",
"enum": [
"MOOVIN"
],
"description": "Moovin."
},
{
"type": "string",
"enum": [
"URB_IT"
],
"description": "Urb-it."
},
{
"type": "string",
"enum": [
"MULTIENTREGAPANAMA"
],
"description": "Multientrega."
},
{
"type": "string",
"enum": [
"JUSDASR"
],
"description": "Jusdasr."
},
{
"type": "string",
"enum": [
"DISCOUNTPOST"
],
"description": "Discount Post."
},
{
"type": "string",
"enum": [
"RHENUS_UK"
],
"description": "Rhenus Logistics UK."
},
{
"type": "string",
"enum": [
"SWISHIP_JP"
],
"description": "Swiship JP."
},
{
"type": "string",
"enum": [
"GLS_US"
],
"description": "GLS USA."
},
{
"type": "string",
"enum": [
"SMTL"
],
"description": "Southwestern Motor Transport. Inc."
},
{
"type": "string",
"enum": [
"EMEGA"
],
"description": "Discount Post Emega."
},
{
"type": "string",
"enum": [
"EXPRESSONE_SV"
],
"description": "EXPRESSONE Slovenia."
},
{
"type": "string",
"enum": [
"HEPSIJET"
],
"description": "hepsiJET."
},
{
"type": "string",
"enum": [
"WELIVERY"
],
"description": "Welivery."
},
{
"type": "string",
"enum": [
"BRINGER"
],
"description": "Bringer Parcel Services."
},
{
"type": "string",
"enum": [
"EASYROUTES"
],
"description": "EasyRoutes."
},
{
"type": "string",
"enum": [
"MRW"
],
"description": "MRW."
},
{
"type": "string",
"enum": [
"RPM"
],
"description": "RPM."
},
{
"type": "string",
"enum": [
"DPD_PRT"
],
"description": "DPD Portugal."
},
{
"type": "string",
"enum": [
"GLS_ROMANIA"
],
"description": "GLS Romania."
},
{
"type": "string",
"enum": [
"LMPARCEL"
],
"description": "LM Parcel."
},
{
"type": "string",
"enum": [
"GTAGSM"
],
"description": "GTA GSM."
},
{
"type": "string",
"enum": [
"DOMINO"
],
"description": "DOMINO."
},
{
"type": "string",
"enum": [
"ESHIPPER"
],
"description": "eShipper."
},
{
"type": "string",
"enum": [
"TRANSPAK"
],
"description": "Transpak Inc.."
},
{
"type": "string",
"enum": [
"XINDUS"
],
"description": "Xindus."
},
{
"type": "string",
"enum": [
"AOYUE"
],
"description": "Aoyue."
},
{
"type": "string",
"enum": [
"EASYPARCEL"
],
"description": "Easyparcel."
},
{
"type": "string",
"enum": [
"EXPRESSONE"
],
"description": "EXPRESSONE."
},
{
"type": "string",
"enum": [
"SENDEO_KARGO"
],
"description": "Sendeo Kargo."
},
{
"type": "string",
"enum": [
"SPEEDAF"
],
"description": "Speedaf Express."
},
{
"type": "string",
"enum": [
"ETOWER"
],
"description": "eTower."
},
{
"type": "string",
"enum": [
"GCX"
],
"description": "GC Express."
},
{
"type": "string",
"enum": [
"NINJAVAN_VN"
],
"description": "Ninjavan Vietnam."
},
{
"type": "string",
"enum": [
"ALLEGRO"
],
"description": "Allegro."
},
{
"type": "string",
"enum": [
"JUMPPOINT"
],
"description": "Jumppoint."
},
{
"type": "string",
"enum": [
"SHIPGLOBAL_US"
],
"description": "ShipGlobal."
},
{
"type": "string",
"enum": [
"KINISI"
],
"description": "Kinisi Transport Pty Ltd."
},
{
"type": "string",
"enum": [
"OAKH"
],
"description": "Oakh Harbour Freight Lines."
},
{
"type": "string",
"enum": [
"AWEST"
],
"description": "American West."
},
{
"type": "string",
"enum": [
"BARSAN"
],
"description": "Barsan Global Lojistik."
},
{
"type": "string",
"enum": [
"ENERGOLOGISTIC"
],
"description": "Energo Logistic."
},
{
"type": "string",
"enum": [
"MADROOEX"
],
"description": "Madrooex."
},
{
"type": "string",
"enum": [
"GOBOLT"
],
"description": "GoBolt."
},
{
"type": "string",
"enum": [
"SWISS_UNIVERSAL_EXPRESS"
],
"description": "Swiss Universal Express."
},
{
"type": "string",
"enum": [
"IORDIRECT"
],
"description": "IOR Direct Solutions."
},
{
"type": "string",
"enum": [
"XMSZM"
],
"description": "xmszm."
},
{
"type": "string",
"enum": [
"GLS_HUN"
],
"description": "GLS Hungary."
},
{
"type": "string",
"enum": [
"SENDY"
],
"description": "Sendy Express."
},
{
"type": "string",
"enum": [
"BRAUNSEXPRESS"
],
"description": "Brauns Express."
},
{
"type": "string",
"enum": [
"GRANDSLAMEXPRESS"
],
"description": "Grand Slam Express."
},
{
"type": "string",
"enum": [
"XGS"
],
"description": "XGS."
},
{
"type": "string",
"enum": [
"OTSCHILE"
],
"description": "OTS."
},
{
"type": "string",
"enum": [
"PACK_UP"
],
"description": "Pack-Up."
},
{
"type": "string",
"enum": [
"PARCELSTARS"
],
"description": "Parcelstars."
},
{
"type": "string",
"enum": [
"TEAMEXPRESSLLC"
],
"description": "Team Express Service LLC."
},
{
"type": "string",
"enum": [
"ASYADEXPRESS"
],
"description": "Asyad Express."
},
{
"type": "string",
"enum": [
"TDN"
],
"description": "TDN."
},
{
"type": "string",
"enum": [
"EARLYBIRD"
],
"description": "Early Bird."
},
{
"type": "string",
"enum": [
"CACESA"
],
"description": "Cacesa."
},
{
"type": "string",
"enum": [
"PARCELJET"
],
"description": "Parceljet."
},
{
"type": "string",
"enum": [
"MNG_KARGO"
],
"description": "MNG Kargo."
},
{
"type": "string",
"enum": [
"SUPERPACKLINE"
],
"description": "Super Pac Line."
},
{
"type": "string",
"enum": [
"SPEEDX"
],
"description": "SpeedX."
},
{
"type": "string",
"enum": [
"VESYL"
],
"description": "Vesyl."
},
{
"type": "string",
"enum": [
"SKYKING"
],
"description": "Sky King."
},
{
"type": "string",
"enum": [
"DIRMENSAJERIA"
],
"description": "DIR."
},
{
"type": "string",
"enum": [
"NETLOGIXGROUP"
],
"description": "Netlogix."
},
{
"type": "string",
"enum": [
"ZYOU"
],
"description": "ZYEX."
},
{
"type": "string",
"enum": [
"JAWAR"
],
"description": "Jawar."
},
{
"type": "string",
"enum": [
"AGSYSTEMS"
],
"description": "Associate Global Systems."
},
{
"type": "string",
"enum": [
"GPS"
],
"description": "GPS."
},
{
"type": "string",
"enum": [
"PTT_KARGO"
],
"description": "PTT Kargo."
},
{
"type": "string",
"enum": [
"MAERGO"
],
"description": "Maergo."
},
{
"type": "string",
"enum": [
"ARIHANTCOURIER"
],
"description": "AICS."
},
{
"type": "string",
"enum": [
"VTFE"
],
"description": "VicTas Freight Express."
},
{
"type": "string",
"enum": [
"YUNANT"
],
"description": "Yunant."
},
{
"type": "string",
"enum": [
"URBIFY"
],
"description": "Urbify."
},
{
"type": "string",
"enum": [
"PACK_MAN"
],
"description": "pack-man."
},
{
"type": "string",
"enum": [
"LIEFERGRUN"
],
"description": "LIEFERGRUN."
},
{
"type": "string",
"enum": [
"OBIBOX"
],
"description": "Obibox."
},
{
"type": "string",
"enum": [
"PAIKEDA"
],
"description": "Paikeda."
},
{
"type": "string",
"enum": [
"SCOTTY"
],
"description": "Scotty."
},
{
"type": "string",
"enum": [
"INTELCOM_CA"
],
"description": "Intelcom."
},
{
"type": "string",
"enum": [
"SWE"
],
"description": "swe."
},
{
"type": "string",
"enum": [
"ASENDIA"
],
"description": "Asendia Global."
},
{
"type": "string",
"enum": [
"DPD_AT"
],
"description": "DPD Austria."
},
{
"type": "string",
"enum": [
"RELAY"
],
"description": "Relay."
},
{
"type": "string",
"enum": [
"ATA"
],
"description": "ATA."
},
{
"type": "string",
"enum": [
"SKYEXPRESS_INTERNATIONAL"
],
"description": "SkyExpress Internationals."
},
{
"type": "string",
"enum": [
"SURAT_KARGO"
],
"description": "Surat Kargo."
},
{
"type": "string",
"enum": [
"SGLINK"
],
"description": "SG LINK."
},
{
"type": "string",
"enum": [
"FLEETOPTICSINC"
],
"description": "FleetOptics."
},
{
"type": "string",
"enum": [
"SHOPLINE"
],
"description": "shopline."
},
{
"type": "string",
"enum": [
"PIGGYSHIP"
],
"description": "PIGGYSHIP."
},
{
"type": "string",
"enum": [
"LOGOIX"
],
"description": "LogoiX."
},
{
"type": "string",
"enum": [
"KOLAY_GELSIN"
],
"description": "Kolay Gelsin."
},
{
"type": "string",
"enum": [
"ASSOCIATED_COURIERS"
],
"description": "Associated Couriers."
},
{
"type": "string",
"enum": [
"UPS_CHECKER"
],
"description": "ups-checker."
},
{
"type": "string",
"enum": [
"WINESHIPPING"
],
"description": "Wineshipping."
},
{
"type": "string",
"enum": [
"SPEDISCI"
],
"description": "Spedisci online."
},
{
"type": "string",
"enum": [
"FOURKITES"
],
"description": "Fourkites."
},
{
"type": "string",
"enum": [
"ETONAS"
],
"description": "Etonas."
},
{
"type": "string",
"enum": [
"FINMILE"
],
"description": "Fin Mile."
},
{
"type": "string",
"enum": [
"UNIUNI"
],
"description": "Uniuni."
},
{
"type": "string",
"enum": [
"RODONAVES"
],
"description": "Rodonaves."
},
{
"type": "string",
"enum": [
"INPOST_IT"
],
"description": "Inpost Italy."
},
{
"type": "string",
"enum": [
"TFORCE_FREIGHT"
],
"description": "Tforce Freight."
},
{
"type": "string",
"enum": [
"RICHMOM"
],
"description": "Rich Mom."
},
{
"type": "string",
"enum": [
"FRANCO"
],
"description": "Corriere Franco."
},
{
"type": "string",
"enum": [
"ECPARCEL"
],
"description": "Ecparcel."
},
{
"type": "string",
"enum": [
"FEDEX_CHINA"
],
"description": "Fedex China."
},
{
"type": "string",
"enum": [
"GOFO_EXPRESS"
],
"description": "Gofo Express."
},
{
"type": "string",
"enum": [
"SHIPBOB"
],
"description": "Shipbob."
},
{
"type": "string",
"enum": [
"JERSEYPOST_ATLAS"
],
"description": "Jersey Post Group."
},
{
"type": "string",
"enum": [
"CORETRAILS"
],
"description": "Coretrails."
},
{
"type": "string",
"enum": [
"RHENUS_ITALY"
],
"description": "Rhenus Logistics Italy."
},
{
"type": "string",
"enum": [
"JADLOG"
],
"description": "Jadlog."
},
{
"type": "string",
"enum": [
"JITSU"
],
"description": "Jitsu."
},
{
"type": "string",
"enum": [
"YANWEN_EXPRESS"
],
"description": "Yanwen Express."
},
{
"type": "string",
"enum": [
"DASHLINK"
],
"description": "Dashlink."
},
{
"type": "string",
"enum": [
"SEINO_SUPER_EXPRESS"
],
"description": "Seino Super Express."
},
{
"type": "string",
"enum": [
"FLOSHIP"
],
"description": "Floship."
},
{
"type": "string",
"enum": [
"METROSCG"
],
"description": "Metro Supply Chain."
},
{
"type": "string",
"enum": [
"SENDPARCEL"
],
"description": "Sendparcel."
},
{
"type": "string",
"enum": [
"P2P"
],
"description": "P2p."
},
{
"type": "string",
"enum": [
"CN_EXPRESS"
],
"description": "Cn Express."
},
{
"type": "string",
"enum": [
"CIRROTRACK"
],
"description": "Cirro Track."
},
{
"type": "string",
"enum": [
"LAND_LOGISTICS"
],
"description": "Land Logistics."
},
{
"type": "string",
"enum": [
"VEHO"
],
"description": "Veho."
},
{
"type": "string",
"enum": [
"MEDLINE"
],
"description": "Medline."
},
{
"type": "string",
"enum": [
"VDTRACK"
],
"description": "Vdtrack."
},
{
"type": "string",
"enum": [
"SINO_SCM"
],
"description": "Sino Scm."
},
{
"type": "string",
"enum": [
"3PE_EXPRESS"
],
"description": "3pe Express."
},
{
"type": "string",
"enum": [
"SWIFTX"
],
"description": "Swiftx."
},
{
"type": "string",
"enum": [
"SFYDEXPRESS"
],
"description": "Sfyd Express."
},
{
"type": "string",
"enum": [
"TOPTRANS"
],
"description": "Toptrans."
},
{
"type": "string",
"enum": [
"PINAG"
],
"description": "PIN AG."
},
{
"type": "string",
"enum": [
"ONTIME"
],
"description": "Ontime."
},
{
"type": "string",
"enum": [
"MOBELSERVICES"
],
"description": "Mobel Services."
},
{
"type": "string",
"enum": [
"PAACK"
],
"description": "Paack."
},
{
"type": "string",
"enum": [
"URVAAM"
],
"description": "Urvaam."
},
{
"type": "string",
"enum": [
"SPX_PH"
],
"description": "Shopee Express (Philippines)."
},
{
"type": "string",
"enum": [
"SPX_VN"
],
"description": "Shopee Express (Vietnam)\t."
},
{
"type": "string",
"enum": [
"STREAM"
],
"description": "Stream."
},
{
"type": "string",
"enum": [
"FIRSTLOGISTICS"
],
"description": "First Logistics."
},
{
"type": "string",
"enum": [
"WMGDELIVERY"
],
"description": "WMG Group."
},
{
"type": "string",
"enum": [
"EMILE"
],
"description": "Emile."
},
{
"type": "string",
"enum": [
"BFE_EXPRESS"
],
"description": "BFE Express."
},
{
"type": "string",
"enum": [
"CASTLERS"
],
"description": "Castlers Software Company Limited."
},
{
"type": "string",
"enum": [
"EMIRO"
],
"description": "Emiro."
},
{
"type": "string",
"enum": [
"AMAZON_ES"
],
"description": "Amazon Spain."
},
{
"type": "string",
"enum": [
"SKYNETWORLDWIDE_IN"
],
"description": "SkyNet Worldwide Express India."
},
{
"type": "string",
"enum": [
"GOFOEXPRESS_IT"
],
"description": "GOFO Italy."
},
{
"type": "string",
"enum": [
"RUNFORINT"
],
"description": "RFL Runforint Logistics."
},
{
"type": "string",
"enum": [
"GOFOEXPRESS_FR"
],
"description": "GOFO France."
},
{
"type": "string",
"enum": [
"EASY_EXPRESS"
],
"description": "Easy Express."
},
{
"type": "string",
"enum": [
"AMAZON_MCF"
],
"description": "Amazon MCF."
},
{
"type": "string",
"enum": [
"THENILE"
],
"description": "SortHub."
},
{
"type": "string",
"enum": [
"MGCARGO"
],
"description": "MG Cargo."
},
{
"type": "string",
"enum": [
"TOOEXPRESS"
],
"description": "Too Express."
},
{
"type": "string",
"enum": [
"ESPOIRER"
],
"description": "Espoirer."
},
{
"type": "string",
"enum": [
"MAXOPTRA"
],
"description": "Max Optra."
},
{
"type": "string",
"enum": [
"CHAMPAGNE_LOGISTICS"
],
"description": "Champagne Logistics."
},
{
"type": "string",
"enum": [
"DRAGONSTARCURIER"
],
"description": "Dragon Star Curier."
},
{
"type": "string",
"enum": [
"GOFOEXPRESS_NL"
],
"description": "GOFO Netherlands."
},
{
"type": "string",
"enum": [
"PERI_LOGISTICS"
],
"description": "Peri Logistics."
},
{
"type": "string",
"enum": [
"SAMEDAY"
],
"description": "Sameday."
},
{
"type": "string",
"enum": [
"VERTCHEZVOUS"
],
"description": "Vert Chez Vous (Labatut Group)."
},
{
"type": "string",
"enum": [
"ORLENPACZKA"
],
"description": "ORLEN Paczka."
},
{
"type": "string",
"enum": [
"RHENUS_CH"
],
"description": "Rhenus."
},
{
"type": "string",
"enum": [
"BESTFULFILLPACKET"
],
"description": "Bestfulfillpacket."
},
{
"type": "string",
"enum": [
"PROCARRIER_RETURNS"
],
"description": "Pro Carrier Returns."
},
{
"type": "string",
"enum": [
"BASIC_SHIPPING"
],
"description": "Basic Shipping."
},
{
"type": "string",
"enum": [
"PRECISION_DELIVERIES"
],
"description": "Precision Deliveries."
},
{
"type": "string",
"enum": [
"OTHER"
],
"description": "Other."
}
]
},
"shipment_tracker": {
"title": "tracker",
"description": "The tracking information for a shipment.",
"type": "object",
"required": [
"tracking_number",
"carrier"
],
"properties": {
"tracking_number": {
"description": "The tracking number for the shipment. This property supports Unicode.",
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[\\S\\s]*$"
},
"carrier": {
"$ref": "#/components/schemas/shipment_carrier"
},
"carrier_name_other": {
"description": "The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.",
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[\\S\\s]*$"
}
}
},
"order_tracker_request": {
"title": "tracker_request",
"description": "The tracking details of an order.",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shipment_tracker"
},
{
"not": {
"anyOf": [
{
"required": [
"quantity"
]
},
{
"required": [
"transaction_id"
]
},
{
"required": [
"shipment_date"
]
},
{
"required": [
"last_updated_time"
]
},
{
"required": [
"notify_buyer"
]
},
{
"required": [
"tracking_number_type"
]
},
{
"required": [
"status"
]
},
{
"required": [
"postage_payment_id"
]
},
{
"required": [
"tracking_number_validated"
]
},
{
"required": [
"shipment_direction"
]
},
{
"required": [
"shipment_uploader"
]
}
]
}
},
{
"type": "object",
"title": "tracker_request",
"description": "The tracking details of an order.",
"required": [
"capture_id"
],
"properties": {
"capture_id": {
"description": "The PayPal capture ID.",
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "^[a-zA-Z0-9]*$"
},
"notify_payer": {
"description": "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.",
"type": "boolean",
"default": false
},
"items": {
"description": "An array of details of items in the shipment.",
"type": "array",
"minItems": 0,
"maxItems": 32767,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/tracker_item"
},
{
"title": "tracker_item",
"description": "Items in a shipment."
}
]
}
}
}
}
]
},
"shipping_options_purchase_unit": {
"title": "Shipping Option and Amount data at Purchase Unit",
"description": "This would contain shipping option and amount data at purchase unit level.",
"type": "object"
},
"order_update_callback_request": {
"title": "OrderUpdateCallbackRequest",
"description": "Shipping Options Callback request. This will be implemented by the merchants.",
"type": "object",
"required": [
"purchase_units"
],
"properties": {
"id": {
"description": "The ID of the order.",
"type": "string",
"minLength": 1,
"maxLength": 36,
"pattern": "^[A-Z0-9-]+$",
"readOnly": true
},
"shipping_address": {
"allOf": [
{
"$ref": "#/components/schemas/address_portable"
},
{
"description": "Redacted shipping address to be used for shipping options and tax calculations.",
"not": {
"anyOf": [
{
"required": [
"address_line_1"
]
},
{
"required": [
"address_line_2"
]
},
{
"required": [
"address_line_3"
]
},
{
"required": [
"admin_area_3"
]
},
{
"required": [
"admin_area_4"
]
},
{
"required": [
"address_details"
]
}
]
}
}
]
},
"shipping_option": {
"allOf": [
{
"$ref": "#/components/schemas/shipping_option"
},
{
"description": "Buyer selected shipping option.",
"not": {
"required": [
"selected"
]
}
}
]
},
"purchase_units": {
"description": "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.",
"type": "array",
"minItems": 1,
"maxItems": 1,
"items": {
"allOf": [
{
"$ref": "#/components/schemas/purchase_unit_request"
},
{
"title": "purchase_unit"
}
]
}
}
}
},
"order_update_callback_response": {
"title": "OrderUpdateCallbackResponse",
"description": "Returns the updated shipping options for an order.",
"type": "object",
"properties": {
"id": {
"description": "The ID of the order.",
"type": "string",
"minLength": 1,
"maxLength": 36,
"pattern": "^[A-Z0-9-]+$",
"readOnly": true
},
"purchase_units": {
"$ref": "#/components/schemas/shipping_options_purchase_unit"
}
}
},
"order_update_callback_error_response_details": {
"title": "OrderUpdateCallbackErrorResponseDetails",
"description": "The error details. Required for client-side `4XX` errors.",
"type": "object",
"required": [
"issue"
],
"properties": {
"field": {
"description": "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.",
"type": "string",
"minLength": 0,
"maxLength": 256,
"pattern": "^.*$"
},
"value": {
"description": "The value of the field that caused the error.",
"type": "string",
"minLength": 0,
"maxLength": 1024,
"pattern": "^.*$"
},
"issue": {
"description": "The unique, fine-grained application-level error code.",
"type": "string",
"minLength": 0,
"maxLength": 256,
"pattern": "^.*$"
}
}
},
"order_update_callback_error_response": {
"title": "OrderUpdateCallbackErrorResponse",
"description": "The error details.",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "The human-readable, unique name of the error.",
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^.*$"
},
"message": {
"description": "The message that describes the error.",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"pattern": "^.*$"
},
"details": {
"description": "An array of additional details about the error.",
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/order_update_callback_error_response_details"
}
}
}
}
},
"responses": {
"default_response": {
"description": "Default response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"generic": {
"summary": "Default response.",
"description": "Example catch all response, should not be encountered in practice.",
"value": {
"name": "INTERNAL_SERVER_ERROR",
"debug_id": "b1d1f06c7246c",
"message": "An internal server error has occurred."
}
}
}
}
}
},
"401_error_response": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"generic": {
"summary": "Generic 'Unauthorized' error.",
"description": "Example response for unauthorized request.",
"value": {
"name": "AUTHENTICATION_FAILURE",
"debug_id": "b1d1f06c7246c",
"message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}
}
}
}
}
},
"403_error_response": {
"description": "Forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"generic": {
"summary": "Generic 'Forbidden' error.",
"description": "Example response for a forbidden request.",
"value": {
"name": "NOT_AUTHORIZED",
"debug_id": "b1d1f06c7246c",
"message": "Authorization failed due to insufficient permissions."
}
}
}
}
}
},
"500_error_response": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"generic": {
"summary": "Generic internal server error.",
"description": "Example response for a request that fails for reasons internal to the server.",
"value": {
"name": "INTERNAL_SERVER_ERROR",
"debug_id": "b1d1f06c7246c",
"message": "An internal server error has occurred."
}
}
}
}
}
},
"404_error_response": {
"description": "Not Found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"generic": {
"summary": "Generic 'Not Found' error.",
"description": "Example response for a request to a resource that does not exist.",
"value": {
"name": "RESOURCE_NOT_FOUND",
"debug_id": "b1d1f06c7246c",
"message": "The specified resource does not exist."
}
}
}
}
}
},
"204_response": {
"description": "No Content."
}
}
},
"x-samples": {
"orders.create": [
{
"title": "Create Order - PayPal Wallet as Payment Source, Resulting in PAYER_ACTION_REQUIRED Response",
"description": "Creates a new order. API caller receives payer-action link.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"intent": "CAPTURE",
"payment_source": {
"paypal": {
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"landing_page": "LOGIN",
"shipping_preference": "GET_FROM_FILE",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}
},
"purchase_units": [
{
"invoice_id": "90210",
"amount": {
"currency_code": "USD",
"value": "230.00",
"breakdown": {
"item_total": {
"currency_code": "USD",
"value": "220.00"
},
"shipping": {
"currency_code": "USD",
"value": "10.00"
}
}
},
"items": [
{
"name": "T-Shirt",
"description": "Super Fresh Shirt",
"unit_amount": {
"currency_code": "USD",
"value": "20.00"
},
"quantity": "1",
"category": "PHYSICAL_GOODS",
"sku": "sku01",
"image_url": "https://example.com/static/images/items/1/tshirt_green.jpg",
"url": "https://example.com/url-to-the-item-being-purchased-1",
"upc": {
"type": "UPC-A",
"code": "123456789012"
}
},
{
"name": "Shoes",
"description": "Running, Size 10.5",
"sku": "sku02",
"unit_amount": {
"currency_code": "USD",
"value": "100.00"
},
"quantity": "2",
"category": "PHYSICAL_GOODS",
"image_url": "https://example.com/static/images/items/1/shoes_running.jpg",
"url": "https://example.com/url-to-the-item-being-purchased-2",
"upc": {
"type": "UPC-A",
"code": "987654321012"
}
}
]
}
]
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "PAYER_ACTION_REQUIRED",
"payment_source": {
"paypal": {}
},
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "payer-action",
"method": "GET"
}
]
}
}
},
{
"title": "Create and authorize an order for a PayPal wallet vaulted account holder passing a usage pattern indicator using stored credentials (Single Shot).",
"description": "Creates an order and authorizes payment with a PayPal wallet vault id as the payment source and a usage pattern (billing indicator) RECURRING_PREPAID passed using stored credentials.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"intent": "AUTHORIZE",
"purchase_units": [
{
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
],
"payment_source": {
"paypal": {
"vault_id": "2w915838hr181240m",
"stored_credential": {
"payment_initiator": "MERCHANT",
"usage": "SUBSEQUENT",
"usage_pattern": "RECURRING_PREPAID"
}
}
}
}
},
"response": {
"status": "201 Created",
"body": {
"id": "8K832279M55989614",
"intent": "AUTHORIZE",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"email_address": "buyer@paypal.com",
"account_id": "XQHSN372NGSP2",
"account_status": "UNVERIFIED",
"name": {
"given_name": "Tom",
"surname": "Business"
},
"phone_number": {
"national_number": "8127081430"
},
"address": {
"country_code": "US"
},
"stored_credential": {
"payment_initiator": "MERCHANT",
"usage": "SUBSEQUENT",
"usage_pattern": "RECURRING_PREPAID"
}
}
},
"purchase_units": [
{
"reference_id": "default",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"payee": {
"email_address": "seller@paypal.com",
"merchant_id": "Q7C9N6S4YRQXG"
},
"shipping": {
"name": {
"full_name": "Tom Business"
},
"address": {
"address_line_1": "123 Fake St.",
"admin_area_2": "Baton Rouge",
"admin_area_1": "LA",
"postal_code": "70802",
"country_code": "US"
}
},
"payments": {
"authorizations": [
{
"status": "CREATED",
"id": "7X550106NA4440028",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"UNAUTHORIZED_TRANSACTION"
]
},
"expiration_time": "2024-06-05T18:46:54Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/7X550106NA4440028",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/7X550106NA4440028/capture",
"rel": "capture",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/7X550106NA4440028/void",
"rel": "void",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/8K832279M55989614",
"rel": "up",
"method": "GET"
}
],
"create_time": "2024-05-07T18:46:54Z",
"update_time": "2024-05-07T18:46:54Z"
}
]
}
}
],
"payer": {
"name": {
"given_name": "Tom",
"surname": "Business"
},
"email_address": "buyer@paypal.com",
"payer_id": "XQHSN372NGSP2",
"phone": {
"phone_number": {
"national_number": "8127081430"
}
},
"address": {
"country_code": "US"
}
},
"create_time": "2024-05-07T18:46:15Z",
"update_time": "2024-05-07T18:46:54Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/8K832279M55989614",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Create Order - Minimal Request and Response",
"description": "Creates an order with only required parameters. By default, uses the minimal representation.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"intent": "CAPTURE",
"purchase_units": [
{
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "201 Created",
"body": {
"id": "5O190127TN364715T",
"status": "CREATED",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/capture",
"rel": "capture",
"method": "POST"
}
]
}
}
},
{
"title": "Create Order - Buy Online Pickup In Store Shipping Type",
"description": "Creates an order with minimal parameters and contains the Buy Online Pickup in Store-related fields.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ",
"Prefer": "return=representation"
},
"body": {
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "PUHF",
"amount": {
"currency_code": "USD",
"value": "50.00"
},
"payee": {
"email_address": "merchant@example.com"
},
"shipping": {
"address": {
"address_line_1": "123 Townsend St",
"address_line_2": "Floor 6",
"admin_area_2": "San Francisco",
"admin_area_1": "CA",
"postal_code": "94107",
"country_code": "US"
},
"type": "PICKUP_IN_STORE"
}
}
]
}
},
"response": {
"status": "201 Created",
"body": {
"id": "4SP74185RW2405200",
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "PUHF",
"amount": {
"currency_code": "USD",
"value": "50.00"
},
"payee": {
"email_address": "merchant@example.com"
},
"shipping": {
"address": {
"address_line_1": "123 Townsend St",
"address_line_2": "Floor 6",
"admin_area_2": "San Francisco",
"admin_area_1": "CA",
"postal_code": "94107",
"country_code": "US"
},
"type": "PICKUP_IN_STORE"
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=4SP74185RW2405200",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200/authorize",
"rel": "authorize",
"method": "POST"
}
],
"status": "CREATED"
}
}
},
{
"title": "Create Order - 400 Bad Request Error - Purchase Unit is Empty",
"description": "This code sample attempts to create an order with empty purchase units. The request fails.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "400 Bad Request",
"body": {
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "10398537340c8",
"details": [
{
"field": "/purchase_units",
"value": "[]",
"location": "body",
"issue": "INVALID_ARRAY_MIN_ITEMS",
"description": "The number of items in an array parameter is too small."
}
],
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-INVALID_ARRAY_MIN_ITEMS",
"rel": "information_link"
}
]
}
}
},
{
"title": "Create Order - 422 Unprocessable Entity Error - Missing Pickup Address",
"description": "This code sample attempts to create an order but the shipping address is required and `shipping.type` is set to PICKUP_FROM_PERSON ",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"intent": "AUTHORIZE",
"payment_source": {
"paypal": {
"experience_context": {
"return_url": "https://www.example.com/returnURL",
"cancel_url": "https://www.example.com/cancelURL",
"shipping_preference": "SET_PROVIDED_ADDRESS"
}
}
},
"purchase_units": [
{
"reference_id": "PUHF",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"shipping": {
"type": "PICKUP_FROM_PERSON"
}
}
]
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"field": "/purchase_units/@reference_id=='PUHF'/shipping/address",
"issue": "MISSING_SHIPPING_ADDRESS",
"description": "The shipping address is required when `shipping_preference=SET_PROVIDED_ADDRESS`."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "f200264a4e02a",
"links": [
{
"href": "https://developer.paypal.com/api/rest/reference/orders/v2/errors/#MISSING_SHIPPING_ADDRESS",
"rel": "information_link",
"method": "GET"
}
]
}
}
},
{
"title": "Create Order - Buy Online Pickup In Store Shipping Type",
"description": "Creates an order with venmo payment source and contains the Buy Online Pickup in Store-related fields.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"Prefer": "return=representation",
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "PUHF",
"amount": {
"currency_code": "USD",
"value": "50.00"
},
"payee": {
"email_address": "merchant@example.com"
},
"shipping": {
"address": {
"address_line_1": "123 Townsend St",
"address_line_2": "Floor 6",
"admin_area_2": "San Francisco",
"admin_area_1": "CA",
"postal_code": "94107",
"country_code": "US"
},
"type": "PICKUP_IN_STORE"
}
}
]
}
},
"response": {
"status": "201 Created",
"body": {
"id": "4SP74185RW2405200",
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "PUHF",
"amount": {
"currency_code": "USD",
"value": "50.00"
},
"payee": {
"email_address": "merchant@example.com"
},
"shipping": {
"address": {
"address_line_1": "123 Townsend St",
"address_line_2": "Floor 6",
"admin_area_2": "San Francisco",
"admin_area_1": "CA",
"postal_code": "94107",
"country_code": "US"
},
"type": "PICKUP_IN_STORE"
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=4SP74185RW2405200",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/4SP74185RW2405200/authorize",
"rel": "authorize",
"method": "POST"
}
],
"status": "CREATED"
}
}
},
{
"title": "Create and Authorize an order with PayPal Wallet and App Switch with return, cancel and fallback app URLs",
"description": "Creates a new order and authorizes the payment using PayPal wallet with App Switch. Merchant provides separate return_app_url and cancel_app_url for native app redirection, which PayPal uses as-is without appending /success or /cancel.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
],
"payment_source": {
"paypal": {
"email_address": "customer@example.com",
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"brand_name": "EXAMPLE INC",
"locale": "en-US",
"landing_page": "LOGIN",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl",
"app_switch_context": {
"native_app": {
"return_app_url": "https://example.com/merchant_app/return",
"cancel_app_url": "https://example.com/merchant_app/cancel",
"os_type": "IOS",
"os_version": "17.3.1"
}
}
}
}
}
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "PAYER_ACTION_REQUIRED",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/app-switch-checkout?token=5O190127TN364715T",
"rel": "payer-action",
"method": "GET"
}
]
}
}
},
{
"title": "Create and Authorize an order with PayPal Wallet where App Switch is Ineligible on a Low RAM Android Device",
"description": "Creates a new order with PayPal Wallet App Switch on a low RAM Android device (Samsung Galaxy A16 5G, SM-A166U, 4 GB total RAM). The merchant passes device metadata in device_info within app_switch_context. XOOS evaluates the device against the Elmo RAM threshold (default 400 MB) and model blocklist (SM-A166 prefix). The device fails both checks — available RAM is below the threshold and the model prefix is on the blocklist — so app_switch_eligibility is returned as false. The merchant must fall back to browser-based checkout using the returned payer-action URL.",
"operationId": "orders.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"intent": "AUTHORIZE",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
],
"payment_source": {
"paypal": {
"email_address": "customer@example.com",
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"brand_name": "EXAMPLE INC",
"locale": "en-US",
"landing_page": "LOGIN",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl",
"app_switch_context": {
"native_app": {
"return_app_url": "https://example.com/merchant_app/return",
"cancel_app_url": "https://example.com/merchant_app/cancel",
"os_type": "ANDROID",
"os_version": "14"
}
}
}
}
}
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "PAYER_ACTION_REQUIRED",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "payer-action",
"method": "GET"
}
]
}
}
}
],
"orders.get": [
{
"title": "Get Order - Show Order Details After Customer Approval",
"description": "Shows order details immediately after customer approval.",
"operationId": "orders.get",
"request": {
"method": "get",
"path": "/v2/checkout/orders/5O190127TN364715T",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "APPROVED",
"intent": "CAPTURE",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"account_id": "QYR5Z8XDVJNXQ"
}
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
],
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"payer_id": "QYR5Z8XDVJNXQ"
},
"create_time": "2018-04-01T21:18:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "approve",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "edit",
"method": "PATCH"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/capture",
"rel": "capture",
"method": "POST"
}
]
}
}
},
{
"title": "Get Order - 404 Not Found Error - Order Not Found",
"description": "This code sample attempts to show details for an order, by ID, but the request fails because the order is not found.",
"operationId": "orders.get",
"request": {
"method": "get",
"path": "/v2/checkout/orders/5O190127TN364715T"
},
"response": {
"status": "404 Not Found",
"body": {
"name": "RESOURCE_NOT_FOUND",
"debug_id": "b1d1f06c7246c",
"message": "The specified resource does not exist."
}
}
}
],
"orders.patch": [
{
"title": "Patch Order - Add Shipping Address",
"description": "Updates an order to add shipping address to purchase unit.",
"operationId": "orders.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "replace",
"path": "/purchase_units/@reference_id=='PUHF'/shipping/address",
"value": {
"address_line_1": "2211 N First Street",
"address_line_2": "Building 17",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95131",
"country_code": "US"
}
}
]
},
"response": {
"status": "204 No Content"
}
},
{
"title": "Patch Order - Replace Amount",
"description": "Updates an order to revise the amount, adding the cost of shipping, to a purchase unit.",
"operationId": "orders.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "replace",
"path": "/purchase_units/@reference_id=='PUHF'/amount",
"value": {
"currency_code": "USD",
"value": "200.00",
"breakdown": {
"item_total": {
"currency_code": "USD",
"value": "180.00"
},
"shipping": {
"currency_code": "USD",
"value": "20.00"
}
}
}
}
]
},
"response": {
"status": "204 No Content"
}
},
{
"title": "Patch Order - Add Items and Replace Amount",
"description": "Updates an order to add items to and replace the amount within a purchase unit. The amount breakdown with an item total is added to reflect the newly added items. Whenever the quantity or price of items is modified in an order with a PATCH, the purchase_units.amount must also be updated.",
"operationId": "orders.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "add",
"path": "/purchase_units/@reference_id=='PUHF'/items",
"value": [
{
"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"
},
{
"name": "Shoes",
"description": "Running, Size 10.5",
"sku": "sku02",
"unit_amount": {
"currency_code": "USD",
"value": "45.00"
},
"tax": {
"currency_code": "USD",
"value": "5.00"
},
"quantity": "2",
"category": "PHYSICAL_GOODS"
}
]
},
{
"op": "replace",
"path": "/purchase_units/@reference_id=='PUHF'/amount",
"value": {
"currency_code": "USD",
"value": "205.00",
"breakdown": {
"item_total": {
"currency_code": "USD",
"value": "180.00"
},
"shipping": {
"currency_code": "USD",
"value": "5.00"
},
"handling": {
"currency_code": "USD",
"value": "0.00"
},
"tax_total": {
"currency_code": "USD",
"value": "20.00"
},
"shipping_discount": {
"currency_code": "USD",
"value": "0.00"
}
}
}
}
]
},
"response": {
"status": "204 No Content"
}
},
{
"title": "Patch Order - 400 Bad Request Error - Shipping Address Invalid",
"description": "This code sample attempts to update an the shipping address with an invalid value. The request fails.",
"operationId": "orders.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/{id}",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "400 Bad Request",
"body": {
"name": "INVALID_REQUEST",
"details": [
{
"field": "/purchase_units/@reference_id=='Reference ID 2'/shipping/address",
"value": "x",
"location": "body",
"issue": "INVALID_PARAMETER_SYNTAX",
"description": "The value of a field does not conform to the expected format."
}
],
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "f087ef02ffdb6",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-INVALID_PARAMETER_SYNTAX",
"rel": "information_link",
"method": "GET"
}
]
}
}
},
{
"title": "Patch Order - 422 Unprocessable Entity Error - Payer Patch Not Allowed",
"description": "This code sample attempts to update an order with a payer object. The request fails since buyer has already approved.",
"operationId": "orders.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "add",
"path": "/payer",
"value": {
"name": {
"given_name": "TestFirst",
"surname": "TestLast"
},
"email_address": "payee@example.com",
"phone": {
"phone_number": {
"national_number": "19876543210"
}
},
"address": {
"address_line_1": "2211 North First Street",
"address_line_2": "Floor 6",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95126",
"country_code": "US"
}
}
}
]
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"field": "/payer",
"issue": "PAYER_PATCH_NOT_ALLOWED",
"description": "Payer path patch is not allowed after payer has approved the order.",
"location": "body"
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "90957fca61718",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-PAYER_PATCH_NOT_ALLOWED",
"rel": "information_link",
"method": "GET"
}
]
}
}
}
],
"orders.confirm": [
{
"title": "Confirm Order - PayPal Wallet Resulting in Payer Action Required",
"description": "The API Caller is adding or changing the PayPal wallet payment_source on an Order after the Order has been created. Orders status transitions to PAYER_ACTION_REQUIRED.",
"operationId": "orders.confirm",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/confirm-payment-source",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"brand_name": "EXAMPLE INC",
"locale": "en-US",
"landing_page": "LOGIN",
"shipping_preference": "SET_PROVIDED_ADDRESS",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}
}
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "PAYER_ACTION_REQUIRED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com"
}
},
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com"
},
"links": [
{
"href": "https://api.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "payer-action",
"method": "GET"
}
]
}
}
},
{
"title": "Confirm Order - 400 Bad Request Error - Missing Required Parameter - Payment Source",
"description": "This code sample attempts to confirm an order, but the payment source is missing. The request fails.",
"operationId": "orders.confirm",
"request": {
"method": "post",
"path": "/v2/checkout/orders/{id}/confirm-payment-source",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "400 Bad Request",
"body": {
"name": "INVALID_REQUEST",
"details": [
{
"field": "/payment_source",
"issue": "MISSING_REQUIRED_PARAMETER",
"description": "A required field or parameter is missing.",
"location": "body"
}
],
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "90957fca61718",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-MISSING_REQUIRED_PARAMETER",
"rel": "information_link",
"method": "GET"
}
]
}
}
},
{
"title": "Confirm Order - 403 Forbidden Error - Invalid PayPal Wallet Vault ID",
"description": "This code sample attempts to confirm an order but the PayPal wallet vault ID was not found. The request fails.",
"operationId": "orders.confirm",
"request": {
"method": "post",
"path": "/v2/checkout/orders/{id}/confirm-payment-source",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "403 Forbidden",
"body": {
"name": "NOT_AUTHORIZED",
"debug_id": "b1d1f06c7246c",
"message": "Authorization failed due to insufficient permissions."
}
}
},
{
"title": "Confirm Order - 404 Not Found Error - Resource Not Found",
"description": "This code sample attempts to confirm an order but the specified order is not found. The request fails.",
"operationId": "orders.confirm",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/confirm-payment-source",
"body": {
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"experience_context": {
"payment_method_preference": "IMMEDIATE_PAYMENT_REQUIRED",
"brand_name": "EXAMPLE INC",
"locale": "en-US",
"landing_page": "LOGIN",
"shipping_preference": "SET_PROVIDED_ADDRESS",
"user_action": "PAY_NOW",
"return_url": "https://example.com/returnUrl",
"cancel_url": "https://example.com/cancelUrl"
}
}
}
}
},
"response": {
"status": "204 No Content"
}
},
{
"title": "Confirm Order - 422 Unprocessable Entity Error -Using Card Vault ID for a PayPal Wallet Payment Source",
"description": "Attempt to Confirm PayPal Wallet for an order with card vault id. The request fails with a MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE error.",
"operationId": "orders.confirm",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/confirm-payment-source",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"payment_source": {
"paypal": {
"vault_id": "8kk845"
}
}
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"field": "/payment_source/paypal/vault_id",
"location": "body",
"issue": "MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE",
"description": "The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "90957fca61718",
"links": [
{
"href": "https://developer.paypal.com/docs/api/orders/v2/#error-MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE",
"rel": "information_link",
"method": "GET"
}
]
}
}
},
{
"title": "Confirm Order - 500 Internal Server Error - A system error has occurred",
"description": "This code sample attempts to confirm an order, but a system error occurred. The request fails. The same request body may be reused by the API Caller to retry.",
"operationId": "orders.confirm",
"request": {
"method": "post",
"path": "/v2/checkout/orders/{id}/confirm-payment-source",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "500 Internal Server Error",
"body": {
"name": "INTERNAL_SERVER_ERROR",
"debug_id": "b1d1f06c7246c",
"message": "An internal server error has occurred."
}
}
}
],
"orders.authorize": [
{
"title": "Authorize Order - PayPal Wallet as Payment Source",
"description": "Authorize payment for an order after PayPal wallet approval. By default, uses the minimal representation.",
"operationId": "orders.authorize",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/authorize",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "201 Created",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"account_id": "QYR5Z8XDVJNXQ"
}
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"payments": {
"authorizations": [
{
"id": "3C679366HH908993F",
"status": "CREATED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"expiration_time": "2021-10-08T23:37:39Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T/capture",
"rel": "capture",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/5O190127TN364715T/void",
"rel": "void",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "up",
"method": "GET"
}
]
}
]
}
}
],
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"payer_id": "QYR5Z8XDVJNXQ"
},
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Authorize Order - Idempotent Response with PayPal Wallet",
"description": "Authorizes payment for an order with the same idempotency key. By default, uses the minimal representation.",
"operationId": "orders.authorize",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/authorize",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"account_status": "VERIFIED",
"email_address": "customer@example.com",
"account_id": "QYR5Z8XDVJNXQ"
}
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"shipping": {
"address": {
"address_line_1": "2211 N First Street",
"address_line_2": "Building 17",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95131",
"country_code": "US"
}
},
"payments": {
"authorizations": [
{
"id": "0AW2184448108334S",
"status": "CREATED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"expiration_time": "2018-05-01T21:20:49Z",
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/capture",
"rel": "capture",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/void",
"rel": "void",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/reauthorize",
"rel": "reauthorize",
"method": "POST"
}
]
}
]
}
}
],
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"payer_id": "QYR5Z8XDVJNXQ"
},
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Authorize Order - PayPal Wallet Vault ID",
"description": "Authorizes payment for an order through a previously acquired vault id for a PayPal wallet. By default, uses the minimal representation.",
"operationId": "orders.authorize",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/authorize",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"payment_source": {
"paypal": {
"vault_id": "nkq2y9g"
}
}
}
},
"response": {
"status": "201 Created",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"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": {
"authorizations": [
{
"id": "0AW2184448108334S",
"status": "CREATED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"expiration_time": "2022-01-29T21:20:49Z",
"create_time": "2021-12-29T21:20:49Z",
"update_time": "2021-12-29T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/capture",
"rel": "capture",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/void",
"rel": "void",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/reauthorize",
"rel": "reauthorize",
"method": "POST"
}
]
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Authorize Order - 403 Forbidden Error - Charity is not confirmed",
"description": "This code sample attempts to authorize a donation order, but charity is not confirmed.",
"operationId": "orders.authorize",
"request": {
"method": "post",
"path": "/v2/checkout/orders/{id}/authorize",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "403 Forbidden",
"body": {
"name": "NOT_AUTHORIZED",
"debug_id": "b1d1f06c7246c",
"message": "Authorization failed due to insufficient permissions."
}
}
},
{
"title": "Authorize Order - 422 - Payer Action Required",
"description": "This code sample attempts to authorize payment for an order that was created by the api caller and the payment could not be processed due to PSD2 SCA compliance requirement.",
"operationId": "orders.authorize",
"request": {
"method": "post",
"path": "/v2/checkout/orders/9SY02093A2309081P/authorize",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "PAYER_ACTION_REQUIRED",
"description": "Transaction cannot complete successfully, instruct the buyer to return to PayPal."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "f63fbc340a6ce",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-PAYER_ACTION_REQUIRED",
"rel": "information_link",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=9SY02093A2309081P",
"rel": "payer-action",
"method": "GET"
}
]
}
}
},
{
"title": "Authorize Order - 422 Unprocessable Entity Error - Payment Denied",
"description": "This code sample attempts to authorize an order, but the payment is denied by PayPal. This can occur due to various reasons such as insufficient funds, expired card, incorrect payment information, or payment gateway issues.",
"operationId": "orders.authorize",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/authorize",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"payment_source": {
"card": {
"vault_id": "8cg02452we902502k"
}
}
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "PAYMENT_DENIED",
"description": "PayPal has declined to process this transaction."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "eb476257836d9",
"links": [
{
"href": "https://developer.paypal.com/docs/api/orders/v2/#error-PAYMENT_DENIED",
"rel": "information_link",
"method": "GET"
}
]
}
}
}
],
"orders.capture": [
{
"title": "Capture Order - PayPal Wallet as Payment Source",
"description": "Captures payment for an order after wallet approval. By default, uses the minimal representation.",
"operationId": "orders.capture",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/capture",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "201 Created",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"account_id": "QYR5Z8XDVJNXQ"
}
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"shipping": {
"address": {
"address_line_1": "2211 N First Street",
"address_line_2": "Building 17",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95131",
"country_code": "US"
}
},
"payments": {
"captures": [
{
"id": "3C679366HH908993F",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"final_capture": true,
"disbursement_mode": "INSTANT",
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "100.00"
},
"paypal_fee": {
"currency_code": "USD",
"value": "3.00"
},
"net_amount": {
"currency_code": "USD",
"value": "97.00"
}
},
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F/refund",
"rel": "refund",
"method": "POST"
}
]
}
]
}
}
],
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"payer_id": "QYR5Z8XDVJNXQ"
},
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Capture Order - Idempotent Response with PayPal Wallet",
"description": "Captures payment for an order after wallet approval with the same idempotency key. By default, uses the minimal representation.",
"operationId": "orders.capture",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/capture",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"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,
"disbursement_mode": "INSTANT",
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "100.00"
},
"paypal_fee": {
"currency_code": "USD",
"value": "3.00"
},
"net_amount": {
"currency_code": "USD",
"value": "97.00"
}
},
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F/refund",
"rel": "refund",
"method": "POST"
}
]
}
]
}
}
],
"payer": {
"name": {
"given_name": "John",
"surname": "Doe"
},
"email_address": "customer@example.com",
"payer_id": "QYR5Z8XDVJNXQ"
},
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Capture Order - Minimal Representation with PayPal Wallet Vault ID",
"description": "The partner captures payment for an order after PayPal Wallet approval. By default, uses the minimal representation.",
"operationId": "orders.capture",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/capture",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "201 Created",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"payment_source": {
"paypal": {
"attributes": {
"vault": {
"id": "m6yd4yw",
"status": "CREATED"
}
}
}
},
"purchase_units": [
{
"reference_id": "refernece_id_1001",
"shipping": {
"name": {
"full_name": "William Chris"
},
"address": {
"address_line_1": "500 Hillside Street",
"address_line_2": "#100",
"admin_area_2": "San Jose",
"admin_area_1": "CA",
"postal_code": "95131",
"country_code": "US"
}
},
"payments": {
"captures": [
{
"id": "54986457XR262021N",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "31.01"
},
"final_capture": true,
"disbursement_mode": "INSTANT",
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED",
"UNAUTHORIZED_TRANSACTION"
]
},
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "31.01"
},
"platform_fees": [
{
"amount": {
"currency_code": "USD",
"value": "10.01"
},
"payee": {
"merchant_id": "J8NCBBULP5JH2"
}
}
],
"net_amount": {
"currency_code": "USD",
"value": "21.00"
}
},
"invoice_id": "invoice_id_380358551C5240203",
"custom_id": "custom_id_1001",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/54986457XR262021N",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/54986457XR262021N/refund",
"rel": "refund",
"method": "POST"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/12645781RH9888226",
"rel": "up",
"method": "GET"
}
],
"create_time": "2020-06-08T23:11:34Z",
"update_time": "2020-06-08T23:11:34Z"
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/vault/payment-tokens/m6yd4yw",
"rel": "payment-token",
"method": "GET"
}
]
}
}
},
{
"title": "Capture Order - 403 Forbidden Error - Invalid Card Vault ID",
"description": "This code sample attempts to capture an order that was created with the `CAPTURE` intent but the card vault id can not be found. The request fails.",
"operationId": "orders.capture",
"request": {
"method": "post",
"path": "/v2/checkout/orders/{id}/capture",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "403 Forbidden",
"body": {
"name": "NOT_AUTHORIZED",
"debug_id": "b1d1f06c7246c",
"message": "Authorization failed due to insufficient permissions."
}
}
},
{
"title": "Capture Order - 404 Not Found Error - Resource Not Found",
"description": "This code sample attempts to capture an order but the specified order is not found. The request fails.",
"operationId": "orders.capture",
"request": {
"method": "post",
"path": "/v2/checkout/orders/{id}/capture",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "404 Not Found",
"body": {
"name": "RESOURCE_NOT_FOUND",
"debug_id": "b1d1f06c7246c",
"message": "The specified resource does not exist."
}
}
},
{
"title": "Capture Order - 422 - Payer Action Required",
"description": "This code sample attempts to capture payment for an order that was created by the api caller and the payment could not be processed due to PSD2 SCA compliance requirement.",
"operationId": "orders.capture",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/capture",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "PAYER_ACTION_REQUIRED",
"description": "Transaction cannot complete successfully, instruct the buyer to return to PayPal."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "f63fbc340a6ce",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-PAYER_ACTION_REQUIRED",
"rel": "information_link",
"method": "GET"
},
{
"href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
"rel": "payer-action",
"method": "GET"
}
]
}
}
},
{
"title": "Capture Order - 422 Unprocessable Entity Error - Action Does Not Match Intent",
"description": "This code sample attempts to capture payment for an order that was created with `intent=AUTHORIZE`. The operation is incorrect.",
"operationId": "orders.capture",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/capture",
"headers": {
"PayPal-Request-Id": "17e81d06-77ab-11e8-adc0-fa71639ebebc",
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"location": "body",
"issue": "ACTION_DOES_NOT_MATCH_INTENT",
"description": "The order was created with an intent of `AUTHORIZE`. To complete authorization, use `/v2/checkout/orders/{order_id}/authorize`. Or, alternately create an order with an intent of `CAPTURE`."
}
],
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "90957fca61718",
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-ACTION_DOES_NOT_MATCH_INTENT",
"rel": "information_link",
"method": "GET"
}
]
}
}
}
],
"orders.track.create": [
{
"title": "Add Tracking to Order - Carrier Information and Items Breakdown",
"description": "Adds tracking information for a PayPal order.",
"operationId": "orders.track.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/track",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX",
"notify_payer": false,
"items": [
{
"name": "T-Shirt",
"sku": "sku02",
"quantity": "1",
"upc": {
"type": "UPC-A",
"code": "012345678901"
},
"image_url": "https://www.example.com/example.jpg",
"url": "https://www.example.com/example"
}
]
}
},
"response": {
"status": "201 Created",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"items": [
{
"name": "Air Jordan Shoe",
"sku": "sku01",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
},
{
"name": "T-Shirt",
"sku": "sku02",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
}
],
"shipping": {
"trackers": [
{
"id": "8MC585209K746392H-443844607820",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "up",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820",
"rel": "edit",
"method": "PATCH"
}
],
"create_time": "2022-08-12T21:20:49Z",
"update_time": "2022-08-12T21:20:49Z"
}
]
},
"payments": {
"captures": [
{
"id": "8MC585209K746392H",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "NOT_ELIGIBLE"
},
"final_capture": true,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "100.00"
},
"paypal_fee": {
"currency_code": "USD",
"value": "3.00"
},
"net_amount": {
"currency_code": "USD",
"value": "97.00"
}
},
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund",
"rel": "refund",
"method": "POST"
}
]
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Add Tracking to Order - Idempotent Response",
"description": "Adds tracking information for a PayPal Order with the same capture id & tracking number. Idempotency for trackers is based on the capture_id and tracking_number combination sent in the request body.",
"operationId": "orders.track.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/track",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX",
"notify_payer": false,
"items": [
{
"name": "T-Shirt",
"sku": "sku01",
"quantity": "1",
"upc": {
"type": "UPC-A",
"code": "012345678901"
},
"image_url": "https://www.example.com/example.jpg",
"url": "https://www.example.com/example"
}
]
}
},
"response": {
"status": "200 OK",
"body": {
"id": "5O190127TN364715T",
"status": "COMPLETED",
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"items": [
{
"name": "Air Jordan Shoe",
"sku": "sku01",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
},
{
"name": "T-Shirt",
"sku": "sku02",
"quantity": "1",
"unit_amount": {
"currency_code": "USD",
"value": "50.00"
}
}
],
"shipping": {
"trackers": [
{
"id": "8MC585209K746392H-443844607820",
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "up",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820",
"rel": "edit",
"method": "PATCH"
}
],
"create_time": "2022-08-12T21:20:49Z",
"update_time": "2022-08-12T21:20:49Z"
}
]
},
"payments": {
"captures": [
{
"id": "8MC585209K746392H",
"status": "COMPLETED",
"amount": {
"currency_code": "USD",
"value": "100.00"
},
"seller_protection": {
"status": "NOT_ELIGIBLE"
},
"final_capture": true,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "USD",
"value": "100.00"
},
"paypal_fee": {
"currency_code": "USD",
"value": "3.00"
},
"net_amount": {
"currency_code": "USD",
"value": "97.00"
}
},
"create_time": "2018-04-01T21:20:49Z",
"update_time": "2018-04-01T21:20:49Z",
"links": [
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund",
"rel": "refund",
"method": "POST"
}
]
}
]
}
}
],
"links": [
{
"href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
"rel": "self",
"method": "GET"
}
]
}
}
},
{
"title": "Add Tracking to Order - 400 Bad Request - Missing Required Parameter",
"description": "This code sample attempts to add tracking information for a PayPal order but required parameter capture id is not passed.",
"operationId": "orders.track.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/track",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "400 Bad Request",
"body": {
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "360ee42996992",
"details": [
{
"field": "/capture_id",
"issue": "MISSING_REQUIRED_PARAMETER",
"description": "A required field / parameter is missing.",
"location": "body"
}
],
"links": [
{
"href": "https://developer.paypal.com/api/orders/v2/#error-MISSING_REQUIRED_PARAMETER",
"rel": "information_link"
}
]
}
}
},
{
"title": "Add Tracking to Order - 403 Forbidden - No Permission for the Order",
"description": "This code sample attempts to add tracking information for a Paypal Order, but the API caller does not have permission to act on this resource.",
"operationId": "orders.track.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/track",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX",
"notify_payer": false,
"items": [
{
"name": "T-Shirt",
"sku": "sku01",
"quantity": "1",
"upc": {
"type": "UPC-A",
"code": "012345678901"
},
"image_url": "https://www.example.com/example.jpg",
"url": "https://www.example.com/example"
}
]
}
},
"response": {
"status": "403 Forbidden",
"body": {
"name": "NOT_AUTHORIZED",
"debug_id": "b1d1f06c7246c",
"message": "Authorization failed due to insufficient permissions."
}
}
},
{
"title": "Add Tracking to Order - 422 Unprocessable Entity Error - Invalid Capture Status.",
"description": "This code sample attempts to add tracking information for a PayPal order but the request fails as capture status is invalid.",
"operationId": "orders.track.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/track",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX"
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "360ee42996992",
"details": [
{
"issue": "CAPTURE_STATUS_NOT_VALID",
"description": "Invalid capture status. Tracker information can only be added to captures in `COMPLETED` state."
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/orders/v2/#error-CAPTURE_STATUS_NOT_VALID",
"rel": "information_link",
"method": "GET"
}
]
}
}
},
{
"title": "Add Tracking to Order - 500 Internal Server Error",
"description": "This code sample attempts to add tracking information for a PayPal Order but the request fails due to an internal server error.",
"operationId": "orders.track.create",
"request": {
"method": "post",
"path": "/v2/checkout/orders/5O190127TN364715T/track",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": {
"capture_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"carrier": "FEDEX",
"notify_payer": false,
"items": [
{
"name": "T-Shirt",
"sku": "sku01",
"quantity": "1",
"upc": {
"type": "UPC-A",
"code": "012345678901"
},
"image_url": "https://www.example.com/example.jpg",
"url": "https://www.example.com/example"
}
]
}
},
"response": {
"status": "500 Internal Server Error",
"body": {
"name": "INTERNAL_SERVER_ERROR",
"debug_id": "b1d1f06c7246c",
"message": "An internal server error has occurred."
}
}
}
],
"orders.trackers.patch": [
{
"title": "Patch Tracking Information - Replace the Status of the Tracker.",
"description": "Updates order tracking information to replace the existing status with a new status.",
"operationId": "orders.trackers.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H443844607820",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "replace",
"path": "/status",
"value": "CANCELLED"
}
]
},
"response": {
"status": "204 No Content"
}
},
{
"title": "Patch Tracking Information - Add Notification for a Shipment.",
"description": "Updates an order tracking information to add notification for a shipment.",
"operationId": "orders.trackers.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H443844607820",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "add",
"path": "/notify_payer",
"value": true
}
]
},
"response": {
"status": "204 No Content"
}
},
{
"title": "Patch Tracking Information - 400 Bad Request Error - Invalid Request.",
"description": "This code sample attempts to update an order tracking information to replace notify_payer, but the request fails due to invalid value in the request.",
"operationId": "orders.trackers.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H443844607820",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
}
},
"response": {
"status": "400 Bad Request",
"body": {
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "2f541ace12987",
"details": [
{
"field": "/notify_payer",
"issue": "INVALID_PARAMETER_VALUE",
"description": "The value of a field is invalid.",
"location": "body"
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/orders/v2/#error-INVALID_PARAMETER_VALUE",
"rel": "information_link",
"method": "GET"
}
]
}
}
},
{
"title": "Patch Tracking Information - 403 Forbidden.",
"description": "This code sample attempts to update an Order Tracking information, but the API caller does not have permission to act on this resource.",
"operationId": "orders.trackers.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H443844607820",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "add",
"path": "/notify_payer",
"value": true
}
]
},
"response": {
"status": "403 Forbidden",
"body": {
"name": "NOT_AUTHORIZED",
"debug_id": "b1d1f06c7246c",
"message": "Authorization failed due to insufficient permissions."
}
}
},
{
"title": "Patch Tracking Information - 404 Not Found Error - Tracker ID Not Found.",
"description": "This code sample attempts to update an Order Tracking information but the request fails as specified tracker id is not found.",
"operationId": "orders.trackers.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H443844607820",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "add",
"path": "/notify_payer",
"value": true
}
]
},
"response": {
"status": "404 Not Found",
"body": {
"name": "RESOURCE_NOT_FOUND",
"debug_id": "b1d1f06c7246c",
"message": "The specified resource does not exist."
}
}
},
{
"title": "Patch Tracking Information - 422 UNPROCESSABLE ENTITY Error - Cannot patch cancelled tracker.",
"description": "This code sample attempts to update an order's Tracking information but the request fails as the tracker had been previously transitioned into the \"cancelled\" state.",
"operationId": "orders.trackers.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H443844607820",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "replace",
"path": "items",
"value": [
{
"name": "T-Shirt",
"sku": "sku01",
"quantity": "1",
"upc": {
"type": "UPC-A",
"code": "upc001"
},
"image_url": "https://www.example.com/example1.jpg",
"url": "https://www.example.com/example"
},
{
"name": "NeoPhone",
"sku": "sku02",
"quantity": "2",
"upc": {
"type": "UPC-A",
"code": "upc002"
},
"image_url": "https://www.example.com/example2.jpg",
"url": "https://www.example.com/example"
}
]
}
]
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"debug_id": "3178dbf457625",
"details": [
{
"field": "path",
"value": "/status",
"location": "body",
"issue": "CANNOT_PATCH_CANCELLED_TRACKER",
"description": "Cancelled trackers cannot be modified."
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/orders/v2/#error-NOT_PATCHABLE",
"rel": "information_link",
"method": "GET"
}
]
}
}
},
{
"title": "Patch Tracking Information - 500 Internal Server Error.",
"description": "This code sample attempts to update an Order Tracking information but the request fails due to an internal server error.",
"operationId": "orders.trackers.patch",
"request": {
"method": "patch",
"path": "/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H443844607820",
"headers": {
"Authorization": "Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"
},
"body": [
{
"op": "add",
"path": "/notify_payer",
"value": true
}
]
},
"response": {
"status": "500 Internal Server Error",
"body": {
"name": "INTERNAL_SERVER_ERROR",
"debug_id": "b1d1f06c7246c",
"message": "An internal server error has occurred."
}
}
}
],
"server.callback": [
{
"title": "Shipping Options Callback Request - Shipping Address Only Event",
"description": "The PayPal callback server sends request with a buyer's shipping address, and the purchase_units of the order, to the merchant listener URL. The request payload is an example of the event that will be sent as soon as the buyer is presented with the \"PayPal Buyer Approval\" page. The merchant responds with a the appropriate tax calculation for the shipping address, and a list of available shipping options.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "8HFTASDATTV",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "200 OK",
"body": {
"id": "8HFTASDATTV",
"purchase_units": {
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "105.00",
"breakdown": {
"item_total": {
"currency_code": "USD",
"value": "100.00"
},
"tax_total": {
"currency_code": "USD",
"value": "5.00"
},
"shipping": {
"currency_code": "USD",
"value": "0.00"
}
}
},
"shipping_options": [
{
"id": "1",
"amount": {
"currency_code": "USD",
"value": "0.00"
},
"type": "SHIPPING",
"label": "Free Shipping",
"selected": true
},
{
"id": "2",
"amount": {
"currency_code": "USD",
"value": "7.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": false
},
{
"id": "3",
"amount": {
"currency_code": "USD",
"value": "10.00"
},
"type": "SHIPPING",
"label": "1-Day Shipping",
"selected": false
}
]
}
}
}
},
{
"title": "Shipping Options Callback Request - Shipping Address and Shipping Options Event",
"description": "The PayPal callback server sends request with a buyer's shipping address, the shipping option the buyer selected, and the purchase_units of the order, to the merchant listener URL. The merchant responds with a the appropriate tax calculation and breakdown for the given address and shipping option combination.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "5O190127TN364715T",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"shipping_option": {
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "200 OK",
"body": {
"id": "8HFTASDATTV",
"purchase_units": {
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "125.00",
"breakdown": {
"item_total": {
"currency_code": "USD",
"value": "100.00"
},
"tax_total": {
"currency_code": "USD",
"value": "5.00"
},
"shipping": {
"currency_code": "USD",
"value": "20.00"
}
}
},
"shipping_options": [
{
"id": "1",
"amount": {
"currency_code": "USD",
"value": "0.00"
},
"type": "SHIPPING",
"label": "Free Shipping",
"selected": false
},
{
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
{
"id": "3",
"amount": {
"currency_code": "USD",
"value": "10.00"
},
"type": "SHIPPING",
"label": "1-Day Shipping",
"selected": false
}
]
}
}
}
},
{
"title": "Shipping Options Callback - 422 Unprocessable Entity - ADDRESS_ERROR",
"description": "This code sample attempts to retrieves the shipping options for an order, but the request fails because the address is not accepted by the merchant.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "5O190127TN364715T",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"shipping_option": {
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "ADDRESS_ERROR"
}
]
}
}
},
{
"title": "Shipping Options Callback - 422 Unprocessable Entity - COUNTRY_ERROR",
"description": "This code sample attempts to retrieves the shipping options for an order, but the request fails because the merchant doesnt ship to the country provided.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "5O190127TN364715T",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"shipping_option": {
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "COUNTRY_ERROR"
}
]
}
}
},
{
"title": "Shipping Options Callback - 422 Unprocessable Entity - METHOD_UNAVAILABLE",
"description": "This code sample attempts to retrieves the shipping options for an order, but the request fails because the merchant support the shipping option provided.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "5O190127TN364715T",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"shipping_option": {
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "METHOD_UNAVAILABLE"
}
]
}
}
},
{
"title": "Shipping Options Callback - 422 Unprocessable Entity - STATE_ERROR",
"description": "This code sample attempts to retrieves the shipping options for an order, but the request fails because the merchant doesnt ship to this state.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "5O190127TN364715T",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"shipping_option": {
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "STATE_ERROR"
}
]
}
}
},
{
"title": "Shipping Options Callback - 422 Unprocessable Entity - STORE_UNAVAILABLE",
"description": "This code sample attempts to retrieves the shipping options for an order, but the request fails because part of the item is not available in the store.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "5O190127TN364715T",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"shipping_option": {
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "STORE_UNAVAILABLE"
}
]
}
}
},
{
"title": "Shipping Options Callback - 422 Unprocessable Entity - ZIP_ERROR",
"description": "This code sample attempts to retrieves the shipping options for an order, but the request fails because the merchant doesnt ship to this state.",
"operationId": "server.callback",
"request": {
"method": "post",
"path": "/v2/checkout/orders/order-update-callback",
"headers": {
"PayPal-Transmission-Id": "69cd13f0-d67a-11e5-baa3-778b53f4ae55",
"PayPal-Transmission-Time": "2016-02-18T20:01:35Z",
"PayPal-Cert-Url": "https://api-m.paypal.com/v1/notifications/certs/CERT-1234567890",
"PayPal-Transmission-Sig": "lmI95Jx3Y9nhR5SJWlHVIWpg4AgFk7n9bCHSRxbrd8A9zrhdu2rMyFrmz+Zjh3s3boXB07VXCXUZy/UFzUlnGJn0wDugt7FlSvdKeIJenLRemUxYCPVoEZzg9VFNqOa48gMkvF+XTpxBeUx/kWy6B5cp7GkT2+pOowfRK7OaynuxUoKW3JcMWw272VKjLTtTAShncla7tGF+55rxyt2KNZIIqxNMJ48RDZheGU5w1npu9dZHnPgTXB9iomeVRoD8O/jhRpnKsGrDschyNdkeh81BJJMH4Ctc6lnCCquoP/GzCzz33MMsNdid7vL/NIWaCsekQpW26FpWPi/tfj8nLA==",
"PayPal-Auth-Algo": "SHA256withRSA"
},
"body": {
"id": "5O190127TN364715T",
"shipping_address": {
"country_code": "US",
"admin_area_1": "TX",
"admin_area_2": "Dallas",
"postal_code": "75001"
},
"shipping_option": {
"id": "2",
"amount": {
"currency_code": "USD",
"value": "20.00"
},
"type": "SHIPPING",
"label": "USPS Priority Shipping",
"selected": true
},
"purchase_units": [
{
"reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
"amount": {
"currency_code": "USD",
"value": "100.00"
}
}
]
}
},
"response": {
"status": "422 Unprocessable Content",
"body": {
"name": "UNPROCESSABLE_ENTITY",
"details": [
{
"issue": "ZIP_ERROR"
}
]
}
}
}
],
"certs.get": [
{
"title": "Get Public Certificate",
"description": "Retrieve the PEM-encoded public certificate for verifying PayPal callback request signatures.",
"operationId": "certs.get",
"request": {
"method": "get",
"path": "/v2/checkout/callback/certs/d01361aa2b87337f"
},
"response": {
"status": "200 OK",
"body": "-----BEGIN CERTIFICATE-----\r\nMIIHXzCCBkegAwIBAgIQAxJN5DSYOQAuQZSJU29v6zANBgkqhkiG9w0BAQsFADB1MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMTQwMgYDVQQDEytEaWdpQ2VydCBTSEEyIEV4dGVuZGVkIFZhbGlkYXRpb24gU2VydmVyIENBMB4XDTI2MDIyNzAwMDAwMFoXDTI2MDQxNDIzNTk1OVowgdsxEzARBgsrBgEEAYI3PAIBAxMCVVMxGTAXBgsrBgEEAYI3PAIBAhMIRGVsYXdhcmUxHTAbBgNVBA8MFFByaXZhdGUgT3JnYW5pemF0aW9uMRAwDgYDVQQFEwczMDE0MjY3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTERMA8GA1UEBxMIU2FuIEpvc2UxFTATBgNVBAoTDFBheVBhbCwgSW5jLjEsMCoGA1UEAxMjbWVzc2FnZXZlcmlmaWNhdGlvbmNlcnRzLnBheXBhbC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCQL4UYfyaj8pdQYOy31q2ECUEpHFKz/vXa0UMzwJrBGmdok5sMtE6ShUaGOO2JVUdhdnFro2HdR0dmCe4sSHrHmL/58bpHsAhgZNtDdTY8ifm95b5rRKeG9aYLT9fcG+4qcp5lRNT6DxQJ9YFfK6fy5Ae15AP6Oad+Z85dWcOS4Exm1hTzhwqoU1PcOm/a1cAtkBUdFehblWKPNWbOhaLGJZJwn7XYgQLLxDeUY9mY4OhePYJuYrhGsrbH9giVgGH307ZMBsjMNjYtPnPNKzt3lsBUPRC+V45KcrWBBaqqGUolh9mM2bPpp7D2P9ON8eotoUb+vg09Jo9GDvczYDfpAgMBAAGjggOCMIIDfjAfBgNVHSMEGDAWgBQ901Cl1qCt7vNKYApl0yHU+PjWDzAdBgNVHQ4EFgQUv50CWLYHZK7qXjn4O9yDMndc4wQwLgYDVR0RBCcwJYIjbWVzc2FnZXZlcmlmaWNhdGlvbmNlcnRzLnBheXBhbC5jb20wSgYDVR0gBEMwQTALBglghkgBhv1sAgEwMgYFZ4EMAQEwKTAnBggrBgEFBQcCARYbaHR0cDovL3d3dy5kaWdpY2VydC5jb20vQ1BTMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwdQYDVR0fBG4wbDA0oDKgMIYuaHR0cDovL2NybDMuZGlnaWNlcnQuY29tL3NoYTItZXYtc2VydmVyLWczLmNybDA0oDKgMIYuaHR0cDovL2NybDQuZGlnaWNlcnQuY29tL3NoYTItZXYtc2VydmVyLWczLmNybDCBiAYIKwYBBQUHAQEEfDB6MCQGCCsGAQUFBzABhhhodHRwOi8vb2NzcC5kaWdpY2VydC5jb20wUgYIKwYBBQUHMAKGRmh0dHA6Ly9jYWNlcnRzLmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydFNIQTJFeHRlbmRlZFZhbGlkYXRpb25TZXJ2ZXJDQS5jcnQwDAYDVR0TAQH/BAIwADCCAX8GCisGAQQB1nkCBAIEggFvBIIBawFpAHYAZBHEbKQS7KeJHKICLgC8q08oB9QeNSer6v7VA8l9zfAAAAGcnkTDmgAABAMARzBFAiEAr/QMXEJsayhVJLOIevxM9jUUbrBPz20gu0zuT0YYsw8CIDlcyK2WYBJArRP7uB8KzH2wsBik6j6DgBbe/UNoK6b7AHcADleUvPOuqT4zGyyZB7P3kN+bwj1xMiXdIaklrGHFTiEAAAGcnkTDnAAABAMASDBGAiEA4nXFbxXfPRLH5hB7Ew6rbHg9FR7JsCM32dFeNuauJ8kCIQDwqhVhR0aJc+MoRBfr3+7J/xadcU9akQgqRk4HXDt9wgB2AEmcm2neHXzs/DbezYdkprhbrwqHgBnRVVL76esp3fjDAAABnJ5Ew6kAAAQDAEcwRQIhAKKaCt2+XIKnNv6AwiNxGbrTq2AXmRaMxlBz4sfflzl8AiAlaS5k3fdqYJDEOSmY6jZuP5wpSDOsJKsCFwkwE0HzfzANBgkqhkiG9w0BAQsFAAOCAQEA0IC51Rq9b8PQGnJOJEUuJnV8pbM8JxnVXZW0iicU1cQcCVD69whgpJUka+GZrJCiWQErpFkw+AUZE83oVk/XfxbHZZnTiyqFgynsOEyerDkvlZuPmhBtudsbH6gZkFOQCRUysOkBmeyxLFb1h8B/kFeHgYeEoAJUv7FbBsCDONGjonjDrJqvl7xKLMOBWWmJuW9NjzQ36MUHjrGASK4WZO8SDj6k7rRRQa1Zs8VbPG3xkCi65QaPdmtBIASy2Ov5qrpXAQqLnt9hiQ7Hn9XRQUxGrzrXLmmHVHY9ISr6xDNOXbU2MwWbIwhbyXTrmWhmzBHaLGKaeOp33vZ5yccyfg==\r\n-----END CERTIFICATE-----"
}
},
{
"title": "Get Public Certificate - 400 Invalid Request - Invalid Certificate ID Format",
"description": "Certificate id has invalid format or length.",
"operationId": "certs.get",
"request": {
"method": "get",
"path": "/v2/checkout/callback/certs/d01361aa2b87337f"
},
"response": {
"status": "400 Bad Request",
"body": {
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "b6b3c3a2e1234",
"details": [
{
"field": "cert_id",
"value": "!!!!!!!!!!!!!!!!",
"location": "path",
"issue": "INVALID_PARAMETER_SYNTAX",
"description": "The value of a field does not conform to the expected format."
}
]
}
}
},
{
"title": "Get Public Certificate - 400 Invalid Request - Invalid Certificate ID Length",
"description": "Certificate id has invalid format or length.",
"operationId": "certs.get",
"request": {
"method": "get",
"path": "/v2/checkout/callback/certs/d01361aa2b87337f"
},
"response": {
"status": "400 Bad Request",
"body": {
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "b6b3c3a2e1234",
"details": [
{
"field": "cert_id",
"value": "abc123",
"location": "path",
"issue": "INVALID_STRING_LENGTH",
"description": "The value of a field is either too short or too long."
}
]
}
}
}
]
}
}