Confirm the Order

POST /orders/:id/confirm-payment-source

Payer confirms their intent to pay for the the Order with the given payment source.

Request

Path Parameters

id stringrequired

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

The ID of the order for which the payer confirms their intent to pay.

Header Parameters

PayPal-Client-Metadata-Id string

Possible values: non-empty and <= 36 characters

Authorization stringrequired

To make REST API calls, include the bearer token in this header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id:secret>.

PayPal-Auth-Assertion string

An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Content-Type stringrequired

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9/+-]+$

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

Prefer string

Possible values: non-empty and <= 25 characters, Value must match regular expression ^[a-zA-Z=]*$

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.

Default value: return=minimal

application/json

Body

application_context

object

Customizes the payer confirmation experience.

brand_name string

Label to present to your payer as part of the PayPal hosted web experience.

Possible values: non-empty and <= 127 characters

return_url uri

The URL where the customer is redirected after the customer approves the payment.

Possible values: >= 10 characters and <= 4000 characters

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

Possible values: >= 10 characters and <= 4000 characters

locale ppaas_common_language_v3

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.

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

stored_payment_source

object

Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

payment_type stringrequired

Indicates the type of the stored payment_source payment.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [ONE_TIME, RECURRING, UNSCHEDULED]

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

previous_network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id stringrequired

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

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [VISA, MASTERCARD, DISCOVER, AMEX, SOLO, JCB, STAR, DELTA, SWITCH, MAESTRO, CB_NATIONALE, CONFIGOGA, CONFIDIS, ELECTRON, CETELEM, CHINA_UNION_PAY, DINERS, ELO, HIPER, HIPERCARD, RUPAY, GE, SYNCHRONY, EFTPOS, UNKNOWN]

payment_source

object

required

The payment source definition.

card

object

The payment card to use to fund a payment. Can be a credit or debit card.

name

The card holder's name as it appears on the card.

Possible values: non-empty and <= 300 characters, Value must match regular expression ^.{1,300}$

number

The primary account number (PAN) for the payment card.

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

security_code

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.

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

expiry date_year_month (string)

The card expiration year and month, in Internet date format For example: 2028-04

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

billing_address

object

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.

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.

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

attributes

object

Additional attributes associated with the use of this card.

customer

object

The details about a customer in PayPal's system of record.

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

Email address of the customer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants.

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])+)\])

phone

object

The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

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}?$

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

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.

Possible values: <= 140 characters

merchant_customer_id string

Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9a-zA-Z-_.^*$@#]+$

vault

object

Instruction to vault the card based on the specified strategy.

store_in_vault string

Defines how and when the payment source gets vaulted.

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

verification

object

Instruction to optionally verify the card based on the specified strategy.

method string

The method used for card verification.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [SCA_ALWAYS, SCA_WHEN_REQUIRED, 3D_SECURE, AVS_CVV]

Default value: SCA_WHEN_REQUIRED

stored_credential

object

Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

payment_type stringrequired

Indicates the type of the stored payment_source payment.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [ONE_TIME, RECURRING, UNSCHEDULED]

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

previous_network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id stringrequired

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

vault_id string

The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

single_use_token string

The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

network_token

object

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.

number stringrequired

Third party network token number.

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

cryptogram string

An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.

Possible values: >= 28 characters and <= 32 characters, Value must match regular expression ^.*$

token_requestor_id string

A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.

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

expiry date_year_month (string)required

The card expiration year and month, in Internet date format.

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

eci_flag eci_flag (string)

Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [MASTERCARD_NON_3D_SECURE_TRANSACTION, MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION, MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION, FULLY_AUTHENTICATED_TRANSACTION, ATTEMPTED_AUTHENTICATION_TRANSACTION, NON_3D_SECURE_TRANSACTION]

experience_context

object

Customizes the payer experience during the 3DS Approval for payment.

return_url uri

The URL where the customer will be redirected upon successfully completing the 3DS challenge.

Possible values: >= 10 characters and <= 4000 characters

cancel_url uri

The URL where the customer will be redirected upon cancelling the 3DS challenge.

Possible values: >= 10 characters and <= 4000 characters

token

object

The tokenized payment source to fund a payment.

id stringrequired

The PayPal-generated ID for the token.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

type stringrequired

The tokenization method that generated the ID.

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

paypal

object

Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting.

experience_context

object

Customizes the payer experience during the approval process for payment with PayPal.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

contact_preference string

The preference to display the contact information (buyer’s shipping email & phone number) on PayPal's checkout for easy merchant-buyer communication.

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

Default value: NO_CONTACT_INFO

landing_page string

The type of landing page to show on the PayPal site for customer checkout.

Possible values: non-empty and <= 13 characters, Value must match regular expression ^[0-9A-Z_]+$, [LOGIN, GUEST_CHECKOUT, NO_PREFERENCE]

Default value: NO_PREFERENCE

user_action string

Configures a Continue or Pay Now checkout flow.

Possible values: non-empty and <= 8 characters, Value must match regular expression ^[0-9A-Z_]+$, [CONTINUE, PAY_NOW]

Default value: CONTINUE

payment_method_preference string

The merchant-preferred payment methods.

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

Default value: UNRESTRICTED

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer will be redirected upon approving a payment.

cancel_url uri

The URL where the customer will be redirected upon cancelling the payment approval.

order_update_callback_config

object

Merchant provided Order Update callback configuration for PayPal Wallet.PayPal will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.

callback_events string[]required

An array of callback events merchant can subscribe to for the corresponding callback url.

Possible values: [SHIPPING_ADDRESS, SHIPPING_OPTIONS], >= 1, <= 5

callback_url urirequired

Merchant provided CallBack url.PayPal/Venmo will use this url to call the merchant back when the events occur .PayPal/Venmo expects a secured url usually in the https format.merchant can append the cart id or other params part of the url as query or path params.

Possible values: >= 10 characters and <= 2040 characters, Value must match regular expression ^.*$

billing_agreement_id string

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

Possible values: >= 2 characters and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9-]+$

stored_credential

object

Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

charge_pattern charge_pattern (string)

DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern instead.

Possible values: non-empty and <= 30 characters, Value must match regular expression ^[A-Z0-9_]+$, [IMMEDIATE, DEFERRED, RECURRING_PREPAID, RECURRING_POSTPAID, THRESHOLD_PREPAID, THRESHOLD_POSTPAID, SUBSCRIPTION_PREPAID, SUBSCRIPTION_POSTPAID, UNSCHEDULED_PREPAID, UNSCHEDULED_POSTPAID, INSTALLMENT_PREPAID, INSTALLMENT_POSTPAID]

usage_pattern charge_pattern (string)

Expected business/pricing model for the billing agreement.

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

vault_id string

The PayPal-generated ID for the payment_source stored within the Vault.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

The email address of the PayPal account holder.

name

object

The name of the PayPal account holder. Supports only the given_name and surname properties.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

phone

object

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.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

birth_date ppaas_date_notime_v2

The birth date of the PayPal account holder in YYYY-MM-DD format.

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])$

tax_info

object

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.

tax_id stringrequired

The customer's tax ID value.

Possible values: non-empty and <= 14 characters, Value must match regular expression ([a-zA-Z0-9])

tax_id_type stringrequired

The customer's tax ID type.

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

address

object

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.

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.

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

attributes

object

Additional attributes associated with the use of this wallet.

customer

object

The details about a customer in PayPal's system of record.

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

phone

object

The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

merchant_customer_id string

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9a-zA-Z-_.^*$@#]+$

vault

object

Attributes used to provide the instructions during vaulting of the PayPal Wallet.

store_in_vault string

Defines how and when the payment source gets vaulted.

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

description string

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.

