How to Link PayPal to Your Apple ID

If you're an Apple user, you may be familiar with the PayPal app. PayPal is a popular online payment service that lets you easily and quickly pay friends and family, shop online, and more

If you're using PayPal on your iPhone or iPad, you may want to consider linking your PayPal account to your Apple ID. This will allow you to use PayPal as your primary payment method on your Apple devices, and it will also allow you to easily access your PayPal account from any device

Here's how to link your PayPal account to your Apple ID

1. Open the PayPal app on your iPhone or iPad

2. Tap the menu button (three lines down from the top of the screen), and then tap Settings

3. Under "Account Info," tap the link next to "Apple ID. "

4. Enter your Apple ID password, and then tap OK

5. Your PayPal account will now be linked to your Apple ID. You can use PayPal as your primary payment method on your Apple devices, and you can also access your PayPal account from any device

1 The $3. 00 promotion pricing is currently only available at Walmart locations across the country. Not all services may be available right away

2 The $3. At participating Walmart locations, there is a 00 cash load service fee. This service fee only applies to the PayPal mobile app when loading cash and does not apply to the PayPal Cash Mastercard. Keep your receipt. You will receive an email confirming that your funds have been added to your PayPal account, if applicable. Each cash-in code can only be used once and will expire one hour after it is created. You may include any amount between $20 and. 00 and $500. 00 per transaction. Load limits of $1,500 for cash-in. 00 per day, $3,500. 00 per week or $5,000 per month are applicable. Additional activity on your PayPal account between the time you generate the code and when you use it may reduce the amount of money you can load. Limits are reset at the start of each calendar month

To obtain the card, you must have a PayPal Balance account

Approval contingent on ID verification. IMPORTANT INFORMATION REGARDING THE PROCESS OF OPENING A NEW CARD ACCOUNT. To assist the government in combating terrorist financing and money laundering, federal law requires all financial institutions to obtain, verify, and record information identifying each person who opens a Card Account. What this means for you. When you open a Card Account, we will ask for your name, address, date of birth, and other identifying information. We may also request a copy of your driver's license or other identification documents. Terms apply. See Cardholder Agreement for details

The Bancorp Bank issues the PayPal Cash Mastercard ("PayPal Cash Card") under license from Mastercard International Incorporated. Mastercard International Incorporated is a registered trademark, and the circles design is a trademark of Mastercard International Incorporated. The Bancorp Bank is solely responsible for the Card and is not liable for any associated accounts or other products, services, or offers from PayPal. The card can be used anywhere Mastercard is accepted. Your PayPal Balance account funds are not held by Bancorp Bank

Apple Inc. owns the trademarks Apple and the Apple logo. , registered in the U. S. and other countries. Apple Inc. 's App Store is a service mark. , registered in the U. S. and other countries

Google Play and its logo are trademarks of Google, LLC

All trademarks and brand names are the property of their respective owners. The use of these trademarks and brand names does not imply endorsement or affiliation with this card program. All rights reserved

Call the Payments API to authorize payments, capture authorized payments, refund previously captured payments, and display payment information. Combine the Payments API with the Orders API. See the PayPal Checkout Overview for more information

Authorizations (resource group)

Use the

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
4 resource to display payment details, capture payment, reauthorize, and cancel authorized payments

Show details for authorized payment

GET/v2/payments/authorizations/{authorization_id}

Displays information for an authorized payment by ID

Header parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5

    string

    required

    Include the bearer token in the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5 header with the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    7 authentication scheme to make REST API calls. The answer is either
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    8 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    9

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    0

    string

    required

    For operations involving a request body, this is required. The value is application/ . Where the 'format' is 'json'.

Path parameters

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    1

    string

    required

    The authorized payment's ID, for which details are to be displayed

Sample Request

curl -v -X GET https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"

Response

Collapse

A successful request yields the HTTP

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
2 status code and a JSON response body containing authorization information

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    This payment's authorized amount

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    7

    The date and time when the authorized payment expires, in hours and minutes.

    Read only

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    8

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    9

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    70

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The PayPal-generated payment authorization ID

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The authorized payment's status

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      76. The authorized payment is created. There have been no captured payments for this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      77. One or more captures have been applied to the authorized payment. The total of these captured payments exceeds the original authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      78. PayPal will not be able to authorize funds for this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      79. The authorized payment has expired.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      70. A captured payment was made for the authorized payment in an amount less than the original authorized payment amount.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      71. The authorized payment was voided. There can be no more captured payments made against this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. The authorization that was created is in the pending state. For more information, see
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      73.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The authorized order pending status details

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    A payment transaction-related object that provides supplementary/additional data

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

    Read only

Sample Response

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}

Capture authorized payment

POST/v2/payments/authorizations/{authorization_id}/capture

ID captures an authorized payment

Header parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    77

    string

    The server keeps keys on file for 45 days

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    78

    string

    Upon successful completion of the request, the preferred server response. Value is

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      79. To optimize communication between the API caller and the server, the server returns a minimal response. The
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      71,
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      75, and HATEOAS links are required as a minimum response
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      02. The server returns a complete resource representation, including the resource's current state

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5

    string

    required

    Include the bearer token in the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5 header with the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    7 authentication scheme to make REST API calls. The answer is either
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    8 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    9

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    0

    string

    required

    For operations involving a request body, this is required. The value is application/ . Where the 'format' is 'json'.

Path parameters

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    1

    string

    required

    The PayPal-generated payment authorization ID to capture

Request body

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The amount to capture. Set an amount to capture a portion of the total authorized amount. If no amount is specified, the entire authorized amount is captured. The amount must be positive and in the same currency as the authorization used to capture the payment

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    91

    boolean

    Indicates whether additional captures can be made against the authorized payment. If you do not intend to capture additional payments against the authorization, set to

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    92. If you intend to capture additional payments against the authorization, set to
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    93

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    96

    string

    A note of caution about this settlement. Appearance in the payer's transaction history as well as emails received by the payer

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    98

    Any additional payment instructions that should be taken into account during payment processing. This processing instruction applies to capturing orders or authorizing orders

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    99

    string

    On the payer's account statement, the payment descriptor

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    80

