Orders API

Important: PayPal for Marketplaces is a limited-release solution at this time. It is available to select partners for approved use cases. For more information, reach out to your PayPal account manager or contact us.

Use the Orders API to create, view, and pay for orders and to disburse funds based on order approval. For details, see the Orders Integration Guide.

Orders (resource group)

Use the /checkout/orders resource to create, cancel, and show details for orders.

Create order

POST /v1/checkout/orders
Creates an order.
First, to set the transaction context and enable the server to perform risk and compliance analysis of the transaction, call /v1/risk/transaction-contexts to generate a tracking ID. Save and include this ID in the Paypal-Client-Metadata-Id request header in your call to /v1/checkout/orders.
A successful request returns the HTTP 200 OK status code and a JSON response body that shows order details.

Request

In the JSON request body, specify one or more purchase units, optional customer information, and, if PayPal is the payment method, redirect URLs. If the customer approves the PayPal payment, redirect the customer to the return URL. Otherwise, redirect the customer to the cancel URL.

  • intent

    enum

    The intent.

    Allowed values: SALE, AUTHORIZE.

  • purchase_units

    array (contains the purchase_unit object)

    required

    A purchase unit. Use to capture required information for the payment contract.
  • application_context

    object

    Application Context - Merchant Experience Information
  • payer_info

    object

    The payer information.
  • redirect_urls

    object

    required

    The redirect URLs. Required only for the PayPal payment method. The supported settings are return and cancel URLs.

Sample Request

curl -v -X POST https://api.sandbox.paypal.com/v1/checkout/orders \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
  "purchase_units": [
  {
    "reference_id": "store_mobile_world_order_1234",
    "description": "Mobile World Store order-1234",
    "amount": {
    "currency": "USD",
    "details": {
      "subtotal": "1.09",
      "shipping": "0.02",
      "tax": "0.33"
    },
    "total": "1.44"
    },
    "payee": {
    "email": "seller@mobileworld.com"
    },
    "items": [
    {
      "name": "NeoPhone",
      "sku": "sku03",
      "price": "0.54",
      "currency": "USD",
      "quantity": "1",
      "category": "PHYSICAL"
    },
    {
      "name": "Fitness Watch",
      "sku": "sku04",
      "price": "0.55",
      "currency": "USD",
      "quantity": "1",
      "category": "PHYSICAL"
    }
    ],
    "shipping_address": {
    "recipient_name": "John Doe",
    "line1": "2211 N First Street",
    "line2": "Building 17",
    "city": "San Jose",
    "country_code": "US",
    "postal_code": "95131",
    "state": "CA",
    "phone": "(123) 456-7890"
    },
    "shipping_method": "United Postal Service",
    "partner_fee_details": {
    "receiver": {
      "email": "partner@mobileworld.com"
    },
    "amount": {
      "value": "0.01",
      "currency": "USD"
    }
    },
    "payment_linked_group": 1,
    "custom": "custom_value_2388",
    "invoice_number": "invoice_number_2388",
    "payment_descriptor": "Payment Mobile World"
  }
  ],
  "redirect_urls": {
  "return_url": "https://marketplace.com/return",
  "cancel_url": "https://marketplace.com/cancel"
  }
}'

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that includes the PayPal-generated order ID, an array of purchase unit objects, payment details, customer information, metadata, and order status.

  • id

    string

    The ID of the order.

    Read only.

  • intent

    enum

    The intent.

    Possible values: SALE, AUTHORIZE.

  • purchase_units

    array (contains the purchase_unit object)

    A purchase unit. Use to capture required information for the payment contract.
  • payment_details

    object

    The payment details for the order.

    Read only.

  • application_context

    object

    Application Context - Merchant Experience Information
  • payer_info

    object

    The payer information.
  • metadata

    object

    Metadata.

    Read only.

  • status

    enum

    The status of the order. After the customer approves the order, the status is APPROVED. After the payment is mader for the order and the order completes, the status is COMPLETED.

    Read only.

    Possible values: CREATED, APPROVED, COMPLETED, FAILED.

  • redirect_urls

    object

    The redirect URLs. Required only for the PayPal payment method. The supported settings are return and cancel URLs.
  • create_time

    string

    The date and time when the resource was created.

    Read only.

  • update_time

    string

    The date and time when the resource was last updated.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

Sample Response

{
  "id": "8RU61172JS455403V",
  "gross_total_amount": {
    "value": "1.44",
    "currency": "USD"
  },
  "purchase_units": [
    {
      "reference_id": "store_mobile_world_order_1234",
      "description": "Mobile World Store order-1234",
      "amount": {
        "currency": "USD",
        "details": {
          "subtotal": "1.09",
          "shipping": "0.02",
          "tax": "0.33"
        },
        "total": "1.44"
      },
      "payee": {
        "email": "seller@mobileworld.com"
      },
      "items": [
        {
          "name": "NeoPhone",
          "sku": "sku03",
          "price": "0.54",
          "currency": "USD",
          "quantity": "1",
          "category": "PHYSICAL"
        },
        {
          "name": "Fitness Watch",
          "sku": "sku04",
          "price": "0.55",
          "currency": "USD",
          "quantity": "1",
          "category": "PHYSICAL"
        }
      ],
      "shipping_address": {
        "recipient_name": "John Doe",
        "default_address": false,
        "preferred_address": false,
        "primary_address": false,
        "disable_for_transaction": false,
        "line1": "2211 N First Street",
        "line2": "Building 17",
        "city": "San Jose",
        "country_code": "US",
        "postal_code": "95131",
        "state": "CA",
        "phone": "(123) 456-7890"
      },
      "shipping_method": "United Postal Service",
      "partner_fee_details": {
        "receiver": {
          "email": "partner@mobileworld.com"
        },
        "amount": {
          "value": "0.01",
          "currency": "USD"
        }
      },
      "payment_linked_group": 1,
      "custom": "custom_value_2388",
      "invoice_number": "invoice_number_2388",
      "payment_descriptor": "Payment Mobile World",
      "status": "CAPTURED"
    }
  ],
  "redirect_urls": {
    "return_url": "https://marketplace.com/return",
    "cancel_url": "https://marketplace.com/cancel"
  },
  "create_time": "2017-04-26T21:18:49Z",
  "links": [
    {
      "href": "https://api.paypal.com//v1/checkout/orders/8RU61172JS455403V",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://www.paypal.com/webapps/hermes?token=8RU61172JS455403V",
      "rel": "approval_url",
      "method": "GET"
    },
    {
      "href": "https://api.paypal.com//v1/checkout/orders/8RU61172JS455403V",
      "rel": "cancel",
      "method": "DELETE"
    }
  ],
  "status": "CREATED"
}