Possible values: non-empty and <= 128 characters

usage_pattern PayPal Payment Token Usage Pattern (string)

Expected business/pricing model for the billing agreement.

Possible values: non-empty and <= 30 characters, [IMMEDIATE, DEFERRED, RECURRING_PREPAID, RECURRING_POSTPAID, THRESHOLD_PREPAID, THRESHOLD_POSTPAID, SUBSCRIPTION_PREPAID, SUBSCRIPTION_POSTPAID, UNSCHEDULED_PREPAID, UNSCHEDULED_POSTPAID, INSTALLMENT_PREPAID, INSTALLMENT_POSTPAID]

usage_type PayPal Payment Token Usage Type (string)required

The usage type associated with the PayPal payment token.

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

customer_type PayPal Payment Token Customer Type (string)

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.

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

Default value: CONSUMER

permit_multiple_payment_tokens boolean

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 value: false

bancontact

object

Bancontact is the most popular online payment in Belgium. More Details.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

blik

object

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.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

email ppaas_common_email_address_v2

The email address of the account holder associated with this payment method.

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])+)\])$

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

consumer_user_agent string

The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0).

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

consumer_ip ppaas_ip_address_v1

The IP address of the consumer. It could be either IPv4 or IPv6.

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*$

level_0

object

The level_0 integration flow object.

auth_code stringrequired

The 6-digit code used to authenticate a consumer within BLIK.

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

one_click

object

The one-click integration flow object.

auth_code string

The 6-digit code used to authenticate a consumer within BLIK.

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

consumer_reference stringrequired

The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.

Possible values: >= 3 characters and <= 64 characters, Value must match regular expression ^[ -~]{3,64}$

alias_label string

A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts.

Possible values: >= 8 characters and <= 35 characters, Value must match regular expression ^[ -~]{8,35}$

alias_key string

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.

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

eps

object

The eps transfer is an online payment method developed by many Austrian banks. More Details.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

giropay

object

Giropay is an Internet payment System in Germany, based on online banking. More Details.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

ideal

object

The Dutch payment method iDEAL is an online payment method that enables consumers to pay online through their own bank. More Details.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

mybank

object

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.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

p24

object

P24 (Przelewy24) is a secure and fast online bank transfer service linked to all the major banks in Poland. More Details.

name stringrequired

The name of the account holder associated with this payment method.

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

email ppaas_common_email_address_v2required

The email address of the account holder associated with this payment method.

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

sofort

object

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.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

trustly

object

Trustly is a payment method that allows customers to shop and pay from their bank account. More Details.

name stringrequired

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2required

The two-character ISO 3166-1 country code.

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

email ppaas_common_email_address_v2required

The email address of the account holder associated with this payment method.

experience_context

object

Customizes the payer experience during the approval process for the payment.

brand_name string

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.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

locale ppaas_common_language_v3

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

return_url uri

The URL where the customer is redirected after the customer approves the payment.

cancel_url uri

The URL where the customer is redirected after the customer cancels the payment.

apple_pay

object

ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native.

id string

ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.

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

stored_credential

object

Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

payment_type stringrequired

Indicates the type of the stored payment_source payment.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [ONE_TIME, RECURRING, UNSCHEDULED]

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

previous_network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id stringrequired

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

attributes

object

Additional attributes associated with apple pay.

customer

object

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

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

phone

object

The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

vault

object

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

store_in_vault stringrequired

Defines how and when the payment source gets vaulted.

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

name string

Name on the account holder associated with apple pay.

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

email_address ppaas_common_email_address_v2

The email address of the account holder associated with apple pay.

phone_number

object

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

decrypted_token

object

The decrypted payload details for the apple pay token.

device_manufacturer_id string

Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.

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

payment_data_type string

Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.

Possible values: non-empty and <= 16 characters, Value must match regular expression ^[0-9A-Z_]+$, [3DSECURE, EMV]

transaction_amount

object

The transaction amount for the payment that the payer has approved on apple platform.

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]+))$

tokenized_card

object

required

Apple Pay tokenized credit card used to pay.

name string

The card holder's name as it appears on the card.

Possible values: non-empty and <= 300 characters, Value must match regular expression ^.{1,300}$

number string

The primary account number (PAN) for the payment card.

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

expiry date_year_month (string)

The card expiration year and month, in Internet date format For example: 2028-04

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

type Card Type (string)

The payment card type.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [CREDIT, DEBIT, PREPAID, STORE, UNKNOWN]

brand Card Brand (string)

The card brand or network. Typically used in the response.

billing_address

object

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.

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.

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

payment_data

object

Apple Pay payment data object which contains the cryptogram, eci_indicator and other data.

cryptogram string

Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.

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

eci_indicator string

ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.

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

emv_data string

Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.

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

pin string

Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.

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

vault_id string

The PayPal-generated ID for the saved apple pay payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

experience_context

object

Customizes the payer experience during the approval process for the payment.

return_url urirequired

The URL where the customer is redirected after the customer approves the payment.

cancel_url urirequired

The URL where the customer is redirected after the customer cancels the payment.

google_pay

object

Google Pay payment source, allows buyer to pay using Google Pay.

name string

Name on the account holder associated with Google Pay.

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

email_address ppaas_common_email_address_v2

The email address of the account holder associated with Google Pay.

phone_number

object

The phone number of account holder, in its canonical international E.164 numbering plan format. Supports only the national_number property.

country_code string

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

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

card

object

The payment card information.

name string

The card holder's name as it appears on the card.

Possible values: non-empty and <= 300 characters, Value must match regular expression ^.{1,300}$

type Card Type (string)

The payment card type.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [CREDIT, DEBIT, PREPAID, STORE, UNKNOWN]

brand Card Brand (string)

The card brand or network. Typically used in the response.

billing_address

object

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.

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.

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

decrypted_token

object

The decrypted payload details for the Google Pay token.

message_id string

A unique ID that identifies the message in case it needs to be revoked or located at a later time.

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

message_expiration string

Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired.

Possible values: >= 13 characters and <= 13 characters, Value must match regular expression \d{13}

payment_method stringrequired

The type of the payment credential. Currently, only CARD is supported.

Possible values: >= 4 characters and <= 4 characters, [CARD]

authentication_method stringrequired

Authentication Method which is used for the card transaction.

Possible values: non-empty and <= 50 characters, [PAN_ONLY, CRYPTOGRAM_3DS]

cryptogram string

Base-64 cryptographic identifier used by card schemes to validate the token verification result. This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS.

Possible values: non-empty and <= 2000 characters

eci_indicator string

Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa card network. This value is passed through in the payment authorization request.

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

card

object

required

Google Pay tokenized credit card used to pay.

name string

The card holder's name as it appears on the card.

Possible values: non-empty and <= 300 characters, Value must match regular expression ^.{1,300}$

number stringrequired

The primary account number (PAN) for the payment card.

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

expiry date_year_month (string)required

The card expiration year and month, in Internet date format.

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

type Card Type (string)

The payment card type.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [CREDIT, DEBIT, PREPAID, STORE, UNKNOWN]

brand Card Brand (string)

The card brand or network. Typically used in the response.

billing_address

object

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.

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.

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

assurance_details

object

Information about what validation has been performed on the returned payment credentials.

account_verified boolean

If true, indicates that Cardholder possession validation has been performed on returned payment credential.

Default value: false

card_holder_authenticated boolean

If true, indicates that identification and verifications (ID&V) was performed on the returned payment credential.If false, the same risk-based authentication can be performed as you would for card transactions. This risk-based authentication can include, but not limited to, step-up with 3D Secure protocol if applicable.

Default value: false

experience_context

object

Customizes the payer experience during the approval process for the payment.

return_url urirequired