Sample Request

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'

Response

Collapse

A successful request returns the HTTP

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
81 status code and a JSON response body containing the payment details that were captured

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The monetary value of this captured payment

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    86

    enum

    The funds that are held on the merchant's behalf

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      87. The funds are immediately released to the merchant.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      88. The funds are held for a limited time. The exact duration is determined by the region and type of integration. You can make the funds available by referencing a payout. Otherwise, the funds will be disbursed automatically after the specified time period.

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    91

    boolean

    Indicates whether additional captures can be made against the authorized payment. If you do not intend to capture additional payments against the authorization, set to

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    92. If you intend to capture additional payments against the authorization, set to
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    93

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The ID generated by PayPal for the captured payment

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    45

    An object that contains additional processor information for a credit card transaction

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    47

    The comprehensive breakdown of the capture activity. This option is not available for pending transactions

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The current state of the captured payment

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      49. This captured payment's funds were credited to the payee's PayPal account.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      90. The funds could not be obtained.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      91. A portion of the captured payment was partially refunded to the payer.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. This captured payment's funds have not yet been credited to the payee's PayPal account. For more information, see
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      73.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      94. A sum greater than or equal to the amount of the captured payment was refunded to the payer.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      95. There was an error in the payment capture process.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The payment status details that were captured

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    A payment transaction-related object that provides supplementary/additional data

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

    Read only

Sample Response

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
7

Reauthorize authorized payment

POST/v2/payments/authorizations/{authorization_id}/reauthorize

By ID, reauthorizes a previously authorized PayPal account payment. Reauthorize a payment after its initial three-day honor period expires to ensure that funds are still available. After the honor period expires, you can issue multiple re-authorizations within the 29-day authorization period

If 30 days have passed since the original authorization date, you must create an authorized payment rather than reauthorizing the original authorized payment

A reauthorized payment has a new three-day honor period

You can reauthorize an authorized payment once for up to 115% of the original authorized amount, not to exceed an increase of $75 USD

Only the

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
3 request parameter is supported
Note. For Partner use cases, this request is currently not supported

Header parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    77

    string

    The server keeps keys on file for 45 days

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    78

    string

    Upon successful completion of the request, the preferred server response. Value is

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      79. To optimize communication between the API caller and the server, the server returns a minimal response. The
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      71,
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      75, and HATEOAS links are required as a minimum response
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      02. The server returns a complete resource representation, including the resource's current state

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5

    string

    required

    Include the bearer token in the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5 header with the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    7 authentication scheme to make REST API calls. The answer is either
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    8 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    9

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    0

    string

    required

    For operations involving a request body, this is required. The value is application/ . Where the 'format' is 'json'.

Path parameters

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    1

    string

    required

    The PayPal-generated payment authorization ID to reauthorize

Request body

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The amount to reauthorize for a previously approved payment

Sample Request

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
7

Response

Collapse

A successful request returns the HTTP status code

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
81 and a JSON response body containing the reauthorized payment details

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    This payment's authorized amount

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    7

    The date and time when the authorized payment expires, in hours and minutes.

    Read only

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    8

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    9

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    70

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The PayPal-generated payment authorization ID

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The authorized payment's status

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      76. The authorized payment is created. There have been no captured payments for this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      77. One or more captures have been applied to the authorized payment. The total of these captured payments exceeds the original authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      78. PayPal will not be able to authorize funds for this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      79. The authorized payment has expired.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      70. A captured payment was made for the authorized payment in an amount less than the original authorized payment amount.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      71. The authorized payment was voided. There can be no more captured payments made against this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. The authorization that was created is in the pending state. For more information, see
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      73.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The authorized order pending status details

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    A payment transaction-related object that provides supplementary/additional data

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

    Read only

Sample Response

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
0

Void authorized payment

POST/v2/payments/authorizations/{authorization_id}/void

By ID, voids or cancels an authorized payment. You cannot cancel a fully captured authorized payment

Header parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    39

    string

    A JSON Web Token (JWT) assertion provided by the API caller that identifies the merchant. For details, see

    Note. When a partner manages API calls on behalf of a merchant in a three-party transaction, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5

    string

    required

    Include the bearer token in the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5 header with the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    7 authentication scheme to make REST API calls. The answer is either
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    8 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    9

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    0

    string

    required

    For operations involving a request body, this is required. The value is application/ . Where the 'format' is 'json'.

Path parameters

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    1

    string

    required

    The PayPal-generated payment authorization ID to void

Sample Request

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
9

Response

Collapse

A successful request returns the HTTP status code

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
47 with no JSON response body

Sample Response

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
8

Captures (resource group)

Use the

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
48 resource to display and refund details for a captured payment

Show captured payment details

GET/v2/payments/captures/{capture_id}

Displays payment details based on ID

Header parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5

    string

    required

    Include the bearer token in the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5 header with the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    7 authentication scheme to make REST API calls. The answer is either
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    8 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    9

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    0

    string

    required

    For operations involving a request body, this is required. The value is application/ . Where the 'format' is 'json'.

Path parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    55

    string

    required

    The ID generated by PayPal for the captured payment for which to show details

Sample Request

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
4

Response

Collapse

A successful request returns the HTTP

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
2 status code and a JSON response body containing the payment details that were captured

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The monetary value of this captured payment

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    86

    enum

    The funds that are held on the merchant's behalf

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      87. The funds are immediately released to the merchant.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      88. The funds are held for a limited time. The exact duration is determined by the region and type of integration. You can make the funds available by referencing a payout. Otherwise, the funds will be disbursed automatically after the specified time period.

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    91

    boolean

    Indicates whether additional captures can be made against the authorized payment. If you do not intend to capture additional payments against the authorization, set to

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    92. If you intend to capture additional payments against the authorization, set to
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    93

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The ID generated by PayPal for the captured payment

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    45

    An object that contains additional processor information for a credit card transaction

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    47

    The comprehensive breakdown of the capture activity. This option is not available for pending transactions

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The current state of the captured payment

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      49. This captured payment's funds were credited to the payee's PayPal account.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      90. The funds could not be obtained.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      91. A portion of the captured payment was partially refunded to the payer.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. This captured payment's funds have not yet been credited to the payee's PayPal account. For more information, see
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      73.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      94. A sum greater than or equal to the amount of the captured payment was refunded to the payer.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      95. There was an error in the payment capture process.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The payment status details that were captured

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    A payment transaction-related object that provides supplementary/additional data

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

    Read only