Cancel order

DELETE /v1/checkout/orders/order_id

Cancels an order, by ID, and deletes the order resource.

To call this method, the order status must be CREATED or APPROVED.

Parameters

  • order_id

    path string

    required

    The ID of the order to cancel.

Sample Request

curl -v -X DELETE https://api.sandbox.paypal.com/v1/checkout/orders/RT52181732T9513405D \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token"

Response

The order status. After the customer approves the order, its status changes to APPROVED. After the order completes, its status changes to COMPLETED.

Sample Response

204 No Content

Show order details

GET /v1/checkout/orders/order_id

Shows details for an order, by ID.

Parameters

  • order_id

    path string

    required

    The ID of the order for which to show details.

Sample Request

curl -v -X GET https://api.sandbox.paypal.com/v1/checkout/orders/8RU61172JS455403V \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token"

Response

  • id

    string

    The ID of the order.

    Read only.

  • intent

    enum

    The intent.

    Possible values: SALE, AUTHORIZE.

  • purchase_units

    array (contains the purchase_unit object)

    A purchase unit. Use to capture required information for the payment contract.
  • payment_details

    object

    The payment details for the order.

    Read only.

  • application_context

    object

    Application Context - Merchant Experience Information
  • payer_info

    object

    The payer information.
  • metadata

    object

    Metadata.

    Read only.

  • status

    enum

    The status of the order. After the customer approves the order, the status is APPROVED. After the payment is mader for the order and the order completes, the status is COMPLETED.

    Read only.

    Possible values: CREATED, APPROVED, COMPLETED, FAILED.

  • redirect_urls

    object

    The redirect URLs. Required only for the PayPal payment method. The supported settings are return and cancel URLs.
  • create_time

    string

    The date and time when the resource was created.

    Read only.

  • update_time

    string

    The date and time when the resource was last updated.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

Sample Response

{
  "id": "8RU61172JS455403V",
  "gross_total_amount": {
    "value": "1.44",
    "currency": "USD"
  },
  "purchase_units": [
    {
      "reference_id": "store_mobile_world_order_1234",
      "description": "Mobile World Store order-1234",
      "amount": {
        "currency": "USD",
        "details": {
          "subtotal": "1.09",
          "shipping": "0.02",
          "tax": "0.33"
        },
        "total": "1.44"
      },
      "payee": {
        "email": "seller@mobileworld.com"
      },
      "items": [
        {
          "name": "NeoPhone",
          "sku": "sku03",
          "price": "0.54",
          "currency": "USD",
          "quantity": "1",
          "category": "PHYSICAL"
        },
        {
          "name": "Fitness Watch",
          "sku": "sku04",
          "price": "0.55",
          "currency": "USD",
          "quantity": "1",
          "category": "PHYSICAL"
        }
      ],
      "shipping_address": {
        "recipient_name": "John Doe",
        "default_address": false,
        "preferred_address": false,
        "primary_address": false,
        "disable_for_transaction": false,
        "line1": "2211 N First Street",
        "line2": "Building 17",
        "city": "San Jose",
        "country_code": "US",
        "postal_code": "95131",
        "state": "CA",
        "type": "GIFT"
      },
      "shipping_method": "United Postal Service",
      "partner_fee_details": {
        "receiver": {
          "email": "partner@mobileworld.com"
        },
        "amount": {
          "value": "0.01",
          "currency": "USD"
        }
      },
      "payment_linked_group": 1,
      "payment_summary": {
        "captures": [
          {
            "id": "14U02018GD754745H",
            "amount": {
              "currency": "USD",
              "details": {},
              "total": "1.44"
            },
            "status": "COMPLETED",
            "transaction_fee": {
              "value": "0.36",
              "currency": "USD"
            },
            "links": [
              {
                "href": "https://api.paypal.com/v1/payments/capture/14U02018GD754745H",
                "rel": "self",
                "method": "GET"
              },
              {
                "href": "https://api.paypal.com/v1/payments/capture/14U02018GD754745H/refund",
                "rel": "refund",
                "method": "POST"
              }
            ]
          }
        ]
      },
      "custom": "custom_value_2388",
      "invoice_number": "invoice_number_2388",
      "payment_descriptor": "Payment Mobile World",
      "status": "CAPTURED"
    }
  ],
  "payment_details": {
    "payment_id": "PAYID-LEAQ63Q3HV803789J6535430"
  },
  "payer_info": {
    "email": "dan@paypal.com",
    "first_name": "Dan",
    "last_name": "Schulman",
    "payer_id": "9WVBNYPKKNBJS",
    "country_code": "US",
    "billing_address": {
      "line1": "1 Main St",
      "line2": "",
      "city": "San Jose",
      "country_code": "US",
      "postal_code": "95131",
      "state": "CA"
    },
    "shipping_address": {
      "recipient_name": "Dan Schulman",
      "default_address": false,
      "preferred_address": false,
      "primary_address": false,
      "disable_for_transaction": false,
      "line1": "2211 N First Street",
      "line2": "Building 17",
      "city": "San Jose",
      "country_code": "US",
      "postal_code": "95131",
      "state": "CA",
      "type": "GIFT"
    }
  },
  "metadata": {
    "supplementary_data": [
      {
        "name": "risk_correlation_id",
        "value": "8RU61172JS455403V"
      },
      {
        "name": "buyer_ipaddress",
        "value": "10.225.82.18"
      },
      {
        "name": "external_channel",
        "value": "WEB"
      }
    ]
  },
  "redirect_urls": {
    "return_url": "https://marketplace.com/return",
    "cancel_url": "https://marketplace.com/cancel"
  },
  "create_time": "2017-04-26T21:18:49Z",
  "links": [
    {
      "href": "https://api.paypal.com/v1/checkout/orders/8RU61172JS455403V",
      "rel": "self",
      "method": "GET"
    }
  ],
  "status": "COMPLETED"
}