The URL where the customer is redirected after the customer approves the payment.

cancel_url urirequired

The URL where the customer is redirected after the customer cancels the payment.

venmo

object

Information needed to indicate that Venmo is being used to fund the payment.

experience_context

object

Customizes the buyer experience during the approval process for payment with Venmo.

brand_name string

The business name of the merchant. The pattern is defined by an external party and supports Unicode.

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

shipping_preference string

The location from which the shipping address is derived.

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

Default value: GET_FROM_FILE

order_update_callback_config

object

Merchant provided Order Update callback configuration for Venmo Wallet.Venmo will call back merchant when the specified event occurs.we recommend merchants to pass both the shipping_options and shipping_address callback events. Not supported when shipping.type is specified or when 'application_context.shipping_preference' is set as 'NO_SHIPPING' or 'SET_PROVIDED_ADDRESS'.

callback_events string[]required

An array of callback events merchant can subscribe to for the corresponding callback url.

Possible values: [SHIPPING_ADDRESS, SHIPPING_OPTIONS], >= 1, <= 5

callback_url urirequired

Possible values: >= 10 characters and <= 2040 characters, Value must match regular expression ^.*$

vault_id string

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.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

The email address of the payer.

attributes

object

Additional attributes associated with the use of this wallet.

customer

object

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

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

phone

object

The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

vault

object

Attributes used to provide the instructions during vaulting of the Venmo Wallet.

store_in_vault stringrequired

Defines how and when the payment source gets vaulted.

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

description string

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.

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

usage_pattern Venmo Payment Token Usage Pattern (string)

Expected business/pricing model for the billing agreement.

Possible values: non-empty and <= 30 characters, Value must match regular expression ^[0-9A-Z_]+$, [IMMEDIATE, DEFERRED, RECURRING_PREPAID, RECURRING_POSTPAID, THRESHOLD_PREPAID, THRESHOLD_POSTPAID]

usage_type Venmo Payment Token Usage Type (string)required

The usage type associated with the Venmo payment token.

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

customer_type Venmo Payment Token Customer Type (string)

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.

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

Default value: CONSUMER

permit_multiple_payment_tokens boolean

Default value: false

Responses

A successful request indicates that the payment source was added to the Order. A successful request returns the HTTP 200 OK status code with a JSON response body that shows order details.

application/json

Schema
Example (from schema)

Schema

object

create_time ppaas_date_time_v3

The date and time when the transaction occurred, in Internet date and time format.

Possible values: >= 20 characters and <= 64 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])[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})$

update_time ppaas_date_time_v3

The date and time when the transaction was last updated, in Internet date and time format.

id string

The ID of the order.

purchase_units

object[]

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.

Possible values: >= 1, <= 10

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.

Possible values: non-empty and <= 127 characters

custom_id string

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Possible values: non-empty and <= 255 characters

invoice_id string

The API caller-provided external invoice ID for this order.

Possible values: non-empty and <= 127 characters

id string

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.

Possible values: non-empty and <= 19 characters

soft_descriptor string

The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format:22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters.

The soft descriptor supports the following ASCII characters:

Alphanumeric characters
Dashes
Asterisks
Periods (.)
Spaces

For Wallet payments marketplace integrations:

The merchant descriptor in the Payment Receiving Preferences must be the marketplace name.
You can't use the remaining space to show the customer service number.
The remaining spaces can be a combination of seller name and country.

For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number.

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]+))$

]

most_recent_errors array

The error reason code and description that are the reason for the most recent order decline.

Possible values: >= 1, <= 10

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.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.

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

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 shipping address and method.

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.

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

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

national_number stringrequired

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

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.

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

trackers

object[]

An array of trackers for a transaction.

Array [

id string

The tracker id.

status Tracker Status (string)

The status of the item shipment.

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Z_]+$, [CANCELLED, SHIPPED]

items

object[]

An array of details of items in the shipment.

Array [

name string

The item name or title.

Possible values: non-empty and <= 127 characters

quantity string

The item quantity. Must be a whole number.

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

sku string

The stock keeping unit (SKU) for the item. This can contain unicode characters.

Possible values: non-empty and <= 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}$

]

links

object[]

An array of request-related HATEOAS links.

Array [

href stringrequired

The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

create_time ppaas_date_time_v3

The date and time when the transaction occurred, in Internet date and time format.

update_time ppaas_date_time_v3

The date and time when the transaction was last updated, in Internet date and time format.

]

supplementary_data

object

Supplementary data about this payment. 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.

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.

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.

payments

object

The comprehensive history of payments for the purchase unit.

authorizations

object[]

An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.

Array [

status Authorization Status (string)

The status for the authorized payment.

Possible values: [CREATED, CAPTURED, DENIED, PARTIALLY_CAPTURED, VOIDED, PENDING]

status_details

object

The details of the authorized order pending status.

reason Authorization Incomplete Reason (string)

The reason why the authorized status is PENDING.

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[A-Z_]+$, [PENDING_REVIEW, DECLINED_BY_RISK_FRAUD_FILTERS]

id string

The PayPal-generated ID for the authorized payment.

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.

custom_id string

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Possible values: <= 255 characters

links

object[]

An array of related HATEOAS links.

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

amount

object

The amount for this authorized payment.

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]+))$

network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id string

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

seller_protection

object

The level of protection offered as defined by PayPal Seller Protection for Merchants.

status Seller Protection Status (string)

Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.

Possible values: [ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE]

dispute_categories string[]

An array of conditions that are covered for the transaction.

Possible values: [ITEM_NOT_RECEIVED, UNAUTHORIZED_TRANSACTION]

expiration_time ppaas_date_time_v3

The date and time when the authorized payment expires, in Internet date and time format.

create_time ppaas_date_time_v3

The date and time when the transaction occurred, in Internet date and time format.

update_time ppaas_date_time_v3

The date and time when the transaction was last updated, in Internet date and time format.

processor_response

object

The processor response information for payment requests, such as direct credit card transactions.

avs_code string

The address verification code for Visa, Discover, Mastercard, or American Express transactions.

Possible values: [A, B, C, D, E, F, G, I, M, N, P, R, S, U, W, X, Y, Z, Null, 0, 1, 2, 3, 4]

cvv_code string

The card verification value code for for Visa, Discover, Mastercard, or American Express.

Possible values: [E, I, M, N, P, S, U, X, All others, 0, 1, 2, 3, 4]

response_code string

Processor response code for the non-PayPal payment processor errors.

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

payment_advice_code string

The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.

Possible values: [01, 02, 03, 04, 21, 22, 24, 25, 26, 27, 28, 29, 30, 40, 43]

]

captures

object[]

An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.

Array [

create_time ppaas_date_time_v3

The date and time when the transaction occurred, in Internet date and time format.

update_time ppaas_date_time_v3

The date and time when the transaction was last updated, in Internet date and time format.

id string

The PayPal-generated ID for the captured payment.

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.

custom_id string

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Possible values: <= 255 characters

final_capture boolean

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.

Default value: false

links

object[]

An array of related HATEOAS links.

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

amount

object

The amount for this captured payment.

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]+))$

network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id string

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

seller_protection

object

The level of protection offered as defined by PayPal Seller Protection for Merchants.

status Seller Protection Status (string)

Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.

Possible values: [ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE]

dispute_categories string[]

An array of conditions that are covered for the transaction.

Possible values: [ITEM_NOT_RECEIVED, UNAUTHORIZED_TRANSACTION]

seller_receivable_breakdown

object

The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.

platform_fees

object[]

An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.

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}$

]

gross_amount

object

required

The amount for this captured payment in the currency of the 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]+))$

paypal_fee

object

The applicable fee for this captured payment in the currency of the 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]+))$

paypal_fee_in_receivable_currency

