Receive updated order information via callback URL

POST /orders/order-update-callback

The documentation for this 'endpoint' is different from the other endpoints under v2 Orders. For this endpoint the role of client and server is reversed. The client sending the request is PayPal, and the server sending the response is the merchant. In the request, PayPal will send the buyer's redacted shipping address and selected shipping option to the callback URL defined the create order request. The response from the merchant will update the Orders resource.

Request

Header Parameters

Content-Type stringrequired

The media type. Required for operations with a request body. The value is application/<format>, where format is json.

application/json

Body

purchase_units

object[]

required

An array of purchase units. At present only 1 purchase_unit is supported. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.

Possible values: >= 1, <= 1

Array [

reference_id string

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.

Possible values: non-empty and <= 256 characters

description string

The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.

Possible values: non-empty and <= 127 characters

custom_id string

The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.

Possible values: non-empty and <= 255 characters

invoice_id string

The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.

Possible values: non-empty and <= 127 characters

soft_descriptor string

The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement.

If an Order is paid using the "PayPal Wallet", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor

Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit

The

PAYPAL

prefix uses 8 characters. Only the first 22 characters will be displayed in the statement.
For example, if:

The PayPal prefix toggle is PAYPAL *.
The merchant descriptor in the profile is Janes Gift.
The soft descriptor is 800-123-1234.

Then, the statement descriptor on the card is

PAYPAL * Janes Gift 80

Possible values: non-empty and <= 22 characters

items

object[]

An array of items that the customer purchases from the merchant.

Array [

name stringrequired

The item name or title.

Possible values: non-empty and <= 127 characters

quantity stringrequired

The item quantity. Must be a whole number.

Possible values: <= 10 characters, Value must match regular expression ^[1-9][0-9]{0,9}$

description string

The detailed item description.

Possible values: <= 2048 characters

sku string

The stock keeping unit (SKU) for the item.

Possible values: <= 127 characters

url uri

The URL to the item being purchased. Visible to buyer and used in buyer experiences.

Possible values: non-empty and <= 2048 characters

category string

The item category type.

Possible values: non-empty and <= 20 characters, [DIGITAL_GOODS, PHYSICAL_GOODS, DONATION]

image_url uri

The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.

Possible values: non-empty and <= 2048 characters, Value must match regular expression ^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpeg|JPG|GIF|PNG|JPEG)

unit_amount

object

required

The item price or rate per unit. If you specify unit_amount, purchase_units[].amount.breakdown.item_total is required. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

tax

object

The item tax for each unit. If tax is specified, purchase_units[].amount.breakdown.tax_total is required. Must equal tax * quantity for all items. tax.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

upc

object

The Universal Product Code of the item.

type Universal Product Code Type (string)required

The Universal Product Code type.

Possible values: non-empty and <= 5 characters, Value must match regular expression ^[0-9A-Z_-]+$, [UPC-A, UPC-B, UPC-C, UPC-D, UPC-E, UPC-2, UPC-5]

code stringrequired

The UPC product code of the item.

Possible values: >= 6 characters and <= 17 characters, Value must match regular expression ^[0-9]{0,17}$

billing_plan

object

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

billing_cycles

object[]

required

An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.

Possible values: >= 1, <= 3

Array [

tenure_type stringrequired

The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.

Possible values: non-empty and <= 24 characters, Value must match regular expression ^[A-Z_]+$, [REGULAR, TRIAL]

total_cycles int32

The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

Possible values: <= 999

Default value: 1

sequence int32

The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a sequence of 1 while a regular billing cycle has a sequence of 2, so that trial cycle runs before the regular cycle.

Possible values: >= 1 and <= 3

Default value: 1

pricing_scheme

object

The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.

pricing_model stringrequired

The pricing model for the billing cycle.

Possible values: non-empty and <= 24 characters, Value must match regular expression ^[A-Z_]+$, [FIXED, VARIABLE, AUTO_RELOAD]

price

object

The price the customer will be charged based on the pricing model

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

reload_threshold_amount

object

The threshold amount on which the reload charge would be triggered. This will be associated with the account-balance where if the account-balance goes below this amount then customer would incur reload charge.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

start_date ppaas_date_notime_v2

The start date for the billing cycle, in YYYY-MM-DD. This field should be not be provided if the billing cycle starts at the time of checkout. When this field is not provided, the billing cycle amount will be included in any data validations confirming that the total provided by the merchant match the sum of individual items due at the time of checkout. Only one billing cycle (with sequence equal to 1) can have a no start date.

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

]

name string

Name of the recurring plan.

Possible values: non-empty and <= 127 characters, Value must match regular expression ^[A-Za-z0-9() +',.:-]+$

setup_fee

object

The setup fee for the recurring plan. Ensure its part of the item amount.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

]

amount

object

required

The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. The amount.value field supports up to 15 digits preceding the decimal. For a list of supported currencies, decimal precision, and maximum charge amount, see the PayPal REST APIs Currency Codes.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

breakdown

object

The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.

item_total

object

The subtotal for all items. Required if the request includes purchase_units[].items[].unit_amount. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

shipping

object

The shipping fee for all items within a given purchase_unit. shipping.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

handling

object

The handling fee for all items within a given purchase_unit. handling.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

tax_total

object

The total tax for all items. Required if the request includes purchase_units.items.tax. Must equal the sum of (items[].tax * items[].quantity) for all items. tax_total.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

insurance

object

The insurance fee for all items within a given purchase_unit. insurance.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

shipping_discount

object

The shipping discount for all items within a given purchase_unit. shipping_discount.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

discount

object

The discount for all items within a given purchase_unit. discount.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

payee

object

The merchant who receives payment for this transaction.

email_address merchant_common_email_address_v2

The email address of merchant.

Possible values: >= 3 characters and <= 254 characters, Value must match regular expression (?:[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])+)\])