Orders payment actions (resource group)

Use the /orders resource with the /pay action to pay for an order.

When you create an order, the response includes an approval URL. Redirect the customer to this URL to approve the order.

Pay for order

POST /v1/checkout/orders/order_id/pay

Pays for an approved order by ID.

After the buyer approves the order, call this method with the order ID and the disbursement mode.

In the JSON request body, indicate whether to disburse funds to the merchant and marketplace accounts immediately or later. If you delay disbursement, you must call /payments/referenced-payouts-items/pay to disburse funds to the merchant and marketplace.

Parameters

  • order_id

    path string

    required

    The ID of the order for which to execute a payment.

Request

  • disbursement_mode

    enum

    required

    Indicates whether to disburse money instantly or later.

    Allowed values: INSTANT, DELAYED.

  • payer

    object

    The source of the funds for this payment. Either a PayPal account or a credit card.

Sample Request

curl -v -X POST https://api.sandbox.paypal.com/v1/checkout/orders/8RU61172JS455403V/pay \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
  "disbursement_mode": "DELAYED"
}'

Response

To verify that the order does not raise any obvious flags, PayPal completes some basic checks synchronously. The synchronous response includes the order ID, the order status, and some buyer information. However, PayPal completes the bulk of order processing asynchronously. To see the asynchronous response, you must configure a webhook listener and subscribe to events. For each purchase unit, the event shows payment capture details.

  • order_id

    string

    The ID of the order.

    Read only.

  • status

    enum

    The status of the order.

    Read only.

    Possible values: APPROVED, CANCELED, COMPLETED, CREATED, EXPIRED, FAILED, IN_PROGRESS, PARTIALLY_COMPLETED, SUBMITTED.

  • intent

    enum

    The intent.

    Possible values: SALE, AUTHORIZE.

  • payer_info

    object

    The payer information.
  • purchase_units

    array (contains the purchase_unit object)

    A purchase unit. Use to capture required information for the payment contract.
  • create_time

    string

    The date and time when the resource was created.

    Read only.

  • update_time

    string

    The date and time when the resource was last updated.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

Sample Response

{
  "order_id": "8RU61172JS455403V",
  "status": "APPROVED",
  "payer_info": {
    "email": "dan@paypal.com",
    "first_name": "Dan",
    "last_name": "Schulman",
    "payer_id": "9WVBNYPKKNBJS",
    "phone": "4087811648",
    "country_code": "US",
    "shipping_address": {
      "recipient_name": "Dan Schulman",
      "default_address": false,
      "preferred_address": false,
      "primary_address": false,
      "disable_for_transaction": false,
      "line1": "2211 N First Street",
      "line2": "Building 17",
      "city": "San Jose",
      "country_code": "US",
      "postal_code": "95131",
      "state": "CA"
    }
  },
  "create_time": "2017-04-26T21:21:50Z",
  "update_time": "2017-04-26T21:21:50Z",
  "links": [
    {
      "href": "https://api.paypal.com/v1/checkout/orders/8RU61172JS455403V",
      "rel": "self",
      "method": "GET"
    }
  ]
}

Common object definitions

address

  • line1

    string

    The first line of the address. For example, number, street, and so on. Maximum length is 100 characters.
  • line2

    string

    The second line of the address. For example, suite, apartment number, and so on. Maximum length is 100 characters.
  • city

    string

    The city name. Maximum length is 50 characters.
  • country_code

    string

  • postal_code

    string

    The zip code or equivalent. Typically required for countries that have them. Maximum length is 20 characters. Required in certain countries.
  • state

    string

    The two-letter code for US states or the equivalent for other countries. Maximum length is 100 characters.
  • phone

    string

    The phone number, in E.123 format. Maximum length is 50 characters.
  • normalization_status

    enum

    The address normalization status. Returned only for payers from Brazil.

    Read only.

    Possible values: UNKNOWN, UNNORMALIZED_USER_PREFERRED, NORMALIZED, UNNORMALIZED.

  • type

    string

    The type of address. For example, HOME_OR_WORK, GIFT, and so on.

alternative_payment

  • account_id

    string

    The ID of the alternative payment account.

    Maximum length: 128.

  • external_customer_id

    string

    The ID of the payer.

    Maximum length: 128.

  • provider_id

    string

    Optional. The alternative payment provider ID. Required only for certain alternative providers. For example, iDEAL.

    Maximum length: 128.

  • expiration_duration

    string

    Optional. The expiration duration. Used by some payment service providers to control the expiration of the payment link.

    Maximum length: 4.

    Pattern: ^\d{1,2}[a-zA-Z]{1}$.

  • locale

    string

    Optional. The locale. Some payment service providers use this attribute to localize error messages and suggested actions.

    Maximum length: 5.

    Pattern: ^[a-z]{2}_[A-Z]{2}$.

amount

  • currency

    string

    The three-character ISO-4217 currency code. PayPal does not support all currencies.
  • total

    string

    The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters. Supports two decimal places.
  • details

    object

    The additional details about the payment amount.

apple_pay_token

  • payment_token

    string

    An Apple Pay token, as a tokenized and encrypted Apple Pay card and fetched by the Apple Pay SDK.
  • first_name

    string

    The Apple Pay card holder's first name.

    Maximum length: 140.

  • last_name

    string

    The Apple Pay card holder's last name.

    Maximum length: 140.

  • billing_address

    object

    The Apple Pay card holder's billing address.
  • payment_method_display_name

    string

    The Apple Pay card description.

    Maximum length: 100.

  • payment_method_network

    string

    The Apple Pay card payment network.

    Maximum length: 100.

  • payment_method_type

    enum

    The Apple Pay card type.

    Possible values: UNKNOWN, DEBIT, CREDIT, PREPAID, STORE.

    Maximum length: 40.

  • apple_transaction_identifier

    string

    The ID for the Apple Pay transaction. Can be used in a receipt.

    Maximum length: 140.