Sample Response

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
9

Refund captured payment

POST/v2/payments/captures/{capture_id}/refund

Refunds a captured payment based on ID. Include an empty payload in the JSON request body for a full refund. Include an

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
3 object in the JSON request body for a partial refund

Header parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    39

    string

    A JSON Web Token (JWT) assertion provided by the API caller that identifies the merchant. For details, see

    Note. When a partner manages API calls on behalf of a merchant in a three-party transaction, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    77

    string

    The server keeps keys on file for 45 days

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    78

    string

    Upon successful completion of the request, the preferred server response. Value is

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      79. To optimize communication between the API caller and the server, the server returns a minimal response. The
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      71,
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      75, and HATEOAS links are required as a minimum response
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      02. The server returns a complete resource representation, including the resource's current state

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5

    string

    required

    Include the bearer token in the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5 header with the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    7 authentication scheme to make REST API calls. The answer is either
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    8 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    9

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    0

    string

    required

    For operations involving a request body, this is required. The value is application/ . Where the 'format' is 'json'.

Path parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    55

    string

    required

    The ID generated by PayPal for the captured payment to refund

Request body

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The amount to refund. Enter an amount to refund a portion of the captured amount. If no amount is specified, a refund of

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    00 is made. The amount must be positive and in the same currency as when the payment was captured

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    96

    string

    The reason for the refund. Appearance in the payer's transaction history as well as emails received by the payer

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    98

    Any additional refund instructions that must be specified during the refund payment processing. This object applies only to merchants who have the PayPal Commerce Platform for Marketplaces and Platforms capability enabled. If you want to use this feature, please contact your account manager

Sample Request

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
0

Response

Collapse

A successful request yields the HTTP

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
81 status code and a JSON response body containing refund information

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The amount refunded to the payer by the payee

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The refund ID generated by PayPal

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    96

    string

    The reason for the refund. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    15

    The breakdown of the refund

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The status of the refund

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      17. The refund was cancelled.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      95. The refund was unable to be processed.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. The refund is pending. For more information, see
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      20.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      49. This transaction's funds were deducted from the customer's account.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The refund status information

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

    Read only

Sample Response

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
1

Refunds (resource group)

Use the

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
24 resource to display refund information

Show refund details

GET/v2/payments/refunds/{refund_id}

Displays refund information based on ID

Header parameters

Collapse

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5

    string

    required

    Include the bearer token in the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    5 header with the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    7 authentication scheme to make REST API calls. The answer is either
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    8 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    9

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    0

    string

    required

    For operations involving a request body, this is required. The value is application/ . Where the 'format' is 'json'.

Path parameters

Collapse

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    31

    string

    required

    The refund ID generated by PayPal for which to show details

Sample Request

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
2

Response

Collapse

A successful request yields the HTTP

curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
-d '{
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "final_capture": true,
  "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
  "soft_descriptor": "Bob's Custom Sweaters"
}'
2 status code and a JSON response body containing refund information

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The amount refunded to the payer by the payee

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The refund ID generated by PayPal

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    96

    string

    The reason for the refund. Appearance in the payer's transaction history as well as emails received by the payer

    Read only

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    15

    The breakdown of the refund

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The status of the refund

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      17. The refund was cancelled.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      95. The refund was unable to be processed.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. The refund is pending. For more information, see
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      20.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      49. This transaction's funds were deducted from the customer's account.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The refund status information

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

    Read only

Sample Response

{
  "id": "0VF52814937998046",
  "status": "CREATED",
  "amount": {
    "value": "10.99",
    "currency_code": "USD"
  },
  "invoice_id": "INVOICE-123",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2017-10-10T23:23:45Z",
  "create_time": "2017-09-11T23:23:45Z",
  "update_time": "2017-09-11T23:23:45Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
    }
  ]
}
3

Common object definitions

account_id

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    48

    string

    A PayPal account's unique identifier

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    49

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    49

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    51

activity_timestamps

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

    Read only

address-country_code

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    54

    string

    The country or region is identified by a two-character ISO 3166-1 code

    Note. The country code for the United Kingdom is
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    55, not
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    56, as used in the country's top-level domain names. For comparable uncontrolled price (CUP) method, bank card, and cross-border transactions, use the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    57 country code for China worldwide

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    60

address_details

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    61

    string

    A location with a name that represents the premise. A building name or number, or a group of buildings with a common name or number. For example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    62

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    64

    string

    The delivery service. Postal code, bag number, or post office name

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    66

    string

    The street name. Just

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    67 in
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    68

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    70

    string

    The street number

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    72

    string

    The street type. Examples include avenue, boulevard, road, and expressway

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    74

    string

    The sub-premise is a first-order entity that exists beneath a named building or location. A single building within a group of buildings with a common name. It could be a flat, a story, a floor, a room, or an apartment

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

address_portable

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The country or region is identified by a two-character ISO 3166-1 code

    Note. The country code for the United Kingdom is
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    55, not
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    56, as used in the country's top-level domain names. For comparable uncontrolled price (CUP) method, bank card, and cross-border transactions, use the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    57 country code for China worldwide

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    60

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    83

    The non-portable additional address details that are occasionally required for compliance, risk, or other scenarios requiring fine-grained address information. Not compatible with common third-party and open source software. Redundant with core fields

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    84, for example, is usually a combination of
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    85,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    66, and
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    72

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88

    string

    The address's first line. For example, number or street. For example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    89. Data entry, compliance, and risk assessments are all required. Must contain the full address

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91

    string

    The address's second line. Suite or apartment number, for example

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    93

    string

    If necessary, the third line of the address. For instance, a street complement for Brazil, a direction text like

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    94, or a landmark in an Indian address

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96

    string

    A country's highest level sub-division, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    97 rather than
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    98. Value, by country, is

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

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700

    string

    A city, town, or village. Smaller than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    701

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    702

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    703

    string

    A subdivision, suburb, neighborhood, or district. Smaller than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    704. Value is

    • Brazil. Suburb, bairro, or neighborhood
    • India. Sub-locality or district. Although street names are not always available, a sub-locality or district can be a very small area

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    706

    string

    The neighborhood, ward, or district. Smaller than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    707 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    708. Value is

    • Guernsey and many French territories, including French Guiana, use this postal sorting code
    • China's fine-grained administrative levels

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710

    string

    The postal code, also known as the zip code or equivalent. Usually required for countries that have a postal code or equivalent. See postal code

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    711