object

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

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]+))$

net_amount

object

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.

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]+))$

receivable_amount

object

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.

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]+))$

exchange_rate

object

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.

value string

The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point.

source_currency ppaas_common_currency_code_v2

The source currency from which to convert an amount.

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

target_currency ppaas_common_currency_code_v2

The target currency to which to convert an amount.

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

disbursement_mode Disbursement Mode (string)

The funds that are held on behalf of the merchant.

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

Default value: INSTANT

processor_response

object

An object that provides additional processor information for a direct credit card transaction.

avs_code string

The address verification code for Visa, Discover, Mastercard, or American Express transactions.

Possible values: [A, B, C, D, E, F, G, I, M, N, P, R, S, U, W, X, Y, Z, Null, 0, 1, 2, 3, 4]

cvv_code string

The card verification value code for for Visa, Discover, Mastercard, or American Express.

Possible values: [E, I, M, N, P, S, U, X, All others, 0, 1, 2, 3, 4]

response_code string

Processor response code for the non-PayPal payment processor errors.

payment_advice_code string

The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.

Possible values: [01, 02, 03, 04, 21, 22, 24, 25, 26, 27, 28, 29, 30, 40, 43]

]

refunds

object[]

An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.

Array [

status Refund Status With Details (string)

The status of the refund.

Possible values: [CANCELLED, FAILED, PENDING, COMPLETED]

status_details

object

The details of the refund status.

reason Refund Incomplete Reason (string)

The reason why the refund has the PENDING or FAILED status.

Possible values: [ECHECK]

id string

The PayPal-generated ID for the refund.

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.

custom_id string

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9-_.,]*$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

note_to_payer string

The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

seller_payable_breakdown

object

The breakdown of the refund.

platform_fees

object[]

An array of platform or partner fees, commissions, or brokerage fees for the refund.

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}$

]

net_amount_breakdown

object[]

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.

Array [

payable_amount

object

The net amount debited from the merchant's PayPal account.

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]+))$

converted_amount

object

The converted payable 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]+))$

exchange_rate

object

The exchange rate that determines the amount that was debited from the merchant's PayPal account.

value string

The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point.

source_currency ppaas_common_currency_code_v2

The source currency from which to convert an amount.

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

target_currency ppaas_common_currency_code_v2

The target currency to which to convert an amount.

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

]

gross_amount

object

The amount that the payee refunded to the payer.

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]+))$

paypal_fee

object

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.

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]+))$

paypal_fee_in_receivable_currency

object

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

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]+))$

net_amount

object

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.

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]+))$

net_amount_in_receivable_currency

object

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

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_refunded_amount

object

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.

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]+))$

links

object[]

An array of related HATEOAS links.

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

amount

object

The amount that the payee refunded to the payer.

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]+))$

payer

object

The details associated with the merchant for this transaction.

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}$

create_time ppaas_date_time_v3

The date and time when the transaction occurred, in Internet date and time format.

update_time ppaas_date_time_v3

The date and time when the transaction was last updated, in Internet date and time format.

]

links

object[]

An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

payment_source

object

The payment source used to fund the payment.

card

object

The payment card to use to fund a payment. Card can be a credit or debit card.

name string

The card holder's name as it appears on the card.

Possible values: >= 2 characters and <= 300 characters

last_digits string

The last digits of the payment card.

Possible values: Value must match regular expression [0-9]{2,}

available_networks Card Brand (string)[]

Array of brands or networks associated with the card.

Possible values: [VISA, MASTERCARD, DISCOVER, AMEX, SOLO, JCB, STAR, DELTA, SWITCH, MAESTRO, CB_NATIONALE, CONFIGOGA, CONFIDIS, ELECTRON, CETELEM, CHINA_UNION_PAY, DINERS, ELO, HIPER, HIPERCARD, RUPAY, GE, SYNCHRONY, EFTPOS, UNKNOWN], >= 1, <= 256

from_request

object

Representation of card details as received in the request.

last_digits string

The last digits of the payment card.

Possible values: >= 2 characters and <= 4 characters, Value must match regular expression [0-9]{2,}

expiry date_year_month (string)

The card expiration year and month, in Internet date format.

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

stored_credential

object

Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

payment_type stringrequired

Indicates the type of the stored payment_source payment.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [ONE_TIME, RECURRING, UNSCHEDULED]

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

previous_network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id stringrequired

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

brand Card Brand (string)

The card brand or network. Typically used in the response.

type Card Type (string)

The payment card type.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [CREDIT, DEBIT, PREPAID, STORE, UNKNOWN]

authentication_result

object

Results of Authentication such as 3D Secure.

liability_shift string

Liability shift indicator. The outcome of the issuer's authentication.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [NO, POSSIBLE, UNKNOWN]

three_d_secure

object

Results of 3D Secure Authentication.

authentication_status pares_status (string)

The outcome of the issuer's authentication.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [Y, N, U, A, C, R, D, I]

enrollment_status enrolled (string)

Status of authentication eligibility.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [Y, N, U, B]

attributes

object

Additional attributes associated with the use of this card.

vault

object

The details about a saved Card payment source.

id string

The PayPal-generated ID for the saved payment source.

Possible values: non-empty and <= 255 characters

status Vault Status (string)

The vault status.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [VAULTED, CREATED, APPROVED]

links

object[]

An array of request-related HATEOAS links.

Possible values: >= 1, <= 10

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

customer

object

The details about a customer in PayPal's system of record.

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

phone

object

The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

merchant_customer_id string

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9a-zA-Z-_.^*$@#]+$

expiry date_year_month (string)

The card expiration year and month, in Internet date format.

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

bin_details

object

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

bin string

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.

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

issuing_bank string

The issuer of the card instrument.

Possible values: non-empty and <= 64 characters

products string[]

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.

Possible values: >= 1, <= 256

bin_country_code ppaas_common_country_code_v2

The two-character ISO-3166-1 country code of the bank.

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

bancontact

object

Information used to pay Bancontact.

card_last_digits string

The last digits of the card used to fund the Bancontact payment.

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

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

iban_last_chars string

The last characters of the IBAN used to pay.

Possible values: >= 4 characters and <= 34 characters, Value must match regular expression [a-zA-Z0-9]{4}

blik

object

Information used to pay using BLIK.

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

email ppaas_common_email_address_v2

The email address of the account holder associated with this payment method.

one_click

object

The one-click integration flow object.

consumer_reference string

The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.

Possible values: >= 3 characters and <= 64 characters, Value must match regular expression ^[ -~]{3,64}$

eps

object

Information used to pay using eps.

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

giropay

object

Information needed to pay using giropay.

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

ideal

object

Information used to pay using iDEAL.

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

iban_last_chars string

The last characters of the IBAN used to pay.

Possible values: >= 4 characters and <= 34 characters, Value must match regular expression [a-zA-Z0-9]{4}

mybank

object

Information used to pay using MyBank.

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

iban_last_chars string

The last characters of the IBAN used to pay.

Possible values: >= 4 characters and <= 34 characters, Value must match regular expression [a-zA-Z0-9]{4}

p24

object

Information used to pay using P24(Przelewy24).

payment_descriptor string

P24 generated payment description.

Possible values: non-empty and <= 2000 characters

method_id string

Numeric identifier of the payment scheme or bank used for the payment.

Possible values: non-empty and <= 300 characters

method_description string

Friendly name of the payment scheme or bank used for the payment.

Possible values: non-empty and <= 2000 characters

name string

The name of the account holder associated with this payment method.

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

email ppaas_common_email_address_v2

The email address of the account holder associated with this payment method.

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

sofort

object

Information used to pay using Sofort.

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

iban_last_chars string

The last characters of the IBAN used to pay.