application_context

  • brand_name

    string

    Brand Name
  • locale

    string

    Locale
  • landing_page

    string

    Landing Page
  • shipping_preferences

    enum

    specify Shipping Preferences

    Possible values: NO_SHIPPING, GET_FROM_FILE, SET_PROVIDED_ADDRESS.

  • user_action

    string

    Defines whether to present the customer with a Continue or Pay Now checkout flow
  • postback_data

    array (contains the name_and_value_pair object)

    A type for name-and-value pairs. Limit the use of name-and-value pairs in an API. Requires approval from architecture.
  • supplementary_data

    array (contains the name_and_value_pair object)

    A type for name-and-value pairs. Limit the use of name-and-value pairs in an API. Requires approval from architecture.

bank_account

  • account_number

    string

    The account number in either:

    Maximum length: 34.

  • account_number_type

    enum

    The type of the bank account number, which is an International Bank Account Number (IBAN) or Basic Bank Account Number (BBAN).

    Possible values: BBAN, IBAN.

  • routing_number

    string

    The routing transit number, or bank code, of the bank. Typically used for domestic accounts only. For international accounts, the IBAN includes the bank code. For more information, see Bank code.

    Maximum length: 34.

  • account_type

    enum

    The bank account type.

    Possible values: CHECKING, SAVINGS.

  • account_name

    string

    The customer-designated account name.

    Maximum length: 64.

  • check_type

    enum

    The check type. Valid when the facilitator or merchant obtained this information from a check.

    Possible values: PERSONAL, COMPANY.

  • auth_type

    enum

    The method by which the check was obtained from the customer, if a check was the source of the information.

    Possible values: CCD, PPD, TEL, POP, ARC, RCK, WEB.

  • auth_capture_timestamp

    string

    The date and time when the authorization was captured, in Internet date and time format. Use this field if the user authorization must be captured due to any privacy requirements.
  • bank_name

    string

    The bank name.

    Maximum length: 64.

  • country_code

    string

  • first_name

    string

    The account holder's first name.

    Maximum length: 64.

  • last_name

    string

    The account holder's last name.

    Maximum length: 64.

  • birth_date

    string

    The bank account holder's birth date, in Internet date format.
  • billing_address

    object

    The billing address.
  • state

    enum

    The funding instrument's state.

    Read only.

    Possible values: ACTIVE, INACTIVE, DELETED.

  • confirmation_status

    enum

    The bank account's confirmation status.

    Read only.

    Possible values: UNCONFIRMED, CONFIRMED.

  • payer_id

    string

    [DEPRECATED] The payer ID. Use external_customer_id instead.
  • external_customer_id

    string

    The facilitor-provided ID of the customer to whom this bank account belongs. Required when you create or use a funding instrument that is stored in the vault.

    Maximum length: 256.

  • merchant_id

    string

    The facilitator-provided ID of the merchant for which this bank account has been stored. Usage of the bank account is restricted to the specific merchant.

    Maximum length: 256.

  • create_time

    string

    The date and time when the resource was created, in Internet date and time format.

    Read only.

  • update_time

    string

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

    Read only.

  • valid_until

    string

    The date and time when the resource can no longer be used to fund a payment, in Internet date and time format.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

bank_token

  • bank_id

    string

    The ID of a bank account that is stored in the PayPal vault.
  • external_customer_id

    string

    The ID of the payer that was used when this bank account was stored in the PayPal vault.
  • mandate_reference_number

    string

    The ID of the direct-debit mandate to validate. Supported for European Union (EU) Single Euro Payments Area (SEPA) bank accounts only.

billing_instrument

  • billing_agreement_id

    string

    The ID of the instrument in the PayPal Wallet.

    Minimum length: 4.

    Maximum length: 20.

    Pattern: BA-([a-zA-Z0-9]){1,17}.

  • selected_installment_option

    object

    The selected installment option for the issuer-based installments (BR and MX).

capture

  • id

    string

    The ID of the capture transaction.

    Read only.

  • amount

    object

    The amount to capture. If you omit this amount, default is the amount from the authorization. If that amount is the same as the authorized amount, the authorization state changes to captured. Otherwise, the authorization state changes to partially_captured. To indicate that this capture is the final capture, set is_final_capture to true.

    Read only.

  • status

    enum

    The state of the capture transaction.

    Read only.

    Possible values: PENDING, COMPLETED, REFUNDED, PARTIALLY_REFUNDED.

  • reason_code

    enum

    A reason code. Indicates the reason for the transaction state of pending or reversed.

    Read only.

    Possible values: CHARGEBACK, GUARANTEE, BUYER_COMPLAINT, REFUND, UNCONFIRMED_SHIPPING_ADDRESS, ECHECK, INTERNATIONAL_WITHDRAWAL, RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION, PAYMENT_REVIEW, REGULATORY_REVIEW, UNILATERAL, VERIFICATION_REQUIRED, DELAYED_DISBURSEMENT.

  • transaction_fee

    object

    The transaction fee.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

carrier_account

  • id

    string

    The ID of the payer's carrier account. Can be used in subsequent REST API calls, such as to make payments.
  • phone_number

    string

    The phone number of the payer, in E.164 format.
  • external_customer_id

    string

    The merchant-created ID for the customer.
  • phone_source

    enum

    The method that is used to obtain the phone number.

    Possible values: READ_FROM_DEVICE, USER_PROVIDED.

  • country_code

    object

    The two-character code for the country where the phone number is registered.

carrier_account_token

  • carrier_account_id

    string

    The ID of a carrier account that is stored in the PayPal vault.
  • external_customer_id

    string

    The ID of the payer that was used when the carrier account instrument was stored in the PayPal vault.

country_code

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 is used in that country's top-level domain names. Use the C2 country code for CHINA WORLDWIDE (for CUP, bank card, and cross-border transactions).

    Minimum length: 2.

    Maximum length: 2.

    Pattern: ^([A-Z]{2}|C2)$.