address_portable

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The country or region is identified by a two-character ISO 3166-1 code

    Note. The country code for the United Kingdom is
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    55, not
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    56, as used in the country's top-level domain names. For comparable uncontrolled price (CUP) method, bank card, and cross-border transactions, use the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    57 country code for China worldwide

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    60

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    83

    Fine-grained address information for Compliance, Risk, and other scenarios is included in the non-portable additional address details. This is incompatible with most third-party and open-source applications. This includes information that is redundant with core fields.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    84, for example, is usually a combination of
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    85,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    66, and
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    72

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88

    string

    The address's first line, such as number and street, for example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    89. Required for data entry as well as compliance and risk assessments. This field must contain the entire address

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91

    string

    The address's second line, for example, a suite or apartment number

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    93

    string

    If necessary, the third line of the address. A street complement for Brazil, direction text such as

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    94, or a landmark in an Indian address are all examples

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96

    string

    A country's highest-level sub-division, which is usually a province, state, or ISO-3166-2 subdivision. This information is formatted for postal delivery, so it is

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    97 rather than
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    98. Value, by country, is

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

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700

    string

    A city, town, or village. Smaller than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    701

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    702

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    703

    string

    Sub-region, suburb, neighborhood, or district. This is smaller than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    704. Value is

    • Brazil. Suburb, bairro, or neighborhood
    • India. Sub-locality or district. Although street names are not always available, a sub-locality or district can be a very small area

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    706

    string

    The neighborhood, ward, or district. This number is less than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    707 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    708. Value is

    • The postal sorting code used in Guernsey and several French territories, including French Guiana
    • China's fine-grained administrative levels

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    63

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710

    string

    The postal code, also known as the ZIP code or equivalent. Usually required for countries that have a postal code or equivalent. See postal code

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    711

address_portable_postal_code_validation

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    748

address_portable_postal_code_validation

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    748

amount_breakdown

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    750

    The total discount for all items within a specific

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    751. The number
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    752 cannot be negative

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    753

    The handling fee for all items within a specific

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    751 period. The number
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    755 cannot be negative

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    756

    The insurance premium for all items within a specified

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    751. The number
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    758 cannot be negative

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    759

    The subtotal for all items. If the request includes

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    760, this field must be filled in. For all items, the total must be
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    761. The number
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    762 cannot be negative

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    The shipping cost for all items within a specified

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    751. The number
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    765 cannot be negative

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    766

    The shipping discount applies to all items within a given

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    751. The number
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    768 cannot be negative

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    769

    The total tax for everything. If the request includes

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    770, this field must be filled in. For all items, the total must be
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    771. The number
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    772 cannot be negative

apple_pay_decrypted_token_data

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    773

    string

    required

    Hex-encoded device manufacturer identifier for Apple Pay

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    775

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    776

    required

    Apple Pay payment data object containing the cryptogram, eci_indicator, and other information

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    777

    enum

    required

    Indicates the type of payment data passed; in the case of non-China, the payment data is 3DSECURE; in China, the payment data is EMV

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      778. The 3D Secure (3DS) authentication scheme was used to validate the card. When using this value, make sure to include cryptogram and eci_indicator in your payment data.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      779. The card was authenticated using the EMV method, which is legal in China. When using this value, make sure to include emv_data and pin as payment data.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    781

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    782

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    783

    required

    Apple Pay is a tokenized credit card that is used to make payments

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    784

    required

    The transaction amount for the payment approved by the payer on the Apple platform

apple_pay_decrypted_token_data. card

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    785

    required

    This card's billing address. Only the

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710, and
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76 properties are supported

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    792

    enum

    The card brand or network. Typically used in the response

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      793. Visa card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      794. Mastecard card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      795. Discover card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      796. American Express card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      797. Solo debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      798. Japan Credit Bureau card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      799. Military Star card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      700. Delta Airlines card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      701. Switch credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      702. Maestro credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      703. Carte Bancaire (CB) credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      704. Configoga credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      705. Confidis credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      706. Visa Electron credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      707. Cetelem credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      708. China union pay credit card.

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    709

    enum

    The card brand or network. Typically used in the response

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      793. Visa card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      794. Mastecard card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      795. Discover card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      796. American Express card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      797. Solo debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      798. Japan Credit Bureau card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      799. Military Star card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      700. Delta Airlines card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      701. Switch credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      702. Maestro credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      703. Carte Bancaire (CB) credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      704. Configoga credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      705. Confidis credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      706. Visa Electron credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      707. Cetelem credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      708. China union pay credit card.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    726

    The year and month of the card's expiration, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    string

    The name of the cardholder as it appears on the card

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    730

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    731

    string

    The payment card's primary account number (PAN)

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    49

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    733

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    734

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    735

    enum

    The payment card type

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      736. A credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      737. A debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      738. A Prepaid card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      739. A store card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      740. Card type cannot be determined.

apple_pay_payment_data

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    741

    string

    3D Secure's definition of an online payment cryptogram

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    775

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    744

    string

    3- Secure defines ECI as an indicator

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    746

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    747

    string

    Apple Pay EMV Payment Structure Encoded for Payment in China

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    775

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    750

    string

    Apple Pay PIN with Bank Key encryption

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    775

