API Version

Orders API

An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders.

Orders (resource group)

Use the /orders resource to create, update, retrieve, authorize, and capture orders.

Create order

POST/v2/checkout/orders

Creates an order.

Note: For error handling and troubleshooting, see Orders v2 errors.

Header parameters

PayPal-Request-Id
string
The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.
Maximum length: 36.
PayPal-Partner-Attribution-Id
string
Maximum length: 36.
PayPal-Client-Metadata-Id
string
Maximum length: 36.
Prefer
string
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.
Maximum length: 25.
Authorization
string
required
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>.
Content-Type
string
required
The media type. Required for operations with a request body. The value is application/<format>, where format is json.
Maximum length: 255.

Request body

intent
enum
required
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit_request object)
required
An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
application_context
object
Customize the payer experience during the approval process for the payment with PayPal.

Sample Request

curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 7b92603e-77ed-4896-8e78-5dea2050476a" \
-d '{
  "intent": "CAPTURE",
  "purchase_units": [
    {
      "reference_id": "REFID-000-1001",
      "amount": {
        "currency_code": "CAD",
        "value": "10.00"
      },
      "payee": {
        "email_address": "seller@paypal.com"
      },
      "payment_instruction": {
        "platform_fees": [
          {
            "amount": {
              "currency_code": "CAD",
              "value": "1.00"
            },
            "payee": {
              "email_address": "_sys_aquarium-1696754097380342@paypal.com"
            }
          }
        ],
        "disbursement_mode": "INSTANT",
        "payee_pricing_tier_id": "999ZAE"
      }
    }
  ],
  "payment_source": {
    "apple_pay": {
      "id": "DSF32432423FSDFS",
      "name": "Randy Oscar",
      "email_address": "randy.oscar@gmail.com",
      "phone_number": {
        "country_code": "1",
        "national_number": "18882211161"
      },
      "shipping": {
        "name": {
          "given_name": "Randy",
          "surname": "Oscar"
        },
        "email_address": "randy.oscar@gmail.com",
        "address": {
          "address_line_1": "123 Townsend S",
          "address_line_2": "Floor 6",
          "admin_area_2": "San Francisc",
          "admin_area_1": "CA",
          "postal_code": "94107",
          "country_code": "US"
        }
      },
      "decrypted_token": {
        "transaction_amount": {
          "currency_code": "USD",
          "value": "10.00"
        },
        "tokenized_card": {
          "number": "4111111111114672",
          "expiry": "2022-02",
          "billing_address": {
            "address_line_1": "123 Townsend S",
            "address_line_2": "Floor 6",
            "admin_area_2": "San Francisc",
            "admin_area_1": "CA",
            "postal_code": "94107",
            "country_code": "US"
          }
        },
        "device_manufacturer_id": "040010030273",
        "payment_data_type": "3DSECURE",
        "payment_data": {
          "cryptogram": "SaDA0Gw9cR37j8xrZP6VFCJpa",
          "eci_indicator": "7"
        }
      }
    }
  }
}'

Response

A successful request returns the HTTP 201 Created status code and a JSON response body that includes by default a minimal response with the ID, status, and HATEOAS links. If you require the complete order resource representation, you must pass the Prefer: return=representation request header. This header value is not the default.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
id
string
The ID of the order.
Read only.
payment_source
object
The payment source used to fund the payment.
intent
enum
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
Minimum length: 1.
Maximum length: 36.
Pattern: ^[0-9A-Z_]+$.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit 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.
status
enum
The order status.
The possible values are:
- CREATED. The order was created with the specified context.
- SAVED. The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.
- APPROVED. The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.
- VOIDED. All purchase units in the order are voided.
- COMPLETED. The payment was authorized or the authorized payment was captured for the order.
- PAYER_ACTION_REQUIRED. The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order.
Read only.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
links
array (contains the link_description object)
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.
Read only.

Sample Response

{
  "id": "6WU455923F879071T",
  "intent": "CAPTURE",
  "status": "COMPLETED",
  "payment_source": {
    "apple_pay": {
      "card": {
        "name": "Randy Oscar",
        "last_digits": "4672",
        "brand": "VISA",
        "type": "CREDIT",
        "billing_address": {
          "address_line_1": "2211 N First Street",
          "address_line_2": "Building 17",
          "admin_area_2": "San Jose",
          "admin_area_1": "CA",
          "postal_code": "95131",
          "country_code": "US"
        }
      }
    }
  },
  "purchase_units": [
    {
      "reference_id": "REFID-000-1001",
      "amount": {
        "currency_code": "CAD",
        "value": "10.00"
      },
      "payee": {
        "merchant_id": "CWL4VKR4T8VE2"
      },
      "payment_instruction": {
        "platform_fees": [
          {
            "amount": {
              "currency_code": "CAD",
              "value": "1.00"
            },
            "payee": {
              "merchant_id": "FCDNN9FSYBZK4"
            }
          }
        ],
        "disbursement_mode": "INSTANT",
        "payee_pricing_tier_id": "999ZAE"
      },
      "soft_descriptor": "PP *SOFT-1001",
      "payments": {
        "captures": [
          {
            "id": "45E71580WN564964G",
            "status": "COMPLETED",
            "amount": {
              "currency_code": "CAD",
              "value": "10.00"
            },
            "final_capture": true,
            "disbursement_mode": "INSTANT",
            "seller_protection": {
              "status": "INELIGIBLE"
            },
            "seller_receivable_breakdown": {
              "gross_amount": {
                "currency_code": "CAD",
                "value": "10.00"
              },
              "paypal_fee": {
                "currency_code": "CAD",
                "value": "0.59"
              },
              "platform_fees": [
                {
                  "amount": {
                    "currency_code": "CAD",
                    "value": "1.00"
                  },
                  "payee": {
                    "merchant_id": "FCDNN9FSYBZK4"
                  }
                }
              ],
              "net_amount": {
                "currency_code": "CAD",
                "value": "8.41"
              },
              "receivable_amount": {
                "currency_code": "USD",
                "value": "8.20"
              },
              "exchange_rate": {
                "source_currency": "CAD",
                "target_currency": "USD",
                "value": "0.974805272898685"
              }
            },
            "links": [
              {
                "href": "https://api-m.paypal.com/v2/payments/captures/45E71580WN564964G",
                "rel": "self",
                "method": "GET"
              },
              {
                "href": "https://api-m.paypal.com/v2/payments/captures/45E71580WN564964G/refund",
                "rel": "refund",
                "method": "POST"
              },
              {
                "href": "https://api-m.paypal.com/v2/checkout/orders/6WU455923F879071T",
                "rel": "up",
                "method": "GET"
              }
            ],
            "create_time": "2020-07-13T22:52:43Z",
            "update_time": "2020-07-13T22:52:43Z"
          }
        ]
      }
    }
  ],
  "create_time": "2020-07-13T22:52:43Z",
  "update_time": "2020-07-13T22:52:43Z",
  "links": [
    {
      "href": "https://api-m.paypal.com/v2/checkout/orders/6WU455923F879071T",
      "rel": "self",
      "method": "GET"
    }
  ]
}

Update order

PATCH/v2/checkout/orders/{id}

Updates an order with a CREATED or APPROVED status. You cannot update an order with the COMPLETED status.

To make an update, you must provide a reference_id. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to default which enables you to use the path: "/purchase_units/@reference_id=='default'/{attribute-or-object}".

Note: For error handling and troubleshooting, see Orders v2 errors.

Patchable attributes or objects:

Attribute	Op	Notes
`intent`	replace
`payer`	replace, add	Using replace op for `payer` will replace the whole `payer` object with the value sent in request.
`purchase_units`	replace, add
`purchase_units[].custom_id`	replace, add, remove
`purchase_units[].description`	replace, add, remove
`purchase_units[].payee.email`	replace
`purchase_units[].shipping.name`	replace, add
`purchase_units[].shipping.address`	replace, add
`purchase_units[].shipping.type`	replace, add
`purchase_units[].soft_descriptor`	replace, remove
`purchase_units[].amount`	replace
`purchase_units[].invoice_id`	replace, add, remove
`purchase_units[].payment_instruction`	replace
`purchase_units[].payment_instruction.disbursement_mode`	replace	By default, `disbursement_mode` is `INSTANT`.
`purchase_units[].payment_instruction.platform_fees`	replace, add, remove
`application_context.client_configuration`	replace, add

Header parameters

Authorization
string
required
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>.
Content-Type
string
required
The media type. Required for operations with a request body. The value is application/<format>, where format is json.
Maximum length: 255.

Path parameters

id
string
required
The ID of the order to update.

Request body

patch_request
array (contains the patch object)
An array of JSON patch objects to apply partial updates to resources.

Sample Request

curl -v -X PATCH https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '[
  {
    "op": "replace",
    "path": "/purchase_units/@reference_id=='PUHF'/shipping/address",
    "value": {
      "address_line_1": "123 Townsend St",
      "address_line_2": "Floor 6",
      "admin_area_2": "San Francisco",
      "admin_area_1": "CA",
      "postal_code": "94107",
      "country_code": "US"
    }
  }
]'

Response

A successful request returns the HTTP 204 No Content status code with an empty object in the JSON response body.

Sample Response

204 No Content

Show order details

GET/v2/checkout/orders/{id}

Shows details for an order, by ID.

Note: For error handling and troubleshooting, see Orders v2 errors.

Query parameters

fields
string
A comma-separated list of fields that should be returned for the order. Valid filter field is payment_source.
Pattern: ^[a-z_]*$.

Header parameters

Authorization
string
required
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>.
Content-Type
string
required
The media type. Required for operations with a request body. The value is application/<format>, where format is json.
Maximum length: 255.

Path parameters

id
string
required
The ID of the order for which to show details.

Sample Request

curl -v -X GET https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows order details.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
id
string
The ID of the order.
Read only.
payment_source
object
The payment source used to fund the payment.
intent
enum
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
Minimum length: 1.
Maximum length: 36.
Pattern: ^[0-9A-Z_]+$.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit 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.
status
enum
The order status.
The possible values are:
- CREATED. The order was created with the specified context.
- SAVED. The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.
- APPROVED. The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.
- VOIDED. All purchase units in the order are voided.
- COMPLETED. The payment was authorized or the authorized payment was captured for the order.
- PAYER_ACTION_REQUIRED. The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order.
Read only.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
links
array (contains the link_description object)
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.
Read only.

Sample Response

{
  "id": "5O190127TN364715T",
  "status": "APPROVED",
  "intent": "CAPTURE",
  "payer": {
    "name": {
      "given_name": "John",
      "surname": "Doe"
    },
    "email_address": "customer@example.com",
    "payer_id": "QYR5Z8XDVJNXQ"
  },
  "purchase_units": [
    {
      "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
      "amount": {
        "currency_code": "USD",
        "value": "100.00"
      }
    }
  ],
  "create_time": "2018-04-01T21:18:49Z",
  "links": [
    {
      "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://www.paypal.com/checkoutnow?token=5O190127TN364715T",
      "rel": "approve",
      "method": "GET"
    },
    {
      "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
      "rel": "update",
      "method": "PATCH"
    },
    {
      "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/capture",
      "rel": "capture",
      "method": "POST"
    }
  ]
}

Authorize payment for order

POST/v2/checkout/orders/{id}/authorize

Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

Note: For error handling and troubleshooting, see Orders v2 errors.

Header parameters

PayPal-Request-Id
string
The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.
Maximum length: 36.
Prefer
string
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.
Maximum length: 25.
PayPal-Client-Metadata-Id
string
Maximum length: 36.
Authorization
string
required
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
string
required
The media type. Required for operations with a request body. The value is application/<format>, where format is json.
Maximum length: 255.

Path parameters

id
string
required
The ID of the order for which to authorize.

Request body

payment_source
object
The source of payment for the order, which can be a token or a card. Use this object only if you have not redirected the user after order creation to approve the payment. In such cases, the user-selected payment method in the PayPal flow is implicitly used.

Sample Request

curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/authorize \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 7b92603e-77ed-4896-8e78-5dea2050476a"

Response

A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows authorized payment details. If a duplicate response is retried, returns the HTTP 200 OK status code. By default, the response is minimal. If you need the complete resource representation, you must pass the Prefer: return=representation request header.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
id
string
The ID of the order.
Read only.
payment_source
object
The payment source used to fund the payment.
intent
enum
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit 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.
status
enum
The order status.
The possible values are:
- CREATED. The order was created with the specified context.
- SAVED. The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.
- APPROVED. The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.
- VOIDED. All purchase units in the order are voided.
- COMPLETED. The payment was authorized or the authorized payment was captured for the order.
- PAYER_ACTION_REQUIRED. The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order.
Read only.
links
array (contains the link_description object)
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.
Read only.

Sample Response

{
  "id": "5O190127TN364715T",
  "status": "COMPLETED",
  "payer": {
    "name": {
      "given_name": "John",
      "surname": "Doe"
    },
    "email_address": "customer@example.com",
    "payer_id": "QYR5Z8XDVJNXQ"
  },
  "purchase_units": [
    {
      "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
      "shipping": {
        "address": {
          "address_line_1": "2211 N First Street",
          "address_line_2": "Building 17",
          "admin_area_2": "San Jose",
          "admin_area_1": "CA",
          "postal_code": "95131",
          "country_code": "US"
        }
      },
      "payments": {
        "authorizations": [
          {
            "id": "0AW2184448108334S",
            "status": "CREATED",
            "amount": {
              "currency_code": "USD",
              "value": "100.00"
            },
            "seller_protection": {
              "status": "ELIGIBLE",
              "dispute_categories": [
                "ITEM_NOT_RECEIVED",
                "UNAUTHORIZED_TRANSACTION"
              ]
            },
            "expiration_time": "2018-05-01T21:20:49Z",
            "create_time": "2018-04-01T21:20:49Z",
            "update_time": "2018-04-01T21:20:49Z",
            "links": [
              {
                "href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S",
                "rel": "self",
                "method": "GET"
              },
              {
                "href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/capture",
                "rel": "capture",
                "method": "POST"
              },
              {
                "href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/void",
                "rel": "void",
                "method": "POST"
              },
              {
                "href": "https://api-m.paypal.com/v2/payments/authorizations/0AW2184448108334S/reauthorize",
                "rel": "reauthorize",
                "method": "POST"
              }
            ]
          }
        ]
      }
    }
  ],
  "links": [
    {
      "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
      "rel": "self",
      "method": "GET"
    }
  ]
}