credit_card

  • number

    string

    The credit card number. Numeric characters only with no spaces or punctuation. The string must conform to the modulo and length required by each credit card type. Redacted in responses.
  • type

    string

    The credit card type. Value is visa, mastercard, discover, or amex.
  • expire_month

    see description

    The expiration month with no leading zero. Value is from 1 to 12.
    Possible types: integer
  • expire_year

    see description

    The four-digit expiration year.
    Possible types: integer
  • cvv2

    string

    The three- to four-digit card validation code.
  • first_name

    string

    The card holder's first name.
  • last_name

    string

    The card holder's last name.
  • billing_address

    object

    The billing address associated with this card.
  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

credit_card_token

  • credit_card_id

    string

    The ID of credit card that is stored in the PayPal vault.
    Important: As of July 1, 2017, the use of the Payments REST API to accept credit card payments is deprecated. Instead, you can accept credit card payments with:

  • payer_id

    string

    A unique ID that you can assign and track when you store a credit card in the vault or use a vaulted credit card. This ID can help to avoid unintentional use or misuse of credit cards. This ID can be any value you would like to associate with the saved card, such as a UUID, user name, or email address. Required when you use a vaulted credit card if a payer_id was originally provided when you vaulted the credit card.
  • last4

    string

    The last four digits of the stored credit card number.

    Read only.

  • type

    string

    The credit card type. Value is visa, mastercard, discover, or amex. Value is in lowercase. Do not use these values for display.

    Read only.

  • expire_month

    see description

    The expiration month with no leading zero. Value is from 1 to 12.
    Possible types: integer

    Read only.

  • expire_year

    see description

    The four-digit expiration year.
    Possible types: integer

    Read only.

credit_instrument

  • id

    string

    The ID of the credit instrument.
    Important: As of July 1, 2017, the use of the Payments REST API to accept credit card payments is deprecated. Instead, you can accept credit card payments with:

    Read only.

  • type

    enum

    The type of credit.

    Read only.

    Possible values: BILL_ME_LATER, PAYPAL_EXTRAS_MASTERCARD, EBAY_MASTERCARD, PAYPAL_SMART_CONNECT.

currency

currency_conversion

  • conversion_date

    string

    The date and time when the conversion rate becomes no longer valid, in Internet date and time format.

    Read only.

  • from_currency

    string

    The three-character ISO-4217 currency code of the currency from which to convert the from amount.

    Read only.

  • from_amount

    string

    The from amount, which is the pre-currency conversion value. Default is 1.

    Read only.

  • to_currency

    string

    The three-character ISO-4217 currency code of the currency into which to convert the from amount.

    Read only.

  • to_amount

    string

    The to amount, which is the post-currency conversion value.

    Read only.

  • conversion_type

    enum

    The conversion type to apply.

    Possible values: PAYPAL, VENDOR.

    Default: PAYPAL.

  • conversion_type_changeable

    boolean

    Indicates whether the payer can change the conversion type.

    Read only.

  • spread

    string

    The rate in percentage which PayPal charges that is above the foreign exchange rate provided by PayPal’s financial partners.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

details

  • subtotal

    string

    The subtotal amount for the items. If the request includes line items, this property is required. Maximum length is 10 characters. Supports two decimal places.
  • shipping

    string

    The shipping fee. Maximum length is 10 characters. Supports two decimal places.
  • tax

    string

    The tax. Maximum length is 10 characters. Supports two decimal places.
  • handling_fee

    string

    The handling fee. Supported for the PayPal payment method only.
  • shipping_discount

    string

    The shipping fee discount. Supported for the PayPal payment method only.
  • insurance

    string

    The insurance fee. Supported for the PayPal payment method only.
  • gift_wrap

    string

    The gift wrap fee.

display_phone

execute_order

  • disbursement_mode

    enum

    Indicates whether to disburse money instantly or later.

    Possible values: INSTANT, DELAYED.

  • payer

    object

    The source of the funds for this payment. Either a PayPal account or a credit card.

extended_bank_account

  • account_number

    string

    The account number in either:

    Maximum length: 34.

  • account_number_type

    enum

    The type of the bank account number, which is an International Bank Account Number (IBAN) or Basic Bank Account Number (BBAN).

    Possible values: BBAN, IBAN.

  • routing_number

    string

    The routing transit number, or bank code, of the bank. Typically used for domestic accounts only. For international accounts, the IBAN includes the bank code. For more information, see Bank code.

    Maximum length: 34.

  • account_type

    enum

    The bank account type.

    Possible values: CHECKING, SAVINGS.

  • account_name

    string

    The customer-designated account name.

    Maximum length: 64.

  • check_type

    enum

    The check type. Valid when the facilitator or merchant obtained this information from a check.

    Possible values: PERSONAL, COMPANY.

  • auth_type

    enum

    The method by which the check was obtained from the customer, if a check was the source of the information.

    Possible values: CCD, PPD, TEL, POP, ARC, RCK, WEB.

  • auth_capture_timestamp

    string

    The date and time when the authorization was captured, in Internet date and time format. Use this field if the user authorization must be captured due to any privacy requirements.
  • bank_name

    string

    The bank name.

    Maximum length: 64.

  • country_code

    string

  • first_name

    string

    The account holder's first name.

    Maximum length: 64.

  • last_name

    string

    The account holder's last name.

    Maximum length: 64.

  • birth_date

    string

    The bank account holder's birth date, in Internet date format.
  • billing_address

    object

    The billing address.
  • state

    enum

    The funding instrument's state.

    Read only.

    Possible values: ACTIVE, INACTIVE, DELETED.

  • confirmation_status

    enum

    The bank account's confirmation status.

    Read only.

    Possible values: UNCONFIRMED, CONFIRMED.

  • payer_id

    string

    [DEPRECATED] The payer ID. Use external_customer_id instead.
  • external_customer_id

    string

    The facilitor-provided ID of the customer to whom this bank account belongs. Required when you create or use a funding instrument that is stored in the vault.

    Maximum length: 256.

  • merchant_id

    string

    The facilitator-provided ID of the merchant for which this bank account has been stored. Usage of the bank account is restricted to the specific merchant.

    Maximum length: 256.

  • create_time

    string

    The date and time when the resource was created, in Internet date and time format.

    Read only.

  • update_time

    string

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

    Read only.

  • valid_until

    string

    The date and time when the resource can no longer be used to fund a payment, in Internet date and time format.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