asset_source

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    required

    Instrument Id for the asset

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    755

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    756

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    757

    enum

    required

    Options for cryptocurrency symbol or code ticker. Liquidity providers and exchanges assign

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      758. The ticker symbol for Bitcoin. https. //en. wikipedia. org/wiki/Bitcoin.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      759. The ticker symbol for Ethereum. https. //en. wikipedia. org/wiki/Ethereum.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      760. The Bitcoin Cash ticker symbol. https. //en. wikipedia. org/wiki/Bitcoin_Cash.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      761. The ticker symbol for Litecoin. https. //en. wikipedia. org/wiki/Litecoin.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    764

authorization

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    string

    The authorized payment's status

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The authorized order pending status details

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    This payment's authorized amount

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    7

    The date and time when the authorized payment expires, in hours and minutes.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    8

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    9

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    70

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The PayPal-generated payment authorization ID

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    A payment transaction-related object that provides supplementary/additional data

authorization

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    string

    The authorized payment's status

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The authorized order pending status details

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    This payment's authorized amount

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    7

    The date and time when the authorized payment expires, in hours and minutes.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    8

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    9

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    70

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The PayPal-generated payment authorization ID

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

authorization_status

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The authorized payment's status

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      76. The authorized payment is created. There have been no captured payments for this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      77. One or more captures have been applied to the authorized payment. The total of these captured payments exceeds the original authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      78. PayPal will not be able to authorize funds for this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      79. The authorized payment has expired.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      70. A captured payment was made for the authorized payment in an amount less than the original authorized payment amount.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      71. The authorized payment was voided. There can be no more captured payments made against this authorized payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. The authorization that was created is in the pending state. For more information, see
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      73.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The authorized order pending status details

    Read only

authorization_status_details

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    006

    enum

    The authorized status is

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72 for the following reasons

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      008. Authorization is pending manual review.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    010

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

bancontact_request

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The ISO 3166-1 country code is two characters long

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    required

    The account holder's name is associated with this payment method

bic

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    014

    string

    The business identification code (BIC). A BIC is used in payment systems to identify a specific business, most commonly a bank

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    015

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    016

blik_request

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The ISO 3166-1 country code is two characters long

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    required

    The account holder's name is associated with this payment method

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    019

    The account holder's email address is linked to this payment method

capture

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    string

    The current state of the captured payment

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The payment status details that were captured

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The monetary value of this captured payment

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    86

    The funds that are held on the merchant's behalf

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    91

    boolean

    Indicates whether additional captures can be made against the authorized payment. If you do not intend to capture additional payments against the authorization, set to

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    92. If you intend to capture additional payments against the authorization, set to
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    93

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The ID generated by PayPal for the captured payment

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    45

    An object that contains additional processor information for a credit card transaction

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    47

    The comprehensive breakdown of the capture activity. This option is not available for pending transactions

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    A payment transaction-related object that provides supplementary/additional data

capture

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    string

    The current state of the captured payment

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The payment status details that were captured

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The monetary value of this captured payment

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    5

    string

    The API caller-provided external ID. Used to match API-initiated transactions with PayPal transactions. It is mentioned in transaction and settlement reports

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    86

    The funds that are held on the merchant's behalf

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    91

    boolean

    Indicates whether additional captures can be made against the authorized payment. If you do not intend to capture additional payments against the authorization, set to

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    92. If you intend to capture additional payments against the authorization, set to
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    93

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    string

    The ID generated by PayPal for the captured payment

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of related

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    45

    An object that contains additional processor information for a credit card transaction

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The level of security provided by PayPal Seller Protection for Merchants

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    47

    The comprehensive breakdown of the capture activity. This option is not available for pending transactions

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    4

    The date and time the transaction took place, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    76

    The date and time when the transaction was last updated, in hours and minutes.

capture_request

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    058

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    96

    string

    A note of caution about this settlement. Appearance in the payer's transaction history as well as emails received by the payer

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    062

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    3

    The amount to capture. Set an amount to capture a portion of the total authorized amount. If no amount is specified, the entire authorized amount is captured. The amount must be positive and in the same currency as the authorization used to capture the payment

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    91

    boolean

    Indicates whether additional captures can be made against the authorized payment. If you do not intend to capture additional payments against the authorization, set to

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    92. If you intend to capture additional payments against the authorization, set to
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    93

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72

    string

    This order's API caller-supplied external invoice number. Appearance in the payer's transaction history as well as emails received by the payer

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    96

    string

    A note of caution about this settlement. Appearance in the payer's transaction history as well as emails received by the payer

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    98

    Any additional payment instructions that should be taken into account during payment processing. This processing instruction applies to capturing orders or authorizing orders

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    99

    string

    On the payer's account statement, the payment descriptor

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    80

capture_status

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    75

    enum

    The current state of the captured payment

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      49. This captured payment's funds were credited to the payee's PayPal account.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      90. The funds could not be obtained.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      91. A portion of the captured payment was partially refunded to the payer.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      72. This captured payment's funds have not yet been credited to the payee's PayPal account. For more information, see
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      73.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      94. A sum greater than or equal to the amount of the captured payment was refunded to the payer.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      95. There was an error in the payment capture process.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    74

    The payment status details that were captured

    Read only

capture_status_details

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    006

    enum

    The reason why the payment status was captured is

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    72 or
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    78

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      086. The payer filed a PayPal dispute for this captured payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      087. The captured funds were reversed as a result of the payer's dispute with the issuer of the financial instrument used to pay for the captured payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      088. The payer made payment with an eCheck that had not yet cleared.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      089. Visit your online account. In your **Account Overview**, accept and deny this payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      090. There is no other specific reason that can be given. Visit your account online or contact PayPal for more information about this captured payment.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      008. The captured payment is being reviewed by hand.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      092. The payee has not yet configured their account's receiving preferences. Visit your account online for more information on how to accept or decline this payment. This reason is typically given in situations where the currency of the captured payment differs from the payee's primary holding currency.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      94. The captured funds were refunded.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      094. The payer is responsible for sending the funds for this captured payment. This code is typically used for manual EFTs.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      095. The payee lacks a PayPal account.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      096. The PayPal account of the payee is not verified.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    9

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