Capture payment for order

POST/v2/checkout/orders/{id}/capture

Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

Note: For error handling and troubleshooting, see Orders v2 errors.

Header parameters

PayPal-Request-Id
string
The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.
Maximum length: 36.
Prefer
string
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.
Maximum length: 25.
PayPal-Client-Metadata-Id
string
Maximum length: 36.
Authorization
string
required
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
string
required
The media type. Required for operations with a request body. The value is application/<format>, where format is json.
Maximum length: 255.

Path parameters

id
string
required
The ID of the order for which to capture a payment.

Request body

payment_source
object
The payment source definition.

Sample Request

curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/32450127TN364715T/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 7b92603e-77ed-4896-8e78-5dea2050476a" \
-d '{}'

Response

A successful response to a non-idempotent request returns the HTTP 201 Created status code with a JSON response body that shows captured payment details. If a duplicate response is retried, returns the HTTP 200 OK status code. By default, the response is minimal. If you need the complete resource representation, pass the Prefer: return=representation request header.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
id
string
The ID of the order.
Read only.
payment_source
object
The payment source used to fund the payment.
intent
enum
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
Minimum length: 1.
Maximum length: 36.
Pattern: ^[0-9A-Z_]+$.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit 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.
status
enum
The order status.
The possible values are:
- CREATED. The order was created with the specified context.
- SAVED. The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.
- APPROVED. The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.
- VOIDED. All purchase units in the order are voided.
- COMPLETED. The payment was authorized or the authorized payment was captured for the order.
- PAYER_ACTION_REQUIRED. The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order.
Read only.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
links
array (contains the link_description object)
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.
Read only.

Sample Response

{
  "id": "32450127TN364715T",
  "status": "COMPLETED",
  "payment_source": {
    "apple_pay": {
      "card": {
        "name": "Randy Oscar",
        "last_digit": "0302",
        "brand": "VISA",
        "type": "CREDIT",
        "billing_address": {
          "address_line_1": "2211 N First Street",
          "address_line_2": "Building 17",
          "admin_area_2": "San Jose",
          "admin_area_1": "CA",
          "postal_code": "95131",
          "country_code": "US"
        }
      }
    }
  },
  "purchase_units": [
    {
      "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",
      "shipping": {
        "address": {
          "address_line_1": "2211 N First Street",
          "address_line_2": "Building 17",
          "admin_area_2": "San Jose",
          "admin_area_1": "CA",
          "postal_code": "95131",
          "country_code": "US"
        }
      },
      "payments": {
        "captures": [
          {
            "id": "3C679366HH908993F",
            "status": "COMPLETED",
            "amount": {
              "currency_code": "USD",
              "value": "100.00"
            },
            "seller_protection": {
              "status": "NOT_ELIGIBLE"
            },
            "final_capture": true,
            "disbursement_mode": "DELAYED",
            "seller_receivable_breakdown": {
              "gross_amount": {
                "currency_code": "USD",
                "value": "100.00"
              },
              "paypal_fee": {
                "currency_code": "USD",
                "value": "3.00"
              },
              "platform_fees": [
                {
                  "amount": {
                    "currency_code": "USD",
                    "value": "25.00"
                  },
                  "payee": {
                    "email_address": "fee@example.com"
                  }
                }
              ],
              "net_amount": {
                "currency_code": "USD",
                "value": "72.00"
              }
            },
            "create_time": "2021-04-09T21:20:49Z",
            "update_time": "2021-04-09T21:20:49Z",
            "links": [
              {
                "href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F",
                "rel": "self",
                "method": "GET"
              },
              {
                "href": "https://api-m.paypal.com/v2/payments/captures/3C679366HH908993F/refund",
                "rel": "refund",
                "method": "POST"
              }
            ]
          }
        ]
      }
    }
  ],
  "links": [
    {
      "href": "https://api-m.paypal.com/v2/checkout/orders/32450127TN364715T",
      "rel": "self",
      "method": "GET"
    }
  ]
}

Confirm the Order

POST/v2/checkout/orders/{id}/confirm-payment-source

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

Header parameters

PayPal-Client-Metadata-Id
string
Maximum length: 36.
Authorization
string
required
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>.
Content-Type
string
required
The media type. Required for operations with a request body. The value is application/<format>, where format is json.
Maximum length: 255.
Prefer
string
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.
Maximum length: 25.

Path parameters

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

Request body

payment_source
object
required
The payment source definition.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
application_context
object
Customizes the payer confirmation experience.

Sample Request

curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders/5O190127TN364715T/confirm-payment-source \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
  "payment_source": {
    "alipay": {
      "name": "John Doe",
      "country_code": "C2"
    }
  },
  "application_context": {
    "locale": "en-PT",
    "return_url": "https://example.com/returnUrl",
    "cancel_url": "https://example.com/cancelUrl"
  }
}'

Response

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.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
id
string
The ID of the order.
Read only.
payment_source
object
The payment source used to fund the payment.
intent
enum
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
Minimum length: 1.
Maximum length: 36.
Pattern: ^[0-9A-Z_]+$.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit 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.
status
enum
The order status.
The possible values are:
- CREATED. The order was created with the specified context.
- SAVED. The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.
- APPROVED. The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.
- VOIDED. All purchase units in the order are voided.
- COMPLETED. The payment was authorized or the authorized payment was captured for the order.
- PAYER_ACTION_REQUIRED. The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order.
Read only.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
links
array (contains the link_description object)
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.
Read only.

Sample Response

{
  "id": "5O190127TN364715T",
  "status": "PAYER_ACTION_REQUIRED",
  "payment_source": {
    "alipay": {
      "name": "John Doe",
      "country_code": "C2"
    }
  },
  "links": [
    {
      "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://www.paypal.com/payment/alipay?token=5O190127TN364715T",
      "rel": "payer-action",
      "method": "GET"
    }
  ]
}

Common object definitions

account_id

account_id
string
The account identifier for a PayPal account.
Minimum length: 13.
Maximum length: 13.
Pattern: ^[2-9A-HJ-NP-Z]{13}$.

account_id

account_id
string
The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
Minimum length: 13.
Maximum length: 13.
Pattern: ^[2-9A-HJ-NP-Z]{13}$.

account_tag

account_tag
string
Account tag in User domain by other clients Eg: YOUTH_ACCOUNT, RESTRICTED, WAX_USER, MASSPAY_ENABLED etc.
Minimum length: 1.
Maximum length: 255.

account_tier

account_tier
enum
Paypal account type
The possible values are:
- BUSINESS. PayPal Business account
- PERSONAL. PayPal personal account
- PREMIER. PayPal Premier account
Minimum length: 1.
Maximum length: 100.
Pattern: ^([A-Z]|<blockquote>[A-Z]).

ach_debit

account_number
string
required
The US bank account number from which the payment will be debited.
Minimum length: 3.
Maximum length: 17.
Pattern: [0-9]{3,17}.
routing_number
string
required
The 9-digit ABA routing transit number for the bank at which the account is held.
Minimum length: 9.
Maximum length: 9.
Pattern: [0-9]{9}.
account_type
enum
Represents the type of the bank account. If not provided, default is CHECKING.
The possible values are:
- CHECKING. Bank account of type CHECKING.
- SAVINGS. Bank account of type SAVINGS.
Minimum length: 1.
Maximum length: 255.
account_holder_name
string
required
Name of the person or business that owns the bank account.
Minimum length: 1.
Maximum length: 300.
attributes

ach_debit_response

last_digits
string
The last 4 digits of the bank account number.
Read only.
Minimum length: 4.
Maximum length: 4.
Pattern: [0-9]{4}.
routing_number
string
The 9-digit ABA routing transit number for the bank at which the account is held.
Read only.
Minimum length: 9.
Maximum length: 9.
Pattern: [0-9]{9}.
account_holder_name
string
Name of the person or business that owns the bank account.
Read only.
Minimum length: 1.
Maximum length: 300.
attributes
The attributes of ach debit.

activity_timestamps

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Read only.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

address_details

street_number
string
The street number.
Maximum length: 100.
street_name
string
The street name. Just Drury in Drury Lane.
Maximum length: 100.
street_type
string
The street type. For example, avenue, boulevard, road, or expressway.
Maximum length: 100.
delivery_service
string
The delivery service. Post office box, bag number, or post office name.
Maximum length: 100.
building_name
string
A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.
Maximum length: 100.
sub_building
string
The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.
Maximum length: 100.

address_name

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.
Maximum length: 300.
address_line_2
string
The second line of the address, for example, a suite or apartment number.
Maximum length: 300.
address_line_3
string
The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
Maximum length: 100.
admin_area_4
string
The neighborhood, ward, or district. This is smaller than admin_area_level_3 or sub_locality. Value is:
- The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
- The fine-grained administrative levels in China.
Maximum length: 100.
admin_area_3
string
The sub-locality, suburb, neighborhood, or district. This is smaller than admin_area_level_2. Value is:
- Brazil. Suburb, bairro, or neighborhood.
- India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.
Maximum length: 100.
admin_area_2
string
A city, town, or village. Smaller than admin_area_level_1.
Maximum length: 120.
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.
Maximum length: 300.
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.
Maximum length: 60.
country_code
string
required
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_details
object
The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

addressee
string
The name on the address, for example, Mr J. Smith.
Minimum length: 1.
Maximum length: 200.

address_portable

address_line_1
string
The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
Maximum length: 300.
address_line_2
string
The second line of the address. For example, suite or apartment number.
Maximum length: 300.
address_line_3
string
The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
Maximum length: 100.
admin_area_4
string
The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:
- The postal sorting code for Guernsey and many French territories, such as French Guiana.
- The fine-grained administrative levels in China.
Maximum length: 100.
admin_area_3
string
A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:
- Brazil. Suburb, bairro, or neighborhood.
- India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.
Maximum length: 100.
admin_area_2
string
A city, town, or village. Smaller than admin_area_level_1.
Maximum length: 120.
admin_area_1
string
The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format 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.
Maximum length: 300.
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.
Maximum length: 60.
country_code
string
required
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Minimum length: 2.
Maximum length: 2.
Pattern: ^([A-Z]{2}|C2)$.
address_details
object
The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

address_portable

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.
Maximum length: 300.
address_line_2
string
The second line of the address, for example, a suite or apartment number.
Maximum length: 300.
address_line_3
string
The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.
Maximum length: 100.
admin_area_4
string
The neighborhood, ward, or district. This is smaller than admin_area_level_3 or sub_locality. Value is:
- The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
- The fine-grained administrative levels in China.
Maximum length: 100.
admin_area_3
string
The sub-locality, suburb, neighborhood, or district. This is smaller than admin_area_level_2. Value is:
- Brazil. Suburb, bairro, or neighborhood.
- India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.
Maximum length: 100.
admin_area_2
string
A city, town, or village. Smaller than admin_area_level_1.
Maximum length: 120.
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.
Maximum length: 300.
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.
Maximum length: 60.
country_code
string
required
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
address_details
object
The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

address_portable

address_line_1
string
The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
Maximum length: 300.
address_line_2
string
The second line of the address. For example, suite or apartment number.
Maximum length: 300.
admin_area_2
string
A city, town, or village. Smaller than admin_area_level_1.
Maximum length: 120.
admin_area_1
string
The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format 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.
Maximum length: 300.
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.
Maximum length: 60.
country_code
string
required
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

address_portable_postal_code_validation

address_portable_postal_code_validation

address_portable_postal_code_validation

address_portable_postal_code_validation

amount_breakdown

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.
shipping
object
The shipping fee for all items within a given purchase_unit. shipping.value can not be a negative number.
handling
object
The handling fee for all items within a given purchase_unit. handling.value can not be a negative number.
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.
insurance
object
The insurance fee for all items within a given purchase_unit. insurance.value can not be a negative number.
shipping_discount
object
The shipping discount for all items within a given purchase_unit. shipping_discount.value can not be a negative number.
discount
object
The discount for all items within a given purchase_unit. discount.value can not be a negative number.

amount_with_breakdown