external_funding

  • reference_id

    string

    The ID for the external funding account.

    Maximum length: 256.

  • code

    string

    The generic ID for the external funding account.

    Maximum length: 256.

  • funding_account_id

    string

    The encrypted PayPal account ID for the funding account.
  • display_text

    string

    The description of the external funding account.

    Maximum length: 127.

  • amount

    object

    The amount that is funded by the external funding account.
  • funding_instruction

    enum

    Indicates whether the payment is to be fully funded by the external funded incentive.

    Possible values: FULLY_FUNDED.

funding_instrument

funding_option

  • id

    string

    The ID of the funding option.
  • funding_sources

    array (contains the funding_source object)

    The funding source details.
  • backup_funding_instrument

    object

    The backup funding instrument. Used for payment if primary funding instrument fails.
  • currency_conversion

    object

    The currency conversion that applies to this funding option.
  • installment_info

    object

    The installment options available for a funding option.
  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

funding_source

  • credit_card

    object

    The credit card instrument.
    Important: As of July 1, 2017, the use of the Payments REST API to accept credit card payments is deprecated. Instead, you can accept credit card payments with:

  • credit_card_token

    object

    The PayPal vaulted credit card instrument.
    Important: As of July 1, 2017, the use of the Payments REST API to accept credit card payments is deprecated. Instead, you can accept credit card payments with:

  • funding_mode

    enum

    The funding mode of the funding source.

    Read only.

    Possible values: INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, DELAYED_TRANSFER, ECHECK, PAY_UPON_INVOICE.

  • funding_instrument_type

    enum

    The instrument type for this funding source.

    Read only.

    Possible values: BALANCE, PAYMENT_CARD, BANK_ACCOUNT, CREDIT, INCENTIVE, EXTERNAL_FUNDING, TAB.

  • soft_descriptor

    string

    The soft descriptor for charging this funding source.

    Read only.

    Maximum length: 22.

  • amount

    object

    The total amount that is anticipated to be pulled from the funding source.

    Read only.

  • negative_balance_amount

    object

    The additional amount to take from the source to recover a balance that is owed to PayPal.

    Read only.

  • legal_text

    string

    The localized legal text for the funding source.
  • terms

    string

    The URL to legal terms for the funding source.
  • funding_detail

    object

    The additional details for the funding source.
  • funding_selection_preference

    enum

    The preferred way to select this funding source.

    Read only.

    Possible values: NONE, WALLET_PREFERRED, PAYMENT_PREFERRED, SYSTEM_DEFAULTED.

  • additional_text

    string

    Additional text for the funding source.
  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

incentive

  • id

    string

    The ID of the instrument in the PayPal Wallet.

    Read only.

  • code

    string

    The code that identifies the incentive.
  • name

    string

    The incentive name.

    Read only.

  • description

    string

    The incentive description.

    Read only.

  • minimum_purchase_amount

    object

    The minimum purchase amount to which this incentive applies.

    Read only.

  • logo_image_url

    string

    The logo image URL for the incentive.

    Read only.

  • expiry_date

    string

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

    Read only.

  • type

    enum

    The type of incentive.

    Read only.

    Possible values: COUPON, GIFT_CARD, MERCHANT_SPECIFIC_BALANCE, VOUCHER, LOYALTY_CARD, MANUFACTURER_COUPON.

  • terms

    string

    The URI to the associated terms.

    Read only.

installment_option

  • term

    see description

    The number of installments.
    Possible types: integer
  • monthly_payment

    object

    The monthly payment.
  • discount_amount

    object

    The discount amount applied to the payment, if any.
  • discount_percentage

    string

    The discount percentage applied to the payment, if any.

installment_options

  • installment_id

    string

    The installment ID.

    Read only.

  • network

    enum

    The credit card network.

    Read only.

    Possible values: VISA, MASTERCARD.

  • issuer

    string

    The credit card issuer.

    Read only.

  • installment_options

    array (contains the installment_option object)

    An installment option.

item

  • sku

    string

    The stock keeping unit (SKU) for the item.

    Maximum length: 127.

  • name

    string

    The item name. Maximum length is 127 characters.
  • description

    string

    The item description. Supported for the PayPal payment method only.

    Maximum length: 127.

  • quantity

    string

    The item quantity. Maximum length is 10 characters.
  • price

    string

    The item cost. Maximum length is 10 characters.
  • currency

    string

  • tax

    string

    The item tax. Supported for the PayPal payment method only.
  • url

    string

    The URL to item information. Available to the payer in the transaction history.

item_option_selection

  • name

    string

    The name of the item optional data.

    Maximum length: 64.

  • select

    string

    The description of the item optional selected value.

    Maximum length: 200.

  • amount

    object

    The amount being charged for the item resulting from the specific selected value of the name parameter.

json_openapi_2_0_language

  • json-openapi-2.0-language

    string

    BCP-47 language tag comprised of ISO-639 alpha-2 language code, followed optionally by ISO-15924 script tag, and ISO-3166 alpha-2 country code.

    Minimum length: 2.

    Maximum length: 10.

    Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$.

measurement

  • value

    string

    The measurement value.
  • unit

    string

    The measurement unit.

metadata

  • postback_data

    array (contains the name_and_value_pair object)

    A type for name-and-value pairs. Limit the use of name-and-value pairs in an API. Requires approval from architecture.
  • supplementary_data

    array (contains the name_and_value_pair object)

    A type for name-and-value pairs. Limit the use of name-and-value pairs in an API. Requires approval from architecture.

name_and_value_pair

  • name

    string

    The key for the name-and-value pair. You must correlate the value and name types.
  • value

    string

    The value for the name-and-value pair.