card

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    785

    This card's billing address. Only the

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710, and
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76 properties are supported

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    792

    enum

    The card brand or network. Typically used in the response

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      793. Visa card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      794. Mastecard card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      795. Discover card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      796. American Express card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      797. Solo debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      798. Japan Credit Bureau card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      799. Military Star card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      700. Delta Airlines card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      701. Switch credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      702. Maestro credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      703. Carte Bancaire (CB) credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      704. Configoga credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      705. Confidis credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      706. Visa Electron credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      707. Cetelem credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      708. China union pay credit card.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    709

    enum

    The card brand or network. Typically used in the response

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      793. Visa card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      794. Mastecard card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      795. Discover card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      796. American Express card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      797. Solo debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      798. Japan Credit Bureau card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      799. Military Star card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      700. Delta Airlines card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      701. Switch credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      702. Maestro credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      703. Carte Bancaire (CB) credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      704. Configoga credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      705. Confidis credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      706. Visa Electron credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      707. Cetelem credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      708. China union pay credit card.

    Read only

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    726

    The year and month of the card's expiration, in

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    948

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    948

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    950

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    71

    The card's PayPal-generated ID

    Read only

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    746

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    954

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    955

    string

    The payment card's last four digits

    Read only

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    957

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    958

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    string

    The name of the cardholder as it appears on the card

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    730

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    731

    string

    The payment card's primary account number (PAN)

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    49

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    733

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    734

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    967

    string

    The card's three- or four-digit security code. Also referred to as the CVV, CVC, CVN, CVE, or CID. When

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    968 is present in the request, this parameter cannot be present

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    957

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    971

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    735

    enum

    The payment card type

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      736. A credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      737. A debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      738. A Prepaid card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      739. A store card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      740. Card type cannot be determined.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

card

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    785

    This card's billing address. Only the

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710, and
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76 properties are supported

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    726

    The year and month of the card's expiration, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    The name of the cardholder as it appears on the card

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    730

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    731

    The payment card's primary account number (PAN)

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    49

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    733

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    734

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    967

    The card's three- or four-digit security code. Also referred to as the CVV, CVC, CVN, CVE, or CID. When

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    968 is present in the request, this parameter cannot be present

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    957

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    971

card

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    785

    This card's billing address. Only the

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710, and
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76 properties are supported

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    792

    enum

    The card brand or network. Typically used in the response

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      793. Visa card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      794. Mastecard card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      795. Discover card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      796. American Express card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      797. Solo debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      798. Japan Credit Bureau card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      799. Military Star card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      700. Delta Airlines card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      701. Switch credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      702. Maestro credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      703. Carte Bancaire (CB) credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      704. Configoga credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      705. Confidis credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      706. Visa Electron credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      707. Cetelem credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      708. China union pay credit card.

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    709

    enum

    The card brand or network. Typically used in the response

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      793. Visa card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      794. Mastecard card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      795. Discover card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      796. American Express card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      797. Solo debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      798. Japan Credit Bureau card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      799. Military Star card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      700. Delta Airlines card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      701. Switch credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      702. Maestro credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      703. Carte Bancaire (CB) credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      704. Configoga credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      705. Confidis credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      706. Visa Electron credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      707. Cetelem credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      708. China union pay credit card.

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    726

    The year and month of the card's expiration, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    string

    The name of the cardholder as it appears on the card

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    730

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    731

    string

    The payment card's primary account number (PAN)

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    49

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    733

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    734

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    735

    enum

    The payment card type

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      736. A credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      737. A debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      738. A Prepaid card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      739. A store card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      740. Card type cannot be determined.

card. address_portable

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The country or region is identified by a two-character ISO 3166-1 code

    Note. The country code for the United Kingdom is
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    55, not
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    56, as used in the country's top-level domain names. For comparable uncontrolled price (CUP) method, bank card, and cross-border transactions, use the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    57 country code for China worldwide

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88

    string

    The address's first line. For example, number or street. For example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    89. Data entry, compliance, and risk assessments are all required. Must contain the full address

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91

    string

    The address's second line. Suite or apartment number, for example

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96

    string

    A country's highest level sub-division, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    97 rather than
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    98. Value, by country, is

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

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700

    string

    A city, town, or village. Smaller than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    701

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    702

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710

    string

    The postal code, also known as the zip code or equivalent. Usually required for countries that have a postal code or equivalent. See postal code

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    711

card. address_portable

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The country or region is identified by a two-character ISO 3166-1 code

    Note. The country code for the United Kingdom is
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    55, not
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    56, as used in the country's top-level domain names. For comparable uncontrolled price (CUP) method, bank card, and cross-border transactions, use the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    57 country code for China worldwide

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88

    string

    The address's first line. For example, number or street. For example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    89. Data entry, compliance, and risk assessments are all required. Must contain the full address

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91

    string

    The address's second line. Suite or apartment number, for example

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96

    string

    A country's highest level sub-division, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example,

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    97 rather than
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    98. Value, by country, is

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

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700

    string

    A city, town, or village. Smaller than

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    701

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    702

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710

    string

    The postal code, also known as the zip code or equivalent. Usually required for countries that have a postal code or equivalent. See postal code

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    711

card_brand

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    894

    enum

    The card network or brand. Credit, debit, gift, and payment cards are all included

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      793. Visa card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      794. Mastecard card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      795. Discover card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      796. American Express card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      797. Solo debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      798. Japan Credit Bureau card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      799. Military Star card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      700. Delta Airlines card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      701. Switch credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      702. Maestro credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      703. Carte Bancaire (CB) credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      704. Configoga credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      705. Confidis credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      706. Visa Electron credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      707. Cetelem credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      708. China union pay credit card.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