merchant_id ppaas_payer_id_v3

The encrypted PayPal account ID of the merchant.

Possible values: >= 13 characters and <= 13 characters, Value must match regular expression ^[2-9A-HJ-NP-Z]{13}$

payment_instruction

object

Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

platform_fees

object[]

An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.

Possible values: <= 1

Array [

amount

object

required

The fee for this transaction.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

payee

object

The recipient of the fee for this transaction. If you omit this value, the default is the API caller.

email_address merchant_common_email_address_v2

The email address of merchant.

merchant_id ppaas_payer_id_v3

The encrypted PayPal account ID of the merchant.

Possible values: >= 13 characters and <= 13 characters, Value must match regular expression ^[2-9A-HJ-NP-Z]{13}$

]

payee_pricing_tier_id string

This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error.

Possible values: non-empty and <= 20 characters, Value must match regular expression ^.*$

payee_receivable_fx_rate_id string

FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.

Possible values: non-empty and <= 4000 characters, Value must match regular expression ^.*$

disbursement_mode Disbursement Mode (string)

The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Complete Payments Platform for Marketplaces and Platforms capability.

Possible values: non-empty and <= 16 characters, Value must match regular expression ^[A-Z_]+$, [INSTANT, DELAYED]

Default value: INSTANT

shipping

object

The name and address of the person to whom to ship the items.

type Fulfillment Type (string)

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.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [SHIPPING, PICKUP_IN_PERSON, PICKUP_IN_STORE, PICKUP_FROM_PERSON]

options

object[]

An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Possible values: <= 10

Array [

id stringrequired

A unique ID that identifies a payer-selected shipping option.

Possible values: <= 127 characters

label stringrequired

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.

Possible values: <= 127 characters

selected booleanrequired

If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. As part of the response if a shipping.option contains selected=true, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one shipping.option can be set to selected=true.

type Shipping Type (string)

A classification for the method of purchase fulfillment.

Possible values: [SHIPPING, PICKUP, PICKUP_IN_STORE, PICKUP_FROM_PERSON]

amount

object

The shipping cost for the selected option.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

]

name

object

The name of the person to whom to ship the items. Supports only the full_name property.

full_name string

When the party is a person, the party's full name.

Possible values: <= 300 characters

email_address ppaas_common_email_address_v2

The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.

Possible values: >= 3 characters and <= 254 characters, Value must match regular expression ^(?:[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])+)\])$

phone_number

object

The phone number of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery. [Format - canonical international E.164 numbering plan]