Possible values: >= 4 characters and <= 34 characters, Value must match regular expression [a-zA-Z0-9]{4}

trustly

object

Information needed to pay using Trustly.

name string

The name of the account holder associated with this payment method.

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

country_code ppaas_common_country_code_v2

The two-character ISO 3166-1 country code.

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

email ppaas_common_email_address_v2

The email address of the account holder associated with this payment method.

bic BIC (string)

The bank identification code (BIC).

Possible values: >= 8 characters and <= 11 characters, Value must match regular expression ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

iban_last_chars string

The last characters of the IBAN used to pay.

Possible values: >= 4 characters and <= 34 characters, Value must match regular expression [a-zA-Z0-9]{4}

venmo

object

Venmo wallet response.

user_name string

The Venmo user name chosen by the user, also know as a Venmo handle.

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

attributes

object

Additional attributes associated with the use of a Venmo Wallet.

vault

object

The details about a saved payment source.

id string

The PayPal-generated ID for the saved payment source.

Possible values: non-empty and <= 255 characters

status Vault Status (string)

The vault status.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [VAULTED, CREATED, APPROVED]

links

object[]

An array of request-related HATEOAS links.

Possible values: >= 1, <= 10

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

customer

object

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

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

email_address merchant_common_email_address_v2

The email address of the payer.

account_id ppaas_payer_id_v3

This is an immutable system-generated id for a user's Venmo account.

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

name

object

The name associated with the Venmo account. Supports only the given_name and surname properties.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

phone_number

object

The phone number associated with the Venmo account, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

address

object

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.

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.

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

paypal

object

The PayPal Wallet response.

account_status string

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

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [VERIFIED, UNVERIFIED]

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

business_name string

The business name of the PayPal account holder (populated for business accounts only)

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

attributes

object

Additional attributes associated with the use of a PayPal Wallet.

vault

object

The details about a saved PayPal Wallet payment source.

id string

The PayPal-generated ID for the saved payment source.

Possible values: non-empty and <= 255 characters

status Vault Status (string)

The vault status.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [VAULTED, CREATED, APPROVED]

links

object[]

An array of request-related HATEOAS links.

Possible values: >= 1, <= 10

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

customer

object

The details about a customer in PayPal's system of record.

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

phone

object

The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

merchant_customer_id string

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9a-zA-Z-_.^*$@#]+$

cobranded_cards

object[]

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

Possible values: <= 25

Array [

labels string[]

Array of labels for the cobranded card.

Possible values: >= 1, <= 25

payee

object

Merchant associated with the purchase.

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}$

amount

object

Amount that was charged to the cobranded card.

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]+))$

]

stored_credential

object

Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

charge_pattern charge_pattern (string)

DEPRECATED. Expected business/pricing model for the billing agreement, Please use usage_pattern instead.

usage_pattern charge_pattern (string)

Expected business/pricing model for the billing agreement.

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

email_address merchant_common_email_address_v2

The email address of the PayPal account holder.

account_id ppaas_payer_id_v3

The PayPal-assigned ID for the PayPal account holder.

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

name

object

The name of the PayPal account holder. Supports only the given_name and surname properties.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

phone_number

object

The phone number, in its canonical international E.164 numbering plan format. 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.

national_number stringrequired

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

birth_date ppaas_date_notime_v2

The birth date of the PayPal account holder in YYYY-MM-DD format.

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])$

tax_info

object

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.

tax_id stringrequired

The customer's tax ID value.

Possible values: non-empty and <= 14 characters, Value must match regular expression ([a-zA-Z0-9])

tax_id_type stringrequired

The customer's tax ID type.

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

address

object

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.

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

apple_pay

object

Information needed to pay using ApplePay.

id string

ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.

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

token string

Encrypted ApplePay token, containing card information. This token would be base64encoded. The pattern is defined by an external party and supports Unicode.

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

stored_credential

object

Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

payment_type stringrequired

Indicates the type of the stored payment_source payment.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [ONE_TIME, RECURRING, UNSCHEDULED]

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

previous_network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id stringrequired

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

name string

Name on the wallet.

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

email_address ppaas_common_email_address_v2

The email address of the account holder associated with this payment method.

phone_number

object

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

card

object

The payment card information.

name string

The card holder's name as it appears on the card.

Possible values: >= 2 characters and <= 300 characters

last_digits string

The last digits of the payment card.

Possible values: Value must match regular expression [0-9]{2,}

available_networks Card Brand (string)[]

Array of brands or networks associated with the card.

from_request

object

Representation of card details as received in the request.

last_digits string

The last digits of the payment card.

Possible values: >= 2 characters and <= 4 characters, Value must match regular expression [0-9]{2,}

expiry date_year_month (string)

The card expiration year and month, in Internet date format.

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

stored_credential

object

Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).
Parameter compatibility:

payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER.
usage=FIRST is compatible only with payment_initiator=CUSTOMER.
previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT.
Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

payment_initiator stringrequired

The person or party who initiated or triggered the payment.

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

payment_type stringrequired

Indicates the type of the stored payment_source payment.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [ONE_TIME, RECURRING, UNSCHEDULED]

usage string

Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [FIRST, SUBSEQUENT, DERIVED]

Default value: DERIVED

previous_network_transaction_reference

object

Reference values used by the card network to identify a transaction.

id stringrequired

Possible values: >= 9 characters and <= 36 characters, Value must match regular expression ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

date string

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.

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^[0-9]+$

acquirer_reference_number string

Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks.

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

network Card Brand (string)

Name of the card network through which the transaction was routed.

brand Card Brand (string)

The card brand or network. Typically used in the response.

type Card Type (string)

The payment card type.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [CREDIT, DEBIT, PREPAID, STORE, UNKNOWN]

authentication_result

object

Results of Authentication such as 3D Secure.

liability_shift string

Liability shift indicator. The outcome of the issuer's authentication.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [NO, POSSIBLE, UNKNOWN]

three_d_secure

object

Results of 3D Secure Authentication.

authentication_status pares_status (string)

The outcome of the issuer's authentication.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [Y, N, U, A, C, R, D, I]

enrollment_status enrolled (string)

Status of authentication eligibility.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [Y, N, U, B]

attributes

object

Additional attributes associated with the use of this card.

vault

object

The details about a saved Card payment source.

id string

The PayPal-generated ID for the saved payment source.

Possible values: non-empty and <= 255 characters

status Vault Status (string)

The vault status.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [VAULTED, CREATED, APPROVED]

links

object[]

An array of request-related HATEOAS links.

Possible values: >= 1, <= 10

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

customer

object

The details about a customer in PayPal's system of record.

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

email_address merchant_common_email_address_v2

phone

object

The phone number of the customer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number.

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

merchant_customer_id string

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9a-zA-Z-_.^*$@#]+$

expiry date_year_month (string)

The card expiration year and month, in Internet date format.

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

bin_details

object

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

bin string

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.

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

issuing_bank string

The issuer of the card instrument.

Possible values: non-empty and <= 64 characters

products string[]

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.

Possible values: >= 1, <= 256

bin_country_code ppaas_common_country_code_v2

The two-character ISO-3166-1 country code of the bank.

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

billing_address

object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

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.

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

country_code ppaas_common_country_code_v2

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

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

attributes

object

Additional attributes associated with apple pay.

vault

object

The details about a saved payment source.

id string

The PayPal-generated ID for the saved payment source.

Possible values: non-empty and <= 255 characters

status Vault Status (string)

The vault status.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [VAULTED, CREATED, APPROVED]

links

object[]

An array of request-related HATEOAS links.

Possible values: >= 1, <= 10