currency_code
string
required
The three-character ISO-4217 currency code that identifies the currency.
Minimum length: 3.
Maximum length: 3.
value
string
required
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.
Maximum length: 32.
Pattern: ^((-?[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.

apple_pay_decrypted_token_data

transaction_amount
object
required
The transaction amount for the payment that the payer has approved on apple platform.
tokenized_card
object
required
Apple Pay tokenized credit card used to pay.
device_manufacturer_id
string
required
Apple Pay Hex-encoded device manufacturer identifier.
Minimum length: 1.
Maximum length: 2000.
payment_data_type
enum
required
Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.
The possible values are:
- 3DSECURE. The card was authenticated using 3D Secure (3DS) authentication scheme. While using this value make sure to populate cryptogram and eci_indicator as part of payment data..
- EMV. The card was authenticated using EMV method, which is applicable for China. While using this value make sure to pass emv_data and pin as part of payment data.
Minimum length: 1.
Maximum length: 16.
Pattern: ^[0-9A-Z_]+$.
payment_data
object
required
Apple Pay payment data object which contains the cryptogram, eci_indicator and other data.

apple_pay_decrypted_token_data.card

name
string
The card holder's name as it appears on the card.
Maximum length: 300.
number
string
The primary account number (PAN) for the payment card.
Minimum length: 13.
Maximum length: 19.
expiry
string
The card expiration year and month, in Internet date format.
card_type
enum
The card brand or network. Typically used in the response.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
Read only.
type
enum
The payment card type.
The possible values are:
- CREDIT. A credit card.
- DEBIT. A debit card.
- PREPAID. A Prepaid card.
- STORE. A store card.
- UNKNOWN. Card type cannot be determined.
brand
enum
The card brand or network. Typically used in the response.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
billing_address
object
required
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.

apple_pay_payment_data

cryptogram
string
Online payment cryptogram, as defined by 3D Secure.
Minimum length: 1.
Maximum length: 2000.
eci_indicator
string
ECI indicator, as defined by 3- Secure.
Minimum length: 1.
Maximum length: 256.
emv_data
string
Encoded Apple Pay EMV Payment Structure used for payments in China.
Minimum length: 1.
Maximum length: 2000.
pin
string
Bank Key encrypted Apple Pay PIN.
Minimum length: 1.
Maximum length: 2000.

authentication_response

liability_shift
enum
Liability shift indicator. The outcome of the issuer's authentication.
The possible values are:
- YES. Liability has shifted to the card issuer. Available only after order is authorized or captured.
- NO. Liability is with the merchant.
- POSSIBLE. Liability may shift to the card issuer. Available only before order is authorized or captured.
- UNKNOWN. The authentication system is not available.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
three_d_secure
object
Results of 3D Secure Authentication.

authorization

status
string
The status for the authorized payment.
status_details
object
The details of the authorized order pending status.

id
string
The PayPal-generated ID for the authorized payment.
amount
object
The amount for this 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.
Maximum length: 127.
seller_protection
object
The level of protection offered as defined by PayPal Seller Protection for Merchants.
expiration_time
string
The date and time when the authorized payment expires, in Internet date and time format.
links
array (contains the link_description object)
An array of related HATEOAS links.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

authorization_status

status
enum
The status for the authorized payment.
The possible values are:
- CREATED. The authorized payment is created. No captured payments have been made for this authorized payment.
- CAPTURED. The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.
- DENIED. PayPal cannot authorize funds for this authorized payment.
- EXPIRED. The authorized payment has expired.
- PARTIALLY_CAPTURED. A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.
- PARTIALLY_CREATED. The payment which was authorized for an amount that is less than the originally requested amount.
- VOIDED. The authorized payment was voided. No more captured payments can be made against this authorized payment.
- PENDING. The created authorization is in pending state. For more information, see status.details.
Read only.
status_details
object
The details of the authorized order pending status.
Read only.

authorization_status_details

reason
enum
The reason why the authorized status is PENDING.
The possible values are:
- PENDING_REVIEW. Authorization is pending manual review.
Minimum length: 1.
Maximum length: 24.
Pattern: ^[A-Z_]+$.

authorization_with_additional_data

processor_response
object
The processor response for card transactions.

bancontact

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).
Minimum length: 8.
Maximum length: 11.
iban_last_chars
string
The last characters of the IBAN used to pay.
card_last_digits
string
The last digits of the card used to fund the Bancontact payment.
Minimum length: 4.
Maximum length: 4.
Pattern: [0-9]{4}.

bancontact_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.

bic

bic
string
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
Minimum length: 8.
Maximum length: 11.

blik

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
email
string
The email address of the account holder associated with this payment method.
Minimum length: 3.
Maximum length: 254.
Pattern: ^.+@[^"\-].+$.

blik_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.
email
string
The email address of the account holder associated with this payment method.

business_name

business_name
string
Required. The business name of the party.
Maximum length: 300.
orthography
enum
The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on most widely used writing systems.
The possible values are:
- Zyyy. The orthography cannot be determined.
- Zzzz. The orthography is unknown.
- Kana. An angular form of Japanese writing for words of foreign origin.
- Cyrl. The Slavic languages alphabet. Used in eastern Europe.
- Arab. The Arabic language alphabet.
- Armn. The Armenian alphabet.
- Beng. The Bengali alphabet. Used in eastern India.
- Cans. The Unified Canadian Aboriginal Syllabics alphabet.
- Deva. The Devanagari (Nagari) alphabet.
- Ethi. The Ethiopic alphabet.
- Geor. The Georgian (Mkhedruli and Mtavruli) alphabet.
- Grek. The Greek alphabet.
- Gujr. The Gujurati language alphabet. Used in western India.
- Guru. The Gurmukhi alphabet. Used in the northern Indian state of Punjab.
- Hani. The Han (Hanzi, Kanji, Hanja) alphabet.
- Hebr. The Hebrew alphabet.
- Java. The Javanese alphabet.
- Jpan. The Japanese (alias for Han + Hiragana + Katakana) alphabet.
- Khmr. The Khmer alphabet.
- Knda. The Kannada alphabet. Used in the southern Indian state of Karnataka.
- Kore. Korean (alias for Hangul + Han).
- Laoo. The Lao alphabet.
- Latn. The Latin alphabet.
- Mlym. The Malayalam alphabet. Used in the southern Indian state of Kerala.
- Mong. The Mongolian alphabet.
- Mymr. The Myanmar (Burmese) alphabet.
- Orya. The Oriya (Odia) alphabet. Used in the eastern Indian state of Odisha.
- Sinh. The Sinhala alphabet.
- Sund. The Sundanese alphabet.
- Syrc. The Syriac alphabet.
- Taml. The Tamil alphabet. Used in the southern Indian state of Tamilnadu.
- Telu. The Telugu language alphabet. Used in the southern Indian state of Andhra pradesh.
- Thaa. The Thaana (Maldivian) alphabet.
- Thai. The Thai alphabet. Used in Thailand.
- Tibt. The Tibetan alphabet.
- Yiii. The Yi alphabet.
Minimum length: 4.
Maximum length: 4.
Pattern: ^[A-Z][a-z]{3}$.

business_name_validation

business_name_validation

business_type

business_type
enum
The business types classified
The possible values are:
- ANY_OTHER_BUSINESS_ENTITY. The any other business entity.
- ASSOCIATION. The association.
- CORPORATION. The corporation.
- GENERAL_PARTNERSHIP. The general partnership.
- GOVERNMENT. The government.
- INDIVIDUAL. The individual.
- LIMITED_LIABILITY_PARTNERSHIP. The limited liability partnership.
- LIMITED_LIABILITY_PROPRIETORS. The limited liability proprietors.
- LIMITED_LIABILITY_PRIVATE_CORPORATION. The limited liability private corporation.
- LIMITED_PARTNERSHIP. The limited partnership.
- LIMITED_PARTNERSHIP_PRIVATE_CORPORATION. The limited partnership private corporation.
- NONPROFIT. The nonprofit.
- ONLY_BUY_OR_SEND_MONEY. The only buy and send money.
- OTHER_CORPORATE_BODY. The other corporate body.
- PARTNERSHIP. The partnership.
- PRIVATE_PARTNERSHIP. The private partnership.
- PROPRIETORSHIP. The proprietorship.
- PROPRIETORSHIP_CRAFTSMAN. The proprietorship craftsman.
- PROPRIETORY_COMPANY. The proprietory company.
- PRIVATE_CORPORATION. The private corporation.
- PUBLIC_COMPANY. The public company.
- PUBLIC_CORPORATION. The public corporation.
- PUBLIC_PARTNERSHIP. The public partnership.
- REGISTERED_COOPERATIVE. A group of private owners who have registered their bsuiness.
Minimum length: 1.
Maximum length: 255.
Pattern: ^([A-Z]|<blockquote>[A-Z]).

capture

status
string
The status of the captured payment.
status_details
object
The details of the captured payment status.

id
string
The PayPal-generated ID for the captured payment.
amount
object
The amount for this 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.
Maximum length: 127.
seller_protection
object
The level of protection offered as defined by PayPal Seller Protection for Merchants.
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.
seller_receivable_breakdown
object
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
disbursement_mode
string
The funds that are held on behalf of the merchant.
links
array (contains the link_description object)
An array of related HATEOAS links.
processor_response
object
An object that provides additional processor information for a direct credit card transaction.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

capture_status

status
enum
The status of the captured payment.
The possible values are:
- COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.
- DECLINED. The funds could not be captured.
- PARTIALLY_REFUNDED. An amount less than this captured payment's amount was partially refunded to the payer.
- PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.
- REFUNDED. An amount greater than or equal to this captured payment's amount was refunded to the payer.
- FAILED. There was an error while capturing payment.
Read only.
status_details
object
The details of the captured payment status.
Read only.

capture_status_details

reason
enum
The reason why the captured payment status is PENDING or DENIED.
The possible values are:
- BUYER_COMPLAINT. The payer initiated a dispute for this captured payment with PayPal.
- CHARGEBACK. The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment.
- ECHECK. The payer paid by an eCheck that has not yet cleared.
- INTERNATIONAL_WITHDRAWAL. Visit your online account. In your **Account Overview**, accept and deny this payment.
- OTHER. No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal.
- PENDING_REVIEW. The captured payment is pending manual review.
- RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION. The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee.
- REFUNDED. The captured funds were refunded.
- TRANSACTION_APPROVED_AWAITING_FUNDING. The payer must send the funds for this captured payment. This code generally appears for manual EFTs.
- UNILATERAL. The payee does not have a PayPal account.
- VERIFICATION_REQUIRED. The payee's PayPal account is not verified.
Minimum length: 1.
Maximum length: 64.
Pattern: ^[A-Z_]+$.

card

id
string
The PayPal-generated ID for the card.
Read only.
name
string
The card holder's name as it appears on the card.
Maximum length: 300.
number
string
required
The primary account number (PAN) for the payment card.
Minimum length: 13.
Maximum length: 19.
expiry
string
required
The card expiration year and month, in Internet date format.
Minimum length: 7.
Maximum length: 7.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$.
security_code
string
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.
Minimum length: 3.
Maximum length: 4.
Pattern: [0-9]{3,4}.
last_digits
string
The last digits of the payment card.
Read only.
Minimum length: 2.
Pattern: [0-9]{2,}.
card_type
enum
The card brand or network. Typically used in the response.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
Read only.
type
enum
The payment card type.
The possible values are:
- CREDIT. A credit card.
- DEBIT. A debit card.
- PREPAID. A Prepaid card.
- STORE. A store card.
- UNKNOWN. Card type cannot be determined.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
brand
enum
The card brand or network. Typically used in the response.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
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.

card

name
string
The card holder's name as it appears on the card.
Maximum length: 300.
number
string
required
The primary account number (PAN) for the payment card.
Minimum length: 13.
Maximum length: 19.
expiry
string
required
The card expiration year and month, in Internet date format.
card_type
enum
The card brand or network. Typically used in the response.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
Read only.
type
enum
The payment card type.
The possible values are:
- CREDIT. A credit card.
- DEBIT. A debit card.
- PREPAID. A Prepaid card.
- STORE. A store card.
- UNKNOWN. Card type cannot be determined.
brand
enum
The card brand or network. Typically used in the response.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
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.

card.address_portable

address_line_1
string
The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
Maximum length: 300.
address_line_2
string
The second line of the address. For example, suite or apartment number.
Maximum length: 300.
admin_area_2
string
A city, town, or village. Smaller than admin_area_level_1.
Maximum length: 120.
admin_area_1
string
The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format 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.
Maximum length: 300.
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.
Maximum length: 60.
country_code
string
required
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

card_brand

card_brand
enum
The card network or brand. Applies to credit, debit, gift, and payment cards.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

card_response

name
string
The card holder's name as it appears on the card.
Minimum length: 2.
Maximum length: 300.
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.
last_digits
string
The last digits of the payment card.
Read only.
Pattern: [0-9]{2,}.
brand
enum
The card brand or network. Typically used in the response.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.
Read only.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
type
enum
The payment card type.
The possible values are:
- CREDIT. A credit card.
- DEBIT. A debit card.
- PREPAID. A Prepaid card.
- UNKNOWN. Card type cannot be determined.
Read only.
authentication_result
object
Results of Authentication such as 3D Secure.

card_response.address_portable

address_line_1
string
The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
Maximum length: 300.
address_line_2
string
The second line of the address. For example, suite or apartment number.
Maximum length: 300.
admin_area_2
string
A city, town, or village. Smaller than admin_area_level_1.
Maximum length: 120.
admin_area_1
string
The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format 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.
Maximum length: 300.
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.
Maximum length: 60.
country_code
string
required
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

card_type

card_type
enum
Type of card. i.e Credit, Debit and so on.
The possible values are:
- CREDIT. A credit card.
- DEBIT. A debit card.
- PREPAID. A Prepaid card.
- STORE. A store card.
- UNKNOWN. Card type cannot be determined.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

checkout_payment_intent

checkout_payment_intent
enum
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.

confirm_order_request

payment_source
object
required
The payment source definition.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
application_context
object
Customizes the payer confirmation experience.

contingency

contingency
enum
An action to be taken on a payment method to validate it.
The possible values are:
- 3D_SECURE. When specified, 3D Secure contingency will be triggered on 3DS enabled cards, if required.
Minimum length: 9.
Maximum length: 9.
Pattern: ^[0-9A-Z_]+$.

country_code

country_code
string
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Minimum length: 2.
Maximum length: 2.
Pattern: ^([A-Z]{2}|C2)$.

country_code

country_code
string
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Minimum length: 2.
Maximum length: 2.
Pattern: ^([A-Z]{2}|C2)$.

currency_code

currency_code
string
The three-character ISO-4217 currency code that identifies the currency.
Minimum length: 3.
Maximum length: 3.

currency_code

currency_code
string
The 3-character ISO-4217 currency code that identifies the currency.
Minimum length: 3.
Maximum length: 3.

customer_service_instructions

customer_service_instructions
string
The contact address for the merchant's customer service.
Maximum length: 256.

date_no_time

date_no_time
string
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
Minimum length: 10.
Maximum length: 10.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$.

date_no_time

date_no_time
string
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
Minimum length: 10.
Maximum length: 10.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$.

date_time

date_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

date_time

date_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

date_year_month

date_year_month
string
The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
Minimum length: 7.
Maximum length: 7.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$.

deposit_bank_details

bic
string
The bank identification code (BIC).
bank_name
string
The name of the bank.
Minimum length: 1.
Maximum length: 127.
iban
string
International Bank Account Number (IBAN) is used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 'Banking and related financial services - International Bank Account Number (IBAN)' version 1997-10-01, or later revisions. Either JWT unsecured or encrypted. This doesn't support Unicode characters.
Minimum length: 10.
Maximum length: 34.
Pattern: ^[A-Z0-9\s-.\\]+$.
account_holder_name
Name of the person or business that owns the bank account.

disbursement_mode

disbursement_mode
enum
The funds that are held on behalf of the merchant.
The possible values are:
- INSTANT. The funds are released to the merchant immediately.
- DELAYED. The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.
Minimum length: 1.
Maximum length: 16.
Pattern: ^[A-Z_]+$.

dispute_category

dispute_category
enum
The condition that is covered for the transaction.
The possible values are:
- ITEM_NOT_RECEIVED. The payer paid for an item that they did not receive.
- UNAUTHORIZED_TRANSACTION. The payer did not authorize the payment.

document_issuer

country_code
string
required
The country code where document was issued.
province_code
string
The state or province code that issued the identity document, as defined by ISO 3166-2:2013.
Minimum length: 5.
Maximum length: 6.
Pattern: ^[A-Z]{2}-([A-Z]{2,3}|[0-9]{2,3})$.
authority
string
The entity that issued the identity document. For example, registration authority.
Minimum length: 1.
Maximum length: 255.

email

email
string
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.
Maximum length: 254.
Pattern: (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\]).

email_address

email_address
string
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.
Minimum length: 3.
Maximum length: 254.
Pattern: ^.+@[^"\-].+$.

email_address

email_address
string
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.
Minimum length: 3.
Maximum length: 254.
Pattern: ^.+@[^"\-].+$.

enrolled

enrolled
enum
Status of Authentication eligibility.
The possible values are:
- Y. Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl.
- N. No. The bank is not participating in 3-D Secure protocol.
- U. Unavailable. The DS or ACS is not available for authentication at the time of the request.
- B. Bypass. The merchant authentication rule is triggered to bypass authentication.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

eps

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).

eps_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.

error

name
string
required
The human-readable, unique name of the error.
message
string
required
The message that describes the error.
debug_id
string
required
The PayPal internal ID. Used for correlation purposes.
information_link
string
The information link, or URI, that shows detailed information about this error for the developer.
Read only.
details
array (contains the error_details object)
An array of additional details about the error.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
Read only.

error_details

field
string
The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.
value
string
The value of the field that caused the error.
location
string
The location of the field that caused the error. Value is body, path, or query.
issue
string
required
The unique, fine-grained application-level error code.
description
string
The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.

exchange_rate

source_currency
string
The source currency from which to convert an amount.
target_currency
string
The target currency to which to convert an amount.
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.

experience_context_base

brand_name
string
The label that overrides the business name in the PayPal account on the PayPal site.
Minimum length: 1.
Maximum length: 127.
locale
string
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.
Minimum length: 2.
Maximum length: 10.
Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.
shipping_preference
enum
The location from which the shipping address is derived.
The possible values are:
- GET_FROM_FILE. Get the customer-provided shipping address on the PayPal site.
- NO_SHIPPING. Redacts the shipping address from the PayPal site. Recommended for digital goods.
- SET_PROVIDED_ADDRESS. Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages.
Minimum length: 1.
Maximum length: 24.
Pattern: ^[A-Z_]+$.
return_url
string
The URL where the customer is redirected after the customer approves the payment.
cancel_url
string
The URL where the customer is redirected after the customer cancels the payment.

financial_instrument-common-url

financial_instrument-common-url
string
Describes the URL.

giropay

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).

giropay_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.

iban_last_chars

iban_last_chars
string
The last characters of the IBAN used to pay.
Minimum length: 4.
Maximum length: 34.
Pattern: [a-zA-Z0-9]{4}.

ideal

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).
iban_last_chars
string
The last characters of the IBAN used to pay.

ideal_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).