order

  • id

    string

    The ID of the order.

    Read only.

  • intent

    enum

    The intent.

    Possible values: SALE, AUTHORIZE.

  • purchase_units

    array (contains the purchase_unit object)

    A purchase unit. Use to capture required information for the payment contract.
  • payment_details

    object

    The payment details for the order.

    Read only.

  • application_context

    object

    Application Context - Merchant Experience Information
  • payer_info

    object

    The payer information.
  • metadata

    object

    Metadata.

    Read only.

  • status

    enum

    The status of the order. After the customer approves the order, the status is APPROVED. After the payment is mader for the order and the order completes, the status is COMPLETED.

    Read only.

    Possible values: CREATED, APPROVED, COMPLETED, FAILED.

  • redirect_urls

    object

    The redirect URLs. Required only for the PayPal payment method. The supported settings are return and cancel URLs.
  • create_time

    string

    The date and time when the resource was created.

    Read only.

  • update_time

    string

    The date and time when the resource was last updated.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

partner_fee_details

  • receiver

    object

    The partner who receives the partner fees.
  • amount

    object

    The amount being collected as partner fee.

pay_order_response

  • order_id

    string

    The ID of the order.

    Read only.

  • status

    enum

    The status of the order.

    Read only.

    Possible values: APPROVED, CANCELED, COMPLETED, CREATED, EXPIRED, FAILED, IN_PROGRESS, PARTIALLY_COMPLETED, SUBMITTED.

  • intent

    enum

    The intent.

    Possible values: SALE, AUTHORIZE.

  • payer_info

    object

    The payer information.
  • purchase_units

    array (contains the purchase_unit object)

    A purchase unit. Use to capture required information for the payment contract.
  • create_time

    string

    The date and time when the resource was created.

    Read only.

  • update_time

    string

    The date and time when the resource was last updated.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

payee

  • email

    string

    The email address associated with the payee's PayPal account. If the email address is not associated with any PayPal account, the payee can only receive PayPal Wallet payments. Direct credit card payments are denied due to card compliance requirements.
  • merchant_id

    string

    The PayPal account ID for the payee.
  • payee_display_metadata

    object

    Displays only metadata for a payee.

payee_display_metadata

  • email

    string

    The email address for the payer. Maximum length is 127 characters.
  • display_phone

    object

    Payee information.
  • brand_name

    string

    The payer's business name.

payer

  • payment_method

    string

    The payment method. Value is paypal for a PayPal Wallet payment.
    Important: As of July 1, 2017, the use of the Payments REST API to accept credit card payments is deprecated. Instead, you can accept credit card payments with:

  • status

    enum

    The status of payer's PayPal account.

    Read only.

    Possible values: VERIFIED, UNVERIFIED.

  • funding_instruments

    array (contains the funding_instrument object)

    A payer's funding instrument. An instance of this schema is valid if and only if it is valid against exactly one of these supported properties.
  • payer_info

    object

    The payer-related information. If the payment_method is paypal, you must set the email address of the PayPal account that funds the transaction in the payer_info.

payer_info

  • email

    string

    The payer's email address. Maximum length is 127 characters.
  • salutation

    string

    The payer's salutation.

    Read only.

  • first_name

    string

    The payer's first name.

    Read only.

  • middle_name

    string

    The payer's middle name.

    Read only.

  • last_name

    string

    The payer's last name.

    Read only.

  • suffix

    string

    The payer's suffix.

    Read only.

  • payer_id

    string

    The PayPal-assigned encrypted payer ID.

    Read only.

  • phone

    string

    The payer's phone number. Maximum length is 20 characters.

    Read only.

  • phone_type

    enum

    The phone type.

    Read only.

    Possible values: HOME, WORK, MOBILE, OTHER.

  • birth_date

    string

    The birth date of the payer, in Internet date format. For example, 1990-04-12.
  • tax_id

    string

    The payer’s tax ID. Supported for the PayPal payment method only.

    Maximum length: 14.

  • tax_id_type

    enum

    The payer’s tax ID type. Supported for the PayPal payment method only.

    Possible values: BR_CPF, BR_CNPJ.

  • country_code

    string

  • billing_address

    object

    The payer's billing address.
  • shipping_address

    object

    [DEPRECATED] The shipping address. Use the shipping address for the purchase unit or at the root level of the checkout session.

    Read only.

payment_card

  • id

    string

    The ID of a credit card to save for later use.

    Read only.

  • number

    string

    The card number.
  • type

    enum

    An enumeration of the card types.

    Possible values: VISA, AMEX, SOLO, JCB, STAR, DELTA, DISCOVER, SWITCH, MAESTRO, CB_NATIONALE, CONFINOGA, COFIDIS, ELECTRON, CETELEM, CHINA_UNION_PAY, MASTERCARD.

  • expire_month

    string

    The two-digit expiry month for the card. Valid value is from 01 to 12.

    Pattern: ([1-9]|0[1-9]|1[012]).

  • expire_year

    string

    The four-digit expiry year for the card.

    Pattern: [0-9]{4}.

  • start_month

    string

    The two-digit start month for the card. Valid value is from 01 to 12. Required for UK Maestro cards.

    Pattern: ([1-9]|0[1-9]|1[012]).

  • start_year

    string

    The four-digit start year for the card. Required for UK Maestro cards.

    Pattern: [0-9]{4}.

  • cvv2

    string

    The validation code for the card. Supported for payments. Not supported for vaulting payment cards for future use.
  • first_name

    string

    The card holder's first name.
  • last_name

    string

    The card holder's last name.
  • billing_country

    string

  • billing_address

    object

    The billing address for the card.
  • external_customer_id

    string

    The facilitator-provided ID of the customer who owns this card account. Required when you create or use a funding instrument that is stored in the PayPal vault.

    Maximum length: 256.

  • status

    enum

    The funding instrument's state.

    Read only.

    Possible values: EXPIRED, ACTIVE.

  • card_product_class

    enum

    An enumeration of the product classes of the financial instrument issuer.

    Read only.

    Possible values: CREDIT, DEBIT, GIFT, PAYPAL_PREPAID, PREPAID, UNKNOWN.

  • valid_until

    string

    The date and time when the instrument can no longer be used to fund a payment, in Internet date and time format.

    Read only.

  • issue_number

    string

    The one- to two-digit card issue number. Required for UK Maestro cards.

    Maximum length: 2.

    Pattern: [0-9]{1,2}.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