country_code stringrequired

The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Possible values: non-empty and <= 3 characters, Value must match regular expression ^[0-9]{1,3}?$

national_number stringrequired

The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Possible values: non-empty and <= 14 characters, Value must match regular expression ^[0-9]{1,14}?$

address

object

The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. admin_area_1 is required for addresses located in Argentina, Brazil, China, Canada, India, Indonesia, Japan, Mexico, Thailand, and the United States.

address_line_1 string

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.

Possible values: <= 300 characters

address_line_2 string

The second line of the address, for example, a suite or apartment number.

Possible values: <= 300 characters

admin_area_2 string

A city, town, or village. Smaller than admin_area_level_1.

Possible values: <= 120 characters

admin_area_1 string

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Possible values: <= 300 characters

postal_code string

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Possible values: <= 60 characters

country_code ppaas_common_country_code_v2required

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^([A-Z]{2}|C2)$

supplementary_data

object

Contains Supplementary Data.

card

object

Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.

level_2

object

The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business.

invoice_id string

Use this field to pass a purchase identification value of up to 127 ASCII characters. The length of this field will be adjusted to meet network specifications (25chars for Visa and Mastercard, 17chars for Amex), and the original invoice ID will still be displayed in your existing reports.

Possible values: non-empty and <= 127 characters, Value must match regular expression ^[\w‘\-.,":;\!?]*$

tax_total

object

Use this field to break down the amount of tax included in the total purchase amount. The value provided here will not add to the total purchase amount. The value can't be negative, and in most cases, it must be greater than zero in order to qualify for lower interchange rates. Value, by country, is:

UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

level_3

object

The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business.

ships_from_postal_code string

Use this field to specify the postal code of the shipping location.

Possible values: non-empty and <= 60 characters, Value must match regular expression ^[a-zA-Z0-9_'.-]*$

line_items

object[]

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.

Possible values: >= 1, <= 100

Array [

name stringrequired

The item name or title.

Possible values: non-empty and <= 127 characters

quantity stringrequired

The item quantity. Must be a whole number.

Possible values: <= 10 characters, Value must match regular expression ^[1-9][0-9]{0,9}$

description string

The detailed item description.

Possible values: <= 2048 characters

sku string

The stock keeping unit (SKU) for the item.

Possible values: <= 127 characters

url uri

The URL to the item being purchased. Visible to buyer and used in buyer experiences.

Possible values: non-empty and <= 2048 characters

image_url uri

The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.

Possible values: non-empty and <= 2048 characters, Value must match regular expression ^(https:)([/|.|\w|\s|-])*\.(?:jpg|gif|png|jpeg|JPG|GIF|PNG|JPEG)

upc

object

The Universal Product Code of the item.

type Universal Product Code Type (string)required

The Universal Product Code type.

Possible values: non-empty and <= 5 characters, Value must match regular expression ^[0-9A-Z_-]+$, [UPC-A, UPC-B, UPC-C, UPC-D, UPC-E, UPC-2, UPC-5]

code stringrequired

The UPC product code of the item.

Possible values: >= 6 characters and <= 17 characters, Value must match regular expression ^[0-9]{0,17}$

billing_plan

object

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

billing_cycles

object[]

required

An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.

Possible values: >= 1, <= 3

Array [

tenure_type stringrequired

The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.

Possible values: non-empty and <= 24 characters, Value must match regular expression ^[A-Z_]+$, [REGULAR, TRIAL]

total_cycles int32

Possible values: <= 999

Default value: 1

sequence int32

Possible values: >= 1 and <= 3

Default value: 1

pricing_scheme

object

The active pricing scheme for this billing cycle. A free trial billing cycle does not require a pricing scheme.

pricing_model stringrequired

The pricing model for the billing cycle.

Possible values: non-empty and <= 24 characters, Value must match regular expression ^[A-Z_]+$, [FIXED, VARIABLE, AUTO_RELOAD]

price

object

The price the customer will be charged based on the pricing model

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

reload_threshold_amount

object

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

start_date ppaas_date_notime_v2

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

]

name string

Name of the recurring plan.

Possible values: non-empty and <= 127 characters, Value must match regular expression ^[A-Za-z0-9() +',.:-]+$

setup_fee

object

The setup fee for the recurring plan. Ensure its part of the item amount.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

commodity_code string

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.

Possible values: non-empty and <= 12 characters, Value must match regular expression ^[a-zA-Z0-9_'.-]*$

unit_of_measure string

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

Possible values: non-empty and <= 12 characters, Value must match regular expression ^[a-zA-Z0-9_'.-]*$

unit_amount

object

required

The item price or rate per unit. Must equal unit_amount * quantity for all items. unit_amount.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

tax

object

The item tax for each unit. Must equal tax * quantity for all items. tax.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

discount_amount

object

Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

total_amount

object

The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

]

shipping_amount

object

Use this field to break down the shipping cost included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

duty_amount

object

Use this field to break down the duty amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

discount_amount

object

Use this field to break down the discount amount included in the total purchase amount. The value provided here will not add to the total purchase amount. The value cannot be negative.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

shipping_address

object

The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties.

address_line_1 string

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.

Possible values: <= 300 characters

address_line_2 string

The second line of the address, for example, a suite or apartment number.

Possible values: <= 300 characters

admin_area_2 string

A city, town, or village. Smaller than admin_area_level_1.

Possible values: <= 120 characters

admin_area_1 string

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Possible values: <= 300 characters

postal_code string

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Possible values: <= 60 characters

country_code ppaas_common_country_code_v2required

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^([A-Z]{2}|C2)$

risk

object

Merchants and partners can add additional customer parameters that can help with better fraud protection and reduced risk for unbranded card payments.

customer

object

Profile information of the sender or receiver.

ip_address ppaas_ip_address_v1

The consumer's IP address, which can be represented in either IPv4 or IPv6 format.

Possible values: >= 7 characters and <= 39 characters, Value must match regular expression ^(([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*$

]

shipping_address

object

required

Redacted shipping address to be used for shipping options and tax calculations.

admin_area_2 string

A city, town, or village. Smaller than admin_area_level_1.

Possible values: <= 120 characters

admin_area_1 string

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Possible values: <= 300 characters

postal_code string

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

Possible values: <= 60 characters

country_code ppaas_common_country_code_v2required

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^([A-Z]{2}|C2)$

shipping_option

object

Buyer selected shipping option.

id stringrequired

A unique ID that identifies a payer-selected shipping option.

Possible values: <= 127 characters

label stringrequired

Possible values: <= 127 characters

type Shipping Type (string)

A classification for the method of purchase fulfillment.

Possible values: [SHIPPING, PICKUP, PICKUP_IN_STORE, PICKUP_FROM_PERSON]

amount

object

The shipping cost for the selected option.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Responses

The callback to merchant was successful.

application/json

Schema
Example (from schema)

Schema

id string

The ID of the order.

Possible values: non-empty and <= 36 characters, Value must match regular expression ^[A-Z0-9-]+$

purchase_units

object

This would contain shipping option and amount data at purchase unit level.

reference_id string

Note: If there are multiple purchase units, reference_id is required for each purchase unit.

Possible values: non-empty and <= 256 characters, Value must match regular expression ^.*$

shipping_options

object[]

An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.

Possible values: >= 1, <= 10

Array [

id stringrequired

A unique ID that identifies a payer-selected shipping option.

Possible values: <= 127 characters

label stringrequired

Possible values: <= 127 characters

selected booleanrequired

type Shipping Type (string)

A classification for the method of purchase fulfillment.

Possible values: [SHIPPING, PICKUP, PICKUP_IN_STORE, PICKUP_FROM_PERSON]

amount

object

The shipping cost for the selected option.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

]

amount

object

The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

breakdown

object

The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.

item_total

object

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

shipping

object

The shipping fee for all items within a given purchase_unit. shipping.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

handling

object

The handling fee for all items within a given purchase_unit. handling.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

tax_total

object

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

insurance

object

The insurance fee for all items within a given purchase_unit. insurance.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

shipping_discount

object

The shipping discount for all items within a given purchase_unit. shipping_discount.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

discount

object

The discount for all items within a given purchase_unit. discount.value can not be a negative number.

currency_code ppaas_common_currency_code_v2required

The three-character ISO-4217 currency code that identifies the currency.

Possible values: >= 3 characters and <= 3 characters

value stringrequired

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

Possible values: <= 32 characters, Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

{
  "id": "string",
  "purchase_units": {
    "reference_id": "string",
    "shipping_options": [
      {
        "id": "string",
        "label": "string",
        "selected": true,
        "type": {},
        "amount": {}
      }
    ],
    "amount": {}
  }
}

The request is not well-formed, is syntactically incorrect, or violates the schema.

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

Possible values: non-empty and <= 256 characters, Value must match regular expression ^.*$

message string

The message that describes the error.

Possible values: non-empty and <= 2048 characters, Value must match regular expression ^.*$

details

object[]

An array of additional details about the error.

Possible values: >= 1, <= 100

Array [

field string

The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

Possible values: <= 256 characters, Value must match regular expression ^.*$

value string

The value of the field that caused the error.

Possible values: <= 1024 characters, Value must match regular expression ^.*$

issue stringrequired

The unique, fine-grained application-level error code.

Possible values: <= 256 characters, Value must match regular expression ^.*$

]

{
  "name": "string",
  "message": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "issue": "string"
    }
  ]
}

The transaction failed due to insufficient permissions.

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

Possible values: non-empty and <= 256 characters, Value must match regular expression ^.*$

message string

The message that describes the error.

Possible values: non-empty and <= 2048 characters, Value must match regular expression ^.*$

details

object[]

An array of additional details about the error.

Possible values: >= 1, <= 100

Array [

field string

The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

Possible values: <= 256 characters, Value must match regular expression ^.*$

value string

The value of the field that caused the error.

Possible values: <= 1024 characters, Value must match regular expression ^.*$

issue stringrequired

The unique, fine-grained application-level error code.

Possible values: <= 256 characters, Value must match regular expression ^.*$

]

{
  "name": "string",
  "message": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "issue": "string"
    }
  ]
}

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

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

Possible values: non-empty and <= 256 characters, Value must match regular expression ^.*$

message string

The message that describes the error.

Possible values: non-empty and <= 2048 characters, Value must match regular expression ^.*$

details

object[]

An array of additional details about the error.

Possible values: >= 1, <= 100

Array [

field string

The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

Possible values: <= 256 characters, Value must match regular expression ^.*$

value string

The value of the field that caused the error.

Possible values: <= 1024 characters, Value must match regular expression ^.*$

issue stringrequired

The unique, fine-grained application-level error code.

Possible values: <= 256 characters, Value must match regular expression ^.*$

]

{
  "name": "string",
  "message": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "issue": "string"
    }
  ]
}

An internal server error has occurred.

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

Possible values: non-empty and <= 256 characters, Value must match regular expression ^.*$

message string

The message that describes the error.

Possible values: non-empty and <= 2048 characters, Value must match regular expression ^.*$

details

object[]

An array of additional details about the error.

Possible values: >= 1, <= 100

Array [

field string

The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

Possible values: <= 256 characters, Value must match regular expression ^.*$

value string

The value of the field that caused the error.

Possible values: <= 1024 characters, Value must match regular expression ^.*$

issue stringrequired

The unique, fine-grained application-level error code.

Possible values: <= 256 characters, Value must match regular expression ^.*$

]

{
  "name": "string",
  "message": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "issue": "string"
    }
  ]
}

The error response.

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

Possible values: non-empty and <= 256 characters, Value must match regular expression ^.*$

message string

The message that describes the error.

Possible values: non-empty and <= 2048 characters, Value must match regular expression ^.*$

details

object[]

An array of additional details about the error.

Possible values: >= 1, <= 100

Array [

field string

The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

Possible values: <= 256 characters, Value must match regular expression ^.*$

value string

The value of the field that caused the error.

Possible values: <= 1024 characters, Value must match regular expression ^.*$

issue stringrequired

The unique, fine-grained application-level error code.

Possible values: <= 256 characters, Value must match regular expression ^.*$

]

{
  "name": "string",
  "message": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "issue": "string"
    }
  ]
}

Receive updated order information via callback URL

/orders/order-update-callback

Request​

Header Parameters

Body

Responses​

Request

Responses