Array [

href stringrequired

rel stringrequired

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

method string

The HTTP method required to make the related call.

Possible values: [GET, POST, PUT, DELETE, HEAD, CONNECT, OPTIONS, PATCH]

]

customer

object

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

id string

The unique ID for a customer generated by PayPal.

Possible values: non-empty and <= 22 characters, Value must match regular expression ^[0-9a-zA-Z_-]+$

name

object

The full name of the customer as provided to the merchant or on file with the merchant.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

google_pay

object

Google Pay Wallet payment data.

name string

Name on the account holder associated with Google Pay.

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

email_address ppaas_common_email_address_v2

The email address of the account holder associated with Google Pay.

phone_number

object

The phone number of account holder, in its canonical international E.164 numbering plan format. Supports only the national_number property.

country_code string

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

national_number stringrequired

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

card

object

The Card from Google Pay Wallet used to fund the payment.

name string

The card holder's name as it appears on the card.

Possible values: non-empty and <= 300 characters, Value must match regular expression ^.{1,300}$

last_digits string

The last digits of the payment card.

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

type Card Type (string)

The payment card type.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Z_]+$, [CREDIT, DEBIT, PREPAID, STORE, UNKNOWN]

brand Card Brand (string)

The card brand or network. Typically used in the response.

billing_address

object

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.

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.

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

authentication_result

object

Results of Authentication such as 3D Secure.

liability_shift string

Liability shift indicator. The outcome of the issuer's authentication.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [NO, POSSIBLE, UNKNOWN]

three_d_secure

object

Results of 3D Secure Authentication.

authentication_status pares_status (string)

The outcome of the issuer's authentication.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [Y, N, U, A, C, R, D, I]

enrollment_status enrolled (string)

Status of authentication eligibility.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [Y, N, U, B]

intent Checkout Payment Intent (string)

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

Possible values: [CAPTURE, AUTHORIZE]

payer

payer_v1

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

email_address merchant_common_email_address_v2

The email address of the payer.

payer_id ppaas_payer_id_v3

The PayPal-assigned ID for the payer.

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

name

object

The name of the payer. Supports only the given_name and surname properties.

given_name string

When the party is a person, the party's given, or first, name.

Possible values: <= 140 characters

surname string

Possible values: <= 140 characters

phone

object

phone_type Phone Type (string)

The phone type.

Possible values: [FAX, HOME, MOBILE, OTHER, PAGER]

phone_number

object

required

The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property.

national_number stringrequired

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

birth_date ppaas_date_notime_v2

The birth date of the payer in YYYY-MM-DD format.

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])$

tax_info

object

The tax information of the payer. Required only for Brazilian payer's. Both tax_id and tax_id_type are required.

tax_id stringrequired

The customer's tax ID value.

Possible values: non-empty and <= 14 characters, Value must match regular expression ([a-zA-Z0-9])

tax_id_type stringrequired

The customer's tax ID type.

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

address

object

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.

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

status Order Status (string)

The order status.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[0-9A-Z_]+$, [CREATED, SAVED, APPROVED, VOIDED, COMPLETED, PAYER_ACTION_REQUIRED]