payment_details

  • payment_id

    string

    The payment ID for the order.

    Read only.

  • disbursement_mode

    enum

    Indicates whether to disburse money instantly or later.

    Read only.

    Possible values: INSTANT, DELAYED.

payment_summary

  • captures

    array (contains the capture object)

    A capture transaction.
  • refunds

    array (contains the refund object)

    A refund transaction.
  • sales

    array (contains the sale object)

    A sale transaction.
  • authorizations

    array (contains the sale object)

    A sale transaction.

percentage

  • percentage

    string

    A percentage as a fixed-point, signed decimal value. Use for all interest rates. For example, represent an interest rate of 19.99% as 19.99. The allowed number formats are plain decimal numbers and whole numbers. Unlike a JSON number or JSON Schema number type, this value MUST NOT be deserialized in JavaScript into a JavaScript Number object, which is 64-bit floating-point and cannot accurately represent all values transmitted by this type. Likewise, in Java, this type MUST be deserialized into a BigDecimal or other fixed-point numeric type.

    Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$.

private_label_card

  • id

    string

    The encrypted ID of the private label card instrument.

    Read only.

  • card_number

    string

    The last four digits of the card number.

    Read only.

  • issuer_id

    string

    The encrypted account number of the associated issuer accounts. Merchants who provide private label store cards have associated issuer account.

    Read only.

  • issuer_name

    string

    The name on the issuer account. Merchants who provide private label store cards have associated issuer accounts.

    Read only.

  • image_key

    string

    The URL to the PLCC program logo image.

    Read only.

purchase_unit

  • reference_id

    string

    Optional. The merchant ID for the purchase unit.

    Maximum length: 256.

  • amount

    object

    The amount to collect.
  • payee

    object

    The recipient of the funds for this transaction.
  • description

    string

    The purchase description.

    Maximum length: 127.

  • custom

    string

    The client-provided external ID. Used to reconcile client transactions with PayPal transactions. Returned in transaction and settlement reports. Only supported for the PayPal payment method.

    Maximum length: 127.

  • invoice_number

    string

    The partner-provided external invoice number for this order. Only supported for the PayPal payment method.

    Maximum length: 256.

  • payment_descriptor

    string

    The payment descriptor on the buyer credit card statement of account activity.

    Maximum length: 22.

  • items

    array (contains the item object)

    The item details.
  • notify_url

    string

    The payment notifications URL.

    Maximum length: 2048.

  • shipping_address

    object

    The shipping address.
  • shipping_method

    string

    The shipping method. For example, USPSParcel.
  • partner_fee_details

    object

    The partner fee.
  • payment_linked_group

    see description

    An ID that groups multiple linked purchase units. The purchase transactions are linked only for the payment and not for refund. A refund is processed only for the specific transaction within the same linked group.
    Possible types: integer
  • metadata

    object

    Metadata.

    Read only.

  • payment_summary

    object

    A payment summary for the purchase unit.

    Read only.

  • status

    enum

    The transaction state.

    Read only.

    Possible values: NOT_PROCESSED, PENDING, VOIDED, AUTHORIZED, CAPTURED.

  • reason_code

    enum

    The reason code for a transaction state of pending or reversed. Eventually, this field will replace pending_reason. Only supported for the PayPal payment method.

    Read only.

    Possible values: PAYER_SHIPPING_UNCONFIRMED, MULTI_CURRENCY, RISK_REVIEW, REGULATORY_REVIEW, VERIFICATION_REQUIRED, ORDER, OTHER, DECLINED_BY_POLICY.

redirect_urls

  • return_url

    string

    The URL where the payer is redirected after he or she approves the payment.
  • cancel_url

    string

    The URL where the payer is redirected after he or she cancels the payment.

refund

  • id

    string

    The ID of the refund transaction. Maximum length is 17 characters.

    Read only.

  • amount

    object

    Details including both the amount refunded to the payer and the amount refunded to the payee. Maximum length is ten characters.

    Read only.

  • capture_id

    string

    The ID of the sale transaction to refund.

    Read only.

  • sale_id

    string

    The ID of the sale transaction to refund.

    Read only.

  • status

    enum

    The status of the refund.

    Read only.

    Possible values: PENDING, COMPLETED, FAILED.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

sale

  • id

    string

    The ID of the sale transaction.

    Read only.

  • amount

    object

    The amount to collect.

    Read only.

  • transaction_fee

    object

    The transaction fee.

    Read only.

  • state

    enum

    The state of the sale transaction.

    Read only.

    Possible values: COMPLETED, PARTIALLY_REFUNDED, PENDING, REFUNDED, DENIED.

  • create_time

    string

    The date and time when the resource was created, in UTC ISO8601 format.

    Read only.

  • update_time

    string

    The date and time when the resource was last updated, in UTC ISO8601 format.

    Read only.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

shipping_address

  • line1

    string

    The first line of the address. For example, number, street, and so on. Maximum length is 100 characters.
  • line2

    string

    The second line of the address. For example, suite, apartment number, and so on. Maximum length is 100 characters.
  • city

    string

    The city name. Maximum length is 50 characters.
  • country_code

    string

  • postal_code

    string

    The zip code or equivalent. Typically required for countries that have them. Maximum length is 20 characters. Required in certain countries.
  • state

    string

    The two-letter code for US states or the equivalent for other countries. Maximum length is 100 characters.
  • phone

    string

    The phone number, in E.123 format. Maximum length is 50 characters.
  • normalization_status

    enum

    The address normalization status. Returned only for payers from Brazil.

    Read only.

    Possible values: UNKNOWN, UNNORMALIZED_USER_PREFERRED, NORMALIZED, UNNORMALIZED.

  • type

    string

    The type of address. For example, HOME_OR_WORK, GIFT, and so on.
  • recipient_name

    string

    The name of the recipient at this address.

    Maximum length: 127.

standin_funding_option

  • standin_funding_token

    string

    An encrypted token for the instrument to use to fund the payment.

    Maximum length: 256.

Additional API information