card_request

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    785

    This card's billing address. Only the

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    88,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    91,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    96,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    700,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    710, and
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76 properties are supported

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    726

    The year and month of the card's expiration, in

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    The name of the cardholder as it appears on the card

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    90

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    730

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    731

    The payment card's primary account number (PAN)

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    49

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    733

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    734

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    967

    The card's three- or four-digit security code. Also referred to as the CVV, CVC, CVN, CVE, or CID. When

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    968 is present in the request, this parameter cannot be present

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    957

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    971

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    435

    Provides additional information for processing a payment with a

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    436 that has been or is intended to be stored (also known as stored_credential or card-on-file)
    Parameter compatibility

    • Only
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      438 and
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      437 are compatible
    • Only
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      438 and
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      439 are compatible
    • Only
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      968 is compatible with
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      441 or
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      442
    • The request can only contain one of the parameters
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      441 and
      curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      442

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    446

    The ID generated by PayPal for the saved card payment source. Usually kept on the merchant's server

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    449

card_stored_credential

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    450

    enum

    required

    The individual or entity who initiated or triggered the payment

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      451. Payment is initiated by the customer's active participation. e. g. a customer making a purchase on a merchant's website.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      452. Payment is initiated by the merchant on behalf of the customer without the customer's active participation. e. g. a merchant charging the customer a monthly subscription fee.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    782

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    456

    enum

    required

    Indicates the payment_source payment type that was previously saved

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      457. One-time payment, for example, an online purchase or donation. (e. g. Checkout with one-click).
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      458. Payment that is part of a series of payments with fixed or variable amounts that occur at regular intervals. (e. g. Subscription payments).
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      459. Payment that is part of a series of payments that occur on an irregular basis and/or have variable amounts. (e. g. Account Topup payments).

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    782

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    442

    The card network uses reference values to identify a transaction

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    464

    enum

    Indicates whether this is a

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    465 or
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    466 payment made with a previously saved payment source (also known as a stored credential or card on file)

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      467. Indicates the initial/first payment with a payment_source that will be saved upon successful payment processing.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      468. Indicates a payment made with a previously used and successfully stored payment_source.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      469. Indicates that PayPal will calculate the value of 'FIRST' or 'SUBSEQUENT' using data that is available to PayPal.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    782

card_type

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    709

    enum

    Type of card. i. e. g. , credit, debit, etc

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      736. A credit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      737. A debit card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      738. A Prepaid card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      739. A store card.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      740. Card type cannot be determined.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    97

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

country_code

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    string

    The country or region is identified by a two-character ISO 3166-1 code

    Note. The country code for the United Kingdom is
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    55, not
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    56, as used in the country's top-level domain names. For comparable uncontrolled price (CUP) method, bank card, and cross-border transactions, use the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    57 country code for China worldwide

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    60

country_code

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    string

    The country or region is identified by a two-character ISO 3166-1 code

    Note. The country code for the United Kingdom is
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    55, not
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    56, as used in the country's top-level domain names. For comparable uncontrolled price (CUP) method, bank card, and cross-border transactions, use the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    57 country code for China worldwide

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    60

cryptocurrency_symbol

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    496

    enum

    Options for cryptocurrency symbol or code ticker. Liquidity providers and exchanges assign

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      758. The ticker symbol for Bitcoin. https. //en. wikipedia. org/wiki/Bitcoin.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      759. The ticker symbol for Ethereum. https. //en. wikipedia. org/wiki/Ethereum.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      760. The Bitcoin Cash ticker symbol. https. //en. wikipedia. org/wiki/Bitcoin_Cash.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      761. The ticker symbol for Litecoin. https. //en. wikipedia. org/wiki/Litecoin.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    764

currency_code

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    904

    string

    The currency is identified by its three-character ISO-4217 currency code

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

currency_code

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    904

    string

    The currency's three-character ISO-4217 currency code

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

customer_service_instructions

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    910

    string

    The customer service contact information for the merchant

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    746

date_no_time

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    912

    string

    The stand-alone date, in . To represent special legal values, such as a date of birth, dates with no associated time or time-zone data should be used. Use the standard

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    913 type whenever possible. All dates are not validated by this regular expression. For example, the 31st of February is valid, and nothing is known about leap years

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    916

date_no_time

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    912

    string

    The stand-alone date, in . To represent special legal values, such as a date of birth, dates with no associated time or time-zone data should be used. Use the standard

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    913 type whenever possible. All dates are not validated by this regular expression. For example, the 31st of February is valid, and nothing is known about leap years

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    916

date_time

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    913

    string

    The date and time, in . Seconds are required, but fractional seconds are permitted

    Note. Although the regular expression provides direction, it does not reject all invalid dates

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    8

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    9

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    70

date_year_month

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    926

    string

    In ISO-8601

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    927 date format, the year and month. See

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    948

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    948

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    950

