Deprecation notice: TheUse the Payments REST API to easily and securely accept online and mobile payments. The payments name space contains resource collections for payments, sales, refunds, authorizations, captures, and orders./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
Important: The use of the PayPal REST /payments
APIs to accept credit card payments is restricted. Instead, you can accept credit card payments with Braintree Direct.
You can enable customers to make PayPal and credit card payments with only a few clicks, depending on the country. You can accept an immediate payment or authorize a payment and capture it later. You can show details for completed payments, refunds, and authorizations. You can make full or partial refunds. You also can void or re-authorize authorizations. For more information, see the Payments overview.Deprecation notice: TheCreates a sale, an authorized payment to be captured later, or an order. To create a sale, authorization, or order, include the payment details in the JSON request body. Set the/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
intent
to sale
, authorize
, or order
. Note: TPP Clients (Third Party Providers in the context of PSD2 regulation) are restricted from usingInclude payer, transaction details, and, for PayPal payments only, redirect URLs. The combination of theauthorize
andorder
intents.
payment_method
and funding_instrument
determines the type of payment that is created. For more information, see Payments REST API.intent required | string The payment intent. Value is:
|
Array of objects (Transaction) An array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment. For update and execute payment calls, the | |
experience_profile_id | string Deprecated. The PayPal-generated ID for the merchant's payment experience profile. For information, see create web experience profile. Use application_context instead. |
note_to_payer | string <= 165 characters A free-form field that clients can use to send a note to the payer. |
object (Redirect URLs) A set of redirect URLs that you provide for PayPal-based payments. | |
required | object (Payer) The source of the funds for this payment. Payment method is PayPal Wallet payment or bank direct debit. |
object (Application Context) Use the application context resource to customize payment flow experience for your buyers. |
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows payment details.
{- "intent": "sale",
- "payer": {
- "payment_method": "paypal"
}, - "transactions": [
- {
- "amount": {
- "total": "30.11",
- "currency": "USD",
- "details": {
- "subtotal": "30.00",
- "tax": "0.07",
- "shipping": "0.03",
- "handling_fee": "1.00",
- "shipping_discount": "-1.00",
- "insurance": "0.01"
}
}, - "description": "The payment transaction description.",
- "custom": "EBAY_EMS_90048630024435",
- "invoice_number": "48787589673",
- "payment_options": {
- "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
}, - "soft_descriptor": "ECHI5786786",
- "item_list": {
- "items": [
- {
- "name": "hat",
- "description": "Brown hat.",
- "quantity": "5",
- "price": "3",
- "tax": "0.01",
- "sku": "1",
- "currency": "USD"
}, - {
- "name": "handbag",
- "description": "Black handbag.",
- "quantity": "1",
- "price": "15",
- "tax": "0.02",
- "sku": "product34",
- "currency": "USD"
}
], - "shipping_address": {
- "recipient_name": "Brian Robinson",
- "line1": "4th Floor",
- "line2": "Unit #34",
- "city": "San Jose",
- "country_code": "US",
- "postal_code": "95131",
- "phone": "011862212345678",
- "state": "CA"
}
}
}
], - "note_to_payer": "Contact us for any questions on your order.",
- "redirect_urls": {
}
}
{- "id": "PAY-1B56960729604235TKQQIYVY",
- "create_time": "2017-09-22T20:53:43Z",
- "update_time": "2017-09-22T20:53:44Z",
- "state": "CREATED",
- "intent": "sale",
- "payer": {
- "payment_method": "paypal"
}, - "transactions": [
- {
- "amount": {
- "total": "30.11",
- "currency": "USD",
- "details": {
- "subtotal": "30.00",
- "tax": "0.07",
- "shipping": "0.03",
- "handling_fee": "1.00",
- "insurance": "0.01",
- "shipping_discount": "-1.00"
}
}, - "description": "The payment transaction description.",
- "custom": "EBAY_EMS_90048630024435",
- "invoice_number": "48787589673",
- "item_list": {
- "items": [
- {
- "name": "hat",
- "sku": "1",
- "price": "3.00",
- "currency": "USD",
- "quantity": "5",
- "description": "Brown hat.",
- "tax": "0.01"
}, - {
- "name": "handbag",
- "sku": "product34",
- "price": "15.00",
- "currency": "USD",
- "quantity": "1",
- "description": "Black handbag.",
- "tax": "0.02"
}
], - "shipping_address": {
- "recipient_name": "Brian Robinson",
- "line1": "4th Floor",
- "line2": "Unit #34",
- "city": "San Jose",
- "state": "CA",
- "phone": "011862212345678",
- "postal_code": "95131",
- "country_code": "US"
}
}
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "approval_url",
- "method": "REDIRECT"
}, - {
- "rel": "execute",
- "method": "POST"
}
]
}
Deprecation notice: TheLists payments that are completed. Payments that you just created with the create payment call do not appear in the list./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
count | integer <= 20 Default: 10 The number of items to list in the response. |
start_id | string The ID of the starting resource in the response. When results are paged, you can use the |
start_index | integer The start index of the payments to list. Typically, you use the |
start_time | string The start date and time for the range to show in the response, in Internet date and time format. For example, |
end_time | string The end date and time for the range to show in the response, in Internet date and time format. For example, |
payee_id | string Filters the payments in the response by a PayPal-assigned merchant ID that identifies the payee. |
sort_by | string Sorts the payments in the response by a create time. |
sort_order | string Sorts the payments in the response in descending order. |
A successful request returns the HTTP 200 OK
status code and a JSON response body that lists payments with payment details.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/payment?count=10&start_index=0&sort_by=create_time&sort_order=desc \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["CLIENT_ID_SECRET"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"]}'
{- "payments": [
- {
- "id": "PAY-0US81985GW1191216KOY7OXA",
- "create_time": "2017-06-30T23:48:44Z",
- "update_time": "2017-06-30T23:49:27Z",
- "state": "APPROVED",
- "intent": "order",
- "payer": {
- "payment_method": "paypal"
}, - "transactions": [
- {
- "amount": {
- "total": "41.15",
- "currency": "USD",
- "details": {
- "subtotal": "30.00",
- "tax": "1.15",
- "shipping": "10.00"
}
}, - "description": "The payment transaction description.",
- "item_list": {
- "items": [
- {
- "name": "hat",
- "sku": "1",
- "price": "3.00",
- "currency": "USD",
- "quantity": "5"
}, - {
- "name": "handbag",
- "sku": "product34",
- "price": "15.00",
- "currency": "USD",
- "quantity": "1"
}
], - "shipping_address": {
- "recipient_name": "John Doe",
- "line1": "4th Floor, One Lagoon Drive",
- "line2": "Unit #34",
- "city": "Redwood City",
- "state": "CA",
- "phone": "4084217591",
- "postal_code": "94065",
- "country_code": "US"
}
}, - "related_resources": [
- {
- "authorization": {
- "id": "53P09338XY5426455",
- "create_time": "2017-06-30T23:50:01Z",
- "update_time": "2017-06-30T23:50:01Z",
- "amount": {
- "total": "41.15",
- "currency": "USD"
}, - "parent_payment": "PAY-0US81985GW1191216KOY7OXA",
- "valid_until": "2017-07-29T23:49:52Z",
- "links": [
- {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "id": "PAY-53485002LD6169910KOZQ25I",
- "create_time": "2017-07-01T19:35:17Z",
- "update_time": "2017-07-01T19:36:05Z",
- "state": "APPROVED",
- "intent": "order",
- "payer": {
- "payment_method": "paypal"
}, - "transactions": [
- {
- "amount": {
- "total": "33.00",
- "currency": "USD",
- "details": {
- "subtotal": "21.00",
- "tax": "2.00",
- "shipping": "10.00"
}
}, - "description": "The payment transaction description.",
- "item_list": {
- "items": [
- {
- "name": "hat",
- "sku": "1",
- "price": "3.00",
- "currency": "USD",
- "quantity": "2"
}, - {
- "name": "handbag",
- "sku": "product34",
- "price": "15.00",
- "currency": "USD",
- "quantity": "1"
}
], - "shipping_address": {
- "recipient_name": "Hannah Lu",
- "line1": "1602 Crane ct",
- "line2": "",
- "city": "San Jose",
- "state": "CA",
- "phone": "4084217591",
- "postal_code": "95052",
- "country_code": "US"
}
}, - "related_resources": [
- {
- "authorization": {
- "id": "91527087GH224122L",
- "create_time": "2017-07-01T19:36:22Z",
- "update_time": "2017-07-01T19:36:22Z",
- "amount": {
- "total": "33.00",
- "currency": "USD"
}, - "parent_payment": "PAY-53485002LD6169910KOZQ25I",
- "valid_until": "2017-07-30T19:36:22Z",
- "links": [
- {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}, - {
- "id": "PAY-7F5790198P134484LKOZSG7Q",
- "create_time": "2017-07-01T21:09:18Z",
- "update_time": "2017-07-01T22:31:56Z",
- "state": "APPROVED",
- "intent": "order",
- "payer": {
- "payment_method": "paypal"
}, - "transactions": [
- {
- "amount": {
- "total": "42.00",
- "currency": "USD",
- "details": {
- "subtotal": "36.00",
- "tax": "1.00",
- "shipping": "5.00"
}
}, - "description": "The payment transaction description.",
- "item_list": {
- "items": [
- {
- "name": "handbag",
- "sku": "product34",
- "price": "36.00",
- "currency": "USD",
- "quantity": "1"
}
], - "shipping_address": {
- "recipient_name": "Anna Joseph",
- "line1": "2525 North 1st street",
- "line2": "unit 4",
- "city": "San Jose",
- "state": "CA",
- "phone": "011862212345678",
- "postal_code": "95031",
- "country_code": "US"
}
}, - "related_resources": [
- {
- "capture": {
- "id": "26062838D7499294V",
- "create_time": "2017-07-01T21:16:22Z",
- "update_time": "2017-07-01T21:16:24Z",
- "amount": {
- "total": "7.00",
- "currency": "USD"
}, - "state": "COMPLETED",
- "parent_payment": "PAY-7F5790198P134484LKOZSG7Q",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "refund",
- "method": "POST"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
}, - {
- "capture": {
- "id": "0YU20012P1477553M",
- "create_time": "2017-07-01T22:31:54Z",
- "update_time": "2017-07-01T22:31:56Z",
- "amount": {
- "total": "35.00",
- "currency": "USD"
}, - "state": "COMPLETED",
- "parent_payment": "PAY-7F5790198P134484LKOZSG7Q",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "refund",
- "method": "POST"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
], - "count": 3,
- "next_id": "PAY-9X4935091L753623RKOZTRHI"
}
Deprecation notice: TheShows details for a payment, by ID, that has yet to complete. For example, shows details for a payment that was created, approved, or failed./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows payment details.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0US81985GW1191216KOY7OXA \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["CLIENT_ID_SECRET"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"]}'
{- "id": "PAY-0US81985GW1191216KOY7OXA",
- "create_time": "2017-06-30T23:48:44Z",
- "update_time": "2017-06-30T23:49:27Z",
- "state": "APPROVED",
- "intent": "order",
- "payer": {
- "payment_method": "paypal"
}, - "transactions": [
- {
- "amount": {
- "total": "41.15",
- "currency": "USD",
- "details": {
- "subtotal": "30.00",
- "tax": "1.15",
- "shipping": "10.00"
}
}, - "description": "The payment transaction description.",
- "item_list": {
- "items": [
- {
- "name": "hat",
- "sku": "1",
- "price": "3.00",
- "currency": "USD",
- "quantity": "5"
}, - {
- "name": "handbag",
- "sku": "product34",
- "price": "15.00",
- "currency": "USD",
- "quantity": "1"
}
], - "shipping_address": {
- "recipient_name": "John Doe",
- "line1": "4th Floor, One Lagoon Drive",
- "line2": "Unit #34",
- "city": "Redwood City",
- "state": "CA",
- "phone": "4084217591",
- "postal_code": "94065",
- "country_code": "US"
}
}, - "related_resources": [
- {
- "authorization": {
- "id": "53P09338XY5426455",
- "create_time": "2017-06-30T23:50:01Z",
- "update_time": "2017-06-30T23:50:01Z",
- "amount": {
- "total": "41.15",
- "currency": "USD"
}, - "parent_payment": "PAY-0US81985GW1191216KOY7OXA",
- "valid_until": "2017-07-29T23:49:52Z",
- "links": [
- {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
Deprecation notice: ThePartially updates a payment, by ID. You can update the amount, shipping address, invoice ID, and custom data. You cannot update a payment after the payment executes./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
Note: TPP Clients (Third Party Providers in the context of PSD2 regulation) are restricted from patching amount once authorized.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | object (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows payment details.
[- {
- "op": "replace",
- "path": "/transactions/0/amount",
- "value": {
- "total": "18.37",
- "currency": "EUR",
- "details": {
- "subtotal": "13.37",
- "shipping": "5.00"
}
}
}, - {
- "op": "add",
- "path": "/transactions/0/item_list/shipping_address",
- "value": {
- "recipient_name": "Anna Gruneberg",
- "line1": "Kathwarinenhof 1",
- "city": "Flensburg",
- "postal_code": "24939",
- "country_code": "DE"
}
}
]
{- "id": "PAY-5YK922393D847794YKER7MUI",
- "intent": "authorize",
- "create_time": "2017-04-24T14:26:59.059Z",
- "payer": {
- "payer_info": {
- "country_code": "DE",
- "email": "payer@example.com",
- "first_name": "Gruneberg",
- "last_name": "Anna",
- "payer_id": "8J4VWY56VUXQ6",
- "phone": "605-521-1234"
}, - "payment_method": "paypal",
- "status": "VERIFIED"
}, - "state": "APPROVED",
- "transactions": [
- {
- "amount": {
- "total": "18.37",
- "currency": "EUR",
- "details": {
- "subtotal": "13.37",
- "shipping": "5.00"
}
}, - "description": "Uber",
- "item_list": {
- "items": [
- {
- "currency": "EUR",
- "name": "iPad",
- "price": "13.37",
- "quantity": "1"
}
], - "shipping_address": {
- "recipient_name": "Anna Gruneberg",
- "line1": "Kathwarinenhof 1",
- "city": "Flensburg",
- "postal_code": "24939",
- "country_code": "DE"
}
}, - "payee": {
- "email": "payee@example.com"
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "self"
}
]
}
Deprecation notice: TheExecutes a PayPal payment that the customer has approved. You can optionally update one or more transactions when you execute the payment./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
Important: This call works only after a customer has approved the payment. For more information, learn about PayPal payments.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows details for the executed payment.
{- "payer_id": "CR87QHB7JTRSC"
}
{- "id": "PAY-9N9834337A9191208KOZOQWI",
- "create_time": "2017-07-01T16:56:57Z",
- "update_time": "2017-07-01T17:05:41Z",
- "state": "APPROVED",
- "intent": "order",
- "payer": {
- "payment_method": "paypal",
- "payer_info": {
- "email": "qa152-biz@example.com",
- "first_name": "Thomas",
- "last_name": "Miller",
- "payer_id": "PUP87RBJV8HPU",
- "shipping_address": {
- "line1": "4th Floor, One Lagoon Drive",
- "line2": "Unit #34",
- "city": "Redwood City",
- "state": "CA",
- "postal_code": "94065",
- "country_code": "US",
- "phone": "011862212345678",
- "recipient_name": "Thomas Miller"
}
}
}, - "transactions": [
- {
- "amount": {
- "total": "41.15",
- "currency": "USD",
- "details": {
- "subtotal": "30.00",
- "tax": "0.15",
- "shipping": "11.00"
}
}, - "description": "The payment transaction description.",
- "item_list": {
- "items": [
- {
- "name": "hat",
- "sku": "1",
- "price": "3.00",
- "currency": "USD",
- "quantity": "5"
}, - {
- "name": "handbag",
- "sku": "product34",
- "price": "15.00",
- "currency": "USD",
- "quantity": "1"
}
], - "shipping_options": [
- {
- "id": "PICKUP0000001",
- "label": "Free Shipping",
- "type": "PICKUP",
- "amount": {
- "currency_code": "USD",
- "value": "5.00"
}, - "selected": true
}
], - "shipping_address": {
- "recipient_name": "Thomas Miller",
- "line1": "4th Floor, One Lagoon Drive",
- "line2": "Unit #34",
- "city": "Redwood City",
- "state": "CA",
- "phone": "011862212345678",
- "postal_code": "94065",
- "country_code": "US"
}
}, - "related_resources": [
- {
- "order": {
- "id": "O-3SP845109F051535C",
- "create_time": "2017-07-01T16:56:58Z",
- "update_time": "2017-07-01T17:05:41Z",
- "state": "PENDING",
- "amount": {
- "total": "41.15",
- "currency": "USD"
}, - "parent_payment": "PAY-9N9834337A9191208KOZOQWI",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}, - {
- "rel": "void",
- "method": "POST"
}, - {
- "rel": "authorization",
- "method": "POST"
}, - {
- "rel": "capture",
- "method": "POST"
}
]
}
}
]
}
], - "links": [
- {
- "rel": "self",
- "method": "GET"
}
]
}
Deprecation notice: TheShows details for a sale, by ID. Returns only sales that were created through the REST API./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows sale details.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/sale/36C38912MN9658832 \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["CLIENT_ID_SECRET"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"]}'
{- "id": "36C38912MN9658832",
- "create_time": "2017-02-19T22:01:53Z",
- "update_time": "2017-02-19T22:01:55Z",
- "state": "COMPLETED",
- "amount": {
- "total": "7.47",
- "currency": "USD"
}, - "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
- "transaction_fee": {
- "value": "1.75",
- "currency": "USD"
}, - "parent_payment": "PAY-5YK922393D847794YKER7MUI",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "refund",
- "method": "POST"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheRefunds a sale, by ID. For a full refund, do not include the/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
amount
object in the JSON request body. For a partial refund, include an amount
object in the JSON request body.A successful request returns the HTTP 201 Created
status code and a JSON response body that shows details for the refunded sale.
{- "amount": {
- "total": "2.34",
- "currency": "USD"
}, - "invoice_number": "INV-1234567"
}
{- "id": "5CY176817C379973E",
- "create_time": "2018-08-15T17:11:32Z",
- "update_time": "2018-08-15T17:11:32Z",
- "state": "COMPLETED",
- "amount": {
- "total": "2.34",
- "currency": "USD"
}, - "refund_from_transaction_fee": {
- "currency": "USD",
- "value": "0.06"
}, - "total_refunded_amount": {
- "currency": "USD",
- "value": "2.34"
}, - "refund_from_received_amount": {
- "currency": "USD",
- "value": "2.28"
}, - "sale_id": " 2MU78835H4515710F ",
- "parent_payment": "PAY-9EH2230144138005NLN2F4EA",
- "invoice_number": "INV-1234567",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}, - {
- "href": "https://sandbox.paypal.com/v1/payments/sale/ 2MU78835H4515710F",
- "rel": "sale",
- "method": "GET"
}
]
}
Deprecation notice: TheShows details for an authorization, by ID./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows authorization details.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/authorization/2DC87612EK520411B \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["AUTHORIZATION_CODE"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"],"subjects":[{"subject":{"account_number":"2245934915437588879","party_id":"2245934915437588879","auth_claims":["PASSWORD"],"auth_state":"LOGGEDIN"}}]}'
{- "id": "2DC87612EK520411B",
- "create_time": "2017-06-25T21:39:15Z",
- "update_time": "2017-06-25T21:39:17Z",
- "state": "AUTHORIZED",
- "amount": {
- "total": "7.47",
- "currency": "USD",
- "details": {
- "subtotal": "7.47"
}
}, - "parent_payment": "PAY-36246664YD343335CKHFA4AY",
- "valid_until": "2017-07-24T21:39:15Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "capture",
- "method": "POST"
}, - {
- "rel": "void",
- "method": "POST"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheCaptures and processes an authorization, by ID. The original payment call must specify an intent of/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
authorize
.A successful request returns the HTTP 201 Created
status code and a JSON response body that shows details for the captured authorization.
{- "amount": {
- "currency": "USD",
- "total": "4.54"
}, - "is_final_capture": true
}
{- "id": "6BA17599X0950293U",
- "create_time": "2017-05-06T22:32:24Z",
- "update_time": "2017-05-06T22:32:25Z",
- "amount": {
- "total": "4.54",
- "currency": "USD"
}, - "is_final_capture": true,
- "state": "COMPLETED",
- "parent_payment": "PAY-44664305570317015KGEC5DI",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "refund",
- "method": "POST"
}, - {
- "rel": "authorization",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheVoids, or cancels, an authorization, by ID. You cannot void a fully captured authorization./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows details for the voided authorization.
curl -v -X POST https://api-m.sandbox.paypal.com/v1/payments/authorization/2DC87612EK520411B/void \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["AUTHORIZATION_CODE"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"],"subjects":[{"subject":{"account_number":"2245934915437588879","party_id":"2245934915437588879","auth_claims":["PASSWORD"],"auth_state":"LOGGEDIN"}}]}'
{- "id": "6CR34526N64144512",
- "create_time": "2017-05-06T21:56:50Z",
- "update_time": "2017-05-06T21:57:51Z",
- "state": "VOIDED",
- "amount": {
- "total": "110.54",
- "currency": "USD",
- "details": {
- "subtotal": "110.54"
}
}, - "parent_payment": "PAY-0PL82432AD7432233KGECOIQ",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheRe-authorizes a PayPal account payment, by authorization ID. To ensure that funds are still available, re-authorize a payment after the initial three-day honor period. Supports only the/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
amount
request parameter. You can re-authorize a payment only once from four to 29 days after three-day honor period for the original authorization expires. If 30 days have passed from the original authorization, you must create a new authorization instead. A re-authorized payment itself has a new three-day honor period. You can re-authorize a transaction once for up to 115% of the originally authorized amount, not to exceed an increase of $75 USD.object (FMF Details) The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary. | |
object (Processor Response) The processor-provided response codes that describe the submitted payment. Supported only when the | |
required | object (Amount) The payment amount, with details. |
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows details for the re-authorized authorization.
{- "amount": {
- "currency": "USD",
- "total": "7.00"
}
}
{- "id": "8AA831015G517922L",
- "create_time": "2017-06-25T21:39:15Z",
- "update_time": "2017-06-25T21:39:17Z",
- "state": "AUTHORIZED",
- "amount": {
- "total": "7.00",
- "currency": "USD"
}, - "parent_payment": "PAY-7LD317540C810384EKHFAGYA",
- "valid_until": "2017-07-24T21:39:15Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}, - {
- "rel": "capture",
- "method": "POST"
}
]
}
Deprecation notice: TheShows details for an order, by ID./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows details for the voided authorization.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/orders/O-0PW72302W3743444R \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["CLIENT_ID_SECRET"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"]}'
{- "id": "O-0PW72302W3743444R",
- "create_time": "2017-06-19T22:05:06Z",
- "update_time": "2017-06-19T22:08:36Z",
- "state": "PENDING",
- "amount": {
- "total": "41.15",
- "currency": "USD"
}, - "pending_reason": "order",
- "parent_payment": "PAY-4D805864V5423372TKOQLRUQ",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}, - {
- "rel": "authorize",
- "method": "POST"
}, - {
- "rel": "capture",
- "method": "POST"
}, - {
- "rel": "void",
- "method": "POST"
}
]
}
Deprecation notice: TheCaptures a payment for an order, by ID. To use this call, the original payment call must specify an/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
order
intent. In the JSON request body, include the payment amount and indicate whether this capture is the final capture for the authorization.A successful request returns the HTTP 201 Created
status code and a JSON response body that shows details for the captured order.
{- "amount": {
- "currency": "USD",
- "total": "4.54"
}, - "is_final_capture": true
}
{- "id": "51366113MA710110S",
- "create_time": "2017-07-01T17:13:45Z",
- "update_time": "2017-07-01T17:13:47Z",
- "amount": {
- "total": "7.00",
- "currency": "USD"
}, - "is_final_capture": false,
- "state": "COMPLETED",
- "parent_payment": "PAY-9N9834337A9191208KOZOQWI",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "refund",
- "method": "POST"
}, - {
- "rel": "order",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheVoids, or cancels, an order, by ID. You can only void orders that are either in the/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
PENDING
or AUTHORIZED
states or those in the CAPTURED
state that are not fully captured.A successful request returns the HTTP 200 OK
status code and a JSON response body that shows details for the voided order.
curl -v -X POST https://api-m.sandbox.paypal.com/v1/payments/orders/O-0NR488530V5211123/do-void \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["AUTHORIZATION_CODE"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"]}'
{- "id": "O-0NR488530V5211123",
- "create_time": "2017-06-28T07:35:08Z",
- "update_time": "2017-06-28T07:36:25Z",
- "state": "VOIDED",
- "amount": {
- "total": "41.15",
- "currency": "USD",
- "details": {
- "subtotal": "30.00",
- "tax": "0.15",
- "shipping": "11.00"
}
}, - "parent_payment": "PAY-0AY778532K612520BKOXHAKY",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheAuthorizes an order, by ID. In the JSON request body, include an/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
amount
object.object (FMF Details) The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary. | |
required | object (Amount) The amount to collect. Note: For an order authorization, you cannot include amount
|
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows details for the authorized order.
{- "amount": {
- "currency": "USD",
- "total": "4.54"
}
}
{- "id": "0PG032325D352531H",
- "create_time": "2017-06-28T07:38:10Z",
- "update_time": "2017-06-28T07:38:12Z",
- "state": "PENDING",
- "amount": {
- "total": "41.15",
- "currency": "USD"
}, - "parent_payment": "O-0NR488530V5211123",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "capture",
- "method": "POST"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheShows details for a captured payment, by ID./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows details for the captured payment.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/capture/8F148933LY9388354 \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["AUTHORIZATION_CODE"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"],"subjects":[{"subject":{"account_number":"2245934915437588879","party_id":"2245934915437588879","auth_claims":["PASSWORD"],"auth_state":"LOGGEDIN"}}]}'
{- "id": "8F148933LY9388354",
- "amount": {
- "total": "110.54",
- "currency": "USD",
- "details": {
- "subtotal": "110.54"
}
}, - "state": "COMPLETED",
- "parent_payment": "PAY-8PT597110X687430LKGECATA",
- "transaction_fee": {
- "value": "3.74",
- "currency": "USD"
}, - "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "refund",
- "method": "POST"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}
]
}
Deprecation notice: TheRefunds a captured payment, by ID. In the JSON request body, include an/v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
amount
object.A successful request returns the HTTP 201 OK
status code and a JSON response body that shows details for the captured payment.
{- "amount": {
- "total": "100.00",
- "currency": "USD"
}, - "invoice_number": "INV-7654321"
}
{- "id": "29V87338W7751874U",
- "create_time": "2018-08-15T17:33:46Z",
- "update_time": "2018-08-15T17:33:46Z",
- "state": "COMPLETED",
- "amount": {
- "total": "100.00",
- "currency": "USD"
}, - "refund_from_transaction_fee": {
- "currency": "USD",
- "value": "2.90"
}, - "total_refunded_amount": {
- "currency": "USD",
- "value": "100.00"
}, - "refund_from_received_amount": {
- "currency": "USD",
- "value": "97.10"
}, - "capture_id": "2F6652020G264741U",
- "parent_payment": "PAY-22L784864U0004637LN2GCYQ",
- "invoice_number": "INV-7654321",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}, - {
- "rel": "capture",
- "method": "GET"
}
]
}
Deprecation notice: TheShows details for a refund, by ID./v1/payments
endpoint is deprecated. Use the/v2/payments
endpoint instead. For details, see PayPal Checkout Basic Integration.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows refund details.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/refund/4GU360220B627614A \ -H 'X-PAYPAL-SECURITY-CONTEXT: {"actor":{"account_number":"1659371090107732880","party_id":"1659371090107732880","auth_claims":["AUTHORIZATION_CODE"],"auth_state":"ANONYMOUS","client_id":"zf3..4BQ0T9aw-ngFr9dmOUZMwuKocrqe72Zx9D-Lf4"},"auth_token":"A015QQVR4S3u79k.UvhQ-AP4EhQikqOogdx-wIbvcvZ7Qaw","auth_token_type":"ACCESS_TOKEN","last_validated":1393560555,"scopes":["https://api-m.sandbox.paypal.com/v1/payments/.*","https://api-m.sandbox.paypal.com/v1/vault/credit-card/.*","openid","https://uri.paypal.com/services/payments/futurepayments","https://api-m.sandbox.paypal.com/v1/vault/credit-card","https://api-m.sandbox.paypal.com/v1/payments/.*"],"subjects":[{"subject":{"account_number":"2245934915437588879","party_id":"2245934915437588879","auth_claims":["PASSWORD"],"auth_state":"LOGGEDIN"}}]}'
{- "id": "4GU360220B627614A",
- "create_time": "2017-01-01T02:00:00Z",
- "update_time": "2017-01-01T03:00:02Z",
- "state": "COMPLETED",
- "amount": {
- "total": "2.34",
- "currency": "USD"
}, - "sale_id": "36C38912MN9658832",
- "parent_payment": "PAY-5YK922393D847794YKER7MUI",
- "invoice_number": "INV-1234567",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "parent_payment",
- "method": "GET"
}, - {
- "rel": "sale",
- "method": "GET"
}
]
}
Message:
The requested agreement is already canceled.
Description: The agreement that was used to make the payment is already canceled.
Message:
The totals of the cart item amounts do not match sale amounts.
Description: The amount total does not match the item amount totals.
Message:
Authorization and Capture feature is not enabled for the merchant.
Description: Make sure that the recipient of the funds is a verified business account.
Message:
Capture refused - this authorization has already been completed.
Description: The capture on the authorization failed because it was already completed by one or more previous captures on this authorization.
Message:
Authorization amount exceeds allowed order limit.
Description: The authorization amount exceeds the allowed order limit.
Message:
Authorization is in [x] state and hence cannot be voided.
Description: You cannot void this authorization because it is in a state, such as captured
or expired
, that cannot be voided.
Message:
Authorization has expired.
Description: The authorization related to this request has expired. You must reauthorize the transaction.
Message:
The requested authorization ID does not exist.
Description: The authorization ID in the request does not exist in the PayPal system.
Message:
Authorization has been voided.
Description: This authorization was already voided. You can show authorization details for a voided authorization.
Message:
Billing agreement token creation failed.
Description: The billing agreement token creation failed.
Message:
Bank account validation failed.
Description: The validation of the bank account failed.
Message:
Billing agreement creation failed.
Description: The billing agreement creation failed.
Message:
Billing Agreement ID must match the one that was provided during payment creation.
Description: Billing Agreement ID must match the one that was provided during payment creation.
Message:
Buyer is not yet set for this purchase.
Description: The customer cannot make this purchase.
Message:
Payer cannot pay him- or herself.
Description: The customer cannot pay him- or herself.
Message:
Can only reauthorize the original authorization, not a reauthorization.
Description: Reauthorization only works on an original authorization ID.
Message:
Reauthorization is not allowed within the honor period.
Description: You can only reauthorize a payment after the three-day honor period concludes.
Message:
Capture amount specified exceeded allowable limit.
Description: You can only capture up to the original authorization amount.
Message:payer_id
does not match ID for this token.
Description: The payer_id
must match the one that was provided when the credit card was stored in the vault.
Message:
Transaction is declined due to compliance violation.
Description: The transaction is declined due to a compliance violation.
Message:
The credit card CVV check failed.
Description: The CVV provided for the credit card was not valid. Resend the payment with a valid CVV for the credit card.
Message:
Credit card was refused.
Description: The credit card used for the payment was refused. Resend the request with another credit card.
Message:
Buyer cannot use credit to complete the payment.
Description: You cannot use credit to complete this payment. Ask the customer to retry the transaction with alternate funding instrument.
Message:
Currency provided in the request must match the currency of the parent order or authorization.
Description: The currency that was used to capture an authorization must match the original currency of the authorization.
Message:
Currency is not supported.
Description: The currency is not currently supported.
Message:
This transaction requires the payee and payer to be resident in the same country, a domestic transaction is required to create this payment.
Description: The payer and payee do not reside in the same country.
Message:
The value of PayPal-Request-Id header has already been used.
Description: Resend the request with a unique PayPal-Request-Id
header value.
Message:
Duplicate invoice Id detected.
Description: Resend the request with a unique invoice_number
value.
Message:
Unauthorized payment.
Description: You do not have the proper permissions to complete this request.
Message:
Credit card token is expired.
Description: Use the Vault API to store the credit card again.
Message:
This feature is unsupported.
Description: This feature is not supported for the payee.
Message:
Full refund refused - partial refund has already been done on this payment.
Description: You cannot refund the full payment amount after you have partially refunded a payment.
Message:
Immediate pay is not supported for the specified payment intent.
Description: For this payment intent, immediate payment is not supported.
Message:
The instrument presented was either declined by the processor or bank, or it can't be used for this payment.
Description: If the customer's funding source has insufficient funds, restart the payment and prompt the customer to choose another payment method that is available on your site.
Message:
Buyer cannot pay - insufficient funds.
Description: The customer must add a valid funding instrument, such as a credit card or bank account, to their PayPal account.
Message:
An internal service error has occurred.
Description: Resend the request at another time. If this error persists, contact PayPal Merchant Technical Support.
Message:
Account number does not exist.
Description: Provide a valid account number and resend the request.
Message:
The combination of city, state, and zip in the address is invalid.
Description: The address contains an invalid combination of a city, state, and zip code.
Message:
The requested experience profile ID was not found.
Description: To get the profile ID for a merchant, list web experience profiles.
Message:
This transaction cannot be processed due to an invalid facilitator configuration.
Description: To process this transaction type, you must have the right account configuration.
Message:
Payer ID is invalid.
Description: The specified payer_id
is not valid. Resend the request with a valid payer_id
.
Message:
Payment token is invalid. A payment token is typically valid for 3 hours since the time it was issued. Please check the token and try again.
Description: Will be returned only for Google Pay Integration for the Create payment call.
Message:
Invalid shipping address.
Description: If the 'shipping_option.type' is set as 'PICKUP' then the 'shipping_address.recipient_name' should start with 'S2S' meaning Ship To Store. Example: 'S2S My Store'.
Message:
The requested resource ID was not found.
Description: Provide a valid resource ID and resend the request.
Message:
You have exceeded the maximum number of payment attempts.
Description: The maximum number of payment attempts was reached.
Message:
You have reached the configured maximum number of authorizations allowed for an order.
Description: You cannot create any more authorizations for this order.
Message:
Merchant is not enabled for channel-initiated billing.
Description: The merchant cannot use channel-initiated billing.
Message:
Merchant is not enabled for reference transaction.
Description: The merchant cannot make reference transactions.
Message:
Need credit card to complete the payment.
Description: To complete this payment, a credit card is required.
Message:
Need bank or credit card to complete the payment.
Description: To complete this payment, a bank card or credit card is required.
Message:
Order has already been voided, expired, or completed.
Description: This order was already voided, completed, or expired.
Message:
You can only void orders that are either in the PENDING
or AUTHORIZED
state, or those in the CAPTURED
state that are not fully captured.
Description: Due to the state of the order, you cannot void it.
Message:
Order has been voided.
Description: The order was already voided. For more information, you can show order details.
Message:
Payee account is locked or closed.
Description: The recipient account is locked or closed and cannot receive payments.
Message:
Refused - payee account does not have a confirmed email.
Description: For this transaction to proceed, the payment recipient must have a confirmed email.
Message:
Refused - payee account is restricted.
Description: The account receiving this payment is restricted and cannot receive payments at this time.
Message:
The Fraud settings for this seller are such that this payment cannot be executed.
Description: The fraud filter configuration for the seller blocks this payment.
Message:
Payee country is not enabled for this feature.
Description: The payee country is not enabled for billing product.
Message:
The payer account cannot be used for this transaction.
Description: The payer account is locked or closed.
Message:
The payer account is restricted.
Description: The payer account cannot be used for this transaction.
Message:
Transaction cannot complete successfully, instruct the buyer to return to PP.
Description: The customer must return to PayPal to before the transaction can complete.
Message:
Payer cannot pay for this transaction.
Description: Payer cannot pay for this transaction. Please contact the payer to find other ways to pay for this transaction.
Message:
Payer country is not enabled for this feature.
Description: The payer country is not enabled for billing product.
Message:
Billing address is empty.
Description: The billing address is required for credit card transactions without a PayPal account.
Message:payer_id
is required for payments made with this token.
Description: A payer_id
is required when one was used to store the credit card in the vault.
Message:
Payment has been done already for this cart.
Description: You have completed the payment for this request already. Look up the transaction to get the details.
Message:
Payment approval has expired.
Description: Inform customers that the transaction has expired and that they must restart the transaction. Offer customers a link to restart the payment flow from payment creation and redirect the customer to PayPal.
Message:
Payment cannot be processed.
Description: PayPal cannot start processing the payment due to an issue with the specified information.
Message:
PayPal has declined to process this transaction.
Description: PayPal declined the payment due to one or more customer issues.
Message:
The payment is expired.
Description: The payment expired because too much time has passed between payment creation or approval and execution of that payment. Restart the payment request starting from payment creation.
Message:
Payer cannot pay with this payment method.
Description: The specified payment method is not usable. For example, PayPal business rules do not allow the payment method or the payment method information was incorrect in the request.
Message:
Payer has not approved payment.
Description: The customer must approve all payments that use the PayPal payment method.
Message:
PayPal request ID is invalid. Please try a different one.
Description: Try a different PayPal request ID.
Message:
This request is invalid due to the current state of the payment.
Description: The payment state does not allow this kind of request.
Message:
No permission for the requested operation.
Description: You do not have the proper permissions to complete this request.
Message:
This transaction requires the payer to provide a valid phone number.
Description: The customer must provide a phone number to PayPal to proceed with the payment.
Message:
The payer cannot pay themselves. The recipient account of the platform fees must be different from the payer account.
Description: The customer cannot pay platform fee for themselves.
Message:
A previous request on this resource is currently in progress. Please wait for some time and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
Description: This scenario only occurs when making multiple API requests on the same resource within a very short duration. To resolve this, API callers need to make subsequent requests with a delay.
Message:
Re-authorization is not allowed for this type of authorization.
Description: You cannot re-authorize an order.
Message:
Transaction failed. Redirect the payer to select another funding source.
Description: The transaction failed so try another funding instrument.
Message:
Refund refused - the requested refund amount would exceed the amount of transaction being refunded.
Description: The requested refund must be less than or equal to the original transaction amount. To see the original transaction amount, show the refund details.
Message:
Refund failed due to insufficient funds in your PayPal account.
Description: You do not have sufficient funds in your PayPal account to process this refund.
Message:
This transaction is too old to refund.
Description: For information about refund time limits, see PayPal Customer Support. After the time limit expires, you must send a payment instead of issuing a refund.
Message:
You cannot perform this operation as payee has opted out on PayPal.com.
Description: The third-party-initiated operations are blocked because the payee has opted out on paypal.com.
Message:
Access token does not have required scope.
Description: You must get user consent with the correct scope for this type of request.
Message:
The transaction exceeds the buyer's sending limit.
Description: The customer cannot make any more transactions.
Message:
Provided shipping address is invalid.
Description: The specified shipping address is not valid.
Message:
Maximum number of reauthorizations for this authorization has been reached.
Description: You can only reauthorize a payment once.
Message:
Maximum number of allowable settlements has been reached. No more settlement for the authorization.
Description: The maximum number of settlements was reached.
Message:
Refund transaction refused - this transaction has already been refunded.
Description: You can only refund a transaction up to the original amount. While you can do multiple partial refunds up to the original amount, you can only do a full refund once.
Message:
Total payment amount exceeded transaction limit.
Description: The transaction limit was exceeded. For information about the PayPal transaction limits, see PayPal Customer Support.
Message:
The transaction exceeds the receiver’s receiving limit.
Description: The amount exceeds the maximum amount for a single transaction.
Message:
This request was refused.
Description: The possible reasons for this failure are:
Message:
PayPal risk refused this transaction.
Description: PayPal risk assessment refused this transaction.
Message:
Merchant profile preference is set to automatically deny certain transactions.
Description: The merchant account preferences are set to deny this kind of transaction.
Message:
Payee country is not supported for this transaction.
Description: The merchant does not accept payments from this country.
Message:
The currency is not accepted by payee.
Description: The merchant does not accept payments in this currency.
Message:
Invalid request - see details.
Description: A validation error occurred with your request.
The billing address or shipping address for a payment.
line1 required | string <= 300 characters The first line of the address. For example, number, street, and so on. | ||||||||||
line2 | string <= 300 characters The second line of the address. For example, suite or apartment number. | ||||||||||
city | string <= 64 characters The city name. | ||||||||||
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is | ||||||||||
postal_code | string The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. | ||||||||||
state | |||||||||||
phone | string <phone> The phone number, in E.123 format. Maximum length is 50 characters. | ||||||||||
normalization_status | string The address normalization status. Returned only for payers from Brazil.
| ||||||||||
type | string The type of address. For example, |
{- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string"
}
The payment amount, with details.
currency required | string The three-character ISO-4217 currency code. PayPal does not support all currencies. |
total required | string The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:
|
object (Payment Amount Details) The additional details about the payment amount. Note: For an order authorization or capture, you cannot include the amount
|
{- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
The application context. Set these properties to customize the payment flow experience for your customers.
brand_name | string <= 127 characters A label that overrides the business name in the merchant's PayPal account on the PayPal checkout pages. | ||||||||||||||
locale | string The locale of pages that the PayPal payment experience displays. Please refer here for list of supported local codes. Defaulted to en_US if not provided or invalid. | ||||||||||||||
landing_page | string The type of landing page to show on the PayPal site for customer checkout. To use the non-PayPal account landing page, set to | ||||||||||||||
shipping_preference | string Default: "GET_FROM_FILE" The shipping preference.
| ||||||||||||||
user_action | string The user action. Presents the customer with either the Continue or Pay Now checkout flow:
| ||||||||||||||
payment_pattern | string (payment_pattern) [ 3 .. 255 ] characters ^[A-Z_]+$ Provides context (e.g. frequency of payment (Single, Recurring) along with whether (Customer is Present, Not Present) for the payment being processed. For Card and PayPal Vaulted/Billing Agreement transactions, this helps specify the appropriate indicators to the networks (e.g. Mastercard, Visa) which ensures compliance as well as ensure a better auth-rate. For bank processing, indicates to clearing house whether the transaction is recurring or not depending on the option chosen.
| ||||||||||||||
object (payment_source) The preferred payment source for the payer. Currently supported only for PayPal Billing Agreements. If provided, checkout experience will have this payment source pre-selected for the payer. |
{- "brand_name": "string",
- "locale": "string",
- "landing_page": "string",
- "shipping_preference": "NO_SHIPPING",
- "user_action": "string",
- "payment_pattern": "CUSTOMER_PRESENT_ONETIME_PURCHASE",
- "preferred_payment_source": {
- "token": {
- "id": "string",
- "type": "BILLING_AGREEMENT"
}
}
}
The authorization details.
id | string The ID of the authorization. | ||||||||||||||
payment_mode | string The payment mode of the authorization.
| ||||||||||||||
state | string The authorized payment state.
| ||||||||||||||
reason_code | string The reason code for the pending transaction state.
| ||||||||||||||
pending_reason | string Deprecated. The reason code for the pending transaction state. Obsolete. Use
| ||||||||||||||
protection_eligibility | string The level of seller protection present for the transaction. Supported for the PayPal payment method only.
| ||||||||||||||
protection_eligibility_type | string The type of seller protection for the transaction. Returned only when the
| ||||||||||||||
object (FMF Details) The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary. | |||||||||||||||
parent_payment | string The ID of the payment on which this transaction is based. | ||||||||||||||
object (Processor Response) The processor-provided response codes that describe the submitted payment. Supported only when the | |||||||||||||||
valid_until | string <date-time> The date and time when the authorization expires, in Internet date and time format. | ||||||||||||||
create_time | string <date-time> The date and time when the authorization was created, in Internet date and time format. | ||||||||||||||
update_time | string <date-time> The date and time when the authorization was last updated, in Internet date and time format. | ||||||||||||||
receipt_id | string^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}$ The receipt ID, which identifies the payment. Value is 16-digit numeric payment ID number that is returned for guest users. | ||||||||||||||
Array of objects (Link Description) An array of request-related HATEOAS links. | |||||||||||||||
required | object (Amount) The payment amount, with details. |
{- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "authorized",
- "reason_code": "AUTHORIZATION",
- "pending_reason": "AUTHORIZATION",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "valid_until": "2019-08-24T14:15:22Z",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "receipt_id": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
The capture transaction details.
id | string The ID of the capture transaction. | ||||||||||||||||||||||||||||||
is_final_capture | boolean Default: false Indicates whether to release all remaining held funds. | ||||||||||||||||||||||||||||||
state | string The state of the capture.
| ||||||||||||||||||||||||||||||
reason_code | string The reason code that describes why the transaction state is pending or reversed.
| ||||||||||||||||||||||||||||||
parent_payment | string The ID of the payment on which this transaction is based. | ||||||||||||||||||||||||||||||
invoice_number | string <= 127 characters The invoice number to track this payment. | ||||||||||||||||||||||||||||||
exchange_rate | string The exchange rate applied for this transaction. Returned when there is a currency conversion from the transaction currency to the receivable currency. | ||||||||||||||||||||||||||||||
note_to_payer | string <= 255 characters A free-form field that clients can use to send a note to the payer. | ||||||||||||||||||||||||||||||
create_time | string <date-time> The date and time of the capture, in Internet date and time format. | ||||||||||||||||||||||||||||||
update_time | string <date-time> The date and time when the resource was last updated, in Internet date and time format. | ||||||||||||||||||||||||||||||
Array of objects (Link Description) An array of request-related HATEOAS links. | |||||||||||||||||||||||||||||||
object (Amount) The amount to capture. If the amount matches the originally authorized amount, the state of the authorization changes to | |||||||||||||||||||||||||||||||
object (Currency) The currency and amount of the transaction fee for this payment. Would not be returned for | |||||||||||||||||||||||||||||||
object (Currency) The currency and amount of the PayPal fee for this payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example | |||||||||||||||||||||||||||||||
object (Currency) The net amount and currency that the merchant receives for this transaction in the receivable currency. |
{- "id": "string",
- "is_final_capture": false,
- "state": "pending",
- "reason_code": "CHARGEBACK",
- "parent_payment": "string",
- "invoice_number": "string",
- "exchange_rate": "string",
- "note_to_payer": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}
}
The card network or brand. Applies to credit, debit, gift, and payment cards.
The card network or brand. Applies to credit, debit, gift, and payment cards.
Enum: | Description |
---|---|
VISA | Visa card. |
MASTERCARD | Mastecard card. |
DISCOVER | Discover card. |
AMEX | American Express card. |
SOLO | Solo debit card. |
JCB | Japan Credit Bureau card. |
STAR | Military Star card. |
DELTA | Delta Airlines card. |
SWITCH | Switch credit card. |
MAESTRO | Maestro credit card. |
CB_NATIONALE | Carte Bancaire (CB) credit card. |
CONFIGOGA | Configoga credit card. |
CONFIDIS | Confidis credit card. |
ELECTRON | Visa Electron credit card. |
CETELEM | Cetelem credit card. |
CHINA_UNION_PAY | China union pay credit card. |
"VISA"
The cart.
reference_id | string <= 256 characters The merchant-provided ID for the purchase unit. |
object (Payee) The payee who receives the funds and fulfills the order. | |
description | string <= 127 characters The purchase description. |
note_to_payee | string <= 255 characters The note to the recipient of the funds in this transaction. |
custom | string <= 127 characters The free-form field for the client's use. |
invoice_number | string <= 127 characters The invoice number to track this payment. |
soft_descriptor | string <= 22 characters The payment descriptor on account transactions on the customer's credit card statement, that PayPal sends to processors. The maximum length of the soft descriptor information that you can pass in the API field is 22 characters, in the following format: 22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)The PAYPAL prefix uses 8 characters. The soft descriptor supports the following ASCII characters:
For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number. |
object (Payment Options) The payment options for this transaction. | |
object (Item List) An array of items that are being purchased. | |
notify_url | string <uri> <= 2048 characters The send payment notifications URL. |
order_url | string <uri> <= 2048 characters The payment-related URL on the merchant site. |
required | object (Amount) The payment amount, with details. |
{- "reference_id": "string",
- "payee": {
- "email": "user@example.com",
- "merchant_id": "string"
}, - "description": "string",
- "note_to_payee": "string",
- "custom": "string",
- "invoice_number": "string",
- "soft_descriptor": "string",
- "payment_options": {
- "allowed_payment_method": "UNRESTRICTED"
}, - "item_list": {
- "items": [
- {
- "sku": "string",
- "name": "string",
- "description": "string",
- "quantity": "string",
- "price": "string",
- "currency": "str",
- "tax": "string"
}
], - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}, - "shipping_phone_number": "string"
}, - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The tokenized credit card details. You can use this instrument to fund a payment.
credit_card_id required | string [ 1 .. 256 ] characters The ID of credit card that is stored in the PayPal vault. |
payer_id | string [ 256 .. 1 ] characters Deprecated. A unique ID that you can assign and track when you store a credit card in the vault or use a vaulted credit card. This ID can help to avoid unintentional use or misuse of credit cards and can be any value, such as a UUID, user name, or email address. Required when you use a vaulted credit card and if a |
external_customer_id | string [ 1 .. 256 ] characters The externally-provided ID of the customer. |
last4 | string = 4 characters The last four digits of the stored credit card number. |
type | string [ 1 .. 256 ] characters The credit card type. Value is |
expire_month | integer [ 1 .. 12 ] The expiration month with no leading zero. Value is from |
expire_year | string = 4 characters ^[0-9]{4}$ The four-digit expiration year. |
{- "credit_card_id": "string",
- "payer_id": "s",
- "external_customer_id": "string",
- "last4": "stri",
- "type": "string",
- "expire_month": 1,
- "expire_year": "stri"
}
The currency and amount for a transaction.
currency required | string The three-character ISO-4217 currency code. PayPal does not support all currencies. |
value required | string The amount. Includes the specified number of digits after decimal separator for the ISO-4217 currency code. |
{- "currency": "string",
- "value": "string"
}
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
The refund transaction details.
id | string The ID of the refund transaction. Maximum length is 17 characters. | ||||||||||
state | string The state of the refund.
| ||||||||||
reason | string The reason that the transaction is being refunded. | ||||||||||
invoice_number | string <= 127 characters The invoice or tracking ID number. | ||||||||||
sale_id | string The ID of the sale transaction being refunded. | ||||||||||
capture_id | string The ID of the sale transaction being refunded. | ||||||||||
parent_payment | string The ID of the payment on which this transaction is based. | ||||||||||
description | string The refund description. Value must be single-byte alphanumeric characters. | ||||||||||
create_time | string <date-time> The date and time when the refund was created, in Internet date and time format. | ||||||||||
update_time | string <date-time> The date and time when the resource was last updated, in Internet date and time format. | ||||||||||
Array of objects (Link Description) An array of request-related HATEOAS links. | |||||||||||
object (Amount) The payment amount, with details. | |||||||||||
custom | string <= 127 characters The note to the payer in this transaction. | ||||||||||
object (Currency) The currency and amount of the transaction fee that is refunded to original the recipient of payment. | |||||||||||
object (Currency) The currency and amount of the refund that is subtracted from the original payment recipient's PayPal balance. | |||||||||||
object (Currency) The currency and amount of the total refund from the original purchase. For example, if a payer makes $100 purchase and the payer was refunded $20 a week ago and $30 in this transaction, the gross refund amount is $30 for this transaction and the total refunded amount is $50. |
{- "id": "string",
- "state": "pending",
- "reason": "string",
- "invoice_number": "string",
- "sale_id": "string",
- "capture_id": "string",
- "parent_payment": "string",
- "description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}, - "custom": "string",
- "refund_from_transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "refund_from_received_amount": {
- "currency": "string",
- "value": "string"
}, - "total_refunded_amount": {
- "currency": "string",
- "value": "string"
}
}
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
"string"
The error details.
name required | string The human-readable, unique name of the error. |
message required | string The message that describes the error. |
debug_id required | string The PayPal internal ID. Used for correlation purposes. |
information_link | string The information link, or URI, that shows detailed information about this error for the developer. |
Array of objects (Error Details) An array of additional details about the error. | |
Array of objects (Link Description) An array of request-related HATEOAS links. |
{- "name": "string",
- "message": "string",
- "debug_id": "string",
- "information_link": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The error details. Required for client-side 4XX
errors.
field | string The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. |
value | string The value of the field that caused the error. |
location | string Default: "body" The location of the field that caused the error. Value is |
issue required | string The unique, fine-grained application-level error code. |
description | string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary.
filter_type required | string The filter type.
| ||||||||||||||||||||||||||||||||||||
filter_id required | string The filter ID.
| ||||||||||||||||||||||||||||||||||||
name | string The filter name. | ||||||||||||||||||||||||||||||||||||
description | string The filter description. |
{- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}
The funding instrument details. An instance of this schema is valid if and only if it validates against exactly one of these supported properties.
object (Credit Card Token) The tokenized credit card details. You can use this instrument to fund a payment. |
{- "credit_card_token": {
- "credit_card_id": "string",
- "payer_id": "s",
- "external_customer_id": "string",
- "last4": "stri",
- "type": "string",
- "expire_month": 1,
- "expire_year": "stri"
}
}
The installment option details.
term required | integer The number of installments. |
required | object (Currency) The currency and amount for a transaction. |
object (Currency) The currency and amount for a transaction. | |
discount_percentage | string <ppaas_common_percentage_v1> (Percentage) ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The percentage as a fixed-point, signed decimal value. Use for all interest rates. For example, specify an interest rate of 19.99% as |
{- "term": 0,
- "monthly_payment": {
- "currency": "string",
- "value": "string"
}, - "discount_amount": {
- "currency": "string",
- "value": "string"
}, - "discount_percentage": "string"
}
The item details.
sku | string <= 127 characters The stock keeping unit (SKU) for the item. |
name | string <= 127 characters The item name. If this value is greater than the maximum allowed length, the API truncates the string. |
description | string <= 127 characters The item description. Supported for only the PayPal payment method. |
quantity required | string <= 10 characters ^[0-9]{0,10}$ The item quantity. Must be a whole number. |
price required | string <= 10 characters ^[0-9]{0,10}(\.[0-9]{0,2})?$ The item cost. Supports two decimal places. |
currency required | string <ppaas_common_currency_code_v2> (currency_code_v3) = 3 characters The three-character ISO-4217 currency code that identifies the currency. |
tax | string The item tax. Supported only for the PayPal payment method. |
{- "sku": "string",
- "name": "string",
- "description": "string",
- "quantity": "string",
- "price": "string",
- "currency": "str",
- "tax": "string"
}
The request-related HATEOAS link information.
href required | string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the |
rel required | string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. |
method | string The HTTP method required to make the related call. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
The currency and amount for a financial transaction, such as a balance or payment due.
currency_code required | string <ppaas_common_currency_code_v2> (currency_code_v3) = 3 characters The three-character ISO-4217 currency code that identifies the currency. |
value required | string <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The value, which might be:
|
{- "currency_code": "str",
- "value": "string"
}
The order transaction details.
id | string The ID of the order transaction. | ||||||||||||||||
payment_mode | string The transaction payment mode.
| ||||||||||||||||
state | string The state of the order transaction.
| ||||||||||||||||
reason_code | string The reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments.
| ||||||||||||||||
pending_reason | string Deprecated. The reason code for the pending transaction state. Obsolete. Use | ||||||||||||||||
protection_eligibility | string The level of seller protection in effect for the transaction.
| ||||||||||||||||
protection_eligibility_type | string The kind of seller protection in effect for the transaction. Returned only when the
| ||||||||||||||||
parent_payment | string The ID of the payment on which this transaction is based. | ||||||||||||||||
object (FMF Details) The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary. | |||||||||||||||||
create_time | string <date-time> The date and time when the resource was created, in Internet date and time format. | ||||||||||||||||
update_time | string <date-time> The date and time when the resource was last updated, in Internet date and time format. | ||||||||||||||||
Array of objects (Link Description) An array of request-related HATEOAS links. | |||||||||||||||||
required | object (Amount) The amount to collect. Note: For an order authorization, you cannot include amount
|
{- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "PENDING",
- "reason_code": "PAYER_SHIPPING_UNCONFIRMED",
- "pending_reason": "payer_shipping_unconfirmed",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "parent_payment": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
The JSON patch object to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | object (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
{- "op": "add",
- "path": "string",
- "value": { },
- "from": "string"
}
An array of JSON patch objects to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | object (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
[- {
- "op": "add",
- "path": "string",
- "value": { },
- "from": "string"
}
]
The payee who receives the funds and fulfills the order.
string <email> The email address associated with the payee's PayPal account. For an intent of authorize or order, the email address must be associated with a confirmed PayPal business account. For an intent of sale, the email can either:
| |
merchant_id | string The PayPal account ID for the payee. |
{- "email": "user@example.com",
- "merchant_id": "string"
}
The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
email_address | string <merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of merchant. |
merchant_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The encrypted PayPal account ID of the merchant. |
{- "email_address": "string",
- "merchant_id": "stringstrings"
}
The payer. The payer funds the payment.
payment_method | string [ 4 .. 17 ] characters The payment method.
| ||||||
status | string [ 8 .. 10 ] characters The status of payer's PayPal account.
| ||||||
Array of objects (Funding Instrument) = 1 items An array of a single funding instrument for the current payment. Valid only and required for the credit card payment method. The array must include either a | |||||||
object (Payer Information) The payer information. |
{- "payment_method": "paypal",
- "status": "VERIFIED",
- "funding_instruments": [
- {
- "credit_card_token": {
- "credit_card_id": "string",
- "payer_id": "s",
- "external_customer_id": "string",
- "last4": "stri",
- "type": "string",
- "expire_month": 1,
- "expire_year": "stri"
}
}
], - "payer_info": {
- "email": "user@example.com",
- "salutation": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "suffix": "string",
- "payer_id": "string",
- "birth_date": "2019-08-24T14:15:22Z",
- "tax_id": "string",
- "tax_id_type": "BR_CPF",
- "billing_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string"
}, - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}
}
}
The payer information.
string <email> The payer's email address. Maximum length is 127 characters. | |||||||
salutation | string The payer's salutation. | ||||||
first_name | string The payer's first name. | ||||||
middle_name | string The payer's middle name. | ||||||
last_name | string The payer's last name. | ||||||
suffix | string The payer's suffix. | ||||||
payer_id | string The PayPal-assigned encrypted payer ID. | ||||||
birth_date | string <date-time> The birth date of the payer, in Internet date format. For example, | ||||||
tax_id | string <= 14 characters The payer's tax ID. Supported for the PayPal payment method only. | ||||||
tax_id_type | string The payer's tax ID type. Supported for the PayPal payment method only.
| ||||||
object (Address) The billing address or shipping address for a payment. | |||||||
object (Shipping Address) The shipping address details. |
{- "email": "user@example.com",
- "salutation": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "suffix": "string",
- "payer_id": "string",
- "birth_date": "2019-08-24T14:15:22Z",
- "tax_id": "string",
- "tax_id_type": "BR_CPF",
- "billing_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string"
}, - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}
}
The payment details.
id | string The ID of the payment. |
intent required | string The payment intent. Value is:
|
Array of objects (Transaction) An array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment. For update and execute payment calls, the | |
state | string The state of the payment, authorization, or order transaction. Value is:
|
experience_profile_id | string Deprecated. The PayPal-generated ID for the merchant's payment experience profile. For information, see create web experience profile. Use application_context instead. |
note_to_payer | string <= 165 characters A free-form field that clients can use to send a note to the payer. |
object (Redirect URLs) A set of redirect URLs that you provide for PayPal-based payments. | |
failure_reason | string The reason code for a payment failure. |
create_time | string <date-time> The date and time when the payment was created, in Internet date and time format. |
update_time | string <date-time> The date and time when the payment was updated, in Internet date and time format. |
Array of objects (Link Description) An array of request-related HATEOAS links. | |
required | object (Payer) The source of the funds for this payment. Payment method is PayPal Wallet payment or bank direct debit. |
object (Application Context) Use the application context resource to customize payment flow experience for your buyers. |
{- "id": "string",
- "intent": "sale",
- "transactions": [
- {
- "payee": {
- "email": "user@example.com",
- "merchant_id": "string"
}, - "description": "string",
- "note_to_payee": "string",
- "custom": "string",
- "invoice_number": "string",
- "soft_descriptor": "string",
- "payment_options": {
- "allowed_payment_method": "UNRESTRICTED"
}, - "item_list": {
- "items": [
- {
- "sku": "string",
- "name": "string",
- "description": "string",
- "quantity": "string",
- "price": "string",
- "currency": "str",
- "tax": "string"
}
], - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}, - "shipping_method": "string",
- "shipping_phone_number": "string"
}, - "related_resources": [
- {
- "sale": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "completed",
- "reason_code": "CHARGEBACK",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "clearing_time": "2019-08-24T14:15:22Z",
- "payment_hold_status": "HELD",
- "payment_hold_reasons": [
- {
- "payment_hold_reason": null
}
], - "exchange_rate": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "receipt_id": "string",
- "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "billing_agreement_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": null,
- "rel": null,
- "method": null
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": null,
- "shipping": null,
- "tax": null,
- "handling_fee": null,
- "shipping_discount": null,
- "insurance": null,
- "gift_wrap": null
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}
}, - "authorization": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "authorized",
- "reason_code": "AUTHORIZATION",
- "pending_reason": "AUTHORIZATION",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "valid_until": "2019-08-24T14:15:22Z",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "receipt_id": "string",
- "links": [
- {
- "href": null,
- "rel": null,
- "method": null
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": null,
- "shipping": null,
- "tax": null,
- "handling_fee": null,
- "shipping_discount": null,
- "insurance": null,
- "gift_wrap": null
}
}
}, - "order": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "PENDING",
- "reason_code": "PAYER_SHIPPING_UNCONFIRMED",
- "pending_reason": "payer_shipping_unconfirmed",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "parent_payment": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": null,
- "rel": null,
- "method": null
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": null,
- "shipping": null,
- "tax": null,
- "handling_fee": null,
- "shipping_discount": null,
- "insurance": null,
- "gift_wrap": null
}
}
}, - "capture": {
- "id": "string",
- "is_final_capture": false,
- "state": "pending",
- "reason_code": "CHARGEBACK",
- "parent_payment": "string",
- "invoice_number": "string",
- "exchange_rate": "string",
- "note_to_payer": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": null,
- "rel": null,
- "method": null
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": null,
- "shipping": null,
- "tax": null,
- "handling_fee": null,
- "shipping_discount": null,
- "insurance": null,
- "gift_wrap": null
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}
}, - "refund": {
- "id": "string",
- "state": "pending",
- "reason": "string",
- "invoice_number": "string",
- "sale_id": "string",
- "capture_id": "string",
- "parent_payment": "string",
- "description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": null,
- "rel": null,
- "method": null
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": null,
- "shipping": null,
- "tax": null,
- "handling_fee": null,
- "shipping_discount": null,
- "insurance": null,
- "gift_wrap": null
}
}
}
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
], - "state": "created",
- "experience_profile_id": "string",
- "note_to_payer": "string",
- "failure_reason": "UNABLE_TO_COMPLETE_TRANSACTION",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "payer": {
- "payment_method": "paypal",
- "status": "VERIFIED",
- "funding_instruments": [
- {
- "credit_card_token": {
- "credit_card_id": "string",
- "payer_id": "s",
- "external_customer_id": "string",
- "last4": "stri",
- "type": "string",
- "expire_month": 1,
- "expire_year": "stri"
}
}
], - "payer_info": {
- "email": "user@example.com",
- "salutation": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "suffix": "string",
- "payer_id": "string",
- "birth_date": "2019-08-24T14:15:22Z",
- "tax_id": "string",
- "tax_id_type": "BR_CPF",
- "billing_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string"
}, - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}
}
}, - "application_context": {
- "brand_name": "string",
- "locale": "string",
- "landing_page": "string",
- "shipping_preference": "NO_SHIPPING",
- "user_action": "string",
- "payment_pattern": "CUSTOMER_PRESENT_ONETIME_PURCHASE",
- "preferred_payment_source": {
- "token": {
- "id": "string",
- "type": "BILLING_AGREEMENT"
}
}
}
}
Executes a PayPal account-based payment with the payer_id
obtained from the web approval URL.
payer_id | string The ID of the payer that PayPal passes in the |
Array of objects (Cart Base) An array of transaction details. Includes the amount and item details. For update and execute payment calls, the |
{- "payer_id": "string",
- "transactions": [
- {
- "reference_id": "string",
- "payee": {
- "email": "user@example.com",
- "merchant_id": "string"
}, - "description": "string",
- "note_to_payee": "string",
- "custom": "string",
- "invoice_number": "string",
- "soft_descriptor": "string",
- "payment_options": {
- "allowed_payment_method": "UNRESTRICTED"
}, - "item_list": {
- "items": [
- {
- "sku": "string",
- "name": "string",
- "description": "string",
- "quantity": "string",
- "price": "string",
- "currency": "str",
- "tax": "string"
}
], - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}, - "shipping_phone_number": "string"
}, - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
]
}
An array of merchant payments that are complete. Payments that you just created with the create payment call do not appear in the list.
Array of objects (Payment) An array of payments that are complete. Payments that you just created with the create payment call do not appear in the list. | |
count | integer <= 20 The number of items returned in each range of results. Note that the last results range might have fewer items than the requested number of items. |
next_id | string The ID of the element to use to get the next range of results. |
{- "payments": [
- {
- "id": "string",
- "intent": "sale",
- "transactions": [
- {
- "payee": {
- "email": "user@example.com",
- "merchant_id": "string"
}, - "description": "string",
- "note_to_payee": "string",
- "custom": "string",
- "invoice_number": "string",
- "soft_descriptor": "string",
- "payment_options": {
- "allowed_payment_method": "UNRESTRICTED"
}, - "item_list": {
- "items": [
- {
- "sku": null,
- "name": null,
- "description": null,
- "quantity": null,
- "price": null,
- "currency": null,
- "tax": null
}
], - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}, - "shipping_method": "string",
- "shipping_phone_number": "string"
}, - "related_resources": [
- {
- "sale": {
- "id": null,
- "payment_mode": null,
- "state": null,
- "reason_code": null,
- "protection_eligibility": null,
- "protection_eligibility_type": null,
- "clearing_time": null,
- "payment_hold_status": null,
- "payment_hold_reasons": [ ],
- "exchange_rate": null,
- "fmf_details": null,
- "receipt_id": null,
- "parent_payment": null,
- "processor_response": null,
- "billing_agreement_id": null,
- "create_time": null,
- "update_time": null,
- "links": [ ],
- "amount": null,
- "transaction_fee": null,
- "receivable_amount": null,
- "transaction_fee_in_receivable_currency": null
}, - "authorization": {
- "id": null,
- "payment_mode": null,
- "state": null,
- "reason_code": null,
- "pending_reason": null,
- "protection_eligibility": null,
- "protection_eligibility_type": null,
- "fmf_details": null,
- "parent_payment": null,
- "processor_response": null,
- "valid_until": null,
- "create_time": null,
- "update_time": null,
- "receipt_id": null,
- "links": [ ],
- "amount": null
}, - "order": {
- "id": null,
- "payment_mode": null,
- "state": null,
- "reason_code": null,
- "pending_reason": null,
- "protection_eligibility": null,
- "protection_eligibility_type": null,
- "parent_payment": null,
- "fmf_details": null,
- "create_time": null,
- "update_time": null,
- "links": [ ],
- "amount": null
}, - "capture": {
- "id": null,
- "is_final_capture": null,
- "state": null,
- "reason_code": null,
- "parent_payment": null,
- "invoice_number": null,
- "exchange_rate": null,
- "note_to_payer": null,
- "create_time": null,
- "update_time": null,
- "links": [ ],
- "amount": null,
- "transaction_fee": null,
- "transaction_fee_in_receivable_currency": null,
- "receivable_amount": null
}, - "refund": {
- "id": null,
- "state": null,
- "reason": null,
- "invoice_number": null,
- "sale_id": null,
- "capture_id": null,
- "parent_payment": null,
- "description": null,
- "create_time": null,
- "update_time": null,
- "links": [ ],
- "amount": null
}
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
], - "state": "created",
- "experience_profile_id": "string",
- "note_to_payer": "string",
- "failure_reason": "UNABLE_TO_COMPLETE_TRANSACTION",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "payer": {
- "payment_method": "paypal",
- "status": "VERIFIED",
- "funding_instruments": [
- {
- "credit_card_token": {
- "credit_card_id": "string",
- "payer_id": "s",
- "external_customer_id": "string",
- "last4": "stri",
- "type": "string",
- "expire_month": 1,
- "expire_year": "stri"
}
}
], - "payer_info": {
- "email": "user@example.com",
- "salutation": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "suffix": "string",
- "payer_id": "string",
- "birth_date": "2019-08-24T14:15:22Z",
- "tax_id": "string",
- "tax_id_type": "BR_CPF",
- "billing_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string"
}, - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}
}
}, - "application_context": {
- "brand_name": "string",
- "locale": "string",
- "landing_page": "string",
- "shipping_preference": "NO_SHIPPING",
- "user_action": "string",
- "payment_pattern": "CUSTOMER_PRESENT_ONETIME_PURCHASE",
- "preferred_payment_source": {
- "token": {
- "id": "string",
- "type": "BILLING_AGREEMENT"
}
}
}
}
], - "count": 20,
- "next_id": "string"
}
Provides context (e.g. frequency of payment (Single, Recurring) along with whether (Customer is Present, Not Present) for the payment being processed. For Card and PayPal Vaulted/Billing Agreement transactions, this helps specify the appropriate indicators to the networks (e.g. Mastercard, Visa) which ensures compliance as well as ensure a better auth-rate. For bank processing, indicates to clearing house whether the transaction is recurring or not depending on the option chosen.
Provides context (e.g. frequency of payment (Single, Recurring) along with whether (Customer is Present, Not Present) for the payment being processed. For Card and PayPal Vaulted/Billing Agreement transactions, this helps specify the appropriate indicators to the networks (e.g. Mastercard, Visa) which ensures compliance as well as ensure a better auth-rate. For bank processing, indicates to clearing house whether the transaction is recurring or not depending on the option chosen.
Enum: | Description |
---|---|
CUSTOMER_PRESENT_ONETIME_PURCHASE | If the payments is an e-commerce payment initiated by the customer. Customer typically enters payment information (e.g. card number, approves payment within the PayPal Checkout flow) and such information that has not been previously stored on file. |
CUSTOMER_NOT_PRESENT_RECURRING | Subsequent recurring payments (e.g. subscriptions with a fixed amount on a predefined schedule when customer is not present. |
CUSTOMER_PRESENT_RECURRING_FIRST | The first payment initiated by the customer which is expected to be followed by a series of subsequent recurring payments transactions (e.g. subscriptions with a fixed amount on a predefined schedule when customer is not present. This is typically used for scenarios where customer stores credentials and makes a purchase on a given date and also set’s up a subscription. |
CUSTOMER_PRESENT_ONETIME_PURCHASE_VAULTED | Also known as (card-on-file) transactions. Payment details are stored to enable checkout with one-click, or simply to streamline the checkout process. For card transaction customers typically do not enter a CVC number as part of the Checkout process. |
CUSTOMER_NOT_PRESENT_ONETIME_PURCHASE_VAULTED | Unscheduled payments that are not recurring on a predefined schedule (e.g. balance top-up). |
MAIL_ORDER_TELEPHONE_ORDER | Payments that are initiated by the customer via the merchant by mail or telephone. |
"CUSTOMER_PRESENT_ONETIME_PURCHASE"
The payment source definition.
object (token) The tokenized payment source to fund a payment. |
{- "token": {
- "id": "string",
- "type": "BILLING_AGREEMENT"
}
}
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
The account identifier for a PayPal account.
The account identifier for a PayPal account.
"stringstrings"
The percentage as a fixed-point, signed decimal value. Use for all interest rates. For example, specify an interest rate of 19.99% as 19.99
. The allowed number formats are plain decimal numbers and whole numbers.
The percentage as a fixed-point, signed decimal value. Use for all interest rates. For example, specify an interest rate of 19.99% as 19.99
. The allowed number formats are plain decimal numbers and whole numbers.
"string"
The processor-provided response codes that describe the submitted payment. Supported only when the payment_method
is credit_card
.
response_code required | string <= 4 characters The PayPal normalized response code, which is generated from the processor's specific response code. | ||||||||||||||||
avs_code | string <= 1 characters [A-z0-9]{1} The Address Verification System (AVS) response code. | ||||||||||||||||
cvv_code | string <= 1 characters [A-z0-9]{1} The CVV system response code. | ||||||||||||||||
advice_code | string The merchant advice on how to handle declines for recurring payments.
| ||||||||||||||||
eci_submitted | string The processor-provided authorization response. | ||||||||||||||||
vpas | string The processor-provided Visa Payer Authentication Service (VPAS) status. |
{- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}
The refund details.
id | string The ID of the refund transaction. Maximum length is 17 characters. | ||||||||||
state | string The state of the refund.
| ||||||||||
reason | string The reason that the transaction is being refunded. | ||||||||||
invoice_number | string <= 127 characters The invoice or tracking ID number. | ||||||||||
sale_id | string The ID of the sale transaction being refunded. | ||||||||||
capture_id | string The ID of the sale transaction being refunded. | ||||||||||
parent_payment | string The ID of the payment on which this transaction is based. | ||||||||||
description | string The refund description. Value must be single-byte alphanumeric characters. | ||||||||||
create_time | string <date-time> The date and time when the refund was created, in Internet date and time format. | ||||||||||
update_time | string <date-time> The date and time when the resource was last updated, in Internet date and time format. | ||||||||||
Array of objects (Link Description) An array of request-related HATEOAS links. | |||||||||||
object (Amount) The payment amount, with details. |
{- "id": "string",
- "state": "pending",
- "reason": "string",
- "invoice_number": "string",
- "sale_id": "string",
- "capture_id": "string",
- "parent_payment": "string",
- "description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
The refund request.
description | string <= 255 characters The refund description. Value is a string of single-byte alphanumeric characters. |
reason | string <= 30 characters The refund reason description. |
invoice_number | string <= 127 characters The invoice number that tracks this payment. Value is a string of single-byte alphanumeric characters. |
object (Amount) The refund amount. Includes both the amount to refund to the payer and the fee amount to refund to the payee. |
{- "description": "string",
- "reason": "string",
- "invoice_number": "string",
- "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
The refund transaction details.
id | string <= 17 characters The ID of the refund transaction. |
state | string The state of the refund. |
reason | string The reason that the transaction is being refunded. |
invoice_number | string <= 127 characters Your own invoice or tracking ID number. Value is a string of single-byte alphanumeric characters. |
sale_id | string The ID of the sale transaction being refunded. |
capture_id | string The ID of the sale transaction being refunded. |
parent_payment | string The ID of the payment on which this transaction is based. |
description | string The refund description. |
create_time | string <date-time> The date and time when the refund was created, in Internet date and time format. |
update_time | string <date-time> The date and time when the resource was last updated, in Internet date and time format. |
Array of objects (Link Description) An array of request-related HATEOAS links. | |
object (Amount) The refund amount. Includes both the amount refunded to the payer and the fee refunded to the payee. |
{- "id": "string",
- "state": "pending",
- "reason": "string",
- "invoice_number": "string",
- "sale_id": "string",
- "capture_id": "string",
- "parent_payment": "string",
- "description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
The payment-related financial transactions, which include sales, authorizations, captures, and refunds. To show resource details, use the resource ID. For example, to show details for a related authorization, use the ID returned in the authorization
object. You can also use the HATEOAS links for a resource to complete operations for that resource. For example, a sale
object provides a refund
link that enables you to refund the sale.
object (Sale) The sale transaction details. | |
object (Authorization) The authorization details. | |
object (Order) The order transaction details. | |
object (Capture) The capture transaction details. | |
object (Refund) The refund details. |
{- "sale": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "completed",
- "reason_code": "CHARGEBACK",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "clearing_time": "2019-08-24T14:15:22Z",
- "payment_hold_status": "HELD",
- "payment_hold_reasons": [
- {
- "payment_hold_reason": "PAYMENT_HOLD"
}
], - "exchange_rate": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "receipt_id": "string",
- "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "billing_agreement_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}
}, - "authorization": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "authorized",
- "reason_code": "AUTHORIZATION",
- "pending_reason": "AUTHORIZATION",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "valid_until": "2019-08-24T14:15:22Z",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "receipt_id": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}, - "order": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "PENDING",
- "reason_code": "PAYER_SHIPPING_UNCONFIRMED",
- "pending_reason": "payer_shipping_unconfirmed",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "parent_payment": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}, - "capture": {
- "id": "string",
- "is_final_capture": false,
- "state": "pending",
- "reason_code": "CHARGEBACK",
- "parent_payment": "string",
- "invoice_number": "string",
- "exchange_rate": "string",
- "note_to_payer": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}
}, - "refund": {
- "id": "string",
- "state": "pending",
- "reason": "string",
- "invoice_number": "string",
- "sale_id": "string",
- "capture_id": "string",
- "parent_payment": "string",
- "description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
}
The payment-related financial transactions, which include sales, authorizations, captures, and refunds. To show resource details, use the resource ID. For example, to show details for a related authorization, use the ID returned in the authorization
object. You can also use the HATEOAS links for a resource to complete operations for that resource. For example, a sale
object provides a refund
link that enables you to refund the sale.
payment_hold_reason | string The reason that PayPal holds the recipient fund. Set only if the payment hold status is |
{- "payment_hold_reason": "PAYMENT_HOLD"
}
The decimal precision to use to compute rewards.
length | string The number of allowed decimal places after the decimal point for rewards conversions. | ||||||
conversion_type | string (rewards_conversion_type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The list of conversion types.
|
{- "length": "string",
- "conversion_type": "AMOUNT_TO_REWARDS"
}
The rounding mode to use to compute rewards.
value | string (rounding_mode_type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The rewards amount rounding mode.
| ||||||||||||||
conversion_type | string (rewards_conversion_type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ The list of conversion types.
|
{- "value": "UP",
- "conversion_type": "AMOUNT_TO_REWARDS"
}
The list of conversion types.
The list of conversion types.
Enum: | Description |
---|---|
AMOUNT_TO_REWARDS | An amount-to-rewards conversion. |
REWARDS_TO_AMOUNT | A rewards-to-amount conversion. |
"AMOUNT_TO_REWARDS"
The rewards amount rounding mode.
The rewards amount rounding mode.
Enum: | Description |
---|---|
UP | Round away from zero. |
DOWN | Round toward zero. |
HALF_UP | Round toward nearest neighbor unless both neighbors are equidistant. If equidistant, round up. |
HALF_DOWN | Round toward nearest neighbor unless both neighbors are equidistant. If equidistant, round down. |
HALF_EVEN | Round toward the nearest neighbor unless both neighbors are equidistant. If equidistant, round toward the even neighbor. |
UNNECESSARY | Because the requested operation has an exact result, no rounding is necessary. |
"UP"
The sale transaction details.
id required | string The ID of the sale transaction. |
payment_mode | string The transaction payment mode. Supported only for PayPal payments. |
state required | string The state of the sale transaction. |
reason_code | string A reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments. |
protection_eligibility | string The merchant protection level in effect for the transaction. Supported only for PayPal payments. |
protection_eligibility_type | string The merchant protection type in effect for the transaction. Returned only when |
clearing_time | string <date-time> The date and time when the PayPal eCheck transaction is expected to clear, in Internet date and time format. |
payment_hold_status | string The recipient fund status. Returned only when the fund status is |
Array of objects (Related Resources) An array of reasons that PayPal holds the recipient fund. Set only if the payment hold status is | |
exchange_rate | string The exchange rate for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. |
object (FMF Details) The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see Fraud Management Filters Summary. | |
receipt_id | string^[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}$ The receipt ID, which is a payment ID number that is returned for guest users to identify the payment. |
parent_payment required | string The ID of the payment on which this transaction is based. |
object (Processor Response) The processor-provided response codes that describe the submitted payment. Supported only when the | |
billing_agreement_id | string The ID of the billing agreement. Used as reference to execute this transaction. |
create_time required | string <date-time> The date and time of the sale, in Internet date and time format. |
update_time | string <date-time> The date and time when the resource was last updated, in Internet date and time format. |
Array of objects (Link Description) An array of request-related HATEOAS links. | |
required | object (Amount) The amount to collect. |
object (Currency) The currency and amount of the transaction fee for this payment. Would not be returned for | |
object (Currency) The currency and amount of the net that the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. | |
object (Currency) The currency and amount of the PayPal fee for this payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example |
{- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "completed",
- "reason_code": "CHARGEBACK",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "clearing_time": "2019-08-24T14:15:22Z",
- "payment_hold_status": "HELD",
- "payment_hold_reasons": [
- {
- "payment_hold_reason": "PAYMENT_HOLD"
}
], - "exchange_rate": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "receipt_id": "string",
- "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "billing_agreement_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}
}
The shipping address details.
line1 required | string <= 300 characters The first line of the address. For example, number, street, and so on. | ||||||||||
line2 | string <= 300 characters The second line of the address. For example, suite or apartment number. | ||||||||||
city | string <= 64 characters The city name. | ||||||||||
country_code required | string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is | ||||||||||
postal_code | string The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. | ||||||||||
state | |||||||||||
phone | string <phone> The phone number, in E.123 format. Maximum length is 50 characters. | ||||||||||
normalization_status | string The address normalization status. Returned only for payers from Brazil.
| ||||||||||
type | string The type of address. For example, | ||||||||||
recipient_name | string <= 127 characters The name of the recipient at this address. |
{- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}
The tokenized payment source to fund a payment.
id required | string [ 1 .. 255 ] characters The PayPal-generated ID for the token. | ||||
type required | string [ 1 .. 255 ] characters ^[0-9A-Z_-]+$ The tokenization method that generated the ID.
|
{- "id": "string",
- "type": "BILLING_AGREEMENT"
}
An array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment.
object (Payee) The payee who receives the funds and fulfills the order. | |
description | string <= 127 characters The purchase description. |
note_to_payee | string <= 255 characters The note to the recipient of the funds in this transaction. |
custom | string <= 127 characters The free-form field for the client's use. |
invoice_number | string <= 127 characters The invoice number to track this payment. |
soft_descriptor | string <= 22 characters The soft descriptor to use to charge this funding source. If greater than the maximum allowed length, the API truncates the string. |
object (Payment Options) The payment options for this transaction. | |
object (Item List) An array of items that are being purchased. | |
notify_url | string <uri> <= 2048 characters The URL to send payment notifications. |
Array of objects (Related Resources) An array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment. | |
object (Amount) The payment amount, with details. |
{- "payee": {
- "email": "user@example.com",
- "merchant_id": "string"
}, - "description": "string",
- "note_to_payee": "string",
- "custom": "string",
- "invoice_number": "string",
- "soft_descriptor": "string",
- "payment_options": {
- "allowed_payment_method": "UNRESTRICTED"
}, - "item_list": {
- "items": [
- {
- "sku": "string",
- "name": "string",
- "description": "string",
- "quantity": "string",
- "price": "string",
- "currency": "str",
- "tax": "string"
}
], - "shipping_address": {
- "line1": "string",
- "line2": "string",
- "city": "string",
- "country_code": "st",
- "postal_code": "string",
- "state": "string",
- "phone": "string",
- "normalization_status": "UNKNOWN",
- "type": "string",
- "recipient_name": "string"
}, - "shipping_method": "string",
- "shipping_phone_number": "string"
}, - "related_resources": [
- {
- "sale": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "completed",
- "reason_code": "CHARGEBACK",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "clearing_time": "2019-08-24T14:15:22Z",
- "payment_hold_status": "HELD",
- "payment_hold_reasons": [
- {
- "payment_hold_reason": "PAYMENT_HOLD"
}
], - "exchange_rate": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "receipt_id": "string",
- "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "billing_agreement_id": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}
}, - "authorization": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "authorized",
- "reason_code": "AUTHORIZATION",
- "pending_reason": "AUTHORIZATION",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "parent_payment": "string",
- "processor_response": {
- "response_code": "stri",
- "avs_code": "s",
- "cvv_code": "s",
- "advice_code": "01_NEW_ACCOUNT_INFORMATION",
- "eci_submitted": "string",
- "vpas": "string"
}, - "valid_until": "2019-08-24T14:15:22Z",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "receipt_id": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}, - "order": {
- "id": "string",
- "payment_mode": "INSTANT_TRANSFER",
- "state": "PENDING",
- "reason_code": "PAYER_SHIPPING_UNCONFIRMED",
- "pending_reason": "payer_shipping_unconfirmed",
- "protection_eligibility": "ELIGIBLE",
- "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
- "parent_payment": "string",
- "fmf_details": {
- "filter_type": "ACCEPT",
- "filter_id": "AVS_NO_MATCH",
- "name": "string",
- "description": "string"
}, - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}, - "capture": {
- "id": "string",
- "is_final_capture": false,
- "state": "pending",
- "reason_code": "CHARGEBACK",
- "parent_payment": "string",
- "invoice_number": "string",
- "exchange_rate": "string",
- "note_to_payer": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}, - "transaction_fee": {
- "currency": "string",
- "value": "string"
}, - "transaction_fee_in_receivable_currency": {
- "currency": "string",
- "value": "string"
}, - "receivable_amount": {
- "currency": "string",
- "value": "string"
}
}, - "refund": {
- "id": "string",
- "state": "pending",
- "reason": "string",
- "invoice_number": "string",
- "sale_id": "string",
- "capture_id": "string",
- "parent_payment": "string",
- "description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}
}
], - "amount": {
- "currency": "string",
- "total": "string",
- "details": {
- "subtotal": "string",
- "shipping": "string",
- "tax": "string",
- "handling_fee": "string",
- "shipping_discount": "string",
- "insurance": "string",
- "gift_wrap": "string"
}
}
}