Note: For error handling and troubleshooting, see Orders v2 errors.operationId: orders.create responses: '200': description: A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows order details. content: application/json: schema: "$ref": "#/components/schemas/order" '201': description: 'A successful request returns the HTTP `201 Created` status code and a JSON response body that includes by default a minimal response with the ID, status, and HATEOAS links. If you require the complete order resource representation, you must pass the
Prefer: return=representation request header. This header value is not the default.'
content:
application/json:
schema:
"$ref": "#/components/schemas/order"
examples:
orders_request_create:
value:
intent: CAPTURE
purchase_units:
- reference_id: d9f80740-38f0-11e8-b467-0ed5f89f718b
amount:
currency_code: USD
value: '100.00'
'400':
description: Request is not well-formed, syntactically incorrect, or violates schema.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_400"
- "$ref": "#/components/schemas/400"
'401':
description: Authentication failed due to missing authorization header, or invalid authentication credentials.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_401"
- "$ref": "#/components/schemas/401"
'422':
description: The requested action could not be performed, semantically incorrect, or failed business validation.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_422"
- "$ref": "#/components/schemas/422"
default:
"$ref": "#/components/responses/default"
parameters:
- "$ref": "#/components/parameters/paypal_request_id"
- "$ref": "#/components/parameters/paypal_partner_attribution_id"
- "$ref": "#/components/parameters/paypal_client_metadata_id"
- "$ref": "#/components/parameters/prefer"
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/order_request"
examples:
order_request:
value:
intent: CAPTURE
purchase_units:
- reference_id: d9f80740-38f0-11e8-b467-0ed5f89f718b
amount:
currency_code: USD
value: '100.00'
payment_source:
paypal:
experience_context:
payment_method_preference: IMMEDIATE_PAYMENT_REQUIRED
payment_method_selected: PAYPAL
brand_name: EXAMPLE INC
locale: en-US
landing_page: LOGIN
user_action: PAY_NOW
return_url: https://example.com/returnUrl
cancel_url: https://example.com/cancelUrl
required: true
security:
- Oauth2:
- https://uri.paypal.com/services/payments/payment
- https://uri.paypal.com/services/payments/orders/client-side-integration
tags:
- Orders
"/v2/checkout/orders/{id}":
get:
summary: Paypal Show order details
description: Shows details for an order, by ID.Note: For error handling and troubleshooting, see Orders v2 errors.operationId: orders.get 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" '401': description: Authentication failed due to missing authorization header, or invalid authentication credentials. content: application/json: schema: allOf: - "$ref": "#/components/schemas/error_401" - "$ref": "#/components/schemas/401" '404': description: The specified resource does not exist. content: application/json: schema: allOf: - "$ref": "#/components/schemas/error_404" - "$ref": "#/components/schemas/404" default: "$ref": "#/components/responses/default" parameters: - "$ref": "#/components/parameters/id" - "$ref": "#/components/parameters/fields" security: - Oauth2: - https://uri.paypal.com/services/payments/payment - https://uri.paypal.com/services/payments/orders/client-side-integration tags: - Orders patch: summary: Paypal Update order description: 'Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.
\"/purchase_units/@reference_id==''default''/{attribute-or-object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.Note: For error handling and troubleshooting, see Orders v2 errors.Patchable attributes or objects:
| Attribute | Op | Notes |
|---|---|---|
intent | replace | |
payer | replace, add | Using replace op for payer will replace the whole payer object with the value sent in request. |
purchase_units | replace, add | |
purchase_units[].custom_id | replace, add, remove | |
purchase_units[].description | replace, add, remove | |
purchase_units[].payee.email | replace | |
purchase_units[].shipping.name | replace, add | |
purchase_units[].shipping.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.platform_fees | replace, add, remove | |
purchase_units[].supplementary_data.airline | replace, add, remove | |
purchase_units[].supplementary_data.card | replace, add, remove | |
application_context.client_configuration | replace, add |
Note: For error handling and troubleshooting, see Orders v2 errors.operationId: orders.authorize responses: '200': description: A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows authorized payment details. content: application/json: schema: "$ref": "#/components/schemas/order_authorize_response" '201': description: 'A successful response to a non-idempotent request returns the HTTP `201 Created` status code with a JSON response body that shows authorized payment details. If a duplicate response is retried, returns the HTTP `200 OK` status code. By default, the response is minimal. If you need the complete resource representation, you must pass the
Prefer: return=representation request header.'
content:
application/json:
schema:
"$ref": "#/components/schemas/order_authorize_response"
'400':
description: Request is not well-formed, syntactically incorrect, or violates schema.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_400"
- "$ref": "#/components/schemas/orders.authorize-400"
'401':
description: Authentication failed due to missing authorization header, or invalid authentication credentials.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_401"
- "$ref": "#/components/schemas/401"
'403':
description: The authorized payment failed due to insufficient permissions.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_403"
- "$ref": "#/components/schemas/orders.authorize-403"
'404':
description: The specified resource does not exist.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_404"
- "$ref": "#/components/schemas/404"
'422':
description: The requested action could not be performed, semantically incorrect, or failed business validation.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_422"
- "$ref": "#/components/schemas/orders.authorize-422"
'500':
description: An internal server error has occurred.
content:
application/json:
schema:
"$ref": "#/components/schemas/error_500"
default:
"$ref": "#/components/responses/default"
parameters:
- "$ref": "#/components/parameters/paypal_request_id"
- "$ref": "#/components/parameters/prefer"
- "$ref": "#/components/parameters/paypal_client_metadata_id"
- "$ref": "#/components/parameters/id"
- "$ref": "#/components/parameters/paypal_auth_assertion"
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/order_authorize_request"
security:
- Oauth2:
- https://uri.paypal.com/services/payments/payment
- https://uri.paypal.com/services/payments/orders/client-side-integration
tags:
- Orders
"/v2/checkout/orders/{id}/capture":
post:
summary: Paypal Capture payment for order
description: Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.Note: For error handling and troubleshooting, see Orders v2 errors.operationId: orders.capture responses: '200': description: A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows captured payment details. content: application/json: schema: "$ref": "#/components/schemas/order" '201': description: 'A successful response to a non-idempotent request returns the HTTP `201 Created` status code with a JSON response body that shows captured payment details. If a duplicate response is retried, returns the HTTP `200 OK` status code. By default, the response is minimal. If you need the complete resource representation, pass the
Prefer: return=representation request header.'
content:
application/json:
schema:
"$ref": "#/components/schemas/order"
'400':
description: Request is not well-formed, syntactically incorrect, or violates schema.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_400"
- "$ref": "#/components/schemas/orders.capture-400"
'401':
description: Authentication failed due to missing authorization header, or invalid authentication credentials.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_401"
- "$ref": "#/components/schemas/401"
'403':
description: The authorized payment failed due to insufficient permissions.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_403"
- "$ref": "#/components/schemas/orders.capture-403"
'404':
description: The specified resource does not exist.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_404"
- "$ref": "#/components/schemas/404"
'422':
description: The requested action could not be performed, semantically incorrect, or failed business validation.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_422"
- "$ref": "#/components/schemas/orders.capture-422"
'500':
description: An internal server error has occurred.
content:
application/json:
schema:
"$ref": "#/components/schemas/error_500"
default:
"$ref": "#/components/responses/default"
parameters:
- "$ref": "#/components/parameters/paypal_request_id"
- "$ref": "#/components/parameters/prefer"
- "$ref": "#/components/parameters/paypal_client_metadata_id"
- "$ref": "#/components/parameters/id"
- "$ref": "#/components/parameters/paypal_auth_assertion"
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/order_capture_request"
security:
- Oauth2:
- https://uri.paypal.com/services/payments/payment
- https://uri.paypal.com/services/payments/orders/client-side-integration
tags:
- Orders
"/v2/checkout/orders/{id}/track":
post:
summary: Paypal Add tracking information for an Order.
description: Adds tracking information for an Order.
operationId: orders.track.create
responses:
'200':
description: A successful response to an idempotent request returns the HTTP `200 OK` status code with a JSON response body that shows tracker details.
content:
application/json:
schema:
"$ref": "#/components/schemas/order"
'201':
description: A successful response to a non-idempotent request returns the HTTP `201 Created` status code with a JSON response body that shows tracker details. If a duplicate response is retried, returns the HTTP `200 OK` status code.
content:
application/json:
schema:
"$ref": "#/components/schemas/order"
'400':
description: Request is not well-formed, syntactically incorrect, or violates schema.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_400"
- "$ref": "#/components/schemas/orders.track.create-400"
'403':
description: Authorization failed due to insufficient permissions.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_403"
- "$ref": "#/components/schemas/orders.track.create-403"
'404':
description: The specified resource does not exist.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_404"
- "$ref": "#/components/schemas/404"
'422':
description: The requested action could not be performed, semantically incorrect, or failed business validation.
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/error_422"
- "$ref": "#/components/schemas/orders.track.create-422"
'500':
description: An internal server error has occurred.
content:
application/json:
schema:
"$ref": "#/components/schemas/error_500"
default:
"$ref": "#/components/responses/default"
parameters:
- "$ref": "#/components/parameters/id"
- "$ref": "#/components/parameters/paypal_auth_assertion"
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/order_tracker_request"
required: true
security:
- Oauth2:
- https://uri.paypal.com/services/payments/payment
tags:
- Orders
"/v2/checkout/orders/{id}/trackers/{tracker_id}":
patch:
summary: Update or cancel tracking information for a PayPal order
description: Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:| Attribute | Op | Notes |
|---|---|---|
items | replace | Using replace op for items will replace the entire items object with the value sent in request. |
notify_payer | replace, add | |
status | replace | Only patching status to CANCELLED is currently supported. |
Note: Up to 64 characters are allowed before and 255 characters are allowed after theformat: merchant_common_email_address_v2 maxLength: 254 minLength: 3 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: type: string title: PayPal Account Identifier description: The account identifier for a PayPal account. format: ppaas_payer_id_v3 minLength: 13 maxLength: 13 pattern: "^[2-9A-HJ-NP-Z]{13}$" payer_base: type: object title: Payer Base description: The customer who approves and pays for the order. The customer is also known as the payer. properties: email_address: description: The email address of the payer. "$ref": "#/components/schemas/email" payer_id: description: The PayPal-assigned ID for the payer. readOnly: true "$ref": "#/components/schemas/account_id" name: type: object title: Name description: The name of the party. properties: prefix: type: string description: The prefix, or title, to the party's name. maxLength: 140 given_name: type: string description: When the party is a person, the party's given, or first, name. maxLength: 140 surname: type: string 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. maxLength: 140 middle_name: type: string 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. maxLength: 140 suffix: type: string description: The suffix for the party's name. maxLength: 140 alternate_full_name: type: string description: DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business. maxLength: 300 full_name: type: string description: When the party is a person, the party's full name. maxLength: 300 phone_type: type: string title: Phone Type description: The phone type. enum: - FAX - HOME - MOBILE - OTHER - PAGER phone: type: object title: Phone description: The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). properties: country_code: type: string description: The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). minLength: 1 maxLength: 3 pattern: "^[0-9]{1,3}?$" national_number: type: string 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). minLength: 1 maxLength: 14 pattern: "^[0-9]{1,14}?$" extension_number: type: string description: The extension number. minLength: 1 maxLength: 15 pattern: "^[0-9]{1,15}?$" required: - country_code - national_number phone_with_type: type: object title: Phone With Type description: The phone information. properties: phone_type: "$ref": "#/components/schemas/phone_type" phone_number: 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. "$ref": "#/components/schemas/phone" required: - phone_number date_no_time: type: string 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. format: ppaas_date_notime_v2 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: type: object description: The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. title: Tax Information properties: tax_id: type: string description: The customer's tax ID value. minLength: 1 maxLength: 14 pattern: "([a-zA-Z0-9])" tax_id_type: type: string description: The customer's tax ID type. minLength: 1 maxLength: 14 pattern: "^[A-Z0-9_]+$" enum: - BR_CPF - BR_CNPJ required: - tax_id - tax_id_type country_code: type: string description: The [two-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 isformat: ppaas_common_country_code_v2 maxLength: 2 minLength: 2 pattern: "^([A-Z]{2}|C2)$" address_portable: type: object 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).' properties: address_line_1: type: string description: The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address. maxLength: 300 address_line_2: type: string description: The second line of the address. For example, suite or apartment number. maxLength: 300 address_line_3: type: string description: The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address. maxLength: 100 admin_area_4: type: string description: The neighborhood, ward, or district. 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.
maxLength: 100
sub_building:
type: string
description: The first-order entity below a named building or location that represents the sub-premises. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
maxLength: 100
required:
- country_code
payer:
type: object
title: Customer
description: The customer who approves and pays for the order. The customer is also known as the payer.
format: payer_v1
allOf:
- "$ref": "#/components/schemas/payer_base"
- properties:
name:
description: The name of the payer. Supports only the `given_name` and `surname` properties.
"$ref": "#/components/schemas/name"
phone:
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`.
"$ref": "#/components/schemas/phone_with_type"
birth_date:
description: The birth date of the payer in `YYYY-MM-DD` format.
"$ref": "#/components/schemas/date_no_time"
tax_info:
description: The tax information of the payer. Required only for Brazilian payer's. Both `tax_id` and `tax_id_type` are required.
"$ref": "#/components/schemas/tax_info"
address:
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.
"$ref": "#/components/schemas/address_portable"
currency_code:
description: The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.
type: string
format: ppaas_common_currency_code_v2
minLength: 3
maxLength: 3
money:
type: object
title: Money
description: The currency and amount for a financial transaction, such as a balance or payment due.
properties:
currency_code:
"$ref": "#/components/schemas/currency_code"
value:
type: string
description: The value, which might be:item_total.value can not be a negative number.
"$ref": "#/components/schemas/money"
shipping:
description: The shipping fee for all items within a given `purchase_unit`. shipping.value can not be a negative number.
"$ref": "#/components/schemas/money"
handling:
description: The handling fee for all items within a given `purchase_unit`. handling.value can not be a negative number.
"$ref": "#/components/schemas/money"
tax_total:
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.
"$ref": "#/components/schemas/money"
insurance:
description: The insurance fee for all items within a given `purchase_unit`. insurance.value can not be a negative number.
"$ref": "#/components/schemas/money"
shipping_discount:
description: The shipping discount for all items within a given `purchase_unit`. shipping_discount.value can not be a negative number.
"$ref": "#/components/schemas/money"
discount:
description: The discount for all items within a given `purchase_unit`. discount.value can not be a negative number.
"$ref": "#/components/schemas/money"
amount_with_breakdown:
type: object
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.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.
"$ref": "#/components/schemas/money"
tax:
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.
"$ref": "#/components/schemas/money"
quantity:
type: string
description: The item quantity. Must be a whole number.
maxLength: 10
pattern: "^[1-9][0-9]{0,9}$"
description:
type: string
description: The detailed item description.
maxLength: 127
sku:
type: string
description: The stock keeping unit (SKU) for the item.
maxLength: 127
category:
type: string
description: The item category type.
minLength: 1
maxLength: 20
enum:
- DIGITAL_GOODS
- PHYSICAL_GOODS
- DONATION
required:
- name
- unit_amount
- quantity
shipping_type:
type: string
title: Shipping Type
description: A classification for the method of purchase fulfillment.
enum:
- SHIPPING
- PICKUP
- PICKUP_IN_STORE
- PICKUP_FROM_PERSON
shipping_option:
type: object
title: Shipping Option
description: The options that the payee or merchant offers to the payer to ship or pick up their items.
properties:
id:
type: string
description: A unique ID that identifies a payer-selected shipping option.
maxLength: 127
label:
type: string
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.
maxLength: 127
type:
description: A classification for the method of purchase fulfillment.
"$ref": "#/components/schemas/shipping_type"
amount:
description: The shipping cost for the selected option.
"$ref": "#/components/schemas/money"
selected:
type: boolean
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`.
required:
- id
- label
- selected
shipping_detail:
type: object
description: The shipping details.
title: Shipping Details
properties:
name:
description: The name of the person to whom to ship the items. Supports only the `full_name` property.
"$ref": "#/components/schemas/name"
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
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
enum:
- SHIPPING
- PICKUP_IN_PERSON
- PICKUP_IN_STORE
- PICKUP_FROM_PERSON
options:
type: array
description: An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.
minItems: 0
maxItems: 10
items:
description: The option that the payee or merchant offers to the payer to ship or pick up their items.
"$ref": "#/components/schemas/shipping_option"
address:
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.
"$ref": "#/components/schemas/address_portable"
level_2_card_processing_data:
type: object
title: Level 2 Card Processing Data
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.
properties:
invoice_id:
type: string
description: Use this field to pass a purchase identification value of up to 12 ASCII characters for AIB and 17 ASCII characters for all other processors.
minLength: 1
maxLength: 17
pattern: ^[\w‘\-.,":;\!?]*$
tax_total:
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"
"$ref": "#/components/schemas/money"
line_item:
type: object
title: Lineitem
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.
allOf:
- "$ref": "#/components/schemas/item"
- properties:
commodity_code:
type: string
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.
minLength: 1
maxLength: 12
pattern: "^[a-zA-Z0-9_'.-]*$"
discount_amount:
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.
"$ref": "#/components/schemas/money"
total_amount:
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.
"$ref": "#/components/schemas/money"
unit_of_measure:
type: string
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).'
minLength: 1
maxLength: 12
pattern: "^[a-zA-Z0-9_'.-]*$"
level_3_card_processing_data:
type: object
title: Level 3 Card Processing Data
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.
properties:
shipping_amount:
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.
"$ref": "#/components/schemas/money"
duty_amount:
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.
"$ref": "#/components/schemas/money"
discount_amount:
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.
"$ref": "#/components/schemas/money"
shipping_address:
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.
"$ref": "#/components/schemas/address_portable"
ships_from_postal_code:
type: string
description: Use this field to specify the postal code of the shipping location.
minLength: 1
maxLength: 60
pattern: "^[a-zA-Z0-9_'.-]*$"
line_items:
type: array
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.
minItems: 1
maxItems: 100
items:
"$ref": "#/components/schemas/line_item"
card_supplementary_data:
type: object
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.
properties:
level_2:
"$ref": "#/components/schemas/level_2_card_processing_data"
level_3:
"$ref": "#/components/schemas/level_3_card_processing_data"
supplementary_data:
title: Supplementary Data
type: object
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.
properties:
card:
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.
"$ref": "#/components/schemas/card_supplementary_data"
purchase_unit_request:
type: object
title: Purchase Unit Request
description: The purchase unit request. Includes required information for the payment contract.
properties:
reference_id:
type: string
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`.
minLength: 1
maxLength: 256
amount:
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.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.'
minLength: 1
maxLength: 22
items:
type: array
description: An array of items that the customer purchases from the merchant.
items:
description: The item.
"$ref": "#/components/schemas/item"
shipping:
description: The name and address of the person to whom to ship the items.
"$ref": "#/components/schemas/shipping_detail"
supplementary_data:
description: Contains Supplementary Data.
"$ref": "#/components/schemas/supplementary_data"
required:
- amount
instrument_id:
type: string
description: The identifier of the instrument.
minLength: 1
maxLength: 256
pattern: "^[A-Za-z0-9-_.+=]+$"
date_year_month:
type: string
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).
minLength: 7
maxLength: 7
pattern: "^[0-9]{4}-(0[1-9]|1[0-2])$"
card_brand:
type: string
title: Card Brand
description: The card network or brand. Applies to credit, debit, gift, and payment cards.
minLength: 1
maxLength: 255
pattern: "^[A-Z_]+$"
enum:
- VISA
- MASTERCARD
- DISCOVER
- AMEX
- SOLO
- JCB
- STAR
- DELTA
- SWITCH
- MAESTRO
- CB_NATIONALE
- CONFIGOGA
- CONFIDIS
- ELECTRON
- CETELEM
- CHINA_UNION_PAY
card_type:
type: string
title: Card Type
description: Type of card. i.e Credit, Debit and so on.
minLength: 1
maxLength: 255
pattern: "^[A-Z_]+$"
enum:
- CREDIT
- DEBIT
- PREPAID
- STORE
- UNKNOWN
merchant_partner_customer_id:
type: string
description: The unique ID for a customer generated by PayPal.
minLength: 1
maxLength: 22
pattern: "^[0-9a-zA-Z_-]+$"
customer:
type: object
title: Customer information based on PayPal's system of record
description: The details about a customer in PayPal's system of record.
properties:
id:
"$ref": "#/components/schemas/merchant_partner_customer_id"
email_address:
description: Email address of the buyer 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. For all other use cases we do not expect partners/merchant to send email_address of their customer.
"$ref": "#/components/schemas/email"
phone:
description: The phone number of the buyer as provided to the merchant or on file with the merchant. The `phone.phone_number` supports only `national_number`.
"$ref": "#/components/schemas/phone_with_type"
store_in_vault_instruction:
type: string
description: Defines how and when the payment source gets vaulted.
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
enum:
- ON_SUCCESS
vault_instruction_base:
type: object
title: Base vault Instruction parameters
description: Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.
properties:
store_in_vault:
"$ref": "#/components/schemas/store_in_vault_instruction"
card_attributes:
type: object
title: Card Attributes
description: Additional attributes associated with the use of this card.
properties:
customer:
"$ref": "#/components/schemas/customer"
vault:
description: Instruction to vault the card based on the specified strategy.
"$ref": "#/components/schemas/vault_instruction_base"
card:
type: object
title: Card
description: The payment card to use to fund a payment. Can be a credit or debit card.
properties:
id:
description: The PayPal-generated ID for the card.
readOnly: true
"$ref": "#/components/schemas/instrument_id"
name:
type: string
description: The card holder's name as it appears on the card.
maxLength: 300
minLength: 1
pattern: "^.{1,300}$"
number:
type: string
description: The primary account number (PAN) for the payment card.
pattern: "^[0-9]{13,19}$"
minLength: 13
maxLength: 19
expiry:
description: The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6).
"$ref": "#/components/schemas/date_year_month"
security_code:
type: string
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`.
pattern: "^[0-9]{3,4}$"
minLength: 3
maxLength: 4
last_digits:
type: string
description: The last digits of the payment card.
pattern: "^[0-9]{2,4}$"
minLength: 2
maxLength: 4
readOnly: true
card_type:
description: The card brand or network. Typically used in the response.
readOnly: true
"$ref": "#/components/schemas/card_brand"
deprecated: true
type:
description: The payment card type.
"$ref": "#/components/schemas/card_type"
brand:
description: The card brand or network. Typically used in the response.
"$ref": "#/components/schemas/card_brand"
billing_address:
description: The billing address for this card. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties.
"$ref": "#/components/schemas/address_portable"
attributes:
description: Additional attributes associated with the use of this card.
"$ref": "#/components/schemas/card_attributes"
vault_id:
type: string
description: The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
minLength: 1
maxLength: 255
pattern: "^[0-9a-zA-Z_-]+$"
payment_initiator:
type: string
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
description: The person or party who initiated or triggered the payment.
enum:
- CUSTOMER
- MERCHANT
stored_payment_source_payment_type:
type: string
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
description: Indicates the type of the stored payment_source payment.
enum:
- ONE_TIME
- RECURRING
- UNSCHEDULED
stored_payment_source_usage_type:
type: string
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
default: DERIVED
description: Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file).
enum:
- FIRST
- SUBSEQUENT
- DERIVED
network_transaction_reference:
type: object
title: Network Transaction Reference
description: Reference values used by the card network to identify a transaction.
properties:
id:
type: string
minLength: 9
maxLength: 36
pattern: "^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$"
description: Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -.
date:
type: string
minLength: 4
maxLength: 4
pattern: "^[0-9]+$"
description: The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date.
network:
description: Name of the card network through which the transaction was routed.
"$ref": "#/components/schemas/card_brand"
acquirer_reference_number:
type: string
description: Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
minLength: 1
maxLength: 36
pattern: "^[a-zA-Z0-9]+$"
required:
- id
card_stored_credential:
type: object
title: Card Stored Credential
description: Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).Note: Passing card number, cvv and expiry directly via the API requires PCI SAQ D compliance.allOf: - "$ref": "#/components/schemas/card" - properties: vault_id: description: The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server. "$ref": "#/components/schemas/vault_id" stored_credential: "$ref": "#/components/schemas/card_stored_credential" network_token: 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. "$ref": "#/components/schemas/network_token_request" experience_context: "$ref": "#/components/schemas/card_experience_context" token: type: object title: Token description: The tokenized payment source to fund a payment. properties: id: type: string description: The PayPal-generated ID for the token. pattern: "^[0-9a-zA-Z_-]+$" minLength: 1 maxLength: 255 type: type: string description: The tokenization method that generated the ID. minLength: 1 maxLength: 255 pattern: "^[0-9A-Z_-]+$" enum: - BILLING_AGREEMENT required: - id - type name-2: type: object title: Name description: The name of the party. properties: prefix: type: string description: The prefix, or title, to the party's name. maxLength: 140 given_name: type: string description: When the party is a person, the party's given, or first, name. maxLength: 140 surname: type: string 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. maxLength: 140 middle_name: type: string 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. maxLength: 140 suffix: type: string description: The suffix for the party's name. maxLength: 140 full_name: type: string description: When the party is a person, the party's full name. maxLength: 300 country_code-2: type: string description: The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.
*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: The country code for Great Britain isformat: ppaas_common_country_code_v2 maxLength: 2 minLength: 2 pattern: "^([A-Z]{2}|C2)$" address_portable-2: type: object 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).' properties: address_line_1: type: string 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. maxLength: 300 address_line_2: type: string description: The second line of the address, for example, a suite or apartment number. maxLength: 300 address_line_3: type: string 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. maxLength: 100 admin_area_4: type: string 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.
maxLength: 100
sub_building:
type: string
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.
maxLength: 100
required:
- country_code
paypal_wallet_customer:
type: object
title: Customer information based on PayPal's system of record
description: The details about a customer in PayPal's system of record.
allOf:
- "$ref": "#/components/schemas/customer"
- properties: {}
vault_owner_id: {}
vault_paypal_wallet_base:
type: object
title: Vaulted PayPal Wallet Common Attributes
description: Resource consolidating common request and response attributes for vaulting PayPal Wallet.
allOf:
- "$ref": "#/components/schemas/vault_instruction_base"
- properties:
description:
type: string
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.
minLength: 1
maxLength: 128
usage_pattern:
type: string
description: Expected business/pricing model for the billing agreement.
minLength: 1
maxLength: 30
enum:
- IMMEDIATE
- DEFERRED
- RECURRING_PREPAID
- RECURRING_POSTPAID
- THRESHOLD_PREPAID
- THRESHOLD_POSTPAID
shipping:
description: The shipping address for the Payer.
"$ref": "#/components/schemas/shipping_detail"
usage_type:
type: string
description: The usage type associated with the PayPal payment token.
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
enum:
- MERCHANT
- PLATFORM
owner_id:
"$ref": "#/components/schemas/vault_owner_id"
customer_type:
type: string
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.
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
default: CONSUMER
enum:
- CONSUMER
- BUSINESS
permit_multiple_payment_tokens:
type: boolean
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.
default: false
required:
- usage_type
paypal_wallet_attributes:
type: object
title: PayPal Wallet Attributes
description: Additional attributes associated with the use of this PayPal Wallet.
properties:
customer:
"$ref": "#/components/schemas/paypal_wallet_customer"
vault:
description: Attributes used to provide the instructions during vaulting of the PayPal Wallet.
"$ref": "#/components/schemas/vault_paypal_wallet_base"
language:
type: string
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/).
format: ppaas_common_language_v3
maxLength: 10
minLength: 2
pattern: "^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$"
paypal_wallet_experience_context:
type: object
title: PayPal Wallet Experience Context
description: Customizes the payer experience during the approval process for payment with PayPal.Note: Partners and Marketplaces might configureproperties: brand_name: type: string 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. minLength: 1 maxLength: 127 pattern: "^.*$" locale: 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`. "$ref": "#/components/schemas/language" shipping_preference: type: string description: The location from which the shipping address is derived. minLength: 1 maxLength: 24 pattern: "^[A-Z_]+$" default: GET_FROM_FILE enum: - GET_FROM_FILE - NO_SHIPPING - SET_PROVIDED_ADDRESS return_url: description: The URL where the customer will be redirected upon approving a payment. format: uri "$ref": "#/components/schemas/url" cancel_url: description: The URL where the customer will be redirected upon cancelling the payment approval. format: uri "$ref": "#/components/schemas/url" landing_page: type: string description: The type of landing page to show on the PayPal site for customer checkout. default: NO_PREFERENCE minLength: 1 maxLength: 13 pattern: "^[0-9A-Z_]+$" enum: - LOGIN - GUEST_CHECKOUT - NO_PREFERENCE user_action: type: string description: Configures a Continue or Pay Now checkout flow. default: CONTINUE minLength: 1 maxLength: 8 pattern: "^[0-9A-Z_]+$" enum: - CONTINUE - PAY_NOW payment_method_preference: type: string description: The merchant-preferred payment methods. minLength: 1 maxLength: 255 pattern: "^[0-9A-Z_]+$" default: UNRESTRICTED enum: - UNRESTRICTED - IMMEDIATE_PAYMENT_REQUIRED billing_agreement_id: type: string description: The PayPal billing agreement ID. References an approved recurring payment for goods or services. minLength: 2 maxLength: 128 pattern: "^[a-zA-Z0-9-]+$" paypal_wallet: type: object title: PayPal Wallet description: A resource that identifies a PayPal Wallet is used for payment. properties: vault_id: description: The PayPal-generated ID for the payment_source stored within the Vault. "$ref": "#/components/schemas/vault_id" email_address: description: The email address of the PayPal account holder. "$ref": "#/components/schemas/email" name: description: The name of the PayPal account holder. Supports only the `given_name` and `surname` properties. "$ref": "#/components/schemas/name-2" phone: 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`. "$ref": "#/components/schemas/phone_with_type" birth_date: description: The birth date of the PayPal account holder in `YYYY-MM-DD` format. "$ref": "#/components/schemas/date_no_time" tax_info: description: The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both `tax_id` and `tax_id_type` are required. "$ref": "#/components/schemas/tax_info" address: description: The address of the PayPal account holder. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer. "$ref": "#/components/schemas/address_portable-2" attributes: description: Additional attributes associated with the use of this wallet. "$ref": "#/components/schemas/paypal_wallet_attributes" experience_context: "$ref": "#/components/schemas/paypal_wallet_experience_context" billing_agreement_id: "$ref": "#/components/schemas/billing_agreement_id" full_name: type: string description: The full name representation like Mr J Smith. minLength: 3 maxLength: 300 experience_context_base: type: object title: Experience Context description: Customizes the payer experience during the approval process for the payment. properties: brand_name: type: string 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. minLength: 1 maxLength: 127 pattern: "^.*$" locale: 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`. "$ref": "#/components/schemas/language" shipping_preference: type: string description: The location from which the shipping address is derived. minLength: 1 maxLength: 24 pattern: "^[A-Z_]+$" default: GET_FROM_FILE enum: - GET_FROM_FILE - NO_SHIPPING - SET_PROVIDED_ADDRESS return_url: description: The URL where the customer is redirected after the customer approves the payment. format: uri "$ref": "#/components/schemas/url" cancel_url: description: The URL where the customer is redirected after the customer cancels the payment. format: uri "$ref": "#/components/schemas/url" altpay_recurring_attributes_request: {} bancontact_request: type: object title: Bancontact payment object description: Information needed to pay using Bancontact. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" attributes: description: Attributes for altpay recurring. "$ref": "#/components/schemas/altpay_recurring_attributes_request" required: - name - country_code email_address: type: string description: The internationalized email address.brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
Note: Up to 64 characters are allowed before and 255 characters are allowed after theformat: ppaas_common_email_address_v2 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])+)\])$ ip_address: type: string 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. format: ppaas_ip_address_v1 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*$" blik_experience_context: type: object title: BLIK Experience Context description: Customizes the payer experience during the approval process for the BLIK payment. allOf: - "$ref": "#/components/schemas/experience_context_base" - properties: consumer_ip: description: The IP address of the consumer. It could be either IPv4 or IPv6. "$ref": "#/components/schemas/ip_address" consumer_user_agent: type: string description: The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0). minLength: 1 maxLength: 256 pattern: "^.*$" blik_seamless: type: object title: BLIK level_0 payment object description: Information used to pay using BLIK level_0 flow. properties: auth_code: type: string description: The 6-digit code used to authenticate a consumer within BLIK. minLength: 6 maxLength: 6 pattern: "^[0-9]{6}$" required: - auth_code blik_one_click: type: object title: BLIK one-click payment object description: Information used to pay using BLIK one-click flow. properties: auth_code: type: string description: The 6-digit code used to authenticate a consumer within BLIK. minLength: 6 maxLength: 6 pattern: "^[0-9]{6}$" consumer_reference: type: string description: The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant. minLength: 3 maxLength: 64 pattern: "^[ -~]{3,64}$" alias_label: type: string description: A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts. minLength: 8 maxLength: 35 pattern: "^[ -~]{8,35}$" alias_key: type: string description: A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference. minLength: 1 maxLength: 19 pattern: "^[0-9]+$" required: - consumer_reference blik_request: type: object title: BLIK payment object description: Information needed to pay using BLIK. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" email: description: The email address of the account holder associated with this payment method. "$ref": "#/components/schemas/email_address" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/blik_experience_context" level_0: description: The level_0 integration flow object. "$ref": "#/components/schemas/blik_seamless" one_click: description: The one-click integration flow object. "$ref": "#/components/schemas/blik_one_click" required: - name - country_code eps_request: type: object title: An eps payment object description: Information needed to pay using eps. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" required: - name - country_code giropay_request: type: object title: A giropay payment object description: Information needed to pay using giropay. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" required: - name - country_code bic: type: string title: BIC description: The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank. minLength: 8 maxLength: 11 pattern: "^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$" ideal_request: type: object title: The iDEAL payment object description: Information needed to pay using iDEAL. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" attributes: description: Attributes for altpay recurring. "$ref": "#/components/schemas/altpay_recurring_attributes_request" required: - name - country_code mybank_request: type: object title: MyBank payment object description: Information needed to pay using MyBank. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" required: - name - country_code p24_request: type: object title: P24 payment object description: Information needed to pay using P24 (Przelewy24). properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" email: description: The email address of the account holder associated with this payment method. "$ref": "#/components/schemas/email_address" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" required: - name - email - country_code sofort_request: type: object title: Sofort payment object description: Information needed to pay using Sofort. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" required: - name - country_code trustly_request: type: object title: Trustly payment object description: Information needed to pay using Trustly. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" experience_context: description: Customizes the payer experience during the approval process for the payment. "$ref": "#/components/schemas/experience_context_base" required: - name - country_code currency_code-2: description: The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency. type: string format: ppaas_common_currency_code_v2 minLength: 3 maxLength: 3 money-2: type: object title: Money description: The currency and amount for a financial transaction, such as a balance or payment due. properties: currency_code: "$ref": "#/components/schemas/currency_code-2" value: type: string description: The value, which might be:@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values.
properties:
brand_name:
type: string
description: The business name of the merchant. The pattern is defined by an external party and supports Unicode.
minLength: 1
maxLength: 127
pattern: "^.*$"
shipping_preference:
type: string
description: The location from which the shipping address is derived.
minLength: 1
maxLength: 24
pattern: "^[A-Z_]+$"
default: GET_FROM_FILE
enum:
- GET_FROM_FILE
- NO_SHIPPING
- SET_PROVIDED_ADDRESS
v3_vault_instruction_base:
type: object
title: Base Vault Instruction Parameters
description: Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.
properties:
store_in_vault:
"$ref": "#/components/schemas/store_in_vault_instruction"
required:
- store_in_vault
vault_venmo_wallet_base:
type: object
title: Vaulted Venmo Wallet Common Attributes
description: Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.
allOf:
- "$ref": "#/components/schemas/v3_vault_instruction_base"
- properties:
description:
type: string
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.
minLength: 1
maxLength: 128
pattern: ^[a-zA-Z0-9_'\-., :;\!?"]*$
usage_pattern:
type: string
description: Expected business/pricing model for the billing agreement.
minLength: 1
maxLength: 30
pattern: "^[0-9A-Z_]+$"
enum:
- IMMEDIATE
- DEFERRED
- RECURRING_PREPAID
- RECURRING_POSTPAID
- THRESHOLD_PREPAID
- THRESHOLD_POSTPAID
usage_type:
type: string
description: The usage type associated with the Venmo payment token.
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
enum:
- MERCHANT
- PLATFORM
customer_type:
type: string
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.
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
default: CONSUMER
enum:
- CONSUMER
- BUSINESS
permit_multiple_payment_tokens:
type: boolean
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.
default: false
required:
- usage_type
venmo_wallet_attributes:
type: object
title: Venmo Wallet Attributes
description: Additional attributes associated with the use of this Venmo Wallet.
properties:
customer:
"$ref": "#/components/schemas/customer"
vault:
description: Attributes used to provide the instructions during vaulting of the Venmo Wallet.
"$ref": "#/components/schemas/vault_venmo_wallet_base"
venmo_wallet_request:
type: object
title: Venmo payment request object
description: Information needed to pay using Venmo.
properties:
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.
"$ref": "#/components/schemas/vault_id"
email_address:
description: The email address of the payer.
"$ref": "#/components/schemas/email"
experience_context:
"$ref": "#/components/schemas/venmo_wallet_experience_context"
attributes:
description: Additional attributes associated with the use of this wallet.
"$ref": "#/components/schemas/venmo_wallet_attributes"
payment_source:
type: object
title: Payment Source
description: The payment source definition.
properties:
card:
"$ref": "#/components/schemas/card_request"
token:
"$ref": "#/components/schemas/token"
paypal:
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.
"$ref": "#/components/schemas/paypal_wallet"
bancontact:
description: Bancontact is the most popular online payment in Belgium. [More Details](https://www.bancontact.com/).
"$ref": "#/components/schemas/bancontact_request"
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/).
"$ref": "#/components/schemas/blik_request"
eps:
description: The eps transfer is an online payment method developed by many Austrian banks. [More Details](https://www.eps-ueberweisung.at/).
"$ref": "#/components/schemas/eps_request"
giropay:
description: Giropay is an Internet payment System in Germany, based on online banking. [More Details](https://giropay.de/).
"$ref": "#/components/schemas/giropay_request"
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/).
"$ref": "#/components/schemas/ideal_request"
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/).
"$ref": "#/components/schemas/mybank_request"
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/).
"$ref": "#/components/schemas/p24_request"
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/).
"$ref": "#/components/schemas/sofort_request"
trustly:
description: Trustly is a payment method that allows customers to shop and pay from their bank account. [More Details](https://www.trustly.net/).
"$ref": "#/components/schemas/trustly_request"
apple_pay:
description: ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.
"$ref": "#/components/schemas/apple_pay_request"
google_pay:
description: Google Pay payment source, allows buyer to pay using Google Pay.
"$ref": "#/components/schemas/google_pay_request"
venmo:
description: Information needed to indicate that Venmo is being used to fund the payment.
"$ref": "#/components/schemas/venmo_wallet_request"
payee_payment_method_preference:
type: string
description: The merchant-preferred payment methods.
minLength: 1
maxLength: 255
pattern: "^[0-9A-Z_]+$"
default: UNRESTRICTED
enum:
- UNRESTRICTED
- IMMEDIATE_PAYMENT_REQUIRED
payment_method:
type: object
description: The customer and merchant payment preferences.
title: Payment Method
properties:
payee_preferred:
"$ref": "#/components/schemas/payee_payment_method_preference"
standard_entry_class_code:
type: string
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.
default: WEB
minLength: 3
maxLength: 255
enum:
- TEL
- WEB
- CCD
- PPD
stored_payment_source:
type: object
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 configureproperties: brand_name: type: string 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. minLength: 1 maxLength: 127 locale: 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. "$ref": "#/components/schemas/language" landing_page: type: string 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. deprecated: true default: NO_PREFERENCE minLength: 1 maxLength: 13 pattern: "^[0-9A-Z_]+$" enum: - LOGIN - BILLING - NO_PREFERENCE shipping_preference: type: string description: DEPRECATED. DEPRECATED. The shipping preference:brand_nameandshipping_preferenceduring partner account setup, which overrides the request values.
Note: The regular expression provides guidance but does not reject all invalid dates.format: ppaas_date_time_v3 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})$" activity_timestamps: type: object description: The date and time stamps that are common to authorized payment, captured payment, and refund transactions. title: Transaction Date and Time Stamps properties: create_time: description: The date and time when the transaction occurred, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). readOnly: true "$ref": "#/components/schemas/date_time" update_time: description: The date and time when the transaction was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). readOnly: true "$ref": "#/components/schemas/date_time" liability_shift: type: string minLength: 1 maxLength: 255 pattern: "^[0-9A-Z_]+$" description: Liability shift indicator. The outcome of the issuer's authentication. enum: - 'NO' - POSSIBLE - UNKNOWN pares_status: type: string minLength: 1 maxLength: 255 pattern: "^[0-9A-Z_]+$" description: Transactions status result identifier. The outcome of the issuer's authentication. enum: - Y - N - U - A - C - R - D - I enrolled: type: string minLength: 1 maxLength: 255 pattern: "^[0-9A-Z_]+$" description: Status of Authentication eligibility. enum: - Y - N - U - B three_d_secure_authentication_response: type: object title: The 3D Secure Authentication Response description: Results of 3D Secure Authentication. properties: authentication_status: description: The outcome of the issuer's authentication. "$ref": "#/components/schemas/pares_status" enrollment_status: description: Status of authentication eligibility. "$ref": "#/components/schemas/enrolled" authentication_flow: {} exemption_details: {} authentication_response: type: object title: Authentication Response description: Results of Authentication such as 3D Secure. properties: liability_shift: "$ref": "#/components/schemas/liability_shift" three_d_secure: "$ref": "#/components/schemas/three_d_secure_authentication_response" authentication_flow: "$ref": "#/components/schemas/authentication_flow" exemption_details: description: Exemption details of 3D Secure Authentication. "$ref": "#/components/schemas/exemption_details" link_description: type: object title: Link Description description: The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information. required: - href - rel properties: href: type: string 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. rel: type: string 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). method: type: string description: The HTTP method required to make the related call. enum: - GET - POST - PUT - DELETE - HEAD - CONNECT - OPTIONS - PATCH vault_response: type: object title: Saved Payment Source Response description: The details about a saved payment source. properties: id: type: string description: The PayPal-generated ID for the saved payment source. minLength: 1 maxLength: 255 status: type: string description: The vault status. minLength: 1 maxLength: 255 pattern: "^[0-9A-Z_]+$" deprecated: true enum: - VAULTED - CREATED - APPROVED customer: "$ref": "#/components/schemas/customer" links: type: array description: An array of request-related HATEOAS links. readOnly: true minItems: 1 maxItems: 10 items: description: A request-related [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links). "$ref": "#/components/schemas/link_description" card_attributes_response: type: object title: Card Attributes Response description: Additional attributes associated with the use of this card. properties: vault: "$ref": "#/components/schemas/vault_response" card_from_request: type: object title: Response of Card from Request description: Representation of card details as received in the request. properties: expiry: description: The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6). "$ref": "#/components/schemas/date_year_month" last_digits: type: string description: The last digits of the payment card. pattern: "[0-9]{2,}" minLength: 2 maxLength: 4 readOnly: true bin_details: type: object title: Bin Details description: Bank Identification Number (BIN) details used to fund a payment. properties: bin: type: string description: The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card. pattern: "^[0-9]+$" maxLength: 25 minLength: 1 issuing_bank: type: string description: The issuer of the card instrument. minLength: 1 maxLength: 64 bin_country_code: description: The [two-character ISO-3166-1 country code](/docs/integration/direct/rest/country-codes/) of the bank. "$ref": "#/components/schemas/country_code" products: type: array description: 'The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE.' items: type: string description: This value provides the category of the BIN. minLength: 1 maxLength: 255 minItems: 1 maxItems: 256 card_response: type: object title: Card Response description: The payment card to use to fund a payment. Card can be a credit or debit card. properties: name: type: string description: The card holder's name as it appears on the card. minLength: 2 maxLength: 300 last_digits: type: string description: The last digits of the payment card. pattern: "[0-9]{2,}" readOnly: true brand: description: The card brand or network. Typically used in the response. readOnly: true "$ref": "#/components/schemas/card_brand" available_networks: type: array description: Array of brands or networks associated with the card. readOnly: true minItems: 1 maxItems: 256 items: "$ref": "#/components/schemas/card_brand" type: type: string description: The payment card type. readOnly: true enum: - CREDIT - DEBIT - PREPAID - UNKNOWN authentication_result: "$ref": "#/components/schemas/authentication_response" attributes: "$ref": "#/components/schemas/card_attributes_response" from_request: "$ref": "#/components/schemas/card_from_request" expiry: description: The card expiration year and month, in [Internet date format](https://tools.ietf.org/html/rfc3339#section-5.6). "$ref": "#/components/schemas/date_year_month" bin_details: description: Bank Identification Number (BIN) details used to fund a payment. "$ref": "#/components/schemas/bin_details" account_id-2: type: string 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. format: ppaas_payer_id_v3 minLength: 13 maxLength: 13 pattern: "^[2-9A-HJ-NP-Z]{13}$" phone_type-2: type: string title: Phone Type description: The phone type. enum: - FAX - HOME - MOBILE - OTHER - PAGER - WORK phone-2: type: object title: Phone description: The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). properties: national_number: type: string 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). minLength: 1 maxLength: 14 pattern: "^[0-9]{1,14}?$" required: - national_number paypal_wallet_vault_response: type: object title: Saved PayPal Wallet Payment Source Response description: The details about a saved PayPal Wallet payment source. allOf: - "$ref": "#/components/schemas/vault_response" - properties: customer: "$ref": "#/components/schemas/paypal_wallet_customer" owner_id: "$ref": "#/components/schemas/vault_owner_id" cobranded_card: type: object title: cobranded card object description: Details about the merchant cobranded card used for order purchase. properties: labels: type: array description: Array of labels for the cobranded card. minItems: 1 maxItems: 25 items: type: string description: Label for the cobranded card. minLength: 1 maxLength: 256 payee: description: Merchant associated with the purchase. "$ref": "#/components/schemas/payee_base" amount: description: Amount that was charged to the cobranded card. "$ref": "#/components/schemas/money" paypal_wallet_attributes_response: type: object title: PayPal Wallet Attributes Response description: Additional attributes associated with the use of a PayPal Wallet. properties: vault: "$ref": "#/components/schemas/paypal_wallet_vault_response" cobranded_cards: type: array description: An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s). minItems: 0 maxItems: 25 items: "$ref": "#/components/schemas/cobranded_card" paypal_wallet_response: type: object title: PayPal Wallet Response description: The PayPal Wallet response. properties: email_address: description: The email address of the PayPal account holder. "$ref": "#/components/schemas/email" account_id: description: The PayPal-assigned ID for the PayPal account holder. readOnly: true "$ref": "#/components/schemas/account_id-2" account_status: type: string description: The account status indicates whether the buyer has verified the financial details associated with their PayPal account. readOnly: true minLength: 1 maxLength: 255 pattern: "^[A-Z_]+$" enum: - VERIFIED - UNVERIFIED name: description: The name of the PayPal account holder. Supports only the `given_name` and `surname` properties. "$ref": "#/components/schemas/name-2" phone_type: "$ref": "#/components/schemas/phone_type-2" phone_number: description: The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. Supports only the `national_number` property. "$ref": "#/components/schemas/phone-2" birth_date: description: The birth date of the PayPal account holder in `YYYY-MM-DD` format. "$ref": "#/components/schemas/date_no_time" tax_info: description: The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both `tax_id` and `tax_id_type` are required. "$ref": "#/components/schemas/tax_info" address: description: The address of the PayPal account holder. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer. "$ref": "#/components/schemas/address_portable-2" attributes: "$ref": "#/components/schemas/paypal_wallet_attributes_response" iban_last_chars: type: string description: The last characters of the IBAN used to pay. minLength: 4 maxLength: 34 pattern: "[a-zA-Z0-9]{4}" altpay_recurring_attributes: {} bancontact: type: object title: Bancontact payment object description: Information used to pay Bancontact. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" iban_last_chars: "$ref": "#/components/schemas/iban_last_chars" card_last_digits: type: string minLength: 4 maxLength: 4 pattern: "[0-9]{4}" description: The last digits of the card used to fund the Bancontact payment. attributes: description: Attributes for SEPA direct debit object. "$ref": "#/components/schemas/altpay_recurring_attributes" blik_one_click_response: type: object title: BLIK one-click payment object description: Information used to pay using BLIK one-click flow. properties: consumer_reference: type: string description: The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant. minLength: 3 maxLength: 64 pattern: "^[ -~]{3,64}$" blik: type: object title: BLIK payment object description: Information used to pay using BLIK. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" email: description: The email address of the account holder associated with this payment method. "$ref": "#/components/schemas/email_address" one_click: description: The one-click integration flow object. "$ref": "#/components/schemas/blik_one_click_response" eps: type: object title: An eps payment object description: Information used to pay using eps. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" giropay: type: object title: A giropay payment object description: Information needed to pay using giropay. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" ideal: type: object title: The iDEAL payment object description: Information used to pay using iDEAL. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" iban_last_chars: "$ref": "#/components/schemas/iban_last_chars" attributes: description: Attributes for SEPA direct debit object. "$ref": "#/components/schemas/altpay_recurring_attributes" mybank: type: object title: MyBank payment object description: Information used to pay using MyBank. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" iban_last_chars: "$ref": "#/components/schemas/iban_last_chars" p24: type: object title: P24 payment object description: Information used to pay using P24(Przelewy24). properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" email: description: The email address of the account holder associated with this payment method. "$ref": "#/components/schemas/email_address" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" payment_descriptor: type: string minLength: 1 maxLength: 2000 description: P24 generated payment description. method_id: type: string minLength: 1 maxLength: 300 description: Numeric identifier of the payment scheme or bank used for the payment. method_description: type: string minLength: 1 maxLength: 2000 description: Friendly name of the payment scheme or bank used for the payment. sofort: type: object title: Sofort payment object description: Information used to pay using Sofort. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" iban_last_chars: "$ref": "#/components/schemas/iban_last_chars" trustly: type: object title: Trustly payment object description: Information needed to pay using Trustly. properties: name: description: The name of the account holder associated with this payment method. "$ref": "#/components/schemas/full_name" country_code: description: The two-character ISO 3166-1 country code. "$ref": "#/components/schemas/country_code" bic: description: The bank identification code (BIC). "$ref": "#/components/schemas/bic" iban_last_chars: "$ref": "#/components/schemas/iban_last_chars" venmo_wallet_attributes_response: type: object title: Venmo Wallet Attributes Response description: Additional attributes associated with the use of a Venmo Wallet. properties: vault: "$ref": "#/components/schemas/vault_response" venmo_wallet_response: type: object title: Venmo Wallet Response Object description: Venmo wallet response. properties: email_address: description: The email address of the payer. "$ref": "#/components/schemas/email" account_id: description: This is an immutable system-generated id for a user's Venmo account. readOnly: true "$ref": "#/components/schemas/account_id-2" user_name: description: The Venmo user name chosen by the user, also know as a Venmo handle. type: string pattern: "^[-a-zA-Z0-9_]*$" minLength: 1 maxLength: 50 name: description: The name associated with the Venmo account. Supports only the `given_name` and `surname` properties. "$ref": "#/components/schemas/name-2" phone_number: description: The phone number associated with the Venmo account, 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. "$ref": "#/components/schemas/phone-2" address: 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. "$ref": "#/components/schemas/address_portable-2" attributes: "$ref": "#/components/schemas/venmo_wallet_attributes_response" payment_source_response: type: object title: Payment Source description: The payment source used to fund the payment. properties: card: "$ref": "#/components/schemas/card_response" paypal: "$ref": "#/components/schemas/paypal_wallet_response" bancontact: "$ref": "#/components/schemas/bancontact" blik: "$ref": "#/components/schemas/blik" eps: "$ref": "#/components/schemas/eps" giropay: "$ref": "#/components/schemas/giropay" ideal: "$ref": "#/components/schemas/ideal" mybank: "$ref": "#/components/schemas/mybank" p24: "$ref": "#/components/schemas/p24" sofort: "$ref": "#/components/schemas/sofort" trustly: "$ref": "#/components/schemas/trustly" venmo: "$ref": "#/components/schemas/venmo_wallet_response" processing_instruction: type: string title: Processing Instruction description: The instruction to process an order. default: NO_INSTRUCTION minLength: 1 maxLength: 36 pattern: "^[0-9A-Z_]+$" enum: - ORDER_COMPLETE_ON_PAYMENT_APPROVAL - NO_INSTRUCTION tracker_status: {} universal_product_code: {} tracker_item: type: object title: Tracker Item description: The details of the items in the shipment. properties: name: type: string description: The item name or title. minLength: 1 maxLength: 127 quantity: type: string description: The item quantity. Must be a whole number. minLength: 1 maxLength: 10 pattern: "^[1-9][0-9]{0,9}$" sku: type: string description: The stock keeping unit (SKU) for the item. This can contain unicode characters. minLength: 1 maxLength: 127 url: type: string format: uri minLength: 1 maxLength: 2048 description: The URL to the item being purchased. Visible to buyer and used in buyer experiences. image_url: type: string format: uri description: The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. minLength: 1 maxLength: 2048 pattern: "^(https:)([/|.|\\w|\\s|-])*\\.(?:jpg|gif|png|jpeg|JPG|GIF|PNG|JPEG)" upc: description: The Universal Product Code of the item. "$ref": "#/components/schemas/universal_product_code" tracker: type: object title: Order Tracker Response. description: The tracking response on creation of tracker. allOf: - properties: id: type: string description: The tracker id. readOnly: true status: "$ref": "#/components/schemas/tracker_status" items: type: array description: An array of details of items in the shipment. items: description: Items in a shipment. "$ref": "#/components/schemas/tracker_item" links: type: array description: An array of request-related HATEOAS links. readOnly: true items: "$ref": "#/components/schemas/link_description" description: A request-related [HATEOAS link](/api/rest/responses/#hateoas-links). - "$ref": "#/components/schemas/activity_timestamps" shipping_with_tracking_details: type: object title: Order Shipping Details description: The order shipping details. allOf: - "$ref": "#/components/schemas/shipping_detail" - properties: trackers: type: array description: An array of trackers for a transaction. items: "$ref": "#/components/schemas/tracker" authorization_status_details: title: Auhorization Status Details description: The details of the authorized payment status. type: object properties: reason: description: The reason why the authorized status is `PENDING`. type: string minLength: 1 maxLength: 24 pattern: "^[A-Z_]+$" enum: - PENDING_REVIEW authorization_status: type: object title: Authorization Status description: The status fields for an authorized payment. properties: status: description: The status for the authorized payment. type: string readOnly: true enum: - CREATED - CAPTURED - DENIED - PARTIALLY_CAPTURED - VOIDED - PENDING status_details: description: The details of the authorized order pending status. readOnly: true "$ref": "#/components/schemas/authorization_status_details" seller_protection: type: object description: The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). title: Seller Protection properties: status: type: string 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). readOnly: true enum: - ELIGIBLE - PARTIALLY_ELIGIBLE - NOT_ELIGIBLE dispute_categories: type: array description: An array of conditions that are covered for the transaction. items: type: string description: The condition that is covered for the transaction. enum: - ITEM_NOT_RECEIVED - UNAUTHORIZED_TRANSACTION readOnly: true authorization: type: object title: Authorization description: The authorized payment transaction. allOf: - "$ref": "#/components/schemas/authorization_status" - properties: id: description: The PayPal-generated ID for the authorized payment. type: string readOnly: true amount: description: The amount for this authorized payment. "$ref": "#/components/schemas/money" 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 readOnly: true custom_id: type: string description: The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. maxLength: 127 network_transaction_reference: "$ref": "#/components/schemas/network_transaction_reference" seller_protection: "$ref": "#/components/schemas/seller_protection" readOnly: true expiration_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). "$ref": "#/components/schemas/date_time" readOnly: true links: description: An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). type: array readOnly: true items: "$ref": "#/components/schemas/link_description" - "$ref": "#/components/schemas/activity_timestamps" processor_response: type: object title: Processor Response description: The processor response information for payment requests, such as direct credit card transactions. properties: avs_code: description: The address verification code for Visa, Discover, Mastercard, or American Express transactions. type: string readOnly: true enum: - A - B - C - D - E - F - G - I - M - N - P - R - S - U - W - X - Y - Z - 'Null' - '0' - '1' - '2' - '3' - '4' cvv_code: description: The card verification value code for for Visa, Discover, Mastercard, or American Express. type: string readOnly: true enum: - E - I - M - N - P - S - U - X - All others - '0' - '1' - '2' - '3' - '4' response_code: description: Processor response code for the non-PayPal payment processor errors. type: string readOnly: true enum: - '0000' - 00N7 - '0100' - '0390' - '0500' - '0580' - '0800' - '0880' - '0890' - '0960' - 0R00 - '1000' - 10BR - '1300' - '1310' - '1312' - '1317' - '1320' - '1330' - '1335' - '1340' - '1350' - '1352' - '1360' - '1370' - '1380' - '1382' - '1384' - '1390' - '1393' - '5100' - '5110' - '5120' - '5130' - '5135' - '5140' - '5150' - '5160' - '5170' - '5180' - '5190' - '5200' - '5210' - '5400' - '5500' - '5650' - '5700' - '5710' - '5800' - '5900' - '5910' - '5920' - '5930' - '5950' - '6300' - '7600' - '7700' - '7710' - '7800' - '7900' - '8000' - '8010' - '8020' - '8030' - '8100' - '8110' - '8220' - '9100' - '9500' - '9510' - '9520' - '9530' - '9540' - '9600' - PCNR - PCVV - PP06 - PPRN - PPAD - PPAB - PPAE - PPAG - PPAI - PPAR - PPAU - PPAV - PPAX - PPBG - PPC2 - PPCE - PPCO - PPCR - PPCT - PPCU - PPD3 - PPDC - PPDI - PPDV - PPDT - PPEF - PPEL - PPER - PPEX - PPFE - PPFI - PPFR - PPFV - PPGR - PPH1 - PPIF - PPII - PPIM - PPIT - PPLR - PPLS - PPMB - PPMC - PPMD - PPNC - PPNL - PPNM - PPNT - PPPH - PPPI - PPPM - PPQC - PPRE - PPRF - PPRR - PPS0 - PPS1 - PPS2 - PPS3 - PPS4 - PPS5 - PPS6 - PPSC - PPSD - PPSE - PPTE - PPTF - PPTI - PPTR - PPTT - PPTV - PPUA - PPUC - PPUE - PPUI - PPUP - PPUR - PPVC - PPVE - PPVT payment_advice_code: description: The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. type: string readOnly: true enum: - '01' - '02' - '03' - '21' authorization_with_additional_data: type: object 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. allOf: - "$ref": "#/components/schemas/authorization" - properties: processor_response: "$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: description: The reason why the captured payment status is `PENDING` or `DENIED`. type: string minLength: 1 maxLength: 64 pattern: "^[A-Z_]+$" enum: - BUYER_COMPLAINT - CHARGEBACK - ECHECK - INTERNATIONAL_WITHDRAWAL - OTHER - PENDING_REVIEW - RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION - REFUNDED - TRANSACTION_APPROVED_AWAITING_FUNDING - UNILATERAL - VERIFICATION_REQUIRED capture_status: type: object title: Capture Status description: The status of a captured payment. properties: status: description: The status of the captured payment. type: string readOnly: true enum: - COMPLETED - DECLINED - PARTIALLY_REFUNDED - PENDING - REFUNDED - FAILED status_details: description: The details of the captured payment status. readOnly: true "$ref": "#/components/schemas/capture_status_details" exchange_rate: description: The exchange rate that determines the amount to convert from one currency to another currency. type: object title: Exchange Rate properties: source_currency: description: The source currency from which to convert an amount. "$ref": "#/components/schemas/currency_code" target_currency: description: The target currency to which to convert an amount. "$ref": "#/components/schemas/currency_code" 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 readOnly: true seller_receivable_breakdown: type: object title: Seller Receivable Breakdown description: The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. properties: gross_amount: description: The amount for this captured payment in the currency of the transaction. "$ref": "#/components/schemas/money" paypal_fee: description: The applicable fee for this captured payment in the currency of the transaction. "$ref": "#/components/schemas/money" paypal_fee_in_receivable_currency: 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'. "$ref": "#/components/schemas/money" net_amount: 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.
"$ref": "#/components/schemas/money"
receivable_amount:
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.
"$ref": "#/components/schemas/money"
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.
"$ref": "#/components/schemas/exchange_rate"
platform_fees:
type: array
description: An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.
minItems: 0
maxItems: 1
items:
"$ref": "#/components/schemas/platform_fee"
required:
- gross_amount
capture:
type: object
title: Capture
description: A captured payment.
allOf:
- "$ref": "#/components/schemas/capture_status"
- properties:
id:
description: The PayPal-generated ID for the captured payment.
type: string
readOnly: true
amount:
description: The amount for this captured payment.
"$ref": "#/components/schemas/money"
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
readOnly: true
custom_id:
type: string
description: The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
maxLength: 127
network_transaction_reference:
"$ref": "#/components/schemas/network_transaction_reference"
seller_protection:
"$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:
"$ref": "#/components/schemas/seller_receivable_breakdown"
readOnly: true
disbursement_mode:
"$ref": "#/components/schemas/disbursement_mode"
links:
description: An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
type: array
readOnly: true
items:
"$ref": "#/components/schemas/link_description"
processor_response:
description: An object that provides additional processor information for a direct credit card transaction.
"$ref": "#/components/schemas/processor_response"
- "$ref": "#/components/schemas/activity_timestamps"
refund_status_details:
title: Refund Status Details
description: The details of the refund status.
type: object
properties:
reason:
description: The reason why the refund has the `PENDING` or `FAILED` status.
type: string
enum:
- ECHECK
refund_status:
type: object
description: The refund status.
title: Refund Status
properties:
status:
description: The status of the refund.
type: string
readOnly: true
enum:
- CANCELLED
- FAILED
- PENDING
- COMPLETED
status_details:
description: The details of the refund status.
readOnly: true
"$ref": "#/components/schemas/refund_status_details"
net_amount_breakdown_item:
type: object
title: Net Amount Breakdown Item
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.
properties:
payable_amount:
description: The net amount debited from the merchant's PayPal account.
readOnly: true
"$ref": "#/components/schemas/money"
converted_amount:
description: The converted payable amount.
readOnly: true
"$ref": "#/components/schemas/money"
exchange_rate:
description: The exchange rate that determines the amount that was debited from the merchant's PayPal account.
readOnly: true
"$ref": "#/components/schemas/exchange_rate"
refund:
type: object
title: Refund
description: The refund information.
allOf:
- "$ref": "#/components/schemas/refund_status"
- properties:
id:
description: The PayPal-generated ID for the refund.
type: string
readOnly: true
amount:
description: The amount that the payee refunded to the payer.
"$ref": "#/components/schemas/money"
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
readOnly: true
custom_id:
type: string
description: The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
minLength: 1
maxLength: 127
pattern: "^[A-Za-z0-9-_.,]*$"
acquirer_reference_number:
type: string
description: Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.
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
readOnly: true
seller_payable_breakdown:
description: The breakdown of the refund.
type: object
title: Merchant Payable Breakdown
properties:
gross_amount:
description: The amount that the payee refunded to the payer.
"$ref": "#/components/schemas/money"
readOnly: true
paypal_fee:
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.
"$ref": "#/components/schemas/money"
readOnly: true
paypal_fee_in_receivable_currency:
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'.
"$ref": "#/components/schemas/money"
readOnly: true
net_amount:
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.
"$ref": "#/components/schemas/money"
readOnly: true
net_amount_in_receivable_currency:
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'.
"$ref": "#/components/schemas/money"
readOnly: true
platform_fees:
type: array
description: An array of platform or partner fees, commissions, or brokerage fees for the refund.
minItems: 0
maxItems: 1
items:
"$ref": "#/components/schemas/platform_fee"
net_amount_breakdown:
type: array
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.
items:
"$ref": "#/components/schemas/net_amount_breakdown_item"
readOnly: true
total_refunded_amount:
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.
"$ref": "#/components/schemas/money"
readOnly: true
payer:
description: The details associated with the merchant for this transaction.
"$ref": "#/components/schemas/payee_base"
readOnly: true
links:
description: An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
type: array
readOnly: true
items:
"$ref": "#/components/schemas/link_description"
- "$ref": "#/components/schemas/activity_timestamps"
payment_collection:
type: object
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.
properties:
authorizations:
type: array
description: An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.
items:
description: The authorized payment for a purchase unit.
"$ref": "#/components/schemas/authorization_with_additional_data"
captures:
type: array
description: An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.
items:
description: The captured payment for a purchase unit.
"$ref": "#/components/schemas/capture"
refunds:
type: array
description: An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.
items:
description: A refund for a purchase unit.
"$ref": "#/components/schemas/refund"
purchase_unit:
type: object
title: Purchase Unit
description: The purchase unit details. Used to capture required information for the payment contract.
properties:
reference_id:
type: string
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.
minLength: 1
maxLength: 256
amount:
"$ref": "#/components/schemas/amount_with_breakdown"
payee:
description: The merchant who receives payment for this transaction.
"$ref": "#/components/schemas/payee"
payment_instruction:
"$ref": "#/components/schemas/payment_instruction"
description:
type: string
description: The purchase description.
minLength: 1
maxLength: 127
custom_id:
type: string
description: The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
minLength: 1
maxLength: 127
invoice_id:
type: string
description: The API caller-provided external invoice ID for this order.
minLength: 1
maxLength: 127
id:
type: string
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.
minLength: 1
maxLength: 19
soft_descriptor:
type: string
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.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:
type: string
description: The JSON Pointer to the target document location from which to move the value. Required for the move operation.
required:
- op
patch_request:
type: array
title: Patch Request
description: An array of JSON patch objects to apply partial updates to resources.
items:
"$ref": "#/components/schemas/patch"
orders.patch-400:
properties:
details:
type: array
items:
anyOf:
- title: FIELD_NOT_PATCHABLE
properties:
issue:
type: string
enum:
- FIELD_NOT_PATCHABLE
description:
type: string
enum:
- Field cannot be patched.
- title: INVALID_ARRAY_MAX_ITEMS
properties:
issue:
type: string
enum:
- INVALID_ARRAY_MAX_ITEMS
description:
type: string
enum:
- The number of items in an array parameter is too large.
- title: INVALID_PARAMETER_SYNTAX
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_SYNTAX
description:
type: string
enum:
- The value of a field does not conform to the expected format.
- title: INVALID_STRING_LENGTH
properties:
issue:
type: string
enum:
- INVALID_STRING_LENGTH
description:
type: string
enum:
- The value of a field is either too short or too long
- title: INVALID_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_VALUE
description:
type: string
enum:
- The value of a field is invalid.
- title: MISSING_REQUIRED_PARAMETER
properties:
issue:
type: string
enum:
- MISSING_REQUIRED_PARAMETER
description:
type: string
enum:
- A required field / parameter is missing.
- title: AMOUNT_NOT_PATCHABLE
properties:
issue:
type: string
enum:
- AMOUNT_NOT_PATCHABLE
description:
type: string
enum:
- The amount cannot be updated as the 'payer' has chosen and approved a specific financing offer for a given amount. Please Create a new Order with the updated Order amount and have the 'payer' approve the new payment terms.
- title: INVALID_PATCH_OPERATION
properties:
issue:
type: string
enum:
- INVALID_PATCH_OPERATION
description:
type: string
enum:
- The operation cannot be honored. Cannot add a property that's already present, use replace. Cannot remove a property thats not present, use add. Cannot replace a property thats not present, use add.
- title: MALFORMED_REQUEST_JSON
properties:
issue:
type: string
enum:
- MALFORMED_REQUEST_JSON
description:
type: string
enum:
- The request JSON is not well formed.
orders.patch-422:
properties:
details:
type: array
items:
anyOf:
- title: AMOUNT_MISMATCH
properties:
issue:
type: string
enum:
- AMOUNT_MISMATCH
description:
type: string
enum:
- Should equal item_total + tax_total + shipping + handling + insurance - shipping_discount - discount.
- title: CANNOT_BE_NEGATIVE
properties:
issue:
type: string
enum:
- CANNOT_BE_NEGATIVE
description:
type: string
enum:
- Must be greater than or equal to 0. If the currency supports decimals, only two decimal place precision is supported.
- title: CANNOT_BE_ZERO_OR_NEGATIVE
properties:
issue:
type: string
enum:
- CANNOT_BE_ZERO_OR_NEGATIVE
description:
type: string
enum:
- Must be greater than zero. If the currency supports decimals, only two decimal place precision is supported.
- title: CITY_REQUIRED
properties:
issue:
type: string
enum:
- CITY_REQUIRED
description:
type: string
enum:
- The specified country requires a city (address.admin_area_2).
- title: DECIMAL_PRECISION
properties:
issue:
type: string
enum:
- DECIMAL_PRECISION
description:
type: string
enum:
- If the currency supports decimals, only two decimal place precision is supported.
- title: DONATION_ITEMS_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- DONATION_ITEMS_NOT_SUPPORTED
description:
type: string
enum:
- If 'purchase_unit' has "DONATION" as the 'items.category' then the Order can at most have one purchase_unit. Multiple purchase_units are not supported if either of them have at least one items with category as "DONATION".
- title: DUPLICATE_REFERENCE_ID
properties:
issue:
type: string
enum:
- DUPLICATE_REFERENCE_ID
description:
type: string
enum:
- "`reference_id` must be unique if multiple `purchase_unit` are provided."
- title: INVALID_CURRENCY_CODE
properties:
issue:
type: string
enum:
- INVALID_CURRENCY_CODE
description:
type: string
enum:
- Currency code is invalid or is not currently supported. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
- title: ITEM_TOTAL_MISMATCH
properties:
issue:
type: string
enum:
- ITEM_TOTAL_MISMATCH
description:
type: string
enum:
- Should equal sum of (unit_amount * quantity) across all items for a given purchase_unit.
- title: ITEM_TOTAL_REQUIRED
properties:
issue:
type: string
enum:
- ITEM_TOTAL_REQUIRED
description:
type: string
enum:
- If item details are specified (items.unit_amount and items.quantity) corresponding amount.breakdown.item_total is required.
- title: MAX_VALUE_EXCEEDED
properties:
issue:
type: string
enum:
- MAX_VALUE_EXCEEDED
description:
type: string
enum:
- Should be less than or equal to 999999999999999.99.
- title: INVALID_JSON_POINTER_FORMAT
properties:
issue:
type: string
enum:
- INVALID_JSON_POINTER_FORMAT
description:
type: string
enum:
- Path should be a valid JSON Pointer https://tools.ietf.org/html/rfc6901 that references a location within the request where the operation is performed.
- title: INVALID_PARAMETER
properties:
issue:
type: string
enum:
- INVALID_PARAMETER
description:
type: string
enum:
- Cannot be specified as part of the request.
- title: NOT_PATCHABLE
properties:
issue:
type: string
enum:
- NOT_PATCHABLE
description:
type: string
enum:
- Cannot be patched.
- title: TAX_TOTAL_MISMATCH
properties:
issue:
type: string
enum:
- TAX_TOTAL_MISMATCH
description:
type: string
enum:
- Should equal sum of (tax * quantity) across all items for a given purchase_unit.
- title: TAX_TOTAL_REQUIRED
properties:
issue:
type: string
enum:
- TAX_TOTAL_REQUIRED
description:
type: string
enum:
- If item details are specified (items.tax_total and items.quantity) corresponding amount.breakdown.tax_total is required.
- title: UNSUPPORTED_INTENT
properties:
issue:
type: string
enum:
- UNSUPPORTED_INTENT
description:
type: string
enum:
- "`intent=AUTHORIZE` is not supported for multiple purchase units. Only `intent=CAPTURE` is supported."
- title: UNSUPPORTED_PATCH_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- UNSUPPORTED_PATCH_PARAMETER_VALUE
description:
type: string
enum:
- The value specified for this field is not currently supported.
- title: PATCH_VALUE_REQUIRED
properties:
issue:
type: string
enum:
- PATCH_VALUE_REQUIRED
description:
type: string
enum:
- Please specify a 'value' to for the field that is being patched.
- title: PATCH_PATH_REQUIRED
properties:
issue:
type: string
enum:
- PATCH_PATH_REQUIRED
description:
type: string
enum:
- Please specify a 'path' for the field for which the operation needs to be performed.
- title: PAYEE_ACCOUNT_LOCKED_OR_CLOSED
properties:
issue:
type: string
enum:
- PAYEE_ACCOUNT_LOCKED_OR_CLOSED
description:
type: string
enum:
- The merchant account is locked or closed.
- title: PAYEE_ACCOUNT_RESTRICTED
properties:
issue:
type: string
enum:
- PAYEE_ACCOUNT_RESTRICTED
description:
type: string
enum:
- The merchant account is restricted.
- title: PAYEE_FX_RATE_ID_EXPIRED
properties:
issue:
type: string
enum:
- PAYEE_FX_RATE_ID_EXPIRED
description:
type: string
enum:
- The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
- title: PAYEE_FX_RATE_ID_CURRENCY_MISMATCH
properties:
issue:
type: string
enum:
- PAYEE_FX_RATE_ID_CURRENCY_MISMATCH
description:
type: string
enum:
- The specified FX Rate ID is for a currency that does not match with the currency of this request. Please specify a different FX Rate ID and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
- title: INVALID_FX_RATE_ID
properties:
issue:
type: string
enum:
- INVALID_FX_RATE_ID
description:
type: string
enum:
- The specific FX Rate ID is not valid. This could be either because we are not able to look up the FX Rate based on this ID or it could be because the ID belongs to another API Caller.
- title: PLATFORM_FEES_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- PLATFORM_FEES_NOT_SUPPORTED
description:
type: string
enum:
- The API Caller is not enabled to process transactions by specifying 'platform_fees'. Please work with your PayPal Account Manager to enable this option for your account.
- title: INVALID_PLATFORM_FEES_ACCOUNT
properties:
issue:
type: string
enum:
- INVALID_PLATFORM_FEES_ACCOUNT
description:
type: string
enum:
- The specified platform_fees payee account is either invalid or account setup is incomplete.Please work with your PayPal Account Manager to enable this option for your account.
- title: INVALID_PLATFORM_FEES_AMOUNT
properties:
issue:
type: string
enum:
- INVALID_PLATFORM_FEES_AMOUNT
description:
type: string
enum:
- The platform_fees amount cannot be greater than order amount.
- title: POSTAL_CODE_REQUIRED
properties:
issue:
type: string
enum:
- POSTAL_CODE_REQUIRED
description:
type: string
enum:
- The specified country requires a postal code.
- title: REFERENCE_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- REFERENCE_ID_NOT_FOUND
description:
type: string
enum:
- Filter expression value is incorrect. Please check the value of the reference_id and try again.
- title: REFERENCE_ID_REQUIRED
properties:
issue:
type: string
enum:
- REFERENCE_ID_REQUIRED
description:
type: string
enum:
- "'reference_id' is required for each 'purchase_unit' if multiple 'purchase_unit' are provided."
- title: MULTI_CURRENCY_ORDER
properties:
issue:
type: string
enum:
- MULTI_CURRENCY_ORDER
description:
type: string
enum:
- Multiple differing values of currency_code are not supported. Entire Order request must have the same currency_code.
- title: SHIPPING_OPTION_NOT_SELECTED
properties:
issue:
type: string
enum:
- SHIPPING_OPTION_NOT_SELECTED
description:
type: string
enum:
- At least one of the shipping.option should be set to 'selected = true'.
- title: SHIPPING_OPTIONS_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- SHIPPING_OPTIONS_NOT_SUPPORTED
description:
type: string
enum:
- Shipping options are not supported when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.
- title: MULTIPLE_SHIPPING_OPTION_SELECTED
properties:
issue:
type: string
enum:
- MULTIPLE_SHIPPING_OPTION_SELECTED
description:
type: string
enum:
- Only one shipping.option can be set to 'selected = true'.
- title: ORDER_ALREADY_COMPLETED
properties:
issue:
type: string
enum:
- ORDER_ALREADY_COMPLETED
description:
type: string
enum:
- The order cannot be patched after it is completed.
- title: PREFERRED_SHIPPING_OPTION_AMOUNT_MISMATCH
properties:
issue:
type: string
enum:
- PREFERRED_SHIPPING_OPTION_AMOUNT_MISMATCH
description:
type: string
enum:
- The amount provided in the preferred shipping option should match the amount provided in amount breakdown
- title: AMOUNT_CHANGE_NOT_ALLOWED
properties:
issue:
type: string
enum:
- AMOUNT_CHANGE_NOT_ALLOWED
description:
type: string
enum:
- The amount specified is different from the amount authorized by payer.
order_confirm_application_context:
type: object
title: Confirm Application Context
description: Customizes the payer confirmation experience.
properties:
brand_name:
type: string
description: Label to present to your payer as part of the PayPal hosted web experience.
minLength: 1
maxLength: 127
locale:
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`.
"$ref": "#/components/schemas/language"
return_url:
type: string
format: uri
minLength: 10
maxLength: 4000
description: The URL where the customer is redirected after the customer approves the payment.
cancel_url:
type: string
format: uri
minLength: 10
maxLength: 4000
description: The URL where the customer is redirected after the customer cancels the payment.
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.
properties:
payment_source:
"$ref": "#/components/schemas/payment_source"
processing_instruction:
"$ref": "#/components/schemas/processing_instruction"
application_context:
"$ref": "#/components/schemas/order_confirm_application_context"
required:
- payment_source
orders.confirm-400:
properties:
details:
type: array
items:
anyOf:
- title: INVALID_PARAMETER_SYNTAX
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_SYNTAX
description:
type: string
enum:
- The value of the field does not conform to the expected format.
- title: INVALID_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_VALUE
description:
type: string
enum:
- A parameter value is not valid.
- title: MISSING_REQUIRED_PARAMETER
properties:
issue:
type: string
enum:
- MISSING_REQUIRED_PARAMETER
description:
type: string
enum:
- A required field / parameter is missing
- title: INVALID_STRING_LENGTH
properties:
issue:
type: string
enum:
- INVALID_STRING_LENGTH
description:
type: string
enum:
- The value of a field is either too short or too long
- title: INVALID_STRING_MAX_LENGTH
properties:
issue:
type: string
enum:
- INVALID_STRING_MAX_LENGTH
description:
type: string
enum:
- The value of a field is too long.
- title: MALFORMED_REQUEST_JSON
properties:
issue:
type: string
enum:
- MALFORMED_REQUEST_JSON
description:
type: string
enum:
- The request JSON is not well formed.
orders.confirm-422:
properties:
details:
type: array
items:
anyOf:
- title: ORDER_ALREADY_CAPTURED
properties:
issue:
type: string
enum:
- ORDER_ALREADY_CAPTURED
description:
type: string
enum:
- Order already captured. If 'intent=CAPTURE' only one capture per order is allowed.
- title: ORDER_ALREADY_AUTHORIZED
properties:
issue:
type: string
enum:
- ORDER_ALREADY_AUTHORIZED
description:
type: string
enum:
- Order already captured. If 'intent=CAPTURE' only one capture per order is allowed.
- title: ORDER_CANNOT_BE_CONFIRMED
properties:
issue:
type: string
enum:
- ORDER_CANNOT_BE_CONFIRMED
description:
type: string
enum:
- An order with status = 'COMPLETED' cannot be confirmed again.
- title: MISSING_PREVIOUS_REFERENCE
properties:
issue:
type: string
enum:
- MISSING_PREVIOUS_REFERENCE
description:
type: string
enum:
- For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
- title: MISSING_CRYPTOGRAM
properties:
issue:
type: string
enum:
- MISSING_CRYPTOGRAM
description:
type: string
enum:
- Cryptogram is mandatory for any customer initiated network token transactions.
- title: CURRENCY_NOT_SUPPORTED_FOR_COUNTRY
properties:
issue:
type: string
enum:
- CURRENCY_NOT_SUPPORTED_FOR_COUNTRY
description:
type: string
enum:
- " For the payment_source specified, the currency of the Order is restricted by the country in which the payee account is based. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes."
- title: CARD_EXPIRED
properties:
issue:
type: string
enum:
- CARD_EXPIRED
description:
type: string
enum:
- The card is expired
- title: CARD_TYPE_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- CARD_TYPE_NOT_SUPPORTED
description:
type: string
enum:
- Processing of this card type is not supported. Use another card type.
- title: CURRENCY_NOT_SUPPORTED_FOR_CARD_TYPE
properties:
issue:
type: string
enum:
- CURRENCY_NOT_SUPPORTED_FOR_CARD_TYPE
description:
type: string
enum:
- The issued currency code of this card is not supported for direct card payments. Please refer https://developer.paypal.com/api/rest/reference/currency-codes/ for list of supported currency codes.
- title: ONLY_ONE_PAYMENT_SOURCE_ALLOWED
properties:
issue:
type: string
enum:
- ONLY_ONE_PAYMENT_SOURCE_ALLOWED
description:
type: string
enum:
- More than one payment method within the payment source is not supported.
- title: NO_PAYMENT_SOURCE_PROVIDED
properties:
issue:
type: string
enum:
- NO_PAYMENT_SOURCE_PROVIDED
description:
type: string
enum:
- At least one payment method is required within the payment source.
- title: PAYMENT_ALREADY_APPROVED
properties:
issue:
type: string
enum:
- PAYMENT_ALREADY_APPROVED
description:
type: string
enum:
- The payment has already been approved. Please capture the order, or create and confirm a new order with this payment source.
- title: UNSUPPORTED_PROCESSING_INSTRUCTION
properties:
issue:
type: string
enum:
- UNSUPPORTED_PROCESSING_INSTRUCTION
description:
type: string
enum:
- The specified processing_instruction is not supported for the given payment_source. Please refer to https://developer.paypal.com/api/orders/v2/#definition-processing_instruction for the list of payment_source that can be specified with this value.
- title: ORDER_COMPLETE_ON_PAYMENT_APPROVAL
properties:
issue:
type: string
enum:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL
description:
type: string
enum:
- A processing_instruction of `ORDER_COMPLETE_ON_PAYMENT_APPROVAL` is required for the specified payment_source.
- title: INVALID_EXPIRY_DATE
properties:
issue:
type: string
enum:
- INVALID_EXPIRY_DATE
description:
type: string
enum:
- Expiry date is invalid. Expiry date should be a date in future and within the threshold for the payment source.
- title: TOKEN_EXPIRED
properties:
issue:
type: string
enum:
- TOKEN_EXPIRED
description:
type: string
enum:
- The token is expired and cannot be used for payment.
- title: INVALID_GOOGLE_PAY_TOKEN
properties:
issue:
type: string
enum:
- INVALID_GOOGLE_PAY_TOKEN
description:
type: string
enum:
- The google pay token is invalid. PayPal was not able to decrypt the googlepay token or PayPal was not able to find the necessary data in the token after decryption.
- title: GOOGLE_PAY_GATEWAY_MERCHANT_ID_MISMATCH
properties:
issue:
type: string
enum:
- GOOGLE_PAY_GATEWAY_MERCHANT_ID_MISMATCH
description:
type: string
enum:
- The gateway merchant ID in Google Pay token is not valid. This could be because the gateway merchant Id that was authorized by payer/buyer on Google Pay does not match with the API caller of the order.
- title: CRYPTOGRAM_REQUIRED
properties:
issue:
type: string
enum:
- CRYPTOGRAM_REQUIRED
description:
type: string
enum:
- Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
- title: ONE_OF_PARAMETERS_REQUIRED
properties:
issue:
type: string
enum:
- ONE_OF_PARAMETERS_REQUIRED
description:
type: string
enum:
- One or more field is required to continue with this request.
- title: RETURN_URL_REQUIRED
properties:
issue:
type: string
enum:
- RETURN_URL_REQUIRED
description:
type: string
enum:
- The return url is required when attempting to vault this source.
- title: CANCEL_URL_REQUIRED
properties:
issue:
type: string
enum:
- CANCEL_URL_REQUIRED
description:
type: string
enum:
- The cancel url is required when attempting to vault this source.
- title: COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- COUNTRY_NOT_SUPPORTED_BY_PAYMENT_SOURCE
description:
type: string
enum:
- Country code provided is not supported by the provided payment source.
- title: REQUIRED_PARAMETER_FOR_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- REQUIRED_PARAMETER_FOR_PAYMENT_SOURCE
description:
type: string
enum:
- The parameter is required for provided payment source.
- title: REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT
properties:
issue:
type: string
enum:
- REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT
description:
type: string
enum:
- This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=`MERCHANT`. For details, see Stored Credential.
- title: ITEM_CATEGORY_NOT_SUPPORTED_BY_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- ITEM_CATEGORY_NOT_SUPPORTED_BY_PAYMENT_SOURCE
description:
type: string
enum:
- The provided payment source does not support provided item category.
- title: PAYMENT_SOURCE_INFO_CANNOT_BE_VERIFIED
properties:
issue:
type: string
enum:
- PAYMENT_SOURCE_INFO_CANNOT_BE_VERIFIED
description:
type: string
enum:
- The combination of the payment_source name, billing address, shipping name and shipping address could not be verified. Please correct this information and try again by creating a new order.
- title: PAYMENT_SOURCE_DECLINED_BY_PROCESSOR
properties:
issue:
type: string
enum:
- PAYMENT_SOURCE_DECLINED_BY_PROCESSOR
description:
type: string
enum:
- The provided payment source is declined by the processor. Please try again with a different payment source by creating a new order.
- title: PAYMENT_SOURCE_CANNOT_BE_USED
properties:
issue:
type: string
enum:
- PAYMENT_SOURCE_CANNOT_BE_USED
description:
type: string
enum:
- The provided payment source cannot be used to pay for the order. Please try again with a different payment source by creating a new order.
- title: SETUP_ERROR_FOR_BANK
properties:
issue:
type: string
enum:
- SETUP_ERROR_FOR_BANK
description:
type: string
enum:
- The API Caller account setup, for bank payments, is incomplete or incorrect. Please contact your PayPal account manager.
- title: BANK_NOT_SUPPORTED_FOR_VERIFICATION
properties:
issue:
type: string
enum:
- BANK_NOT_SUPPORTED_FOR_VERIFICATION
description:
type: string
enum:
- Verification for this bank account is not supported.
- title: APPLE_PAY_AMOUNT_MISMATCH
properties:
issue:
type: string
enum:
- APPLE_PAY_AMOUNT_MISMATCH
description:
type: string
enum:
- The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
- title: ONE_OF_THE_PARAMETERS_REQUIRED
properties:
issue:
type: string
enum:
- ONE_OF_THE_PARAMETERS_REQUIRED
description:
type: string
enum:
- One or more field is required to continue with this request.
- title: BILLING_ADDRESS_INVALID
properties:
issue:
type: string
enum:
- BILLING_ADDRESS_INVALID
description:
type: string
enum:
- Provided billing address is invalid.
- title: SHIPPING_ADDRESS_INVALID
properties:
issue:
type: string
enum:
- SHIPPING_ADDRESS_INVALID
description:
type: string
enum:
- Provided shipping address is invalid.
- title: ORDER_IS_PENDING_APPROVAL
properties:
issue:
type: string
enum:
- ORDER_IS_PENDING_APPROVAL
description:
type: string
enum:
- The order was confirmed and payer action completed but order approval processing from PayPal is pending. No action is needed from Payee or Payer. Please wait until order status changes to 'APPROVED'.
- title: DEVICE_DATA_NOT_AVAILABLE
properties:
issue:
type: string
enum:
- DEVICE_DATA_NOT_AVAILABLE
description:
type: string
enum:
- Device Data is not available for processing this order. The PayPal-Client-Metadata-Id header value sent during `Create Order` api call is either missing or incorrect or there was an error in collecting required data. Please verify if appropriate value for PayPal-Client-Metadata-Id header is being sent during 'Create Order' api call. Please note this error only applies to payment_source.pay_upon_invoice at the moment.
- title: CURRENCY_NOT_SUPPORTED_FOR_BANK
properties:
issue:
type: string
enum:
- CURRENCY_NOT_SUPPORTED_FOR_BANK
description:
type: string
enum:
- The payment_source does not support the currency of the Order. For ACH debit, only USD is supported and for SEPA debit, only EUR is supported.
- title: ONLY_ONE_BANK_SOURCE_ALLOWED
properties:
issue:
type: string
enum:
- ONLY_ONE_BANK_SOURCE_ALLOWED
description:
type: string
enum:
- More than one payment method within the bank payment object is not supported.
- title: INVALID_IBAN
properties:
issue:
type: string
enum:
- INVALID_IBAN
description:
type: string
enum:
- IBAN provided is not a valid bank account number.
- title: IBAN_COUNTRY_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- IBAN_COUNTRY_NOT_SUPPORTED
description:
type: string
enum:
- Country code of issuer bank for the provided IBAN is not supported for SEPA debit payments.
- title: PAYEE_COUNTRY_NOT_SUPPORTED_FOR_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- PAYEE_COUNTRY_NOT_SUPPORTED_FOR_PAYMENT_SOURCE
description:
type: string
enum:
- Payee country code is not supported by the provided payment source.
- title: CARD_NUMBER_REQUIRED
properties:
issue:
type: string
enum:
- CARD_NUMBER_REQUIRED
description:
type: string
enum:
- The card number is required when attempting to process payment with card.
- title: CARD_EXPIRY_REQUIRED
properties:
issue:
type: string
enum:
- CARD_EXPIRY_REQUIRED
description:
type: string
enum:
- The card expiry is required when attempting to process payment with card.
- title: INCOMPATIBLE_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INCOMPATIBLE_PARAMETER_VALUE
description:
type: string
enum:
- The value of the field is incompatible/redundant with other fields in the order.
- title: VAULT_INSTRUCTION_DUPLICATED
properties:
issue:
type: string
enum:
- VAULT_INSTRUCTION_DUPLICATED
description:
type: string
enum:
- Only one vault instruction is allowed. Please use `vault.store_in_vault` to provide vault instruction.
- title: VAULT_INSTRUCTION_REQUIRED
properties:
issue:
type: string
enum:
- VAULT_INSTRUCTION_REQUIRED
description:
type: string
enum:
- Vault instruction is required. Please use `vault.store_in_vault` to provide vault instruction.
- title: MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE
description:
type: string
enum:
- The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
- title: NOT_ELIGIBLE_FOR_PNREF_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_PNREF_PROCESSING
description:
type: string
enum:
- API caller is not enabled to process payments with the `pnref`. Please contact customer support to request permissions to process transactions with PNREF.
- title: NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING
description:
type: string
enum:
- API caller is not enable to process payments using `paypal_transaction_id`. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
- title: PAYPAL_TRANSACTION_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- PAYPAL_TRANSACTION_ID_NOT_FOUND
description:
type: string
enum:
- Specified `paypal_transaction_id` was not found. Verify the value and try the request again.
- title: PNREF_NOT_FOUND
properties:
issue:
type: string
enum:
- PNREF_NOT_FOUND
description:
type: string
enum:
- Specified `pnref` was not found. Verify the value and try the request again.
- title: INVALID_SECURITY_CODE_LENGTH
properties:
issue:
type: string
enum:
- INVALID_SECURITY_CODE_LENGTH
description:
type: string
enum:
- The security_code length is invalid for the specified card brand.
- title: NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- NOT_ENABLED_TO_VAULT_PAYMENT_SOURCE
description:
type: string
enum:
- The API caller or the merchant on whose behalf the API call is initiated is not allowed to vault the given source. Please contact PayPal customer support for assistance.
- title: CRYPTOGRAM_REQUIRED
properties:
issue:
type: string
enum:
- CRYPTOGRAM_REQUIRED
description:
type: string
enum:
- Cryptogram is required if authentication method is CRYPTOGRAM 3DS.
- title: EMV_DATA_REQUIRED
properties:
issue:
type: string
enum:
- EMV_DATA_REQUIRED
description:
type: string
enum:
- EMV Data is required if authentication method is EMV.
- title: ALIAS_DECLINED_BY_PROCESSOR
properties:
issue:
type: string
enum:
- ALIAS_DECLINED_BY_PROCESSOR
description:
type: string
enum:
- The provided alias was declined by the processor. Please create a new order with a different alias_key and/or alias_label and try again.
- title: BLIK_ONE_CLICK_MISSING_REQUIRED_PARAMETER
properties:
issue:
type: string
enum:
- BLIK_ONE_CLICK_MISSING_REQUIRED_PARAMETER
description:
type: string
enum:
- Blik's one_click flow requires one_click.auth_code and one_click.alias_label parameters for the buyer's first transaction. For all subsequent transactions,only the one_click.alias_key parameter is required.
- title: TRANSACTION_LIMIT_EXCEEDED
properties:
issue:
type: string
enum:
- TRANSACTION_LIMIT_EXCEEDED
description:
type: string
enum:
- Total payment amount exceeded transaction limit.
order_authorize_request:
type: object
title: Authorize Request
description: The authorization of an order request.
properties:
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.
"$ref": "#/components/schemas/payment_source"
order_authorize_response:
type: object
title: Order
description: The order authorize response.
allOf:
- "$ref": "#/components/schemas/activity_timestamps"
- properties:
id:
type: string
description: The ID of the order.
readOnly: true
payment_source:
"$ref": "#/components/schemas/payment_source_response"
intent:
"$ref": "#/components/schemas/checkout_payment_intent"
processing_instruction:
"$ref": "#/components/schemas/processing_instruction"
payer:
"$ref": "#/components/schemas/payer"
purchase_units:
type: array
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.
minItems: 1
maxItems: 10
items:
"$ref": "#/components/schemas/purchase_unit"
description: A purchase unit. Establishes a contract between a customer and merchant.
status:
"$ref": "#/components/schemas/order_status"
readOnly: true
links:
type: array
description: An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the 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.
readOnly: true
items:
"$ref": "#/components/schemas/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.
orders.authorize-400:
properties:
details:
type: array
items:
anyOf:
- title: INVALID_COUNTRY_CODE
properties:
issue:
type: string
enum:
- INVALID_COUNTRY_CODE
description:
type: string
enum:
- Country code is invalid. Please refer to https://developer.paypal.com/api/rest/reference/country-codes/ for a list of supported country codes.
- title: INVALID_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_VALUE
description:
type: string
enum:
- A parameter value is not valid.
- title: MISSING_REQUIRED_PARAMETER
properties:
issue:
type: string
enum:
- MISSING_REQUIRED_PARAMETER
description:
type: string
enum:
- A required field / parameter is missing
- title: INVALID_STRING_LENGTH
properties:
issue:
type: string
enum:
- INVALID_STRING_LENGTH
description:
type: string
enum:
- The value of a field is either too short or too long
- title: INVALID_PARAMETER_SYNTAX
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_SYNTAX
description:
type: string
enum:
- The value of a field does not conform to the expected format.
- title: MALFORMED_REQUEST_JSON
properties:
issue:
type: string
enum:
- MALFORMED_REQUEST_JSON
description:
type: string
enum:
- The request JSON is not well formed.
orders.authorize-403:
properties:
details:
type: array
items:
anyOf:
- title: NOT_ELIGIBLE_FOR_TOKEN_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_TOKEN_PROCESSING
description:
type: string
enum:
- API caller is not enabled to process payments with the specified type of token. Please contact customer support to request permissions to process transactions with this type of token.
- title: PERMISSION_DENIED
properties:
issue:
type: string
enum:
- PERMISSION_DENIED
description:
type: string
enum:
- You do not have permission to access or perform operations on this resource.
- title: PERMISSION_DENIED_FOR_DONATION_ITEMS
properties:
issue:
type: string
enum:
- PERMISSION_DENIED_FOR_DONATION_ITEMS
description:
type: string
enum:
- The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
orders.authorize-422:
properties:
details:
type: array
items:
anyOf:
- title: ACTION_DOES_NOT_MATCH_INTENT
properties:
issue:
type: string
enum:
- ACTION_DOES_NOT_MATCH_INTENT
description:
type: string
enum:
- Order was created with an intent to 'CAPTURE'. Please use v2/checkout/orders/order_id/capture to complete the transaction or alternately Create an order with an intent of 'AUTHORIZE'.
- title: AGREEMENT_ALREADY_CANCELLED
properties:
issue:
type: string
enum:
- AGREEMENT_ALREADY_CANCELLED
description:
type: string
enum:
- The requested agreement is already canceled.
- title: BILLING_AGREEMENT_NOT_FOUND
properties:
issue:
type: string
enum:
- BILLING_AGREEMENT_NOT_FOUND
description:
type: string
enum:
- The requested Billing Agreement token was not found.
- title: MISSING_PREVIOUS_REFERENCE
properties:
issue:
type: string
enum:
- MISSING_PREVIOUS_REFERENCE
description:
type: string
enum:
- For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
- title: MISSING_CRYPTOGRAM
properties:
issue:
type: string
enum:
- MISSING_CRYPTOGRAM
description:
type: string
enum:
- Cryptogram is mandatory for any customer initiated network token transactions.
- title: CARD_BRAND_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- CARD_BRAND_NOT_SUPPORTED
description:
type: string
enum:
- Processing of this card brand is not supported. Please use another card to continue with this transaction.
- title: DECLINED_DUE_TO_RELATED_TXN
properties:
issue:
type: string
enum:
- DECLINED_DUE_TO_RELATED_TXN
description:
type: string
enum:
- One or more transactions in this Order did not succeed. Since this Order is being processed as an All or None Order, if one or more transactions in this Order do not succeed, then all purchase units are marked declined and will not be processed.
- title: DOMESTIC_TRANSACTION_REQUIRED
properties:
issue:
type: string
enum:
- DOMESTIC_TRANSACTION_REQUIRED
description:
type: string
enum:
- This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
- title: DUPLICATE_INVOICE_ID
properties:
issue:
type: string
enum:
- DUPLICATE_INVOICE_ID
description:
type: string
enum:
- Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
- title: ORDER_NOT_APPROVED
properties:
issue:
type: string
enum:
- ORDER_NOT_APPROVED
description:
type: string
enum:
- Payer has not yet approved the Order for payment. Please redirect the payer to the 'rel':'approve' url returned as part of the HATEOAS links within the Create Order call.
- title: MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED
properties:
issue:
type: string
enum:
- MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED
description:
type: string
enum:
- You have exceeded the maximum number of payment attempts.
- title: PAYEE_BLOCKED_TRANSACTION
properties:
issue:
type: string
enum:
- PAYEE_BLOCKED_TRANSACTION
description:
type: string
enum:
- The Fraud settings for this seller are such that this payment cannot be executed.
- title: PAYEE_FX_RATE_ID_EXPIRED
properties:
issue:
type: string
enum:
- PAYEE_FX_RATE_ID_EXPIRED
description:
type: string
enum:
- The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
- title: UNSUPPORTED_INTENT_FOR_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- UNSUPPORTED_INTENT_FOR_PAYMENT_SOURCE
description:
type: string
enum:
- "`intent=AUTHORIZE` is not supported for the specified payment_source. Only `intent=CAPTURE` is supported."
- title: PAYER_ACCOUNT_LOCKED_OR_CLOSED
properties:
issue:
type: string
enum:
- PAYER_ACCOUNT_LOCKED_OR_CLOSED
description:
type: string
enum:
- The payer account cannot be used for this transaction.
- title: PAYER_ACCOUNT_RESTRICTED
properties:
issue:
type: string
enum:
- PAYER_ACCOUNT_RESTRICTED
description:
type: string
enum:
- PAYER_ACCOUNT_RESTRICTED
- title: PAYER_CANNOT_PAY
properties:
issue:
type: string
enum:
- PAYER_CANNOT_PAY
description:
type: string
enum:
- Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction.
- title: PAYPAL_TRANSACTION_ID_EXPIRED
properties:
issue:
type: string
enum:
- PAYPAL_TRANSACTION_ID_EXPIRED
description:
type: string
enum:
- Specified `paypal_transaction_id` has expired. PayPal transaction ID expires 4 years after the date of the initial transaction.
- title: PNREF_EXPIRED
properties:
issue:
type: string
enum:
- PNREF_EXPIRED
description:
type: string
enum:
- Specified `pnref` has expired. PNREF expires 15 months after the date of the initial transaction.
- title: REFERENCED_CARD_EXPIRED
properties:
issue:
type: string
enum:
- REFERENCED_CARD_EXPIRED
description:
type: string
enum:
- The card underlying the token has expired and hence cannot be used to process a payment.
- title: TOKEN_EXPIRED
properties:
issue:
type: string
enum:
- TOKEN_EXPIRED
description:
type: string
enum:
- The token is expired and cannot be used for payment.
- title: TOKEN_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- TOKEN_ID_NOT_FOUND
description:
type: string
enum:
- Specified token was not found. Verify the token and try the request again.
- title: TRANSACTION_LIMIT_EXCEEDED
properties:
issue:
type: string
enum:
- TRANSACTION_LIMIT_EXCEEDED
description:
type: string
enum:
- Total payment amount exceeded transaction limit.
- title: TRANSACTION_RECEIVING_LIMIT_EXCEEDED
properties:
issue:
type: string
enum:
- TRANSACTION_RECEIVING_LIMIT_EXCEEDED
description:
type: string
enum:
- The transaction exceeds the receiver's receiving limit.
- title: TRANSACTION_REFUSED
properties:
issue:
type: string
enum:
- TRANSACTION_REFUSED
description:
type: string
enum:
- The request was refused.
- title: ORDER_ALREADY_AUTHORIZED
properties:
issue:
type: string
enum:
- ORDER_ALREADY_AUTHORIZED
description:
type: string
enum:
- Order already authorized.If 'intent=AUTHORIZE' only one authorization per order is allowed.
- title: AUTH_CAPTURE_NOT_ENABLED
properties:
issue:
type: string
enum:
- AUTH_CAPTURE_NOT_ENABLED
description:
type: string
enum:
- Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
- title: AMOUNT_CANNOT_BE_SPECIFIED
properties:
issue:
type: string
enum:
- AMOUNT_CANNOT_BE_SPECIFIED
description:
type: string
enum:
- An authorization amount can only be specified if an Order has been saved by calling /v2/checkout/orders/{order_id}/save. Please save the order and try again.
- title: AUTHORIZATION_AMOUNT_EXCEEDED
properties:
issue:
type: string
enum:
- AUTHORIZATION_AMOUNT_EXCEEDED
description:
type: string
enum:
- Authorization amount specified exceeded allowable limit. Specify a different amount and try the request again. Alternately, contact Customer Support to increase your limits. Local regulations (e.g. in PSD2 countries) prohibit overages above the amount authorized by the payer.
- title: AUTHORIZATION_CURRENCY_MISMATCH
properties:
issue:
type: string
enum:
- AUTHORIZATION_CURRENCY_MISMATCH
description:
type: string
enum:
- The currency of the authorization should be same as that in which the Order was created and approved by the Payer. Please check the 'currency_code' and try again.
- title: MAX_AUTHORIZATION_COUNT_EXCEEDED
properties:
issue:
type: string
enum:
- MAX_AUTHORIZATION_COUNT_EXCEEDED
description:
type: string
enum:
- Maximum number of authorization allowed for the order is reached. Please contact Customer Support if you need to increase your limit.
- title: ORDER_COMPLETED_OR_VOIDED
properties:
issue:
type: string
enum:
- ORDER_COMPLETED_OR_VOIDED
description:
type: string
enum:
- Order is voided or completed and hence cannot be authorized.
- title: ORDER_EXPIRED
properties:
issue:
type: string
enum:
- ORDER_EXPIRED
description:
type: string
enum:
- Order is expired and hence cannot be authorized. Please contact Customer Support if you need to increase your order validity period.
- title: INVALID_PICKUP_ADDRESS
properties:
issue:
type: string
enum:
- INVALID_PICKUP_ADDRESS
description:
type: string
enum:
- 'If the ''shipping_option.type'' is set as ''PICKUP'' then the ''shipping_detail.name.full_name'' should start with ''S2S'' meaning Ship To Store. Example: ''S2S My Store''.'
- title: SHIPPING_ADDRESS_INVALID
properties:
issue:
type: string
enum:
- SHIPPING_ADDRESS_INVALID
description:
type: string
enum:
- Provided shipping address is invalid.
- title: PAYMENT_TYPE_NOT_SUPPORTED_FOR_INTENT
properties:
issue:
type: string
enum:
- PAYMENT_TYPE_NOT_SUPPORTED_FOR_INTENT
description:
type: string
enum:
- Provided payment type not supported for order intent. Payment authorizations are supported only for order with `intent=AUTHORIZE` and payment captures are supported only for order with `intent=CAPTURE`.
- title: BILLING_AGREEMENT_ID_MISMATCH
properties:
issue:
type: string
enum:
- BILLING_AGREEMENT_ID_MISMATCH
description:
type: string
enum:
- Billing Agreement ID must exactly match the Billing Agreement ID that was provided during order creation.
- title: PREFERRED_PAYMENT_SOURCE_MISMATCH
properties:
issue:
type: string
enum:
- PREFERRED_PAYMENT_SOURCE_MISMATCH
description:
type: string
enum:
- Payment Source must exactly match the Preferred Payment Source that was provided during order creation.
- title: INCOMPATIBLE_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INCOMPATIBLE_PARAMETER_VALUE
description:
type: string
enum:
- The value of the field is incompatible/redundant with other fields in the order.
- title: INVALID_PREVIOUS_TRANSACTION_REFERENCE
properties:
issue:
type: string
enum:
- INVALID_PREVIOUS_TRANSACTION_REFERENCE
description:
type: string
enum:
- The authorization or capture referenced by `previous_transaction_reference` is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid `previous_transaction_reference`.
- title: PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK
properties:
issue:
type: string
enum:
- PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK
description:
type: string
enum:
- The capture referenced by `previous_transaction_reference` has a chargeback and hence cannot be used for this order. Please use a `previous_transaction_reference` which does not have a chargeback.
- title: PREVIOUS_TRANSACTION_REFERENCE_VOIDED
properties:
issue:
type: string
enum:
- PREVIOUS_TRANSACTION_REFERENCE_VOIDED
description:
type: string
enum:
- The status of authorization referenced by `previous_transaction_reference` is `VOIDED` and hence cannot be used for this order. Please use a `previous_transaction_reference` whose status is not `VOIDED`.
- title: PAYMENT_SOURCE_MISMATCH
properties:
issue:
type: string
enum:
- PAYMENT_SOURCE_MISMATCH
description:
type: string
enum:
- The `payment_source` in the request must match the `payment_source` used for the authorization or capture referenced by `previous_transaction_reference`. Please use `previous_transaction_reference` whose `payment_source` matches with the `payment_source` specified in the order.
- title: MERCHANT_INITIATED_WITH_SECURITY_CODE
properties:
issue:
type: string
enum:
- MERCHANT_INITIATED_WITH_SECURITY_CODE
description:
type: string
enum:
- "`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if `payment_source.card.security_code` is present in the order. `security_code` can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with `security_code` is the order."
- title: MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS
properties:
issue:
type: string
enum:
- MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS
description:
type: string
enum:
- "`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order."
- title: MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS
properties:
issue:
type: string
enum:
- MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS
description:
type: string
enum:
- "`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit)."
- title: RETURN_URL_REQUIRED
properties:
issue:
type: string
enum:
- RETURN_URL_REQUIRED
description:
type: string
enum:
- The return url is required when attempting to vault this source.
- title: CANCEL_URL_REQUIRED
properties:
issue:
type: string
enum:
- CANCEL_URL_REQUIRED
description:
type: string
enum:
- The cancel url is required when attempting to vault this source.
- title: PAYER_ACTION_REQUIRED
properties:
issue:
type: string
enum:
- PAYER_ACTION_REQUIRED
description:
type: string
enum:
- Transaction cannot complete successfully, instruct the buyer to return to PayPal.
- title: APPLE_PAY_AMOUNT_MISMATCH
properties:
issue:
type: string
enum:
- APPLE_PAY_AMOUNT_MISMATCH
description:
type: string
enum:
- The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
- title: CARD_NUMBER_REQUIRED
properties:
issue:
type: string
enum:
- CARD_NUMBER_REQUIRED
description:
type: string
enum:
- The card number is required when attempting to process payment with card.
- title: CARD_EXPIRY_REQUIRED
properties:
issue:
type: string
enum:
- CARD_EXPIRY_REQUIRED
description:
type: string
enum:
- The card expiry is required when attempting to process payment with card.
- title: VAULT_INSTRUCTION_REQUIRED
properties:
issue:
type: string
enum:
- VAULT_INSTRUCTION_REQUIRED
description:
type: string
enum:
- Vault instruction is required. Please use `vault.store_in_vault` to provide vault instruction.
- title: MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE
description:
type: string
enum:
- The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
- title: ORDER_CANNOT_BE_SAVED
properties:
issue:
type: string
enum:
- ORDER_CANNOT_BE_SAVED
description:
type: string
enum:
- The option to save an order is only available if the `intent` is AUTHORIZE and `processing_instruction` uses one of the `ORDER_SAVED` options. For example, `intent`=AUTHORIZE, `processing_instruction`=ORDER_SAVED_EXPLICITLY. Please change the intent and/or processing_instruction` and try again.
- title: SAVE_ORDER_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- SAVE_ORDER_NOT_SUPPORTED
description:
type: string
enum:
- The API caller account is setup in a way that does not allow it to be used for saving the order. This functionality is not available for PayPal Commerce Platform for Platforms & Marketplaces.
- title: NOT_ELIGIBLE_FOR_PNREF_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_PNREF_PROCESSING
description:
type: string
enum:
- API caller is not enabled to process payments with the `pnref`. Please contact customer support to request permissions to process transactions with PNREF.
- title: NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING
description:
type: string
enum:
- API caller is not enable to process payments using `paypal_transaction_id`. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
- title: PAYPAL_TRANSACTION_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- PAYPAL_TRANSACTION_ID_NOT_FOUND
description:
type: string
enum:
- Specified `paypal_transaction_id` was not found. Verify the value and try the request again.
- title: PNREF_NOT_FOUND
properties:
issue:
type: string
enum:
- PNREF_NOT_FOUND
description:
type: string
enum:
- Specified `pnref` was not found. Verify the value and try the request again.
- title: INVALID_SECURITY_CODE_LENGTH
properties:
issue:
type: string
enum:
- INVALID_SECURITY_CODE_LENGTH
description:
type: string
enum:
- The security_code length is invalid for the specified card brand.
- title: REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT
properties:
issue:
type: string
enum:
- REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT
description:
type: string
enum:
- This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=`MERCHANT`. For details, see Stored Credential.
order_capture_request:
type: object
title: Order Capture Request
description: Completes an capture payment for an order.
properties:
payment_source:
"$ref": "#/components/schemas/payment_source"
orders.capture-400:
properties:
details:
type: array
items:
anyOf:
- title: INVALID_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_VALUE
description:
type: string
enum:
- A parameter value is not valid.
- title: MISSING_REQUIRED_PARAMETER
properties:
issue:
type: string
enum:
- MISSING_REQUIRED_PARAMETER
description:
type: string
enum:
- A required field / parameter is missing
- title: INVALID_STRING_LENGTH
properties:
issue:
type: string
enum:
- INVALID_STRING_LENGTH
description:
type: string
enum:
- The value of a field is either too short or too long
- title: INVALID_PARAMETER_SYNTAX
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_SYNTAX
description:
type: string
enum:
- The value of a field does not conform to the expected format.
- title: MALFORMED_REQUEST_JSON
properties:
issue:
type: string
enum:
- MALFORMED_REQUEST_JSON
description:
type: string
enum:
- The request JSON is not well formed.
orders.capture-403:
properties:
details:
type: array
items:
anyOf:
- title: CONSENT_NEEDED
properties:
issue:
type: string
enum:
- CONSENT_NEEDED
description:
type: string
enum:
- CONSENT_NEEDED
- title: NOT_ELIGIBLE_FOR_TOKEN_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_TOKEN_PROCESSING
description:
type: string
enum:
- API caller is not enabled to process payments with the specified type of token. Please contact customer support to request permissions to process transactions with this type of token.
- title: PERMISSION_DENIED
properties:
issue:
type: string
enum:
- PERMISSION_DENIED
description:
type: string
enum:
- You do not have permission to access or perform operations on this resource.
- title: PERMISSION_DENIED_FOR_DONATION_ITEMS
properties:
issue:
type: string
enum:
- PERMISSION_DENIED_FOR_DONATION_ITEMS
description:
type: string
enum:
- The API Caller or Payee have not been granted appropriate permissions to send 'items.category' as 'DONATION'. Please speak to your account manager if you want to process these type of items.
orders.capture-422:
properties:
details:
type: array
items:
anyOf:
- title: AGREEMENT_ALREADY_CANCELLED
properties:
issue:
type: string
enum:
- AGREEMENT_ALREADY_CANCELLED
description:
type: string
enum:
- The requested agreement is already canceled.
- title: BILLING_AGREEMENT_NOT_FOUND
properties:
issue:
type: string
enum:
- BILLING_AGREEMENT_NOT_FOUND
description:
type: string
enum:
- The requested Billing Agreement token was not found.
- title: DECLINED_DUE_TO_RELATED_TXN
properties:
issue:
type: string
enum:
- DECLINED_DUE_TO_RELATED_TXN
description:
type: string
enum:
- One or more transactions in this Order did not succeed. Since this Order is being processed as an All or None Order, if one or more transactions in this Order do not succeed, then all purchase units are marked declined and will not be processed.
- title: MISSING_PREVIOUS_REFERENCE
properties:
issue:
type: string
enum:
- MISSING_PREVIOUS_REFERENCE
description:
type: string
enum:
- For Merchant initiated network token transactions, either the payment_source.card.stored_credential.previous_network_transaction_reference or payment_source.card.stored_credential.previous_transaction_reference must be included in the request.
- title: MISSING_CRYPTOGRAM
properties:
issue:
type: string
enum:
- MISSING_CRYPTOGRAM
description:
type: string
enum:
- Cryptogram is mandatory for any customer initiated network token transactions.
- title: CARD_BRAND_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- CARD_BRAND_NOT_SUPPORTED
description:
type: string
enum:
- Processing of this card brand is not supported. Please use another card to continue with this transaction.
- title: COMPLIANCE_VIOLATION
properties:
issue:
type: string
enum:
- COMPLIANCE_VIOLATION
description:
type: string
enum:
- Transaction is declined due to compliance violation.
- title: DOMESTIC_TRANSACTION_REQUIRED
properties:
issue:
type: string
enum:
- DOMESTIC_TRANSACTION_REQUIRED
description:
type: string
enum:
- This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
- title: DUPLICATE_INVOICE_ID
properties:
issue:
type: string
enum:
- DUPLICATE_INVOICE_ID
description:
type: string
enum:
- Duplicate Invoice ID detected. To avoid a potential duplicate transaction your account setting requires that Invoice Id be unique for each transaction.
- title: INSTRUMENT_DECLINED
properties:
issue:
type: string
enum:
- INSTRUMENT_DECLINED
description:
type: string
enum:
- The instrument presented was either declined by the processor or bank, or it can't be used for this payment.
- title: ORDER_NOT_APPROVED
properties:
issue:
type: string
enum:
- ORDER_NOT_APPROVED
description:
type: string
enum:
- Payer has not yet approved the Order for payment. Please redirect the payer to the 'rel':'approve' url returned as part of the HATEOAS links within the Create Order call or provide a valid `payment_source` in the request.
- title: MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED
properties:
issue:
type: string
enum:
- MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED
description:
type: string
enum:
- You have exceeded the maximum number of payment attempts.
- title: PAYEE_BLOCKED_TRANSACTION
properties:
issue:
type: string
enum:
- PAYEE_BLOCKED_TRANSACTION
description:
type: string
enum:
- The Fraud settings for this seller are such that this payment cannot be executed.
- title: PAYEE_FX_RATE_ID_EXPIRED
properties:
issue:
type: string
enum:
- PAYEE_FX_RATE_ID_EXPIRED
description:
type: string
enum:
- The specified FX Rate ID has expired. Please specify a different FX Rate Id and try the request again. Alternately, remove the FX Rate ID to process the request using the default exchange rate.
- title: PAYER_ACCOUNT_LOCKED_OR_CLOSED
properties:
issue:
type: string
enum:
- PAYER_ACCOUNT_LOCKED_OR_CLOSED
description:
type: string
enum:
- The payer account cannot be used for this transaction.
- title: PAYER_ACCOUNT_RESTRICTED
properties:
issue:
type: string
enum:
- PAYER_ACCOUNT_RESTRICTED
description:
type: string
enum:
- PAYER_ACCOUNT_RESTRICTED
- title: PAYER_CANNOT_PAY
properties:
issue:
type: string
enum:
- PAYER_CANNOT_PAY
description:
type: string
enum:
- Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction.
- title: PAYPAL_TRANSACTION_ID_EXPIRED
properties:
issue:
type: string
enum:
- PAYPAL_TRANSACTION_ID_EXPIRED
description:
type: string
enum:
- Specified `paypal_transaction_id` has expired. PayPal transaction ID expires 4 years after the date of the initial transaction.
- title: PNREF_EXPIRED
properties:
issue:
type: string
enum:
- PNREF_EXPIRED
description:
type: string
enum:
- Specified `pnref` has expired. PNREF expires 15 months after the date of the initial transaction.
- title: REFERENCED_CARD_EXPIRED
properties:
issue:
type: string
enum:
- REFERENCED_CARD_EXPIRED
description:
type: string
enum:
- The card underlying the token has expired and hence cannot be used to process a payment.
- title: TOKEN_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- TOKEN_ID_NOT_FOUND
description:
type: string
enum:
- Specified token was not found. Verify the token and try the request again.
- title: TRANSACTION_LIMIT_EXCEEDED
properties:
issue:
type: string
enum:
- TRANSACTION_LIMIT_EXCEEDED
description:
type: string
enum:
- Total payment amount exceeded transaction limit.
- title: TRANSACTION_RECEIVING_LIMIT_EXCEEDED
properties:
issue:
type: string
enum:
- TRANSACTION_RECEIVING_LIMIT_EXCEEDED
description:
type: string
enum:
- The transaction exceeds the receiver's receiving limit.
- title: TRANSACTION_REFUSED
properties:
issue:
type: string
enum:
- TRANSACTION_REFUSED
description:
type: string
enum:
- The request was refused.
- title: REDIRECT_PAYER_FOR_ALTERNATE_FUNDING
properties:
issue:
type: string
enum:
- REDIRECT_PAYER_FOR_ALTERNATE_FUNDING
description:
type: string
enum:
- Transaction failed. Redirect the payer to select another funding source.
- title: ORDER_ALREADY_CAPTURED
properties:
issue:
type: string
enum:
- ORDER_ALREADY_CAPTURED
description:
type: string
enum:
- Order already captured.If 'intent=CAPTURE' only one capture per order is allowed.
- title: TRANSACTION_BLOCKED_BY_PAYEE
properties:
issue:
type: string
enum:
- TRANSACTION_BLOCKED_BY_PAYEE
description:
type: string
enum:
- Transaction blocked by Payee’s Fraud Protection settings.
- title: AUTH_CAPTURE_NOT_ENABLED
properties:
issue:
type: string
enum:
- AUTH_CAPTURE_NOT_ENABLED
description:
type: string
enum:
- Authorization and Capture feature is not enabled for the merchant. Make sure that the recipient of the funds is a verified business account.
- title: NOT_ENABLED_FOR_BANK_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ENABLED_FOR_BANK_PROCESSING
description:
type: string
enum:
- The API Caller account is not setup to be able to process bank payments. Please contact your PayPal account manager.
- title: NOT_ENABLED_FOR_CARD_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ENABLED_FOR_CARD_PROCESSING
description:
type: string
enum:
- The API Caller account is not setup to be able to process card payments. Please contact PayPal customer support.
- title: PAYEE_NOT_ENABLED_FOR_BANK_PROCESSING
properties:
issue:
type: string
enum:
- PAYEE_NOT_ENABLED_FOR_BANK_PROCESSING
description:
type: string
enum:
- Payee account is not setup to be able to process bank payments. Please contact your PayPal account manager.
- title: PAYEE_NOT_ENABLED_FOR_CARD_PROCESSING
properties:
issue:
type: string
enum:
- PAYEE_NOT_ENABLED_FOR_CARD_PROCESSING
description:
type: string
enum:
- Payee account is not setup to be able to process card payments. Please contact PayPal customer support.
- title: INVALID_PICKUP_ADDRESS
properties:
issue:
type: string
enum:
- INVALID_PICKUP_ADDRESS
description:
type: string
enum:
- 'If the ''shipping_option.type'' is set as ''PICKUP'' then the ''shipping_detail.name.full_name'' should start with ''S2S'' meaning Ship To Store. Example: ''S2S My Store''.'
- title: SHIPPING_ADDRESS_INVALID
properties:
issue:
type: string
enum:
- SHIPPING_ADDRESS_INVALID
description:
type: string
enum:
- Provided shipping address is invalid.
- title: PAYMENT_SOURCE_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- PAYMENT_SOURCE_NOT_SUPPORTED
description:
type: string
enum:
- The payer selected method of payment is not supported when multiple purchase units are specified for an Order.
- title: ORDER_COMPLETION_IN_PROGRESS
properties:
issue:
type: string
enum:
- ORDER_COMPLETION_IN_PROGRESS
description:
type: string
enum:
- The order was created with processing_instruction of ORDER_COMPLETE_ON_PAYMENT_APPROVAL. The customer has approved the payment and PayPal is still in the process of capturing the order on your behalf as instructed. Please try your request again.
- title: BILLING_AGREEMENT_ID_MISMATCH
properties:
issue:
type: string
enum:
- BILLING_AGREEMENT_ID_MISMATCH
description:
type: string
enum:
- Billing Agreement ID must exactly match the Billing Agreement ID that was provided during order creation.
- title: PREFERRED_PAYMENT_SOURCE_MISMATCH
properties:
issue:
type: string
enum:
- PREFERRED_PAYMENT_SOURCE_MISMATCH
description:
type: string
enum:
- Payment Source must exactly match the Preferred Payment Source that was provided during order creation.
- title: INCOMPATIBLE_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INCOMPATIBLE_PARAMETER_VALUE
description:
type: string
enum:
- The value of the field is incompatible/redundant with other fields in the order.
- title: INVALID_PREVIOUS_TRANSACTION_REFERENCE
properties:
issue:
type: string
enum:
- INVALID_PREVIOUS_TRANSACTION_REFERENCE
description:
type: string
enum:
- The authorization or capture referenced by `previous_transaction_reference` is not valid. This could be either because the previous_transaction_reference is not found or doesn't belong to the payee. Please use a valid `previous_transaction_reference`.
- title: PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK
properties:
issue:
type: string
enum:
- PREVIOUS_TRANSACTION_REFERENCE_HAS_CHARGEBACK
description:
type: string
enum:
- The capture referenced by `previous_transaction_reference` has a chargeback and hence cannot be used for this order. Please use a `previous_transaction_reference` which does not have a chargeback.
- title: PREVIOUS_TRANSACTION_REFERENCE_VOIDED
properties:
issue:
type: string
enum:
- PREVIOUS_TRANSACTION_REFERENCE_VOIDED
description:
type: string
enum:
- The status of authorization referenced by `previous_transaction_reference` is `VOIDED` and hence cannot be used for this order. Please use a `previous_transaction_reference` whose status is not `VOIDED`.
- title: PAYMENT_SOURCE_MISMATCH
properties:
issue:
type: string
enum:
- PAYMENT_SOURCE_MISMATCH
description:
type: string
enum:
- The `payment_source` in the request must match the `payment_source` used for the authorization or capture referenced by `previous_transaction_reference`. Please use `previous_transaction_reference` whose `payment_source` matches with the `payment_source` specified in the order.
- title: MERCHANT_INITIATED_WITH_SECURITY_CODE
properties:
issue:
type: string
enum:
- MERCHANT_INITIATED_WITH_SECURITY_CODE
description:
type: string
enum:
- "`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if `payment_source.card.security_code` is present in the order. `security_code` can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with `security_code` is the order."
- title: MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS
properties:
issue:
type: string
enum:
- MERCHANT_INITIATED_WITH_AUTHENTICATION_RESULTS
description:
type: string
enum:
- "`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if 3D-Secure authentication results are present in the order. 3D-Secure authentication results can be present in the order only when customer is the payment initiator. It is semantically incorrect to perform a merchant initiated payment with 3D-Secure authentication results is the order."
- title: MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS
properties:
issue:
type: string
enum:
- MERCHANT_INITIATED_WITH_MULTIPLE_PURCHASE_UNITS
description:
type: string
enum:
- "`stored_payment_source.payment_initiator` = `MERCHANT` is not supported if more than one purchase_unit is present in the Order. Merchant initiated payments are not supported from orders with more than one purchase_unit. Please retry the request with multiple Order requests (one for each purchase_unit)."
- title: RETURN_URL_REQUIRED
properties:
issue:
type: string
enum:
- RETURN_URL_REQUIRED
description:
type: string
enum:
- The return url is required when attempting to vault this source.
- title: CANCEL_URL_REQUIRED
properties:
issue:
type: string
enum:
- CANCEL_URL_REQUIRED
description:
type: string
enum:
- The cancel url is required when attempting to vault this source.
- title: SETUP_ERROR_FOR_BANK
properties:
issue:
type: string
enum:
- SETUP_ERROR_FOR_BANK
description:
type: string
enum:
- The API Caller account setup, for bank payments, is incomplete or incorrect. Please contact your PayPal account manager.
- title: BANK_NOT_SUPPORTED_FOR_VERIFICATION
properties:
issue:
type: string
enum:
- BANK_NOT_SUPPORTED_FOR_VERIFICATION
description:
type: string
enum:
- Verification for this bank account is not supported.
- title: PAYER_ACTION_REQUIRED
properties:
issue:
type: string
enum:
- PAYER_ACTION_REQUIRED
description:
type: string
enum:
- Transaction cannot complete successfully, instruct the buyer to return to PayPal.
- title: APPLE_PAY_AMOUNT_MISMATCH
properties:
issue:
type: string
enum:
- APPLE_PAY_AMOUNT_MISMATCH
description:
type: string
enum:
- The 'amount' specified in the Order should match the amount that was viewed and authorized by the payer/buyer on Apple Pay. If the amount has changed, please redirect the buyer to authorize the order again via Apple Pay.
- title: CURRENCY_NOT_SUPPORTED_FOR_BANK
properties:
issue:
type: string
enum:
- CURRENCY_NOT_SUPPORTED_FOR_BANK
description:
type: string
enum:
- The payment_source does not support the currency of the Order. For ACH debit, only USD is supported and for SEPA debit, only EUR is supported.
- title: ONLY_ONE_BANK_SOURCE_ALLOWED
properties:
issue:
type: string
enum:
- ONLY_ONE_BANK_SOURCE_ALLOWED
description:
type: string
enum:
- More than one payment method within the bank payment object is not supported.
- title: INVALID_IBAN
properties:
issue:
type: string
enum:
- INVALID_IBAN
description:
type: string
enum:
- IBAN provided is not a valid bank account number.
- title: IBAN_COUNTRY_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- IBAN_COUNTRY_NOT_SUPPORTED
description:
type: string
enum:
- Country code of issuer bank for the provided IBAN is not supported for SEPA debit payments.
- title: CARD_NUMBER_REQUIRED
properties:
issue:
type: string
enum:
- CARD_NUMBER_REQUIRED
description:
type: string
enum:
- The card number is required when attempting to process payment with card.
- title: CARD_EXPIRY_REQUIRED
properties:
issue:
type: string
enum:
- CARD_EXPIRY_REQUIRED
description:
type: string
enum:
- The card expiry is required when attempting to process payment with card.
- title: VAULT_INSTRUCTION_REQUIRED
properties:
issue:
type: string
enum:
- VAULT_INSTRUCTION_REQUIRED
description:
type: string
enum:
- Vault instruction is required. Please use `vault.store_in_vault` to provide vault instruction.
- title: MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE
properties:
issue:
type: string
enum:
- MISMATCHED_VAULT_ID_TO_PAYMENT_SOURCE
description:
type: string
enum:
- The vault_id does not match the payment_source provided. Please verify that the vault_id token used refers to the matching payment_source and try again. For example, a PayPal token cannot be passed in the vault_id field in the payment_source.card object.
- title: NOT_ELIGIBLE_FOR_PNREF_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_PNREF_PROCESSING
description:
type: string
enum:
- API caller is not enabled to process payments with the `pnref`. Please contact customer support to request permissions to process transactions with PNREF.
- title: NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING
properties:
issue:
type: string
enum:
- NOT_ELIGIBLE_FOR_PAYPAL_TRANSACTION_ID_PROCESSING
description:
type: string
enum:
- API caller is not enable to process payments using `paypal_transaction_id`. Please contact customer support to request permissions to process transactions with PayPal transaction ID.
- title: PAYPAL_TRANSACTION_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- PAYPAL_TRANSACTION_ID_NOT_FOUND
description:
type: string
enum:
- Specified `paypal_transaction_id` was not found. Verify the value and try the request again.
- title: PNREF_NOT_FOUND
properties:
issue:
type: string
enum:
- PNREF_NOT_FOUND
description:
type: string
enum:
- Specified `pnref` was not found. Verify the value and try the request again.
- title: INVALID_SECURITY_CODE_LENGTH
properties:
issue:
type: string
enum:
- INVALID_SECURITY_CODE_LENGTH
description:
type: string
enum:
- The security_code length is invalid for the specified card brand.
- title: PLATFORM_FEE_PAYEE_CANNOT_BE_SAME_AS_PAYER
properties:
issue:
type: string
enum:
- PLATFORM_FEE_PAYEE_CANNOT_BE_SAME_AS_PAYER
description:
type: string
enum:
- The payer cannot pay themselves. The recipient account of the platform fees must be different from the payer account.
- title: REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT
properties:
issue:
type: string
enum:
- REQUIRED_PARAMETER_FOR_CUSTOMER_INITIATED_PAYMENT
description:
type: string
enum:
- This parameter is required when the customer is present. If the customer is not present, indicate so by sending payment_initiator=`MERCHANT`. For details, see Stored Credential.
- title: IDENTIFIER_NOT_FOUND
properties:
issue:
type: string
enum:
- IDENTIFIER_NOT_FOUND
description:
type: string
enum:
- Specified identifier was not found. Please verify the correct identifier was used and try the request again.
shipment_tracking_number_type:
type: string
title: Shipment Tracking Number Type.
description: The tracking number type.
minLength: 1
maxLength: 64
pattern: "^[0-9A-Z_]+$"
enum:
- CARRIER_PROVIDED
- E2E_PARTNER_PROVIDED
shipment_tracking_status:
type: string
title: Shipment Tracking Status.
description: The status of the item shipment. For allowed values, see Shipping Statuses.
minLength: 1
maxLength: 64
pattern: "^[0-9A-Z_]+$"
enum:
- CANCELLED
- DELIVERED
- LOCAL_PICKUP
- ON_HOLD
- SHIPPED
- SHIPMENT_CREATED
- DROPPED_OFF
- IN_TRANSIT
- RETURNED
- LABEL_PRINTED
- ERROR
- UNCONFIRMED
- PICKUP_FAILED
- DELIVERY_DELAYED
- DELIVERY_SCHEDULED
- DELIVERY_FAILED
- INRETURN
- IN_PROCESS
- NEW
- VOID
- PROCESSED
- NOT_SHIPPED
- COMPLETED
shipment_carrier:
type: string
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.
minLength: 1
maxLength: 64
pattern: "^[0-9A-Z_]+$"
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
- LAO_POST
- 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
- CN_GOFLY
- 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
- EZSHIP
- 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
- MARA_XPRESS
- 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
- IND_JAYONEXPRESS
- 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
- NINJAVAN_ID
- 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
- BARQEXP
- 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
- BDMNET
- 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
shipment_tracker:
type: object
title: Shipment Tracker.
description: The tracking information for a shipment.
properties:
transaction_id:
type: string
description: The PayPal transaction ID.
minLength: 1
maxLength: 50
pattern: "^[a-zA-Z0-9]*$"
tracking_number:
type: string
description: The tracking number for the shipment. This property supports Unicode.
minLength: 1
maxLength: 64
tracking_number_type:
description: The type of tracking number.
"$ref": "#/components/schemas/shipment_tracking_number_type"
status:
"$ref": "#/components/schemas/shipment_tracking_status"
shipment_date:
description: The date when the shipment occurred, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
"$ref": "#/components/schemas/date_no_time"
carrier:
"$ref": "#/components/schemas/shipment_carrier"
carrier_name_other:
type: string
description: The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.
minLength: 1
maxLength: 64
postage_payment_id:
type: string
description: The postage payment ID. This property supports Unicode.
readOnly: true
minLength: 1
maxLength: 64
notify_buyer:
type: boolean
description: If true, sends an email notification to the buyer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.
default: false
quantity:
type: integer
description: The quantity of items shipped.
readOnly: true
minimum: 1
maximum: 100
tracking_number_validated:
type: boolean
description: Indicates whether the carrier validated the tracking number.
readOnly: true
last_updated_time:
description: The date and time when the tracking information was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
"$ref": "#/components/schemas/date_time"
shipment_direction:
type: string
description: To denote whether the shipment is sent forward to the receiver or returned back.
minLength: 1
maxLength: 50
pattern: "^[0-9A-Z_]+$"
enum:
- FORWARD
- RETURN
shipment_uploader:
readOnly: true
type: string
description: To denote which party uploaded the shipment tracking info.
minLength: 1
maxLength: 50
pattern: "^[0-9A-Z_]+$"
enum:
- MERCHANT
- CONSUMER
- PARTNER
required:
- transaction_id
- status
order_tracker_request:
type: object
title: Order Tracker Request.
description: The tracking details of an order.
allOf:
- "$ref": "#/components/schemas/shipment_tracker"
- properties:
capture_id:
type: string
description: The PayPal capture ID.
minLength: 1
maxLength: 50
pattern: "^[a-zA-Z0-9]*$"
notify_payer:
type: boolean
description: If true, sends an email notification to the payer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.
default: false
items:
type: array
description: An array of details of items in the shipment.
items:
description: Items in a shipment.
"$ref": "#/components/schemas/tracker_item"
required:
- capture_id
orders.track.create-400:
properties:
details:
type: array
items:
anyOf:
- title: MISSING_REQUIRED_PARAMETER
properties:
issue:
type: string
enum:
- MISSING_REQUIRED_PARAMETER
description:
type: string
enum:
- A required field / parameter is missing.
- title: INVALID_STRING_LENGTH
properties:
issue:
type: string
enum:
- INVALID_STRING_LENGTH
description:
type: string
enum:
- The value of a field is either too short or too long.
- title: INVALID_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_VALUE
description:
type: string
enum:
- A parameter value is not valid.
- title: INVALID_PARAMETER_SYNTAX
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_SYNTAX
description:
type: string
enum:
- The value of a field does not conform to the expected format.
orders.track.create-403:
properties:
details:
type: array
items:
anyOf:
- title: PERMISSION_DENIED
properties:
issue:
type: string
enum:
- PERMISSION_DENIED
description:
type: string
enum:
- You do not have permission to access or perform operations on this resource.
orders.track.create-422:
properties:
details:
type: array
items:
anyOf:
- title: CAPTURE_STATUS_NOT_VALID
properties:
issue:
type: string
enum:
- CAPTURE_STATUS_NOT_VALID
description:
type: string
enum:
- Invalid capture status. Tracker information can only be added to captures in `COMPLETED` state.
- title: ITEM_SKU_MISMATCH
properties:
issue:
type: string
enum:
- ITEM_SKU_MISMATCH
description:
type: string
enum:
- Item sku must match one of the items sku that was provided during order creation.
- title: CAPTURE_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- CAPTURE_ID_NOT_FOUND
description:
type: string
enum:
- Specified capture ID does not exist. Check the capture ID and try again.
- title: MSP_NOT_SUPPORTED
properties:
issue:
type: string
enum:
- MSP_NOT_SUPPORTED
description:
type: string
enum:
- Multiple purchase units are not supported for this operation.
orders.trackers.patch-400:
properties:
details:
type: array
items:
anyOf:
- title: FIELD_NOT_PATCHABLE
properties:
issue:
type: string
enum:
- FIELD_NOT_PATCHABLE
description:
type: string
enum:
- Field cannot be patched.
- title: INVALID_PARAMETER_VALUE
properties:
issue:
type: string
enum:
- INVALID_PARAMETER_VALUE
description:
type: string
enum:
- The value of a field is invalid.
- title: MISSING_REQUIRED_PARAMETER
properties:
issue:
type: string
enum:
- MISSING_REQUIRED_PARAMETER
description:
type: string
enum:
- A required field or parameter is missing.
- title: INVALID_STRING_LENGTH
properties:
issue:
type: string
enum:
- INVALID_STRING_LENGTH
description:
type: string
enum:
- The value of a field is either too short or too long.
- title: INVALID_PATCH_OPERATION
properties:
issue:
type: string
enum:
- INVALID_PATCH_OPERATION
description:
type: string
enum:
- The operation cannot be honored. Cannot add a property that's already present, use replace. Cannot remove a property thats not present, use add. Cannot replace a property thats not present, use add.
- title: MALFORMED_REQUEST_JSON
properties:
issue:
type: string
enum:
- MALFORMED_REQUEST_JSON
description:
type: string
enum:
- The request JSON is not well formed.
orders.trackers.patch-403:
properties:
details:
type: array
items:
anyOf:
- title: PERMISSION_DENIED
properties:
issue:
type: string
enum:
- PERMISSION_DENIED
description:
type: string
enum:
- You do not have permission to access or perform operations on this resource.
orders.trackers.patch-404:
properties:
details:
type: array
items:
anyOf:
- title: TRACKER_ID_NOT_FOUND
properties:
issue:
type: string
enum:
- TRACKER_ID_NOT_FOUND
description:
type: string
enum:
- Specified tracker ID does not exist. Check the tracker ID and try again.
orders.trackers.patch-422:
properties:
details:
type: array
items:
anyOf:
- title: INVALID_JSON_POINTER_FORMAT
properties:
issue:
type: string
enum:
- INVALID_JSON_POINTER_FORMAT
description:
type: string
enum:
- Path should be a valid [JSON Pointer](https://tools.ietf.org/html/rfc6901) that references a location within the request where the operation is performed.
- title: NOT_PATCHABLE
properties:
issue:
type: string
enum:
- NOT_PATCHABLE
description:
type: string
enum:
- Cannot be patched.
- title: PATCH_VALUE_REQUIRED
properties:
issue:
type: string
enum:
- PATCH_VALUE_REQUIRED
description:
type: string
enum:
- Specify a `value` for the field being patched.
- title: PATCH_PATH_REQUIRED
properties:
issue:
type: string
enum:
- PATCH_PATH_REQUIRED
description:
type: string
enum:
- Specify a `value` for the field in which the operation needs to be performed.
- title: ITEM_SKU_MISMATCH
properties:
issue:
type: string
enum:
- ITEM_SKU_MISMATCH
description:
type: string
enum:
- Item sku must match one of the items sku that was provided during order creation.
parameters:
paypal_request_id:
name: PayPal-Request-Id
in: header
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.
required: false
schema:
type: string
minLength: 1
maxLength: 108
paypal_partner_attribution_id:
name: PayPal-Partner-Attribution-Id
in: header
required: false
schema:
type: string
minLength: 1
maxLength: 36
paypal_client_metadata_id:
name: PayPal-Client-Metadata-Id
in: header
required: false
schema:
type: string
minLength: 1
maxLength: 36
prefer:
name: Prefer
in: header
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.