identity_document

type
enum
The type of identity document.
The possible values are:
- SOCIAL_SECURITY_NUMBER. Social security number.
- INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER. Individual tax identification number.
- NATIONAL_IDENTIFICATION_NUMBER. National identification number, such as Brazil's *Cadastro de Pessoas Fisicas* (CPF) or India's *Aadhaar* number.
- TAX_IDENTIFICATION_NUMBER. The tax identification number, such as PAN CARD.
- PASSPORT_NUMBER. The passport number.
- SSN4. The last 4 digits of the social security number.
Minimum length: 1.
Maximum length: 255.
issuer
object
Information about the authority that issues the identification document.
id_number
string
The identification code for the document, for example, the passport number.
Minimum length: 1.
Maximum length: 100.
issued_date
string
The date when the document was issued.
expiration_date
string
The expiration date of the document.

identity_document_type

identity_document_type
enum
The identity document type.
The possible values are:
- SOCIAL_SECURITY_NUMBER. Social security number.
- INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER. Individual tax identification number.
- NATIONAL_IDENTIFICATION_NUMBER. National identification number, such as Brazil's *Cadastro de Pessoas Fisicas* (CPF) or India's *Aadhaar* number.
- TAX_IDENTIFICATION_NUMBER. The tax identification number, such as PAN CARD.
- PASSPORT_NUMBER. The passport number.
- SSN4. The last 4 digits of the social security number.
Minimum length: 1.
Maximum length: 255.

issuer

issuer
enum
The issuer of the credit financing offer.
The possible values are:
- PAYPAL. Issued by PayPal.
- CARD_ISSUER_INSTALLMENTS. Issued by card issuer.
Minimum length: 1.
Maximum length: 40.

item

name
string
required
The item name or title.
Minimum length: 1.
Maximum length: 127.
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.
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.
quantity
string
required
The item quantity. Must be a whole number.
Maximum length: 10.
Pattern: ^[1-9][0-9]{0,9}$.
description
string
The detailed item description.
Maximum length: 127.
sku
string
The stock keeping unit (SKU) for the item.
Maximum length: 127.
category
enum
The item category type.
The possible values are:
- DIGITAL_GOODS. Goods that are stored, delivered, and used in their electronic format. This value is not currently supported for API callers that leverage the PayPal for Commerce Platform product.
- PHYSICAL_GOODS. A tangible item that can be shipped with proof of delivery.
- DONATION. A contribution or gift for which no good or service is exchanged, usually to a not for profit organization.
Minimum length: 1.
Maximum length: 20.

language

language
string
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code.
Minimum length: 2.
Maximum length: 10.
Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.

language

language
string
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code.
Minimum length: 2.
Maximum length: 10.
Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.

liability_shift

liability_shift
enum
Liability shift indicator. The outcome of the issuer's authentication.
The possible values are:
- YES. Liability has shifted to the card issuer. Available only after order is authorized or captured.
- NO. Liability is with the merchant.
- POSSIBLE. Liability may shift to the card issuer. Available only before order is authorized or captured.
- UNKNOWN. The authentication system is not available.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

link_description

href
string
required
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
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
Possible values: GET,POST,PUT,DELETE,HEAD,CONNECT,OPTIONS,PATCH.

merchant_partner_customer_id

merchant_partner_customer_id
string
The unique ID for a customer in merchant's or partner's system of records.
Minimum length: 1.
Maximum length: 22.
Pattern: ^[0-9a-zA-Z_-]+$.

model-account

account_number
string
Unique account number.
Minimum length: 1.
Maximum length: 20.
account_id
string
The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
Minimum length: 13.
Maximum length: 13.
Pattern: ^[2-9A-HJ-NP-Z]{13}$.
tier
enum
The classification of the PayPal account.
The possible values are:
- BUSINESS. PayPal Business account
- PERSONAL. PayPal personal account
- PREMIER. PayPal Premier account
Minimum length: 1.
Maximum length: 100.
Pattern: ^([A-Z]|<blockquote>[A-Z]).
registration_type
string
The registration_type fields represents how the account was created. Currently supported values are FULL, GUEST, ANONYMOUS. For more information about the meaning of each registration type, refer to the UserGuide.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
legal_country_code
string
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
account_tags
array (contains the account_tag object)
Array of tags stored for the account in User domain by other clients Eg: YOUTH_ACCOUNT, RESTRICTED, WAX_USER, MASSPAY_ENABLED etc.
status
string
Status of account like OPEN, or CLOSED. For paypal accounts, the status is defined by User domain.
Minimum length: 1.
Maximum length: 30.
pricing_category
string
Pricing category for the account as defined by PalPal pricing.
Minimum length: 1.
Maximum length: 30.
legal_entity
string
The account's legal PayPal entity Eg: INC, EUROPE, CHINA etc. For paypal accounts, it is defined by User domain.
Minimum length: 1.
Maximum length: 30.
time_created
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

model-address_with_confirmation

id
string
Unique address identifier.
Minimum length: 1.
Maximum length: 30.
confirmation_status
string
Address confirmation status like NONE, PENDING, CONFIRMED, FAILED.
Minimum length: 1.
Maximum length: 127.
confirmation_authority
string
What 3rd party or process has determined the current confirmation_status.
Minimum length: 1.
Maximum length: 255.

model-auth_tolerance

percent
string
Defines the maximum percentage that can be captured for an authorization, as a fixed-point, signed decimal number. For example, define a 110.99% toklerance as 110.99.
Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.
absolute
object
Defines the maximum absolute value above the authorized amount that can be captured for an authorization.

model-authorization_directives

honor_time_offset
integer
Honor period offset. This is the offset period (in seconds) starting from time of authorization after which held funds (if any) will be released automatically.
Minimum value: 1.
Maximum value: 31622400.
expiry_time_offset
integer
Expiry period offset. This is the offset period (in seconds) starting from time of authorization after which authorization is voided automatically.
Minimum value: 1.
Maximum value: 31622400.
allow_multiple_captures
boolean
Indicates if multiple captures can be allowed on an Authorization.
tolerance
object
Auth-Capture Tolerance details.

model-business

id
string
Unique identifier for a party.
Minimum length: 1.
Maximum length: 30.
external_id
string
External identifier for a party, it could be venmo id, facebook email etc.
Minimum length: 1.
Maximum length: 30.
primary
boolean
Indicates if the party is primary Party.
primary_email
string
The primary email address of the party.
emails
array (contains the email_address object)
Email addresses.
phones
array (contains the model-phone_info object)
Details of party's phone numbers.
addresses
array (contains the model-address_with_confirmation object)
Details of party's addresses.
create_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
update_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.

names
array (contains the business_name object)
Names of business.
type
string
Type of business. Eg: INDIVIDUAL, PROPRIETORSHIP, PARTNERSHIP etc.
Minimum length: 1.
Maximum length: 255.
Pattern: ^([A-Z]|<blockquote>[A-Z]).
category
object
Business category information. For more information, see Categories and subcategories.
identifications
array (contains the model-business_identification object)
Identification details for the business.
description
string
Description of business.
Minimum length: 1.
Maximum length: 255.
owners
array (contains the model-person object)
Beneficial owners of the business.
url
string
Web site url (online presence) for the business.
Minimum length: 1.
Maximum length: 100.
customer_service_contacts
object
Contact information for customer service.

model-business_category

category
string
Industry standard category code of business.
Minimum length: 1.
Maximum length: 50.
sub_category
string
Industry standard sub category of business.
Minimum length: 1.
Maximum length: 50.
mcc_code
string
Industry standard merchant category code of business.
Minimum length: 1.
Maximum length: 4.

model-business_identification

type
string
The type of identification number. Eg: TAX_IDENTIFICATION_NUMBER, BUSINESS_REGISTRATION_NUMBER.
Minimum length: 1.
Maximum length: 127.
identifier
string
The number or value of the identifier.
Minimum length: 1.
Maximum length: 127.
issuer
object
Details about an authority that issues a document.
issued_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.

model-customer_service_contact

emails
array (contains the email_address object)
Customer service email addresses.
phones
array (contains the model-phone_info object)
Details of customer service phone numbers.

model-enums-currency_receiving_type

model-enums-currency_receiving_type
enum
Currency receiving type defines the options when receiving payment in a currency not held by the reciver.
The possible values are:
- ACCEPT. Accept payment after auto currency conversion.
- DENY. Deny payment.
- HOLD. Pend payment for seller's approval.
- ACCEPT_OPEN. Accept payment after opening a new currency holding.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

model-enums-disbursement_type

model-enums-disbursement_type
enum
Disbursement type.
The possible values are:
- INSTANT. Instant Disbursement Type.
- DELAYED. Delayed Disbursement Type.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

model-enums-facilitator_type

model-enums-facilitator_type
enum
Facilitator type.
The possible values are:
- API_CALLER. A party who sets up the context and eventually owns or controls the payment.
- PARTNER. A checkout participant involved in the transaction who is setup as a partner.
- INTERNAL. Internal applications or actors.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

model-enums-liability_type

model-enums-liability_type
enum
Liability type defined by PayPal Risk.
The possible values are:
- FULL. Full liability for post payment events. The loss_account will be used for events including refunds, reversals, disputes etc.
- PARTIAL. Partial liability for post payment events. The loss_account will be used for limited cases like UNAUTH.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

model-enums-participant_type

model-enums-participant_type
enum
Participant type.
The possible values are:
- SENDER. Sender of the payment.
- RECEIVER. Receiver of the payment.
- FACILITATOR. Facilitator of the payment.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

model-enums-pricing_type

model-enums-pricing_type
enum
Type of pricing applied to a payment.
The possible values are:
- BLENDED. Blended Pricing Type.
- IC_PLUS. IC+ Pricing Type.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

model-odfi_details

