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": "PayPal-Request-Id", "description": "The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 108, "pattern": "^[\\S\\s]*$" }, "examples": { "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": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "00_orders_create": { "summary": "Create Order - PayPal Wallet as Payment Source, Resulting in PAYER_ACTION_REQUIRED Response", "description": "Creates a new order. API caller receives payer-action link.", "value": "7b92603e-77ed-4896-8e78-5dea2050476a" } } }, { "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": {
"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",
"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"
}
}
},
"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"
}
]
}
},
"orders_create_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",
"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"
}
]
}
},
"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",
"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"
}
]
}
}
}
}
}
},
"400": {
"description": "Request is not well-formed, syntactically incorrect, or violates schema.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"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"
}
]
}
}
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"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"
}
]
}
}
}
}
}
}
},
"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/00_orders_create",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/00_orders_create",
"response_example": "responses/200/content/application~1json/examples/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/orders_create_authorize_single_step_paypal_with_vault_id_and_stored_credentials_usage_pattern",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/orders_create_authorize_single_step_paypal_with_vault_id_and_stored_credentials_usage_pattern",
"response_example": "responses/201/content/application~1json/examples/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/orders_create_simple",
"response_example": "responses/201/content/application~1json/examples/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/orders_create_create_orders_with_shipping_type_pickup_in_store"
],
"request_body_example": "requestBody/content/application~1json/examples/orders_create_create_orders_with_shipping_type_pickup_in_store",
"response_example": "responses/201/content/application~1json/examples/orders_create_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/orders_create_create_order_mixed_cart_with_shipping_options_bwp_unknown_status"
],
"response_example": "responses/400/content/application~1json/examples/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/create_422_unprocessable_entity_missing_pickup_address",
"response_example": "responses/422/content/application~1json/examples/create_422_unprocessable_entity_missing_pickup_address"
}
],
"x-codeSamples": [
{
"lang": "csharp",
"label": ".NET",
"source": "using Microsoft.Extensions.Logging;\nusing PaypalServerSdk.Standard;\nusing PaypalServerSdk.Standard.Authentication;\nusing PaypalServerSdk.Standard.Controllers;\nusing PaypalServerSdk.Standard.Exceptions;\nusing PaypalServerSdk.Standard.Http.Response;\nusing PaypalServerSdk.Standard.Models;\nusing System;\nusing System.Collections.Generic;\nusing System.Threading.Tasks;\n\nnamespace TestConsoleProject\n{\n public class Program\n {\n public static async Task Main()\n {\n PaypalServerSdkClient client = new PaypalServerSdkClient.Builder()\n .ClientCredentialsAuth(\n new ClientCredentialsAuthModel.Builder(\n \"OAuthClientId\",\n \"OAuthClientSecret\"\n )\n .Build())\n .Environment(PaypalServerSdk.Standard.Environment.Sandbox)\n .LoggingConfig(config => config\n .LogLevel(LogLevel.Information)\n .RequestConfig(reqConfig => reqConfig.Body(true))\n .ResponseConfig(respConfig => respConfig.Headers(true))\n )\n .Build();\n\n OrdersController ordersController = client.OrdersController;\n\n CreateOrderInput createOrderInput = new CreateOrderInput\n {\n Body = new OrderRequest\n {\n Intent = CheckoutPaymentIntent.Capture,\n PurchaseUnits = new ListNote: 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": { "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": { "00_orders_get": { "summary": "Get Order - Show Order Details After Customer Approval", "description": "Shows order details immediately after customer approval.", "value": { "id": "5O190127TN364715T", "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" } ] } } } } } }, "404": { "$ref": "#/components/responses/404_error_response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "orders.get_404": { "summary": "404 Resource not found", "value": { "name": "RESOURCE_NOT_FOUND", "message": "The specified resource does not exist.", "debug_id": "ccb6f410b107f", "details": [ { "issue": "INVALID_RESOURCE_ID", "description": "Specified resource ID does not exist. Please check the resource ID and try again." } ], "links": [ { "href": "https://developer.paypal.com/docs/api/payments/v2/#error-INVALID_RESOURCE_ID", "rel": "information_link" } ] } } } } } } }, "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/00_orders_get", "parameters/@name=='Authorization'/examples/bearer" ], "response_example": "responses/200/content/application~1json/examples/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/00_orders_get" ], "response_example": "responses/404/content/application~1json/examples/generic" } ], "x-codeSamples": [ { "lang": "csharp", "label": ".NET", "source": "using Microsoft.Extensions.Logging;\nusing PaypalServerSdk.Standard;\nusing PaypalServerSdk.Standard.Authentication;\nusing PaypalServerSdk.Standard.Controllers;\nusing PaypalServerSdk.Standard.Exceptions;\nusing PaypalServerSdk.Standard.Http.Response;\nusing PaypalServerSdk.Standard.Models;\nusing System;\nusing System.Collections.Generic;\nusing System.Threading.Tasks;\n\nnamespace TestConsoleProject\n{\n public class Program\n {\n public static async Task Main()\n {\n PaypalServerSdkClient client = new PaypalServerSdkClient.Builder()\n .ClientCredentialsAuth(\n new ClientCredentialsAuthModel.Builder(\n \"OAuthClientId\",\n \"OAuthClientSecret\"\n )\n .Build())\n .Environment(PaypalServerSdk.Standard.Environment.Sandbox)\n .LoggingConfig(config => config\n .LogLevel(LogLevel.Information)\n .RequestConfig(reqConfig => reqConfig.Body(true))\n .ResponseConfig(respConfig => respConfig.Headers(true))\n )\n .Build();\n\n OrdersController ordersController = client.OrdersController;\n\n GetOrderInput getOrderInput = new GetOrderInput\n {\n Id = \"5O190127TN364715T\",\n };\n\n try\n {\n ApiResponse
\\\"/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": [ { "name": "PayPal-Request-Id", "description": "The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 108, "pattern": "^[\\S\\s]*$" }, "examples": { "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": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "orders_authorize_idempotent": { "summary": "Authorize Order - Idempotent Response with PayPal Wallet", "description": "Authorizes payment for an order with the same idempotency key. By default, uses the minimal representation.", "value": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "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": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "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": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "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": "7b92603e-77ed-4896-8e78-5dea2050476a" } } }, { "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": {
"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",
"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"
}
]
}
},
"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",
"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"
}
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/403_error_response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"orders.authorize_403": {
"summary": "403 Authorization error",
"value": {
"name": "NOT_AUTHORIZED",
"message": "Authorization failed due to insufficient permissions.",
"debug_id": "9ecb6d8e2e112",
"details": [
{
"issue": "PERMISSION_DENIED",
"description": "You do not have permission to access or perform operations on this resource."
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/overview/#error",
"rel": "information_link"
}
]
}
}
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"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"
}
]
}
},
"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"
}
]
}
}
}
}
}
}
},
"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/00_orders_authorize",
"parameters/@name=='PayPal-Request-Id'/examples/00_orders_authorize",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/201/content/application~1json/examples/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/orders_authorize_idempotent",
"parameters/@name=='PayPal-Request-Id'/examples/orders_authorize_idempotent",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/200/content/application~1json/examples/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/orders_authorize_paypal_wallet_vault_id",
"parameters/@name=='PayPal-Request-Id'/examples/orders_authorize_paypal_wallet_vault_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/orders_authorize_paypal_wallet_vault_id",
"response_example": "responses/201/content/application~1json/examples/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/orders_authorize_paypal_billing_agreement_id",
"parameters/@name=='PayPal-Request-Id'/examples/orders_authorize_paypal_billing_agreement_id",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/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/authorize_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"parameters/@name=='PayPal-Request-Id'/examples/authorize_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/authorize_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"response_example": "responses/422/content/application~1json/examples/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/authorize_422_unprocessable_entity_payment_denied",
"parameters/@name=='PayPal-Request-Id'/examples/authorize_422_unprocessable_entity_payment_denied",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/authorize_422_unprocessable_entity_payment_denied",
"response_example": "responses/422/content/application~1json/examples/authorize_422_unprocessable_entity_payment_denied"
}
],
"x-codeSamples": [
{
"lang": "csharp",
"label": ".NET",
"source": "using Microsoft.Extensions.Logging;\nusing PaypalServerSdk.Standard;\nusing PaypalServerSdk.Standard.Authentication;\nusing PaypalServerSdk.Standard.Controllers;\nusing PaypalServerSdk.Standard.Exceptions;\nusing PaypalServerSdk.Standard.Http.Response;\nusing PaypalServerSdk.Standard.Models;\nusing System;\nusing System.Collections.Generic;\nusing System.Threading.Tasks;\n\nnamespace TestConsoleProject\n{\n public class Program\n {\n public static async Task Main()\n {\n PaypalServerSdkClient client = new PaypalServerSdkClient.Builder()\n .ClientCredentialsAuth(\n new ClientCredentialsAuthModel.Builder(\n \"OAuthClientId\",\n \"OAuthClientSecret\"\n )\n .Build())\n .Environment(PaypalServerSdk.Standard.Environment.Sandbox)\n .LoggingConfig(config => config\n .LogLevel(LogLevel.Information)\n .RequestConfig(reqConfig => reqConfig.Body(true))\n .ResponseConfig(respConfig => respConfig.Headers(true))\n )\n .Build();\n\n OrdersController ordersController = client.OrdersController;\n\n AuthorizeOrderInput authorizeOrderInput = new AuthorizeOrderInput\n {\n Id = \"5O190127TN364715T\",\n Prefer = \"return=minimal\",\n };\n\n try\n {\n ApiResponseNote: 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": "PayPal-Request-Id", "description": "The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 108, "pattern": "^[\\S\\s]*$" }, "examples": { "orders_capture_wallet_idempotent": { "summary": "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.", "value": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "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": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "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": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "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": "7b92603e-77ed-4896-8e78-5dea2050476a" }, "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": "7b92603e-77ed-4896-8e78-5dea2050476a" } } }, { "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": {
"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",
"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,
"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"
}
]
}
},
"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",
"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,
"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"
}
]
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/403_error_response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"orders.capture_403": {
"summary": "403 Authorization error",
"value": {
"name": "NOT_AUTHORIZED",
"message": "Authorization failed due to insufficient permissions.",
"debug_id": "9ecb6d8e2e112",
"details": [
{
"issue": "PERMISSION_DENIED",
"description": "You do not have permission to access or perform operations on this resource."
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/overview/#error",
"rel": "information_link"
}
]
}
}
}
}
}
},
"404": {
"$ref": "#/components/responses/404_error_response",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"orders.capture_404": {
"summary": "404 Resource not found",
"value": {
"name": "RESOURCE_NOT_FOUND",
"message": "The specified resource does not exist.",
"debug_id": "ccb6f410b107f",
"details": [
{
"issue": "INVALID_RESOURCE_ID",
"description": "Specified resource ID does not exist. Please check the resource ID and try again."
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/payments/v2/#error-INVALID_RESOURCE_ID",
"rel": "information_link"
}
]
}
}
}
}
}
},
"422": {
"description": "The requested action could not be performed, semantically incorrect, or failed business validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
},
"examples": {
"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"
}
]
}
},
"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"
}
]
}
}
}
}
}
}
},
"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/00_orders_capture",
"parameters/@name=='PayPal-Request-Id'/examples/00_orders_capture",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/201/content/application~1json/examples/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/orders_capture_wallet_idempotent",
"parameters/@name=='PayPal-Request-Id'/examples/orders_capture_wallet_idempotent",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/200/content/application~1json/examples/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/orders_capture_vault_wallet",
"parameters/@name=='PayPal-Request-Id'/examples/orders_capture_vault_wallet",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/201/content/application~1json/examples/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/orders_capture_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"parameters/@name=='PayPal-Request-Id'/examples/orders_capture_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"parameters/@name=='Authorization'/examples/bearer",
"parameters/@name=='Prefer'/examples/orders_capture_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted"
],
"request_body_example": "requestBody/content/application~1json/examples/orders_capture_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/orders_capture_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"parameters/@name=='PayPal-Request-Id'/examples/orders_capture_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted",
"parameters/@name=='Authorization'/examples/bearer",
"parameters/@name=='Prefer'/examples/orders_capture_orders_capture_bank_ach_debit_verified_account_customer_id_vault_instruction_vaulted"
],
"request_body_example": "requestBody/content/application~1json/examples/orders_capture_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/capture_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"parameters/@name=='PayPal-Request-Id'/examples/capture_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"parameters/@name=='Authorization'/examples/bearer"
],
"request_body_example": "requestBody/content/application~1json/examples/capture_422_payer_action_required_cib_psd2_sca_ba_in_sc",
"response_example": "responses/422/content/application~1json/examples/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/capture_422_unprocessable_entity",
"parameters/@name=='PayPal-Request-Id'/examples/capture_422_unprocessable_entity",
"parameters/@name=='Authorization'/examples/bearer"
],
"response_example": "responses/422/content/application~1json/examples/capture_422_unprocessable_entity"
}
],
"x-codeSamples": [
{
"lang": "csharp",
"label": ".NET",
"source": "using Microsoft.Extensions.Logging;\nusing PaypalServerSdk.Standard;\nusing PaypalServerSdk.Standard.Authentication;\nusing PaypalServerSdk.Standard.Controllers;\nusing PaypalServerSdk.Standard.Exceptions;\nusing PaypalServerSdk.Standard.Http.Response;\nusing PaypalServerSdk.Standard.Models;\nusing System;\nusing System.Collections.Generic;\nusing System.Threading.Tasks;\n\nnamespace TestConsoleProject\n{\n public class Program\n {\n public static async Task Main()\n {\n PaypalServerSdkClient client = new PaypalServerSdkClient.Builder()\n .ClientCredentialsAuth(\n new ClientCredentialsAuthModel.Builder(\n \"OAuthClientId\",\n \"OAuthClientSecret\"\n )\n .Build())\n .Environment(PaypalServerSdk.Standard.Environment.Sandbox)\n .LoggingConfig(config => config\n .LogLevel(LogLevel.Information)\n .RequestConfig(reqConfig => reqConfig.Body(true))\n .ResponseConfig(respConfig => respConfig.Headers(true))\n )\n .Build();\n\n OrdersController ordersController = client.OrdersController;\n\n CaptureOrderInput captureOrderInput = new CaptureOrderInput\n {\n Id = \"5O190127TN364715T\",\n Prefer = \"return=minimal\",\n };\n\n try\n {\n ApiResponse| 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" ] }, "phone_number_without_country_code": { "title": "Phone Number Format Requiring National Number Excluding Country 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),requiring only the national_number field.", "type": "object", "required": [ "national_number" ], "properties": { "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}?$" } } }, "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_number_without_country_code" }, { "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" ] } } }, "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" ] }, "image_url": { "description": "The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.", "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" }, "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" }, "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. File type and size restrictions apply. An image that violates these restrictions will not be honored.", "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"
},
"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"
]
},
"card_type": {
"title": "card_type",
"description": "Type of card. i.e Credit, Debit and so on.",
"type": "string",
"enum": [
"CREDIT",
"DEBIT",
"PREPAID",
"STORE",
"UNKNOWN"
]
},
"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"
]
},
"enrolled": {
"description": "Status of Authentication eligibility.",
"type": "string",
"enum": [
"Y",
"N",
"U",
"B"
]
},
"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"
]
},
"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_-]+$"
},
"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"
]
},
"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"
}
}
},
"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" ] } } }, "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" }, "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" ] }, "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" ] }, "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" }, "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" ] }, "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": { "os_type": { "description": "Operating System type of the device that the buyer is using.", "type": "string", "enum": [ "ANDROID", "IOS", "OTHER" ], "readOnly": true }, "os_version": { "description": "Operating System version of the device that the buyer is using.", "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^.*$", "readOnly": true } } }, "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 }, "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" ] } }, "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" }, "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" }, "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" }, "user_action": { "description": "Configures a Continue or Pay Now checkout flow.", "type": "string", "enum": [ "CONTINUE", "PAY_NOW" ], "default": "CONTINUE" }, "payment_method_preference": { "description": "The merchant-preferred payment methods.", "type": "string", "enum": [ "UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED" ], "default": "UNRESTRICTED" }, "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"
},
"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"
}
}
},
"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"
]
},
"usage_type": {
"title": "Venmo Payment Token Usage Type",
"description": "The usage type associated with the Venmo payment token.",
"type": "string",
"enum": [
"MERCHANT",
"PLATFORM"
]
},
"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"
},
"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"
}
}
},
"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"
]
},
"image_url": {
"description": "The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.",
"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"
]
},
"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. File type and size restrictions apply. An image that violates these restrictions will not be honored.",
"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"
]
},
"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."
}
]
},
"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"
]
}
}
},
"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
},
"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
},
"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"
]
}
}
}
},
"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
},
"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
},
"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
},
"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
}
}
},
"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"
]
}
}
},
"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
},
"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"
]
}
}
},
"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
},
"status_details": {
"allOf": [
{
"$ref": "#/components/schemas/refund_status_details"
},
{
"description": "The details of the refund status.",
"readOnly": true
}
]
}
}
},
"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
}
]
}
}
},
"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"
}
]
}
},
"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
}
]
},
"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.| See | Since Version |
|---|---|
| payment_source.paypal | 2.9 |
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"
},
"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."
}
]
}
}
},
"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"
}
]
},
"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",
"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"
},
{
"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."
}
]
}
}
}
}
]
},
"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
}
}
},
"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."
}
}
}
}