{
  "create_time": "string",
  "update_time": "string",
  "id": "string",
  "purchase_units": [
    {
      "reference_id": "string",
      "description": "string",
      "custom_id": "string",
      "invoice_id": "string",
      "id": "string",
      "soft_descriptor": "string",
      "items": [
        {
          "name": "string",
          "quantity": "string",
          "description": "string",
          "sku": "string",
          "url": "string",
          "category": "DIGITAL_GOODS",
          "image_url": "string",
          "unit_amount": {
            "currency_code": "string",
            "value": "string"
          },
          "tax": {
            "currency_code": "string",
            "value": "string"
          },
          "upc": {
            "type": "UPC-A",
            "code": "string"
          },
          "billing_plan": {
            "billing_cycles": [
              {
                "tenure_type": "REGULAR",
                "total_cycles": 1,
                "sequence": 1,
                "pricing_scheme": {
                  "pricing_model": "FIXED",
                  "price": {
                    "currency_code": "string",
                    "value": "string"
                  },
                  "reload_threshold_amount": {
                    "currency_code": "string",
                    "value": "string"
                  }
                },
                "start_date": "string"
              }
            ],
            "name": "string",
            "setup_fee": {
              "currency_code": "string",
              "value": "string"
            }
          }
        }
      ],
      "most_recent_errors": [
        null
      ],
      "amount": {
        "currency_code": "string",
        "value": "string",
        "breakdown": {
          "item_total": {
            "currency_code": "string",
            "value": "string"
          },
          "shipping": {
            "currency_code": "string",
            "value": "string"
          },
          "handling": {
            "currency_code": "string",
            "value": "string"
          },
          "tax_total": {
            "currency_code": "string",
            "value": "string"
          },
          "insurance": {
            "currency_code": "string",
            "value": "string"
          },
          "shipping_discount": {
            "currency_code": "string",
            "value": "string"
          },
          "discount": {
            "currency_code": "string",
            "value": "string"
          }
        }
      },
      "payee": {
        "email_address": "string",
        "merchant_id": "string"
      },
      "payment_instruction": {
        "platform_fees": [
          {
            "amount": {
              "currency_code": "string",
              "value": "string"
            },
            "payee": {
              "email_address": "string",
              "merchant_id": "string"
            }
          }
        ],
        "payee_pricing_tier_id": "string",
        "payee_receivable_fx_rate_id": "string",
        "disbursement_mode": "INSTANT"
      },
      "shipping": {
        "type": "SHIPPING",
        "options": [
          {
            "id": "string",
            "label": "string",
            "selected": true,
            "type": "SHIPPING",
            "amount": {
              "currency_code": "string",
              "value": "string"
            }
          }
        ],
        "name": {
          "full_name": "string"
        },
        "email_address": "string",
        "phone_number": {
          "country_code": "string",
          "national_number": "string"
        },
        "address": {
          "address_line_1": "string",
          "address_line_2": "string",
          "admin_area_2": "string",
          "admin_area_1": "string",
          "postal_code": "string",
          "country_code": "string"
        },
        "trackers": [
          {
            "id": "string",
            "status": "CANCELLED",
            "items": [
              {
                "name": "string",
                "quantity": "string",
                "sku": "string",
                "url": "string",
                "image_url": "string",
                "upc": {
                  "type": "UPC-A",
                  "code": "string"
                }
              }
            ],
            "links": [
              {
                "href": "string",
                "rel": "string",
                "method": "GET"
              }
            ],
            "create_time": "string",
            "update_time": "string"
          }
        ]
      },
      "supplementary_data": {
        "card": {
          "level_2": {
            "invoice_id": "string",
            "tax_total": {
              "currency_code": "string",
              "value": "string"
            }
          },
          "level_3": {
            "ships_from_postal_code": "string",
            "line_items": [
              {
                "name": "string",
                "quantity": "string",
                "description": "string",
                "sku": "string",
                "url": "string",
                "image_url": "string",
                "upc": {
                  "type": "UPC-A",
                  "code": "string"
                },
                "billing_plan": {
                  "billing_cycles": [
                    {
                      "tenure_type": "REGULAR",
                      "total_cycles": 1,
                      "sequence": 1,
                      "pricing_scheme": {
                        "pricing_model": "FIXED",
                        "price": {
                          "currency_code": "string",
                          "value": "string"
                        },
                        "reload_threshold_amount": {
                          "currency_code": "string",
                          "value": "string"
                        }
                      },
                      "start_date": "string"
                    }
                  ],
                  "name": "string",
                  "setup_fee": {
                    "currency_code": "string",
                    "value": "string"
                  }
                },
                "commodity_code": "string",
                "unit_of_measure": "string",
                "unit_amount": {
                  "currency_code": "string",
                  "value": "string"
                },
                "tax": {
                  "currency_code": "string",
                  "value": "string"
                },
                "discount_amount": {
                  "currency_code": "string",
                  "value": "string"
                },
                "total_amount": {
                  "currency_code": "string",
                  "value": "string"
                }
              }
            ],
            "shipping_amount": {
              "currency_code": "string",
              "value": "string"
            },
            "duty_amount": {
              "currency_code": "string",
              "value": "string"
            },
            "discount_amount": {
              "currency_code": "string",
              "value": "string"
            },
            "shipping_address": {
              "address_line_1": "string",
              "address_line_2": "string",
              "admin_area_2": "string",
              "admin_area_1": "string",
              "postal_code": "string",
              "country_code": "string"
            }
          }
        },
        "risk": {
          "customer": {
            "ip_address": "string"
          }
        }
      },
      "payments": {
        "authorizations": [
          {
            "status": "CREATED",
            "status_details": {
              "reason": "PENDING_REVIEW"
            },
            "id": "string",
            "invoice_id": "string",
            "custom_id": "string",
            "links": [
              {
                "href": "string",
                "rel": "string",
                "method": "GET"
              }
            ],
            "amount": {
              "currency_code": "string",
              "value": "string"
            },
            "network_transaction_reference": {
              "id": "string",
              "date": "string",
              "acquirer_reference_number": "string",
              "network": "VISA"
            },
            "seller_protection": {
              "status": "ELIGIBLE",
              "dispute_categories": [
                "ITEM_NOT_RECEIVED"
              ]
            },
            "expiration_time": "string",
            "create_time": "string",
            "update_time": "string",
            "processor_response": {
              "avs_code": "A",
              "cvv_code": "E",
              "response_code": "0000",
              "payment_advice_code": "01"
            }
          }
        ],
        "captures": [
          {
            "create_time": "string",
            "update_time": "string",
            "id": "string",
            "invoice_id": "string",
            "custom_id": "string",
            "final_capture": false,
            "links": [
              {
                "href": "string",
                "rel": "string",
                "method": "GET"
              }
            ],
            "amount": {
              "currency_code": "string",
              "value": "string"
            },
            "network_transaction_reference": {
              "id": "string",
              "date": "string",
              "acquirer_reference_number": "string",
              "network": "VISA"
            },
            "seller_protection": {
              "status": "ELIGIBLE",
              "dispute_categories": [
                "ITEM_NOT_RECEIVED"
              ]
            },
            "seller_receivable_breakdown": {
              "platform_fees": [
                {
                  "amount": {
                    "currency_code": "string",
                    "value": "string"
                  },
                  "payee": {
                    "email_address": "string",
                    "merchant_id": "string"
                  }
                }
              ],
              "gross_amount": {
                "currency_code": "string",
                "value": "string"
              },
              "paypal_fee": {
                "currency_code": "string",
                "value": "string"
              },
              "paypal_fee_in_receivable_currency": {
                "currency_code": "string",
                "value": "string"
              },
              "net_amount": {
                "currency_code": "string",
                "value": "string"
              },
              "receivable_amount": {
                "currency_code": "string",
                "value": "string"
              },
              "exchange_rate": {
                "value": "string",
                "source_currency": "string",
                "target_currency": "string"
              }
            },
            "disbursement_mode": "INSTANT",
            "processor_response": {
              "avs_code": "A",
              "cvv_code": "E",
              "response_code": "0000",
              "payment_advice_code": "01"
            }
          }
        ],
        "refunds": [
          {
            "status": "CANCELLED",
            "status_details": {
              "reason": "ECHECK"
            },
            "id": "string",
            "invoice_id": "string",
            "custom_id": "string",
            "acquirer_reference_number": "string",
            "note_to_payer": "string",
            "seller_payable_breakdown": {
              "platform_fees": [
                {
                  "amount": {
                    "currency_code": "string",
                    "value": "string"
                  },
                  "payee": {
                    "email_address": "string",
                    "merchant_id": "string"
                  }
                }
              ],
              "net_amount_breakdown": [
                {
                  "payable_amount": {
                    "currency_code": "string",
                    "value": "string"
                  },
                  "converted_amount": {
                    "currency_code": "string",
                    "value": "string"
                  },
                  "exchange_rate": {
                    "value": "string",
                    "source_currency": "string",
                    "target_currency": "string"
                  }
                }
              ],
              "gross_amount": {
                "currency_code": "string",
                "value": "string"
              },
              "paypal_fee": {
                "currency_code": "string",
                "value": "string"
              },
              "paypal_fee_in_receivable_currency": {
                "currency_code": "string",
                "value": "string"
              },
              "net_amount": {
                "currency_code": "string",
                "value": "string"
              },
              "net_amount_in_receivable_currency": {
                "currency_code": "string",
                "value": "string"
              },
              "total_refunded_amount": {
                "currency_code": "string",
                "value": "string"
              }
            },
            "links": [
              {
                "href": "string",
                "rel": "string",
                "method": "GET"
              }
            ],
            "amount": {
              "currency_code": "string",
              "value": "string"
            },
            "payer": {
              "email_address": "string",
              "merchant_id": "string"
            },
            "create_time": "string",
            "update_time": "string"
          }
        ]
      }
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ],
  "payment_source": {
    "card": {
      "name": "string",
      "last_digits": "string",
      "available_networks": [
        "VISA"
      ],
      "from_request": {
        "last_digits": "string",
        "expiry": "string"
      },
      "stored_credential": {
        "payment_initiator": "CUSTOMER",
        "payment_type": "ONE_TIME",
        "usage": "DERIVED",
        "previous_network_transaction_reference": {
          "id": "string",
          "date": "string",
          "acquirer_reference_number": "string",
          "network": "VISA"
        }
      },
      "brand": "VISA",
      "type": "CREDIT",
      "authentication_result": {
        "liability_shift": "NO",
        "three_d_secure": {
          "authentication_status": "Y",
          "enrollment_status": "Y"
        }
      },
      "attributes": {
        "vault": {
          "id": "string",
          "status": "VAULTED",
          "links": [
            {
              "href": "string",
              "rel": "string",
              "method": "GET"
            }
          ],
          "customer": {
            "id": "string",
            "email_address": "string",
            "phone": {
              "phone_type": "FAX",
              "phone_number": {
                "national_number": "string"
              }
            },
            "name": {
              "given_name": "string",
              "surname": "string"
            },
            "merchant_customer_id": "string"
          }
        }
      },
      "expiry": "string",
      "bin_details": {
        "bin": "string",
        "issuing_bank": "string",
        "products": [
          "string"
        ],
        "bin_country_code": "string"
      }
    },
    "bancontact": {
      "card_last_digits": "string",
      "name": "string",
      "country_code": "string",
      "bic": "string",
      "iban_last_chars": "string"
    },
    "blik": {
      "name": "string",
      "country_code": "string",
      "email": "string",
      "one_click": {
        "consumer_reference": "string"
      }
    },
    "eps": {
      "name": "string",
      "country_code": "string",
      "bic": "string"
    },
    "giropay": {
      "name": "string",
      "country_code": "string",
      "bic": "string"
    },
    "ideal": {
      "name": "string",
      "country_code": "string",
      "bic": "string",
      "iban_last_chars": "string"
    },
    "mybank": {
      "name": "string",
      "country_code": "string",
      "bic": "string",
      "iban_last_chars": "string"
    },
    "p24": {
      "payment_descriptor": "string",
      "method_id": "string",
      "method_description": "string",
      "name": "string",
      "email": "string",
      "country_code": "string"
    },
    "sofort": {
      "name": "string",
      "country_code": "string",
      "bic": "string",
      "iban_last_chars": "string"
    },
    "trustly": {
      "name": "string",
      "country_code": "string",
      "email": "string",
      "bic": "string",
      "iban_last_chars": "string"
    },
    "venmo": {
      "user_name": "string",
      "attributes": {
        "vault": {
          "id": "string",
          "status": "VAULTED",
          "links": [
            {
              "href": "string",
              "rel": "string",
              "method": "GET"
            }
          ],
          "customer": {
            "id": "string",
            "name": {
              "given_name": "string",
              "surname": "string"
            }
          }
        }
      },
      "email_address": "string",
      "account_id": "string",
      "name": {
        "given_name": "string",
        "surname": "string"
      },
      "phone_number": {
        "national_number": "string"
      },
      "address": {
        "address_line_1": "string",
        "address_line_2": "string",
        "admin_area_2": "string",
        "admin_area_1": "string",
        "postal_code": "string",
        "country_code": "string"
      }
    },
    "paypal": {
      "account_status": "VERIFIED",
      "phone_type": "FAX",
      "business_name": "string",
      "attributes": {
        "vault": {
          "id": "string",
          "status": "VAULTED",
          "links": [
            {
              "href": "string",
              "rel": "string",
              "method": "GET"
            }
          ],
          "customer": {
            "id": "string",
            "email_address": "string",
            "phone": {
              "phone_type": "FAX",
              "phone_number": {
                "national_number": "string"
              }
            },
            "name": {
              "given_name": "string",
              "surname": "string"
            },
            "merchant_customer_id": "string"
          }
        },
        "cobranded_cards": [
          {
            "labels": [
              "string"
            ],
            "payee": {
              "email_address": "string",
              "merchant_id": "string"
            },
            "amount": {
              "currency_code": "string",
              "value": "string"
            }
          }
        ]
      },
      "stored_credential": {
        "payment_initiator": "CUSTOMER",
        "charge_pattern": "IMMEDIATE",
        "usage_pattern": "IMMEDIATE",
        "usage": "DERIVED"
      },
      "email_address": "string",
      "account_id": "string",
      "name": {
        "given_name": "string",
        "surname": "string"
      },
      "phone_number": {
        "national_number": "string"
      },
      "birth_date": "string",
      "tax_info": {
        "tax_id": "string",
        "tax_id_type": "BR_CPF"
      },
      "address": {
        "address_line_1": "string",
        "address_line_2": "string",
        "admin_area_2": "string",
        "admin_area_1": "string",
        "postal_code": "string",
        "country_code": "string"
      }
    },
    "apple_pay": {
      "id": "string",
      "token": "string",
      "stored_credential": {
        "payment_initiator": "CUSTOMER",
        "payment_type": "ONE_TIME",
        "usage": "DERIVED",
        "previous_network_transaction_reference": {
          "id": "string",
          "date": "string",
          "acquirer_reference_number": "string",
          "network": "VISA"
        }
      },
      "name": "string",
      "email_address": "string",
      "phone_number": {
        "national_number": "string"
      },
      "card": {
        "name": "string",
        "last_digits": "string",
        "available_networks": [
          "VISA"
        ],
        "from_request": {
          "last_digits": "string",
          "expiry": "string"
        },
        "stored_credential": {
          "payment_initiator": "CUSTOMER",
          "payment_type": "ONE_TIME",
          "usage": "DERIVED",
          "previous_network_transaction_reference": {
            "id": "string",
            "date": "string",
            "acquirer_reference_number": "string",
            "network": "VISA"
          }
        },
        "brand": "VISA",
        "type": "CREDIT",
        "authentication_result": {
          "liability_shift": "NO",
          "three_d_secure": {
            "authentication_status": "Y",
            "enrollment_status": "Y"
          }
        },
        "attributes": {
          "vault": {
            "id": "string",
            "status": "VAULTED",
            "links": [
              {
                "href": "string",
                "rel": "string",
                "method": "GET"
              }
            ],
            "customer": {
              "id": "string",
              "email_address": "string",
              "phone": {
                "phone_type": "FAX",
                "phone_number": {
                  "national_number": "string"
                }
              },
              "name": {
                "given_name": "string",
                "surname": "string"
              },
              "merchant_customer_id": "string"
            }
          }
        },
        "expiry": "string",
        "bin_details": {
          "bin": "string",
          "issuing_bank": "string",
          "products": [
            "string"
          ],
          "bin_country_code": "string"
        },
        "billing_address": {
          "address_line_1": "string",
          "address_line_2": "string",
          "admin_area_2": "string",
          "admin_area_1": "string",
          "postal_code": "string",
          "country_code": "string"
        },
        "country_code": "string"
      },
      "attributes": {
        "vault": {
          "id": "string",
          "status": "VAULTED",
          "links": [
            {
              "href": "string",
              "rel": "string",
              "method": "GET"
            }
          ],
          "customer": {
            "id": "string",
            "name": {
              "given_name": "string",
              "surname": "string"
            }
          }
        }
      }
    },
    "google_pay": {
      "name": "string",
      "email_address": "string",
      "phone_number": {
        "country_code": "string",
        "national_number": "string"
      },
      "card": {
        "name": "string",
        "last_digits": "string",
        "type": "CREDIT",
        "brand": "VISA",
        "billing_address": {
          "address_line_1": "string",
          "address_line_2": "string",
          "admin_area_2": "string",
          "admin_area_1": "string",
          "postal_code": "string",
          "country_code": "string"
        },
        "authentication_result": {
          "liability_shift": "NO",
          "three_d_secure": {
            "authentication_status": "Y",
            "enrollment_status": "Y"
          }
        }
      }
    }
  },
  "intent": "CAPTURE",
  "payer": {
    "email_address": "string",
    "payer_id": "string",
    "name": {
      "given_name": "string",
      "surname": "string"
    },
    "phone": {
      "phone_type": "FAX",
      "phone_number": {
        "national_number": "string"
      }
    },
    "birth_date": "string",
    "tax_info": {
      "tax_id": "string",
      "tax_id_type": "BR_CPF"
    },
    "address": {
      "address_line_1": "string",
      "address_line_2": "string",
      "admin_area_2": "string",
      "admin_area_1": "string",
      "postal_code": "string",
      "country_code": "string"
    }
  },
  "status": "CREATED"
}

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

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

message stringrequired

The message that describes the error.

debug_id stringrequired

The PayPal internal ID. Used for correlation purposes.

details object[]

An array of additional details about the error.

links object[]

An array of request-related HATEOAS links.

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

Authorization failed due to insufficient permissions.

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

message stringrequired

The message that describes the error.

debug_id stringrequired

The PayPal internal ID. Used for correlation purposes.

details object[]

An array of additional details about the error.

links object[]

An array of request-related HATEOAS links.

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

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

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

message stringrequired

The message that describes the error.

debug_id stringrequired

The PayPal internal ID. Used for correlation purposes.

details object[]

An array of additional details about the error.

links object[]

An array of request-related HATEOAS links.

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

An internal server error has occurred.

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

message stringrequired

The message that describes the error.

debug_id stringrequired

The PayPal internal ID. Used for correlation purposes.

details object[]

An array of additional details about the error.

links object[]

An array of request-related HATEOAS links.

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

The error response.

application/json

Schema
Example (from schema)

Schema

name stringrequired

The human-readable, unique name of the error.

message stringrequired

The message that describes the error.

debug_id stringrequired

The PayPal internal ID. Used for correlation purposes.

details object[]

An array of additional details about the error.

links object[]

An array of request-related HATEOAS links.

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

Confirm the Order

/orders/:id/confirm-payment-source

Request​

Path Parameters

Header Parameters

Body

Responses​

Request

Responses