standard_entry_class_code
enum
The Standard Entry Class (SEC) code is a three-character code included in the company/batch header record to identify the type of ACH transactions contained in that batch.
The possible values are:
- ARC. Account Receivable Check. Converted checks received via the US mail or at a drop box location for the payment of goods or services.
- BOC. Back Office Conversion. Converted checks received by merchant at the point of purchase or at manned bill payment locations, and processed during back office operations.
- CCD. Corporate Credit or Debit. Transfer of funds where they are either distributed or consolidated between corporate entities.
- CTX. Corporate Trade Exchange. Application that supports the transfer of funds within a trading partner relationship.
- IAT. International ACH Transaction. Transaction involving a financial agency's office that is not located in the territorial jurisdiction of the United States.
- POP. Point of Purchase Entry. Entry initiated by the consumer via a debit card for payment of goods or services.
- PPD. Prearranged Payment and Deposit Entry. Entry initiated by an organization based on a standing or single entry authorization from a receiver to transfer funds to or from a consumer account of the receiver.
- RCK. Represented Check Entry. Application used by originators to re-present a check that has been processed through the check collection system and returned because of insufficient or uncollected funds.
- TEL. Telephone Authorized Entry. Debit transaction to a consumer's account pursuant to an oral authorization obtained from the consumer via the telephone.
- WEB. Internet Authorized Entry. Entry used for the origination of debit entries to a consumer's account pursuant to an authorization that is obtained from the Receiver via the internet.
Minimum length: 1.
Maximum length: 3.
Pattern: ^[A-Z]+$.

model-participant

account_number
string
Unique account number.
Minimum length: 1.
Maximum length: 20.
account_id
string
The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.
Minimum length: 13.
Maximum length: 13.
Pattern: ^[2-9A-HJ-NP-Z]{13}$.
tier
string
The classification of the PayPal account.
Minimum length: 1.
Maximum length: 100.
Pattern: ^([A-Z]|<blockquote>[A-Z]).
registration_type
string
The registration_type fields represents how the account was created. Currently supported values are FULL, GUEST, ANONYMOUS. For more information about the meaning of each registration type, refer to the UserGuide.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
legal_country_code
string
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
account_tags
array (contains the account_tag object)
Array of tags stored for the account in User domain by other clients Eg: YOUTH_ACCOUNT, RESTRICTED, WAX_USER, MASSPAY_ENABLED etc.
status
string
Status of account like OPEN, or CLOSED. For paypal accounts, the status is defined by User domain.
Minimum length: 1.
Maximum length: 30.
pricing_category
string
Pricing category for the account as defined by PalPal pricing.
Minimum length: 1.
Maximum length: 30.
legal_entity
string
The account's legal PayPal entity Eg: INC, EUROPE, CHINA etc. For paypal accounts, it is defined by User domain.
Minimum length: 1.
Maximum length: 30.
time_created
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

person
Person information.
business
object
Business information.

model-party

id
string
Unique identifier for a party.
Minimum length: 1.
Maximum length: 30.
external_id
string
External identifier for a party, it could be venmo id, facebook email etc.
Minimum length: 1.
Maximum length: 30.
primary
boolean
Indicates if the party is primary Party.
primary_email
string
The primary email address of the party.
emails
array (contains the email_address object)
Email addresses.
phones
array (contains the model-phone_info object)
Details of party's phone numbers.
addresses
array (contains the model-address_with_confirmation object)
Details of party's addresses.
create_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
update_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.

model-payment_context_attribute

name
string
Context attribute name.
Minimum length: 1.
Maximum length: 127.
value
string
Context attribute value.
Minimum length: 1.
Maximum length: 255.

model-payment_details_request

payment_source
object
The payment source used for the payment of an order
purchase_units
array (contains the model-update_purchase_unit_request object)
required
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.

model-payment_directives

disbursement_type
enum
Disbursement type.
The possible values are:
- INSTANT. Instant Disbursement Type.
- DELAYED. Delayed Disbursement Type.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
linked_group_id
string
Identifier that links the transactions to be treated as one atomic unit for payment processing. All-or-none policy is enforced by this identifier.
Minimum length: 1.
Maximum length: 10.
settlement_account_number
string
Settlement account number where the funds finally get settled to.
Minimum length: 1.
Maximum length: 30.
loss_account_number
string
Loss account number used for recovery of loss.
Minimum length: 1.
Maximum length: 30.
liability_type
enum
Liability type defined by PayPal Risk.
The possible values are:
- FULL. Full liability for post payment events. The loss_account will be used for events including refunds, reversals, disputes etc.
- PARTIAL. Partial liability for post payment events. The loss_account will be used for limited cases like UNAUTH.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
special_deny
boolean
Special deny setting to force decline a (compliance) pending transaction.
allow_duplicate_invoice_id
boolean
A directive to allow or deny transactions with duplicate invoice id (for the receiver account).
policy_directives
array (contains the model-policy_directive object)
Policy directives indicating how to process the payment.
payment_method_directives
array (contains the model-payment_method_directive object)
Directives for certain payment methods based on eligibility.
pricing_directives
array (contains the model-pricing_directive object)
Pricing directives for the transaction.
authorization_directives
object
Auth directives for the transaction.
currency_receiving_directive
enum
Currency receiving type defines the options when receiving payment in a currency not held by the reciver.
The possible values are:
- ACCEPT. Accept payment after auto currency conversion.
- DENY. Deny payment.
- HOLD. Pend payment for seller's approval.
- ACCEPT_OPEN. Accept payment after opening a new currency holding.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
immediate_payment_required
boolean
Flag to indicate if immediate payment is required. A directive to fail the transaction if the payment goes to a pending state.

model-payment_method_directive

payment_processing_type
string
Indicates the type of payment processing. Eg: CUSTOM_CARD_PROCESSING, CUSTOM_BANK_PROCESSING.
Minimum length: 1.
Maximum length: 127.
processing_decision
string
Defines the payment processing decision as ALLOW, DENY, UNKNOWN.
Minimum length: 1.
Maximum length: 30.
reason
array (contains the reason_code object)
Reasons for the decision. Usually set for a DENY decision.

model-person

id
string
Unique identifier for a party.
Minimum length: 1.
Maximum length: 30.
external_id
string
External identifier for a party, it could be venmo id, facebook email etc.
Minimum length: 1.
Maximum length: 30.
primary
boolean
Indicates if the party is primary Party.
primary_email
string
The primary email address of the party.
emails
array (contains the email_address object)
Email addresses.
phones
array (contains the model-phone_info object)
Details of party's phone numbers.
addresses
array (contains the model-address_with_confirmation object)
Details of party's addresses.
create_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
update_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.

names
array (contains the name object)
Names of person.
citizenship
string
The two character iso country code for where the legal citizenship of party.
birth_date
string
Person's date of birth.
identifications
array (contains the identity_document object)
Identity documents for the entity like passport number.

model-phone_info

phone_number
object
The phone number in its canonical international E.164 numbering plan format.
phone_type
enum
The phone type.
The possible values are:
- FAX. A fax machine.
- HOME. A home phone.
- MOBILE. A mobile phone.
- OTHER. Other.
- PAGER. A pager.
- WORK. A work phone.

model-policy_directive

payment_decision
string
Indicates the payment state decision. Can be ALLOW, DENY or ALLOW_WITH_HOLD.
Minimum length: 1.
Maximum length: 30.
reason
array (contains the reason_code object)
List of reasons for the payment decision.

model-pricing_directive

participant_type
enum
Participant type.
The possible values are:
- SENDER. Sender of the payment.
- RECEIVER. Receiver of the payment.
- FACILITATOR. Facilitator of the payment.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.
account_number
string
Account number of the preference owner.
Minimum length: 1.
Maximum length: 30.
Pattern: ^[0-9]{1,30}?$.
type
enum
Pricing type.
The possible values are:
- BLENDED. Blended Pricing Type.
- IC_PLUS. IC+ Pricing Type.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[A-Z_]+$.

model-shipping_details

shipping_address
object
Shipping Address.
options
array (contains the shipping_option object)
An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.

model-soft_descriptor_details

soft_descriptor
string
Soft Descriptor.
Minimum length: 1.
Maximum length: 30.
contact_type
string
Contact type allows the merchant to specify the type of the additional information passing in the soft descriptor Eg : CITY/URL/PHONE.
Minimum length: 1.
Maximum length: 127.
contact_value
string
Contact value allows the merchant to provide the business location, business phone number or URL to the instrument holder.
Minimum length: 1.
Maximum length: 255.

model-update_authorization_request

id
string
required
The unique transaction ID for the authorized payment.
Minimum length: 1.
Maximum length: 20.
status
enum
required
The status for the authorized payment.
The possible values are:
- CREATED. The authorized payment is created. No captured payments have been made for this authorized payment.
- CAPTURED. The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.
- DENIED. PayPal cannot authorize funds for this authorized payment.
- EXPIRED. The authorized payment has expired.
- PARTIALLY_CAPTURED. A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.
- VOIDED. The authorized payment was voided. No more captured payments can be made against this authorized payment.
- PENDING. The created authorization is in pending state. For more information, see status.details
Minimum length: 1.
Maximum length: 127.
Pattern: ^[A-Z_]+$.
status_details
object
The details of the authorized order pending status.

model-update_capture_request

id
string
required
The transaction ID for the captured payment.
Minimum length: 1.
Maximum length: 20.
status
enum
required
The status of the captured payment.
The possible values are:
- COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.
- DECLINED. The funds could not be captured.
- PARTIALLY_REFUNDED. An amount less than this captured payment's amount was partially refunded to the payer.
- PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details
- REFUNDED. An amount greater than or equal to this captured payment's amount was refunded to the payer.
Minimum length: 1.
Maximum length: 127.
Pattern: ^[A-Z_]+$.
status_details
object
The details of the captured payment status.

model-update_payment_collection_request

authorizations
array (contains the model-update_authorization_request object)
An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.
captures
array (contains the model-update_capture_request object)
An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.

model-update_purchase_unit_request

reference_id
string
required
The API caller-provided external ID for the purchase unit.
Minimum length: 1.
Maximum length: 256.
payments
object
required
The comprehensive summary of payments for the purchase unit.

money

currency_code
string
required
The three-character ISO-4217 currency code that identifies the currency.
Minimum length: 3.
Maximum length: 3.
value
string
required
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.
Maximum length: 32.
Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.

money

currency_code
string
required
The 3-character ISO-4217 currency code that identifies the currency.
Minimum length: 3.
Maximum length: 3.
value
string
required
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.
Maximum length: 32.
Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.

mybank

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).
iban_last_chars
string
The last characters of the IBAN used to pay.

mybank_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.

name

name
string
The full name representation like Mr J Smith.
Minimum length: 3.
Maximum length: 300.

name

prefix
string
The prefix, or title, to the party's name.
Maximum length: 140.
given_name
string
When the party is a person, the party's given, or first, name.
Maximum length: 140.
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.
Maximum length: 140.
middle_name
string
When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
Maximum length: 140.
suffix
string
The suffix for the party's name.
Maximum length: 140.
full_name
string
When the party is a person, the party's full name.
Maximum length: 300.

name

prefix
string
The prefix, or title, to the party's name.
Maximum length: 140.
given_name
string
When the party is a person, the party's given, or first, name.
Maximum length: 140.
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.
Maximum length: 140.
middle_name
string
When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
Maximum length: 140.
suffix
string
The suffix for the party's name.
Maximum length: 140.
alternate_full_name
string
DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
Maximum length: 300.
full_name
string
When the party is a person, the party's full name.
Maximum length: 300.

name

given_name
string
When the party is a person, the party's given, or first, name.
Maximum length: 140.
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.
Maximum length: 140.

name_validation

name_validation

name_validation

name_validation

net_amount_breakdown

payable_amount
object
The net amount debited from the merchant's PayPal account.
Read only.
converted_amount
object
The converted payable amount.
Read only.
exchange_rate
object
The exchange rate that determines the amount that was debited from the merchant's PayPal account.
Read only.

network_transaction_reference

id
string
required
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.
Minimum length: 9.
Maximum length: 15.
Pattern: ^[a-zA-Z0-9]+$.
date
string
The date that the transaction was authorized by the scheme. For MasterCard, this is the "BankNet reference date" field in response.
Minimum length: 4.
Maximum length: 4.
Pattern: ^[0-9]+$.
network
enum
required
Name of the card network through which the transaction was routed.
The possible values are:
- VISA. Visa card.
- MASTERCARD. Mastecard card.
- DISCOVER. Discover card.
- AMEX. American Express card.
- SOLO. Solo debit card.
- JCB. Japan Credit Bureau card.
- STAR. Military Star card.
- DELTA. Delta Airlines card.
- SWITCH. Switch credit card.
- MAESTRO. Maestro credit card.
- CB_NATIONALE. Carte Bancaire (CB) credit card.
- CONFIGOGA. Configoga credit card.
- CONFIDIS. Confidis credit card.
- ELECTRON. Visa Electron credit card.
- CETELEM. Cetelem credit card.
- CHINA_UNION_PAY. China union pay credit card.

order

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

id
string
The ID of the order.
payment_source
object
The payment source used to fund the payment.
intent
string
The intent to either capture payment immediately or authorize a payment for an order after order creation.
processing_instruction
string
The instruction to process an order.
Minimum length: 1.
Maximum length: 36.
Pattern: ^[0-9A-Z_]+$.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit 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.
status
string
The order status.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
links
array (contains the link_description object)
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.

order_application_context

brand_name
string
The label that overrides the business name in the PayPal account on the PayPal site.
Minimum length: 1.
Maximum length: 127.
locale
string
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.
Minimum length: 2.
Maximum length: 10.
Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.
landing_page
enum
The type of landing page to show on the PayPal site for customer checkout.
The possible values are:
- LOGIN. When the customer clicks PayPal Checkout, the customer is redirected to a page to log in to PayPal and approve the payment.
- BILLING. When the customer clicks PayPal Checkout, the customer is redirected to a page to enter credit or debit card and other relevant billing information required to complete the purchase.
- NO_PREFERENCE. When the customer clicks PayPal Checkout, the customer is redirected to either a page to log in to PayPal and approve the payment or to a page to enter credit or debit card and other relevant billing information required to complete the purchase, depending on their previous interaction with PayPal.
Minimum length: 1.
Maximum length: 13.
Pattern: ^[0-9A-Z_]+$.
shipping_preference
enum
The shipping preference:
- Displays the shipping address to the customer.
- Enables the customer to choose an address on the PayPal site.
- Restricts the customer from changing the address during the payment-approval process.
The possible values are:
- GET_FROM_FILE. Use the customer-provided shipping address on the PayPal site.
- NO_SHIPPING. Redact the shipping address from the PayPal site. Recommended for digital goods.
- SET_PROVIDED_ADDRESS. Use the merchant-provided address. The customer cannot change this address on the PayPal site.
Minimum length: 1.
Maximum length: 20.
Pattern: ^[0-9A-Z_]+$.
user_action
enum
Configures a Continue or Pay Now checkout flow.
The possible values are:
- CONTINUE. After you redirect the customer to the PayPal payment page, a Continue button appears. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.
- PAY_NOW. After you redirect the customer to the PayPal payment page, a Pay Now button appears. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.
Minimum length: 1.
Maximum length: 8.
Pattern: ^[0-9A-Z_]+$.
payment_method
object
The customer and merchant payment preferences.
return_url
string
The URL where the customer is redirected after the customer approves the payment.
cancel_url
string
The URL where the customer is redirected after the customer cancels the payment.
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.