disbursement_mode

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    86

    enum

    The funds that are held on the merchant's behalf

    The possible values are

    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      87. The funds are immediately released to the merchant.
    • {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      88. The funds are held for a limited time. The exact duration is determined by the region and type of integration. You can make the funds available by referencing a payout. Otherwise, the funds will be disbursed automatically after the specified time period.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    781

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

dispute_category

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    937

    enum

    The condition for which the transaction is covered

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      938. The payer paid for something they did not receive.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      939. The payment was not authorized by the payer.

email

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    019

    string

    The internationalized email address

    Note. There can be up to 64 characters before and 255 characters after the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    941 sign. The generally accepted maximum length for an email address, however, is 254 characters. The pattern confirms the existence of an unquoted
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    941 sign

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    943

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    944

email_address

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    945

    string

    The internationalized email address

    Note. There can be up to 64 characters before and 255 characters after the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    941 sign. The generally accepted maximum length for an email address, however, is 254 characters. The pattern confirms the existence of an unquoted
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    941 sign

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    943

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    950

email_address

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    945

    string

    The internationalized email address

    Note. There can be up to 64 characters before and 255 characters after the
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    941 sign. The generally accepted maximum length for an email address, however, is 254 characters. The pattern confirms the existence of an unquoted
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    941 sign

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    943

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    950

eps_request

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The ISO 3166-1 country code is two characters long

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    required

    The account holder's name is associated with this payment method

error

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    959

    string

    required

    The PayPal internal ID. Used for correlation purposes

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    960

    string

    required

    The message describing the error

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    string

    required

    The error's human-readable and unique name

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    962

    array (contains the object)

    A collection of additional information about the error

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    963

    string

    The information link, or URI, that displays detailed error information for the developer

    Read only

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    73

    array (contains the object)

    An array of request-related

    Read only

error_details

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    965

    string

    required

    The one-of-a-kind, finely grained application-level error code

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    966

    string

    An issue's human-readable description. Because the description of an API can change over time, clients should not rely on it

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    967

    string

    The field that resulted in the error. Set this value to the JSON pointer value of this field if it is in the body. Required for client-side errors

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    968

    string

    The field's location that caused the error.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    969,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    970, or
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    971 is the value

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    972

    string

    The field value that caused the error

exchange_rate

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    973

    The currency from which an amount is converted

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    974

    The currency into which an amount should be converted

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    972

    string

    The target currency amount. The same as one unit of the source currency. Integer or decimal value formatted with one to 15 digits to the right of the decimal point

experience_context_base

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    976

    string

    On the PayPal website, the label that takes precedence over the business name in the PayPal account

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    6

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    979

    The URL to which the customer is redirected after canceling the payment

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    980

    The PayPal payment experience's BCP 47-formatted locale of pages. PayPal supports a five-character code.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    981,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    982,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    983,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    984,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    985,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    986,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    987,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    988,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    989,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    990,
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    991, or
    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    992 are some examples

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    993

    The URL to which the customer is redirected after approving the payment

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    994

    enum

    The place where the shipping address is derived

    The possible values are

    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      995. On the PayPal website, enter the customer's shipping address.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      996. The shipping address is removed from the PayPal site. Recommended for digital goods.
    • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer Access-Token" \
      -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
      -d '{
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "final_capture": true,
        "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
        "soft_descriptor": "Bob's Custom Sweaters"
      }'
      997. Get the merchant-provided address. This address cannot be changed on the PayPal website by the customer. If the merchant does not provide an address, the customer can enter one on the PayPal pages.

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    010

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    011

financial_instrument-common-instrument_id

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    001

    string

    The identifier of the instrument

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    746

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    954

financial_instrument-common-url

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    005

    string

    Describes the URL

giropay_request

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The ISO 3166-1 country code is two characters long

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    required

    The account holder's name is associated with this payment method

ideal_request

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The ISO 3166-1 country code is two characters long

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    727

    required

    The account holder's name is associated with this payment method

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    014

    The bank identification code (BIC)

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    015

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    016

language

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    013

    string

    The language in which the error-related strings, such as messages, issues, and suggested actions, should be localized. The ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code comprise the tag

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    58

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    763

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    016

link_description

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    017

    string

    required

    The complete target URL. Combine the method with this URI Template-formatted link to make the related call. Include the

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    018,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    019, and
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    020 characters for pre-processing. The key HATEOAS component that connects a completed call to a subsequent call is the
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    017

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    022

    string

    required

    The, which serves as an ID for a link and unambiguously describes the link's semantics. See Link Relations

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    023

    enum

    The HTTP method that must be used to make the related call

    Possible values.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    024,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    025,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    026,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    027,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    028,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    029,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    030,
    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    031
    .

merchant_partner_customer_id

Collapse
  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    032

    string

    PayPal's unique identifier for a customer

    Minimum length.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    02

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    80

    Pattern.

    curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    449

money

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    904

    required

    The currency is identified by its three-character ISO-4217 currency code

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    972

    string

    required

    The value, which might be

    • An integer for non-fractional currencies such as
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      040
    • A decimal fraction for currency subdivided into thousandths, such as
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      041
    See Currency Codes for the required number of decimal places for a currency code

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    042

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    043

money

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    904

    required

    The currency's three-character ISO-4217 currency code

    Minimum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    969

  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    972

    string

    required

    The value, which might be

    • An integer for non-fractional currencies such as
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      040
    • A decimal fraction for currency subdivided into thousandths, such as
      {
        "id": "0VF52814937998046",
        "status": "CREATED",
        "amount": {
          "value": "10.99",
          "currency_code": "USD"
        },
        "invoice_id": "INVOICE-123",
        "seller_protection": {
          "status": "ELIGIBLE",
          "dispute_categories": [
            "ITEM_NOT_RECEIVED",
            "UNAUTHORIZED_TRANSACTION"
          ]
        },
        "expiration_time": "2017-10-10T23:23:45Z",
        "create_time": "2017-09-11T23:23:45Z",
        "update_time": "2017-09-11T23:23:45Z",
        "links": [
          {
            "rel": "self",
            "method": "GET",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
          },
          {
            "rel": "capture",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
          },
          {
            "rel": "void",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
          },
          {
            "rel": "reauthorize",
            "method": "POST",
            "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
          }
        ]
      }
      041
    See Currency Codes for the required number of decimal places for a currency code

    Maximum length.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    042

    Pattern.

    {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "seller_protection": {
        "status": "ELIGIBLE",
        "dispute_categories": [
          "ITEM_NOT_RECEIVED",
          "UNAUTHORIZED_TRANSACTION"
        ]
      },
      "expiration_time": "2017-10-10T23:23:45Z",
      "create_time": "2017-09-11T23:23:45Z",
      "update_time": "2017-09-11T23:23:45Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046"
        },
        {
          "rel": "capture",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/capture"
        },
        {
          "rel": "void",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void"
        },
        {
          "rel": "reauthorize",
          "method": "POST",
          "href": "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize"
        }
      ]
    }
    043

mybank_request

Collapse
  • curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/capture \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Access-Token" \
    -H "PayPal-Request-Id: 123e4567-e89b-12d3-a456-426655440010" \
    -d '{
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE-123",
      "final_capture": true,
      "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
      "soft_descriptor": "Bob's Custom Sweaters"
    }'
    76

    required

    The ISO 3166-1 country code is two characters long

  • {
      "id": "0VF52814937998046",
      "status": "CREATED",
      "amount": {
        "value": "10.99",
        "currency_code": "USD"
      },
      "invoice_id": "INVOICE