order_authorize_request

payment_source
object
The source of payment for the order, which can be a token or a card. Use this object only if you have not redirected the user after order creation to approve the payment. In such cases, the user-selected payment method in the PayPal flow is implicitly used.

order_authorize_request.payment_source

token
object
The tokenized payment source to fund a payment.

order_authorize_response

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

id
string
The ID of the order.
payment_source
object
The payment source used to fund the payment.
intent
string
The intent to either capture payment immediately or authorize a payment for an order after order creation.
processing_instruction
string
The instruction to process an order.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit 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.
status
string
The order status.
links
array (contains the link_description object)
An array of request-related HATEOAS links. To complete payer approval, use the approve link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include application_context.return_url is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment.

order_capture_request

payment_source
object
The payment source definition.

order_capture_request.payment_source

token
object
The tokenized payment source to fund a payment.

order_confirm_application_context

brand_name
string
Label to present to your payer as part of the PayPal hosted web experience.
Minimum length: 1.
Maximum length: 127.
locale
string
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.
return_url
string
The URL where the customer is redirected after the customer approves the payment.
Minimum length: 10.
Maximum length: 4000.
cancel_url
string
The URL where the customer is redirected after the customer cancels the payment.
Minimum length: 10.
Maximum length: 4000.

order_request

intent
enum
required
The intent to either capture payment immediately or authorize a payment for an order after order creation.
The possible values are:
- CAPTURE. The merchant intends to capture payment immediately after the customer makes a payment.
- AUTHORIZE. The merchant intends to authorize a payment and place funds on hold after the customer makes a payment. Authorized payments are best captured within three days of authorization but are available to capture for up to 29 days. After the three-day honor period, the original authorized payment expires and you must re-authorize the payment. You must make a separate request to capture payments on demand. This intent is not supported when you have more than one `purchase_unit` within your order.
processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
purchase_units
array (contains the purchase_unit_request object)
required
An array of purchase units. Each purchase unit establishes a contract between a payer and the payee. Each purchase unit represents either a full or partial order that the payer intends to purchase from the payee.
application_context
object
Customize the payer experience during the approval process for the payment with PayPal.

order_status

order_status
enum
The order status.
The possible values are:
- CREATED. The order was created with the specified context.
- SAVED. The order was saved and persisted. The order status continues to be in progress until a capture is made with final_capture = true for all purchase units within the order.
- APPROVED. The customer approved the payment through the PayPal wallet or another form of guest or unbranded payment. For example, a card, bank account, or so on.
- VOIDED. All purchase units in the order are voided.
- COMPLETED. The payment was authorized or the authorized payment was captured for the order.
- PAYER_ACTION_REQUIRED. The order requires an action from the payer (e.g. 3DS authentication). Redirect the payer to the "rel":"payer-action" HATEOAS link returned as part of the response prior to authorizing or capturing the order.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

orthography

orthography
enum
The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on most widely used writing systems.
The possible values are:
- Zyyy. The orthography cannot be determined.
- Zzzz. The orthography is unknown.
- Kana. An angular form of Japanese writing for words of foreign origin.
- Cyrl. The Slavic languages alphabet. Used in eastern Europe.
- Arab. The Arabic language alphabet.
- Armn. The Armenian alphabet.
- Beng. The Bengali alphabet. Used in eastern India.
- Cans. The Unified Canadian Aboriginal Syllabics alphabet.
- Deva. The Devanagari (Nagari) alphabet.
- Ethi. The Ethiopic alphabet.
- Geor. The Georgian (Mkhedruli and Mtavruli) alphabet.
- Grek. The Greek alphabet.
- Gujr. The Gujurati language alphabet. Used in western India.
- Guru. The Gurmukhi alphabet. Used in the northern Indian state of Punjab.
- Hani. The Han (Hanzi, Kanji, Hanja) alphabet.
- Hebr. The Hebrew alphabet.
- Java. The Javanese alphabet.
- Jpan. The Japanese (alias for Han + Hiragana + Katakana) alphabet.
- Khmr. The Khmer alphabet.
- Knda. The Kannada alphabet. Used in the southern Indian state of Karnataka.
- Kore. Korean (alias for Hangul + Han).
- Laoo. The Lao alphabet.
- Latn. The Latin alphabet.
- Mlym. The Malayalam alphabet. Used in the southern Indian state of Kerala.
- Mong. The Mongolian alphabet.
- Mymr. The Myanmar (Burmese) alphabet.
- Orya. The Oriya (Odia) alphabet. Used in the eastern Indian state of Odisha.
- Sinh. The Sinhala alphabet.
- Sund. The Sundanese alphabet.
- Syrc. The Syriac alphabet.
- Taml. The Tamil alphabet. Used in the southern Indian state of Tamilnadu.
- Telu. The Telugu language alphabet. Used in the southern Indian state of Andhra pradesh.
- Thaa. The Thaana (Maldivian) alphabet.
- Thai. The Thai alphabet. Used in Thailand.
- Tibt. The Tibetan alphabet.
- Yiii. The Yi alphabet.
Minimum length: 4.
Maximum length: 4.
Pattern: ^[A-Z][a-z]{3}$.

p24

name
string
The name of the account holder associated with this payment method.
email
string
The email address of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
payment_descriptor
string
P24 generated payment description.
Minimum length: 1.
Maximum length: 2000.
method_id
string
Numeric identifier of the payment scheme or bank used for the payment.
Minimum length: 1.
Maximum length: 300.
method_description
string
Friendly name of the payment scheme or bank used for the payment.
Minimum length: 1.
Maximum length: 2000.

p24_request

name
string
required
The name of the account holder associated with this payment method.
email
string
required
The email address of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.

pares_status

pares_status
enum
Transactions status result identifier. The outcome of the issuer's authentication.
The possible values are:
- Y. Successful authentication.
- N. Failed authentication / account not verified / transaction denied.
- U. Unable to complete authentication.
- A. Successful attempts transaction.
- C. Challenge required for authentication.
- R. Authentication rejected (merchant must not submit for authorization).
- D. Challenge required; decoupled authentication confirmed.
- I. Informational only; 3DS requestor challenge preference acknowledged.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

patch

`op`

enum

required

The operation.

The possible values are:

add.
Depending on the target location reference, completes one of these functions:
- The target location is an array index. Inserts a new value into the array at the specified index.
- The target location is an object parameter that does not already exist. Adds a new parameter to the object.
- The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.
remove. Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.
replace. Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.
move. Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.
copy. Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.

test. Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:

Type	Considered equal if both values
strings	Contain the same number of Unicode characters and their code points are byte-by-byte equal.
numbers	Are numerically equal.
arrays	Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objects	Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (`false`, `true`, and `null`)	Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.

For more information, see 4.6. test.

path
string
The JSON Pointer to the target document location at which to complete the operation.
value
number,integer,string,boolean,null,array,object
The value to apply. The remove operation does not require a value.
from
string
The JSON Pointer to the target document location from which to move the value. Required for the move operation.

patch_request

patch_request
array (contains the patch object)
An array of JSON patch objects to apply partial updates to resources.

pay_upon_invoice_experience_context

brand_name
string
The label that overrides the business name in the PayPal account on the PayPal site.
Minimum length: 1.
Maximum length: 127.
locale
string
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.
Minimum length: 2.
Maximum length: 10.
Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.
shipping_preference
string
The location from which the shipping address is derived.
Minimum length: 1.
Maximum length: 24.
Pattern: ^[A-Z_]+$.
return_url
string
The URL where the customer is redirected after the customer approves the payment.
cancel_url
string
The URL where the customer is redirected after the customer cancels the payment.

logo_url
string
The URL to the logo of the payment method.
customer_service_instructions
array (contains the customer_service_instructions object)
The payee's customer service contact instructions provided to the payer.

payee

email_address
string
The email address of merchant.
merchant_id
string
The encrypted PayPal account ID of the merchant.

payee_base

email_address
string
The email address of merchant.
merchant_id
string
The encrypted PayPal account ID of the merchant.

payee_payment_method_preference

payee_payment_method_preference
enum
The merchant-preferred payment methods.
The possible values are:
- UNRESTRICTED. Accepts any type of payment from the customer.
- IMMEDIATE_PAYMENT_REQUIRED. Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

payer

email_address
string
The email address of the payer.
Maximum length: 254.
Pattern: (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\]).
payer_id
string
The PayPal-assigned ID for the payer.
Minimum length: 13.
Maximum length: 13.
Pattern: ^[2-9A-HJ-NP-Z]{13}$.

name
object
The name of the payer. Supports only the given_name and surname properties.
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.
birth_date
string
The birth date of the payer in YYYY-MM-DD format.
tax_info
object
The tax information of the payer. Required only for Brazilian payer's. Both tax_id and tax_id_type are required.
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.

payer_base

email_address
string
The email address of the payer.
Maximum length: 254.
Pattern: (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\]).
payer_id
string
The PayPal-assigned ID for the payer.
Read only.
Minimum length: 13.
Maximum length: 13.
Pattern: ^[2-9A-HJ-NP-Z]{13}$.

payment_collection

authorizations
array (contains the authorization_with_additional_data object)
An array of authorized payments for a purchase unit. A purchase unit can have zero or more authorized payments.
captures
array (contains the capture object)
An array of captured payments for a purchase unit. A purchase unit can have zero or more captured payments.
refunds
array (contains the refund object)
An array of refunds for a purchase unit. A purchase unit can have zero or more refunds.

payment_initiator

payment_initiator
enum
The person or party who initiated or triggered the payment.
The possible values are:
- CUSTOMER. Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.
- MERCHANT. Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

payment_instruction

platform_fees
array (contains the platform_fee object)
An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.
disbursement_mode
enum
The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.
The possible values are:
- INSTANT. The funds are released to the merchant immediately.
- DELAYED. The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration.
Minimum length: 1.
Maximum length: 16.
Pattern: ^[A-Z_]+$.
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.
Minimum length: 1.
Maximum length: 20.
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.
Minimum length: 1.
Maximum length: 4000.

payment_method

payee_preferred
enum
The merchant-preferred payment methods.
The possible values are:
- UNRESTRICTED. Accepts any type of payment from the customer.
- IMMEDIATE_PAYMENT_REQUIRED. Accepts only immediate payment from the customer. For example, credit card, PayPal balance, or instant ACH. Ensures that at the time of capture, the payment does not have the `pending` status.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
standard_entry_class_code
enum
NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.
The possible values are:
- TEL. The API caller (merchant/partner) accepts authorization and payment information from a consumer over the telephone.
- WEB. The API caller (merchant/partner) accepts Debit transactions from a consumer on their website.
- CCD. Cash concentration and disbursement for corporate debit transaction. Used to disburse or consolidate funds. Entries are usually Optional high-dollar, low-volume, and time-critical. (e.g. intra-company transfers or invoice payments to suppliers).
- PPD. Prearranged payment and deposit entries. Used for debit payments authorized by a consumer account holder, and usually initiated by a company. These are usually recurring debits (such as insurance premiums).
Minimum length: 3.
Maximum length: 255.

payment_source

token
object
The tokenized payment source to fund a payment.
bancontact
object
Bancontact is the most popular online payment in Belgium. More Details.
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.
eps
object
The eps transfer is an online payment method developed by many Austrian banks. More Details.
giropay
object
Giropay is an Internet payment System in Germany, based on online banking. More Details.
ideal
object
The Dutch payment method iDEAL is an online payment method that enables consumers to pay online through their own bank. More Details.
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.
p24
object
P24 (Przelewy24) is a secure and fast online bank transfer service linked to all the major banks in Poland. More Details.
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.
trustly
object
Trustly is a payment method that allows customers to shop and pay from their bank account. More Details.

payment_source_response

card
object
The payment card to use to fund a payment. Card can be a credit or debit card.
paypal
bancontact
object
Information used to pay Bancontact.
blik
object
Information used to pay using BLIK.
eps
object
Information used to pay using eps.
giropay
object
Information needed to pay using giropay.
ideal
object
Information used to pay using iDEAL.
mybank
object
Information used to pay using MyBank.
p24
object
Information used to pay using P24(Przelewy24).
sofort
object
Information used to pay using Sofort.
trustly
object
Information needed to pay using Trustly.

payment_source_response

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

percentage

percentage
string
The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.

phone

country_code
string
required
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).
Minimum length: 1.
Maximum length: 3.
Pattern: ^[0-9]{1,3}?$.
national_number
string
required
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).
Minimum length: 1.
Maximum length: 14.
Pattern: ^[0-9]{1,14}?$.
extension_number
string
The extension number.
Minimum length: 1.
Maximum length: 15.
Pattern: ^[0-9]{1,15}?$.

phone

country_code
string
required
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).
Minimum length: 1.
Maximum length: 3.
Pattern: ^[0-9]{1,3}?$.
national_number
string
required
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).
Minimum length: 1.
Maximum length: 14.
Pattern: ^[0-9]{1,14}?$.
extension_number
string
The extension number.
Minimum length: 1.
Maximum length: 15.
Pattern: ^[0-9]{1,15}?$.

phone_type

phone_type
enum
The phone type.
Possible values: FAX,HOME,MOBILE,OTHER,PAGER.

phone_type

phone_type
enum
The phone type.
The possible values are:
- FAX. A fax machine.
- HOME. A home phone.
- MOBILE. A mobile phone.
- OTHER. Other.
- PAGER. A pager.
- WORK. A work phone.

phone_with_type

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

phone_with_type.phone

national_number
string
required
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).
Minimum length: 1.
Maximum length: 14.
Pattern: ^[0-9]{1,14}?$.

platform_fee

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

processing_instruction

processing_instruction
enum
The instruction to process an order.
The possible values are:
- ORDER_COMPLETE_ON_PAYMENT_APPROVAL. API Caller expects the Order to be auto completed (i.e. for PayPal to authorize or capture depending on the intent) on completion of payer approval. This option is not relevant for payment_source that typically do not require a payer approval or interaction. This option is currently only available for the following payment_source: Alipay, Bancontact, BLIK, boletobancario, eps, giropay, iDEAL, Multibanco, MyBank, OXXO, P24, PayU, PUI, SafetyPay, SatisPay, Sofort, Trustly, TrustPay, Verkkopankki, WeChat Pay
- NO_INSTRUCTION. The API caller intends to authorize v2/checkout/orders/id/authorize or capture v2/checkout/orders/id/capture after the payer approves the order.
Minimum length: 1.
Maximum length: 36.
Pattern: ^[0-9A-Z_]+$.

processor_response

avs_code
enum
The address verification code for Visa, Discover, Mastercard, or American Express transactions.
The possible values are:
- A. For Visa, Mastercard, or Discover transactions, the address matches but the zip code does not match. For American Express transactions, the card holder address is correct.
- B. For Visa, Mastercard, or Discover transactions, the address matches. International A.
- C. For Visa, Mastercard, or Discover transactions, no values match. International N.
- D. For Visa, Mastercard, or Discover transactions, the address and postal code match. International X.
- E. For Visa, Mastercard, or Discover transactions, not allowed for Internet or phone transactions. For American Express card holder, the name is incorrect but the address and postal code match.
- F. For Visa, Mastercard, or Discover transactions, the address and postal code match. UK-specific X. For American Express card holder, the name is incorrect but the address matches.
- G. For Visa, Mastercard, or Discover transactions, global is unavailable. Nothing matches.
- I. For Visa, Mastercard, or Discover transactions, international is unavailable. Not applicable.
- M. For Visa, Mastercard, or Discover transactions, the address and postal code match. For American Express card holder, the name, address, and postal code match.
- N. For Visa, Mastercard, or Discover transactions, nothing matches. For American Express card holder, the address and postal code are both incorrect.
- P. For Visa, Mastercard, or Discover transactions, postal international Z. Postal code only.
- R. For Visa, Mastercard, or Discover transactions, re-try the request. For American Express, the system is unavailable.
- S. For Visa, Mastercard, Discover, or American Express, the service is not supported.
- U. For Visa, Mastercard, or Discover transactions, the service is unavailable. For American Express, information is not available. For Maestro, the address is not checked or the acquirer had no response. The service is not available.
- W. For Visa, Mastercard, or Discover transactions, whole ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.
- X. For Visa, Mastercard, or Discover transactions, exact match of the address and the nine-digit ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.
- Y. For Visa, Mastercard, or Discover transactions, the address and five-digit ZIP code match. For American Express, the card holder address and postal code are both correct.
- Z. For Visa, Mastercard, or Discover transactions, the five-digit ZIP code matches but no address. For American Express, only the card holder postal code is correct.
- Null. For Maestro, no AVS response was obtained.
- 0. For Maestro, all address information matches.
- 1. For Maestro, none of the address information matches.
- 2. For Maestro, part of the address information matches.
- 3. For Maestro, the merchant did not provide AVS information. It was not processed.
- 4. For Maestro, the address was not checked or the acquirer had no response. The service is not available.
Read only.
cvv_code
enum
The card verification value code for for Visa, Discover, Mastercard, or American Express.
The possible values are:
- E. For Visa, Mastercard, Discover, or American Express, error - unrecognized or unknown response.
- I. For Visa, Mastercard, Discover, or American Express, invalid or null.
- M. For Visa, Mastercard, Discover, or American Express, the CVV2/CSC matches.
- N. For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does not match.
- P. For Visa, Mastercard, Discover, or American Express, it was not processed.
- S. For Visa, Mastercard, Discover, or American Express, the service is not supported.
- U. For Visa, Mastercard, Discover, or American Express, unknown - the issuer is not certified.
- X. For Visa, Mastercard, Discover, or American Express, no response. For Maestro, the service is not available.
- All others. For Visa, Mastercard, Discover, or American Express, error.
- 0. For Maestro, the CVV2 matched.
- 1. For Maestro, the CVV2 did not match.
- 2. For Maestro, the merchant has not implemented CVV2 code handling.
- 3. For Maestro, the merchant has indicated that CVV2 is not present on card.
- 4. For Maestro, the service is not available.
Read only.
response_code
enum
Processor response code for the non-PayPal payment processor errors.
The possible values are:
- 0000. APPROVED.
- 0100. REFERRAL.
- 0800. BAD_RESPONSE_REVERSAL_REQUIRED.
- 1000. PARTIAL_AUTHORIZATION.
- 1300. INVALID_DATA_FORMAT.
- 1310. INVALID_AMOUNT.
- 1312. INVALID_TRANSACTION_CARD_ISSUER_ACQUIRER.
- 1317. INVALID_CAPTURE_DATE.
- 1320. INVALID_CURRENCY_CODE.
- 1330. INVALID_ACCOUNT.
- 1335. INVALID_ACCOUNT_RECURRING.
- 1340. INVALID_TERMINAL.
- 1350. INVALID_MERCHANT.
- 1360. BAD_PROCESSING_CODE.
- 1370. INVALID_MCC.
- 1380. INVALID_EXPIRATION.
- 1382. INVALID_CARD_VERIFICATION_VALUE.
- 1384. INVALID_LIFE_CYCLE_OF_TRANSACTION.
- 1390. INVALID_ORDER.
- 1393. TRANSACTION_CANNOT_BE_COMPLETED.
- 0500. DO_NOT_HONOR.
- 5100. GENERIC_DECLINE.
- 5110. CVV2_FAILURE.
- 5120. INSUFFICIENT_FUNDS.
- 5130. INVALID_PIN.
- 5140. CARD_CLOSED.
- 5150. PICKUP_CARD_SPECIAL_CONDITIONS. Try using another card. Do not retry the same card.
- 5160. UNAUTHORIZED_USER.
- 5170. AVS_FAILURE.
- 5180. INVALID_OR_RESTRICTED_CARD. Try using another card. Do not retry the same card.
- 5190. SOFT_AVS.
- 5200. DUPLICATE_TRANSACTION.
- 5210. INVALID_TRANSACTION.
- 5400. EXPIRED_CARD.
- 5500. INCORRECT_PIN_REENTER.
- 5700. TRANSACTION_NOT_PERMITTED. Outside of scope of accepted business.
- 5800. REVERSAL_REJECTED.
- 5900. INVALID_ISSUE.
- 5910. ISSUER_NOT_AVAILABLE_NOT_RETRIABLE.
- 5920. ISSUER_NOT_AVAILABLE_RETRIABLE.
- 6300. ACCOUNT_NOT_ON_FILE.
- 7600. APPROVED_NON_CAPTURE.
- 7700. ERROR_3DS.
- 7710. AUTHENTICATION_FAILED.
- 7800. BIN_ERROR.
- 7900. PIN_ERROR.
- 8000. PROCESSOR_SYSTEM_ERROR.
- 8010. HOST_KEY_ERROR.
- 8020. CONFIGURATION_ERROR.
- 8030. UNSUPPORTED_OPERATION.
- 8100. FATAL_COMMUNICATION_ERROR.
- 8110. RETRIABLE_COMMUNICATION_ERROR.
- 8220. SYSTEM_UNAVAILABLE.
- 9100. DECLINED_PLEASE_RETRY. Retry.
- 9500. SUSPECTED_FRAUD. Try using another card. Do not retry the same card.
- 9510. SECURITY_VIOLATION.
- 9520. LOST_OR_STOLEN. Try using another card. Do not retry the same card.
- 9530. HOLD_CALL_CENTER. The merchant must call the number on the back of the card. POS scenario.
- 9540. REFUSED_CARD.
- 9600. UNRECOGNIZED_RESPONSE_CODE.
- 5930. CARD_NOT_ACTIVATED.
- PPMD. PPMD.
- PPCE. CE_REGISTRATION_INCOMPLETE.
- PPNT. NETWORK_ERROR.
- PPCT. CARD_TYPE_UNSUPPORTED.
- PPTT. TRANSACTION_TYPE_UNSUPPORTED.
- PPCU. CURRENCY_USED_INVALID.
- PPQC. QUASI_CASH_UNSUPPORTED.
- PPVE. VALIDATION_ERROR.
- PPVT. VIRTUAL_TERMINAL_UNSUPPORTED.
- PPDC. DCC_UNSUPPORTED.
- PPER. INTERNAL_SYSTEM_ERROR.
- PPIM. ID_MISMATCH.
- PPH1. H1_ERROR.
- PPSD. STATUS_DESCRIPTION.
- PPAG. ADULT_GAMING_UNSUPPORTED.
- PPLS. LARGE_STATUS_CODE.
- PPCO. COUNTRY.
- PPAD. BILLING_ADDRESS.
- PPAU. MCC_CODE.
- PPUC. CURRENCY_CODE_UNSUPPORTED.
- PPUR. UNSUPPORTED_REVERSAL.
- PPVC. VALIDATE_CURRENCY.
- PPS0. BANKAUTH_ROW_MISMATCH.
- PPS1. BANKAUTH_ROW_SETTLED.
- PPS2. BANKAUTH_ROW_VOIDED.
- PPS3. BANKAUTH_EXPIRED.
- PPS4. CURRENCY_MISMATCH.
- PPS5. CREDITCARD_MISMATCH.
- PPS6. AMOUNT_MISMATCH.
- PPRF. INVALID_PARENT_TRANSACTION_STATUS.
- PPEX. EXPIRY_DATE.
- PPAX. AMOUNT_EXCEEDED.
- PPDV. AUTH_MESSAGE.
- PPDI. DINERS_REJECT.
- PPAR. AUTH_RESULT.
- PPBG. BAD_GAMING.
- PPGR. GAMING_REFUND_ERROR.
- PPCR. CREDIT_ERROR.
- PPAI. AMOUNT_INCOMPATIBLE.
- PPIF. IDEMPOTENCY_FAILURE.
- PPMC. BLOCKED_Mastercard.
- PPAE. AMEX_DISABLED.
- PPFV. FIELD_VALIDATION_FAILED.
- PPII. INVALID_INPUT_FAILURE.
- PPPM. INVALID_PAYMENT_METHOD.
- PPUA. USER_NOT_AUTHORIZED.
- PPFI. INVALID_FUNDING_INSTRUMENT.
- PPEF. EXPIRED_FUNDING_INSTRUMENT.
- PPFR. RESTRICTED_FUNDING_INSTRUMENT.
- PPEL. EXCEEDS_FREQUENCY_LIMIT.
- PCVV. CVV_FAILURE.
- PPTV. INVALID_VERIFICATION_TOKEN.
- PPTE. VERIFICATION_TOKEN_EXPIRED.
- PPPI. INVALID_PRODUCT.
- PPIT. INVALID_TRACE_ID.
- PPTF. INVALID_TRACE_REFERENCE.
- PPFE. FUNDING_SOURCE_ALREADY_EXISTS.
- PPTR. VERIFICATION_TOKEN_REVOKED.
- PPTI. INVALID_TRANSACTION_ID.
- PPD3. SECURE_ERROR_3DS.
- PPPH. NO_PHONE_FOR_DCC_TRANSACTION.
- PPAV. ARC_AVS.
- PPC2. ARC_CVV.
- PPLR. LATE_REVERSAL.
- PPNC. NOT_SUPPORTED_NRC.
- PPRR. MERCHANT_NOT_REGISTERED.
- PPSC. ARC_SCORE.
- PPSE. AMEX_DENIED.
- PPUE. UNSUPPORT_ENTITY.
- PPUI. UNSUPPORT_INSTALLMENT.
- PPUP. UNSUPPORT_POS_FLAG.
- PPRE. UNSUPPORT_REFUND_ON_PENDING_BC.
Read only.
payment_advice_code
enum
The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.
The possible values are:
- 01. For Mastercard, expired card account upgrade or portfolio sale conversion. Obtain new account information before next billing cycle.
- 02. For Mastercard, over credit limit or insufficient funds. Retry the transaction 72 hours later. For Visa, the card holder wants to stop only one specific payment in the recurring payment relationship. The merchant must NOT resubmit the same transaction. The merchant can continue the billing process in the subsequent billing period.
- 03. For Mastercard, account closed as fraudulent. Obtain another type of payment from customer due to account being closed or fraud. Possible reason: Account closed as fraudulent. For Visa, the card holder wants to stop all recurring payment transactions for a specific merchant. Stop recurring payment requests.
- 21. For Mastercard, the card holder has been unsuccessful at canceling recurring payment through merchant. Stop recurring payment requests. For Visa, all recurring payments were canceled for the card number requested. Stop recurring payment requests.
Read only.

purchase_unit

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.
Note: If there are multiple purchase units, reference_id is required for each purchase unit.
Minimum length: 1.
Maximum length: 256.
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.
payee
object
The merchant who receives payment for this transaction.
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.
description
string
The purchase description.
Minimum length: 1.
Maximum length: 127.
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.
Minimum length: 1.
Maximum length: 127.
invoice_id
string
The API caller-provided external invoice ID for this order.
Minimum length: 1.
Maximum length: 127.
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.
Minimum length: 1.
Maximum length: 19.
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.
Minimum length: 1.
Maximum length: 22.
items
array (contains the item object)
An array of items that the customer purchases from the merchant.
shipping
object
The shipping address and method.
payments
object
The comprehensive history of payments for the purchase unit.
Read only.

purchase_unit_request

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.
Minimum length: 1.
Maximum length: 256.
amount
object
required
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
payee
object
The merchant who receives payment for this transaction.
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.
description
string
The purchase description. The maximum length of the character is dependent on the type of characters used. The character length is specified assuming a US ASCII character. Depending on type of character; (e.g. accented character, Japanese characters) the number of characters that that can be specified as input might not equal the permissible max length.
Minimum length: 1.
Maximum length: 127.
custom_id
string
The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions. Appears in transaction and settlement reports but is not visible to the payer.
Minimum length: 1.
Maximum length: 127.
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.
Minimum length: 1.
Maximum length: 127.
soft_descriptor
string
The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement.

If an Order is paid using the "PayPal Wallet", the statement descriptor will appear in following format on the payer's card statement: PAYPAL_prefix+(space)+merchant_descriptor+(space)+ soft_descriptor
Note: The merchant descriptor is the descriptor of the merchant’s payment receiving preferences which can be seen by logging into the merchant account https://www.sandbox.paypal.com/businessprofile/settings/info/edit
The PAYPAL prefix uses 8 characters. Only the first 22 characters will be displayed in the statement.
For example, if:
- The merchant descriptor in the profile is Janes Gift.
- The soft descriptor is 800-123-1234.
Then, the statement descriptor on the card is PAYPAL Janes Gift 80.
Minimum length: 1.
Maximum length: 22.
items
array (contains the item object)
An array of items that the customer purchases from the merchant.
shipping
object
The name and address of the person to whom to ship the items.

reason

reason
enum
The reason for the risk assessment score.
The possible values are:
- UNUSUAL_ENTITY. The account and transaction is associated with possibly unusual entities.
- UNUSUAL_ENTITY_DEVICE_RISK. The account and transaction is associated with stronger correlation to bad devices.
- HIGH_VELOCITY. The account or device is associated with a high transaction frequency.
- HIGH_RISK_CONNECTION. This transaction is initiated from risky network, such as VPN or proxy.
- NEGATIVE_HISTORY. This account and device are associated with a high rate of possibly fraudulent transactions.
- HIGH_RISK_LINKING. This account and transaction indicate stronger correlation to a possibly fraudulent network.
- HIGH_RISK_GENERIC. The transaction has stronger indicators of fraudulent activity due to multiple reasons.
- LOW_UNAUTHORIZED_RISK. This transaction is unlikely to be fraudulent.
- HIGH_MERCHANDISE_RISK. This merchant has a history of a stronger correlation to fraud.
- UNUSUAL_MERCHANT_IDENTITY. PayPal cannot confirm this merchant’s identity.
- RISKY_BUSINESS_PROFILE. The industry or vertical for this merchant is risky.
- UNUSUAL_ACCOUNT_ENTITIES. This merchant account is associated with risky entities, such as a possibly stolen or risky credit card, or a device linked to possible fraud.
- SUBSTANDARD_SELLER. This merchant has unusually high rates of reversals.
- UNUSUAL_SELLING_BEHAVIOR. A change occurred in business models from historical selling for this merchant.
- INCREASED_RISK_EXPOSURE. This merchant account is at increased risk due to a change in selling velocity or other changes.
- INSUFFICIENT_INFORMATION. The merchant has a limited transaction history.
- POTENTIAL_COLLUSION. The merchant shows stronger potential for collusion with the consumer.
- LOW_MERCHANDISE_RISK. The merchant is unlikely to be fraudulent.
- LINKED_PAYPAL_SELLER. This merchant has an account with PayPal.
Maximum length: 256.

reason_code

reason_code
string
A reason for the processing decision. Eg: CUSTOM_BANK_PROCESSING_NOT_ENABLED_FOR_RECEIVER, PRODUCT_UCC_NOT_ENABLED_FOR_RECEIVER Etc.
Minimum length: 1.
Maximum length: 127.

refund

status
string
The status of the refund.
status_details
object
The details of the refund status.

id
string
The PayPal-generated ID for the refund.
amount
object
The amount that the payee refunded to the payer.
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.
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.
links
array (contains the link_description object)
An array of related HATEOAS links.

create_time
string
The date and time when the transaction occurred, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.
update_time
string
The date and time when the transaction was last updated, in Internet date and time format.
Minimum length: 20.
Maximum length: 64.
Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$.

refund_status

status
enum
The status of the refund.
The possible values are:
- CANCELLED. The refund was cancelled.
- PENDING. The refund is pending. For more information, see status_details.reason.
- COMPLETED. The funds for this transaction were debited to the customer's account.
Read only.
status_details
object
The details of the refund status.
Read only.

refund_status_details

reason
enum
The reason why the refund has the PENDING or FAILED status.
The possible values are:
- ECHECK. The customer's account is funded through an eCheck, which has not yet cleared.

risk_assessment

score
integer
The fine-grained numeric evaluation. Value is from 0 to 999.
Read only.
Maximum value: 999.
reasons
array (contains the reason object)
An array of risk assessment reasons.
Read only.

seller_payable_breakdown

gross_amount
object
The amount that the payee refunded to the payer.
Read only.
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.
Read only.
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'.
Read only.
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.
Read only.
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'.
Read only.
platform_fees
array (contains the platform_fee object)
An array of platform or partner fees, commissions, or brokerage fees for the refund.
net_amount_breakdown
array (contains the 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.
Read only.
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.

seller_protection

status
enum
Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.
The possible values are:
- ELIGIBLE. Your PayPal balance remains intact if the customer claims that they did not receive an item or the account holder claims that they did not authorize the payment.
- PARTIALLY_ELIGIBLE. Your PayPal balance remains intact if the customer claims that they did not receive an item.
- NOT_ELIGIBLE. This transaction is not eligible for seller protection.
Read only.
dispute_categories
array (contains the dispute_category object)
An array of conditions that are covered for the transaction.
Read only.

seller_receivable_breakdown

gross_amount
object
required
The amount for this captured payment in the currency of the transaction.
paypal_fee
object
The applicable fee for this captured payment in the currency of the transaction.
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'.
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.
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.
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.
Read only.
platform_fees
array (contains the platform_fee object)
An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.

shipping_detail

name
object
The name of the person to whom to ship the items. Supports only the full_name property.
type
enum
The method by which the payer wants to get their items from the payee e.g shipping, in-person pickup. Either type or options but not both may be present.
The possible values are:
- SHIPPING. The payer intends to receive the items at a specified address.
- PICKUP_IN_PERSON. The payer intends to pick up the items from the payee in person.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
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.

shipping_detail.address_portable

address_line_1
string
The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
Maximum length: 300.
address_line_2
string
The second line of the address. For example, suite or apartment number.
Maximum length: 300.
admin_area_2
string
A city, town, or village. Smaller than admin_area_level_1.
Maximum length: 120.
admin_area_1
string
The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format 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.
Maximum length: 300.
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.
Maximum length: 60.
country_code
string
required
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

shipping_detail.name

full_name
string
When the party is a person, the party's full name.
Maximum length: 300.

shipping_option

id
string
required
A unique ID that identifies a payer-selected shipping option.
Maximum length: 127.
label
string
required
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.
Maximum length: 127.
type
enum
The method by which the payer wants to get their items.
The possible values are:
- SHIPPING. The payer intends to receive the items at a specified address.
- PICKUP. The payer intends to pick up the items at a specified address. For example, a store address.
amount
object
The shipping cost for the selected option.
selected
boolean
required
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.

shipping_type

shipping_type
enum
The method by which the payer wants to get their items.
The possible values are:
- SHIPPING. The payer intends to receive the items at a specified address.
- PICKUP. The payer intends to pick up the items at a specified address. For example, a store address.

sofort

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).
iban_last_chars
string
The last characters of the IBAN used to pay.

sofort_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.

stored_payment_source

payment_initiator
enum
required
The person or party who initiated or triggered the payment.
The possible values are:
- CUSTOMER. Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website.
- MERCHANT. Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
payment_type
enum
required
Indicates the type of the stored payment_source payment.
The possible values are:
- ONE_TIME. One Time payment such as online purchase or donation. (e.g. Checkout with one-click).
- RECURRING. Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).
- UNSCHEDULED. Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
usage
enum
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
The possible values are:
- FIRST. Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.
- SUBSEQUENT. Indicates a payment using a stored payment_source which has been successfully used previously for a payment.
- DERIVED. Indicates that PayPal will derive the value of `FIRST` or `SUBSEQUENT` based on data available to PayPal.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
previous_network_transaction_reference
object
Reference values used by the card network to identify a transaction.

stored_payment_source_payment_type

stored_payment_source_payment_type
enum
Indicates the type of the stored payment_source payment.
The possible values are:
- ONE_TIME. One Time payment such as online purchase or donation. (e.g. Checkout with one-click).
- RECURRING. Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments).
- UNSCHEDULED. Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments).
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

stored_payment_source_usage_type

stored_payment_source_usage_type
enum
Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
The possible values are:
- FIRST. Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment.
- SUBSEQUENT. Indicates a payment using a stored payment_source which has been successfully used previously for a payment.
- DERIVED. Indicates that PayPal will derive the value of `FIRST` or `SUBSEQUENT` based on data available to PayPal.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

tax_info

tax_id
string
required
The customer's tax ID value.
Minimum length: 1.
Maximum length: 14.
tax_id_type
enum
required
The customer's tax ID type.
The possible values are:
- BR_CPF. The individual tax ID type, typically is 11 characters long.
- BR_CNPJ. The business tax ID type, typically is 14 characters long.
Minimum length: 1.
Maximum length: 14.

three_d_secure_authentication_response

authentication_status
enum
The outcome of the issuer's authentication.
The possible values are:
- Y. Successful authentication.
- N. Failed authentication / account not verified / transaction denied.
- U. Unable to complete authentication.
- A. Successful attempts transaction.
- C. Challenge required for authentication.
- R. Authentication rejected (merchant must not submit for authorization).
- D. Challenge required; decoupled authentication confirmed.
- I. Informational only; 3DS requestor challenge preference acknowledged.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.
enrollment_status
enum
Status of authentication eligibility.
The possible values are:
- Y. Yes. The bank is participating in 3-D Secure protocol and will return the ACSUrl.
- N. No. The bank is not participating in 3-D Secure protocol.
- U. Unavailable. The DS or ACS is not available for authentication at the time of the request.
- B. Bypass. The merchant authentication rule is triggered to bypass authentication.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_]+$.

time_duration

time_duration
string
The ISO-8601-formatted length of time in years, months, weeks, days, hours, minutes, and seconds.
Note: The format is PyYmMdDThHmMsS. When an amount is zero, you can omit it. Because week cannot co-exist with other time components in ISO-8601 duration, specify P7D. Make provisions to incorporate the effects of daylight savings time.

For more information, see durations.
Pattern: ^P([0-9]+Y)?([0-9]+M)?([0-9]+W)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+S)?)?$.

token

id
string
required
The PayPal-generated ID for the token.
Minimum length: 1.
Maximum length: 255.
type
enum
required
The tokenization method that generated the ID.
The possible values are:
- BILLING_AGREEMENT. The PayPal billing agreement ID. References an approved recurring payment for goods or services.
Minimum length: 1.
Maximum length: 255.
Pattern: ^[0-9A-Z_-]+$.

trustly

name
string
The name of the account holder associated with this payment method.
country_code
string
The two-character ISO 3166-1 country code.
bic
string
The bank identification code (BIC).
iban_last_chars
string
The last characters of the IBAN used to pay.

trustly_request

name
string
required
The name of the account holder associated with this payment method.
country_code
string
required
The two-character ISO 3166-1 country code.

PayPal-Request-Id

PayPal-Partner-Attribution-Id

PayPal-Client-Metadata-Id

Prefer

Authorization

Content-Type

intent

processing_instruction

payer

purchase_units

application_context

Sample Request

create_time

update_time

id

payment_source

intent

processing_instruction

payer

purchase_units

status

links

Sample Response

Authorization

Content-Type

id

patch_request

Sample Request

Sample Response

fields

Authorization

Content-Type

id

Sample Request

create_time

update_time

id

payment_source

intent

processing_instruction

payer

purchase_units

status

links

Sample Response

PayPal-Request-Id

Prefer

PayPal-Client-Metadata-Id

Authorization

PayPal-Auth-Assertion

Content-Type

id

payment_source

Sample Request

create_time

update_time

id

payment_source

intent

processing_instruction

payer

purchase_units

status

links

Sample Response

PayPal-Request-Id

Prefer

PayPal-Client-Metadata-Id

Authorization

PayPal-Auth-Assertion

Content-Type

id

payment_source

Sample Request

create_time

update_time

id

payment_source

intent

processing_instruction

`PayPal-Request-Id`

`PayPal-Partner-Attribution-Id`

`PayPal-Client-Metadata-Id`

`Prefer`

`Authorization`

`Content-Type`

`intent`

`processing_instruction`

`payer`

`purchase_units`

`application_context`

`create_time`

`update_time`

`id`

`payment_source`

`intent`

`processing_instruction`

`payer`

`purchase_units`

`status`

`links`

`Authorization`

`Content-Type`

`id`

`patch_request`

`fields`

`Authorization`

`Content-Type`

`id`

`create_time`

`update_time`

`id`

`payment_source`

`intent`

`processing_instruction`

`payer`

`purchase_units`

`status`

`links`

`PayPal-Request-Id`

`Prefer`

`PayPal-Client-Metadata-Id`

`Authorization`

`PayPal-Auth-Assertion`

`Content-Type`

`id`

`payment_source`

`create_time`

`update_time`

`id`

`payment_source`

`intent`

`processing_instruction`

`payer`

`purchase_units`

`status`

`links`

`PayPal-Request-Id`

`Prefer`

`PayPal-Client-Metadata-Id`

`Authorization`

`PayPal-Auth-Assertion`

`Content-Type`

`id`

`payment_source`

`create_time`

`update_time`

`id`

`payment_source`

`intent`

`processing_instruction`

`payer`

`purchase_units`

`status`

`links`

`PayPal-Client-Metadata-Id`

`Authorization`

`Content-Type`

`Prefer`

`id`