Payments(1)

API Version v1

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

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.

operation/payment.create Create payment

post/v1/payments/payment

Try it

Creates 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 intent to sale, authorize, or order.

Include payer, transaction details, and, for PayPal payments only, redirect URLs. The combination of the payment_method and funding_instrument determines the type of payment that is created. For more information, see Payments REST API.

SecurityOauth2

Request

header Parameters


PayPal-Partner-Attribution-Id	string<= 32 characters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


intent required	string The payment intent. Value is: - `sale`. Makes an immediate payment. - `authorize`. Authorizes a payment for capture later. - `order`. Creates an order. Enum:"sale""authorize""order"
transactions	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 `transactions` object accepts the `amount` object only.
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.
redirect_urls	object (Redirect URLs) A set of redirect URLs that you provide for PayPal-based payments.
payer required	object (Payer) The source of the funds for this payment. Payment method is PayPal Wallet payment or bank direct debit.
application_context	object (Application Context) Use the application context resource to customize payment flow experience for your buyers.

Responses

201 A successful request returns the HTTP 201 Created status code and a JSON response body that shows payment details.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Create PayPal PaymentSample 1 - 201 - Create PayPal Payment

Copy

Expand allCollapse all

`{"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": {"return_url": "https://example.com/return",

"cancel_url": "https://example.com/cancel"

}

Response samples

application/json

Sample 1 - 201 - Create PayPal PaymentSample 1 - 201 - Create PayPal Payment

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-1B56960729604235TKQQIYVY",

"rel": "self",

"method": "GET"

},

{"href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-60385559L1062554J",

"rel": "approval_url",

"method": "REDIRECT"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-1B56960729604235TKQQIYVY/execute",

"rel": "execute",

"method": "POST"

}

]

operation/payment.list List payments

get/v1/payments/payment

Try it

Lists payments that are completed. Payments that you just created with the create payment call do not appear in the list.

The list shows the payments that are made to the merchant who makes the call. To filter the payments that appear in the response, you can specify one or more optional query and pagination parameters. See Filtering and pagination.

SecurityOauth2

Request

query Parameters


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 `next_id` value as the `start_id` to continue with the next set of results.
start_index	integer The start index of the payments to list. Typically, you use the `start_index` to jump to a specific position in the resource history based on its cart. For example, to start at the second item in a list of results, specify `?start_index=2`.
start_time	string The start date and time for the range to show in the response, in Internet date and time format. For example, `start_time=2016-03-06T11:00:00Z`.
end_time	string The end date and time for the range to show in the response, in Internet date and time format. For example, `end_time=2016-03-06T11:00:00Z`.
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. Value:"create_time"
sort_order	string Sorts the payments in the response in descending order. Value:"desc"

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

any

Responses

200 A successful request returns the HTTP 200 OK status code and a JSON response body that lists payments with payment details.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Copy

{ }

Response samples

application/json

Sample 1 - 200 - List PaymentsSample 1 - 200 - List Payments

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0US81985GW1191216KOY7OXA",

"rel": "parent_payment",

"method": "GET"

}

]

}

}

]

}

],

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0US81985GW1191216KOY7OXA",

"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-53485002LD6169910KOZQ25I",

"rel": "parent_payment",

"method": "GET"

}

]

}

}

]

}

],

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-53485002LD6169910KOZQ25I",

"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/capture/26062838D7499294V",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/capture/26062838D7499294V/refund",

"rel": "refund",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-7F5790198P134484LKOZSG7Q",

"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/capture/0YU20012P1477553M",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/capture/0YU20012P1477553M/refund",

"rel": "refund",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-7F5790198P134484LKOZSG7Q",

"rel": "parent_payment",

"method": "GET"

}

]

}

}

]

}

],

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-7F5790198P134484LKOZSG7Q",

"rel": "self",

"method": "GET"

}

]

}

],

"count": 3,

"next_id": "PAY-9X4935091L753623RKOZTRHI"

operation/payment.get Show payment details

get/v1/payments/payment/{payment_id}

Try it

Shows details for a payment, by ID, that has yet to complete. For example, shows details for a payment that was created, approved, or failed.

SecurityOauth2

Request

path Parameters


payment_id required	string The ID of the payment for which to show details.

Responses

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

Request samples

cURL

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0US81985GW1191216KOY7OXA \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer access_token6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g'

Response samples

application/json

Sample 1 - 200 - Show Payment Details for BOPIS use caseSample 1 - 200 - Show Payment Details for BOPIS use case

Copy

Expand allCollapse all

`{"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"

},

"shipping_options": [{"id": "PICKUP0000001",

"label": "Free Shipping",

"type": "PICKUP",

"amount": {"currency_code": "USD",

"value": "5.00"

},

"selected": true

}

]

},

"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0US81985GW1191216KOY7OXA",

"rel": "parent_payment",

"method": "GET"

}

]

}

}

]

}

],

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0US81985GW1191216KOY7OXA",

"rel": "self",

"method": "GET"

}

]

operation/payment.update Partially update payment

patch/v1/payments/payment/{payment_id}

Try it

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

SecurityOauth2

Request

path Parameters


payment_id required	string The ID of the payment to update.

Request Body schema: application/json

Array

| op
required | string

The operation.

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

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

For more information, see 4.6. test. | | | path | string
The JSON Pointer to the target document location at which to complete the operation. | | value | object (Patch Value)
The value to apply. The remove operation does not require a value. | | from | string
The JSON Pointer to the target document location from which to move the value. Required for the move operation. |

Responses

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

Request samples

Payload
cURL

application/json

Sample 1 - 200 - Update PaymentSample 1 - 200 - Update Payment

Copy

Expand allCollapse all

[{"op": "replace",\ \ "path": "/transactions/0/item_list/shipping_options",\ \ "value": [{"id": "PICKUP0000001",\ \ "type": "PICKUP",\ \ "label": "Pickup Info",\ \ "amount": {"currency": "USD",\ \ "value": "10.00"\ \ },\ \ "selected": true\ \ }\ \ ]\ \ }\ \ ]

Response samples

application/json

Sample 1 - 200 - Update PaymentSample 1 - 200 - Update Payment

Copy

Expand allCollapse all

`{"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"

},

"shipping_options": [{"id": "PICKUP0000001",

"label": "Pickup Info",

"type": "PICKUP",

"amount": {"value": "10.00",

"currency": "USD"

},

"selected": true

}

]

},

"payee": {"email": "payee@example.com"

}

}

],

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-5YK922393D847794YKER7MUI",

"method": "GET",

"rel": "self"

}

]

operation/payment.execute Execute approved PayPal payment

post/v1/payments/payment/{payment_id}/execute

Try it

Executes a PayPal payment that the customer has approved. You can optionally update one or more transactions when you execute the payment.

SecurityOauth2

Request

path Parameters


payment_id required	string The ID of the payment to execute.

header Parameters


PayPal-Request-Id	string<= 78 characters The server stores keys for 30 days.
PayPal-Partner-Attribution-Id	string<= 32 characters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


payer_id	string The ID of the payer that PayPal passes in the `return_url`.
transactions	Array of objects (Cart Base) An array of transaction details. Includes the amount and item details. For update and execute payment calls, the `transactions` object accepts only the `amount` object.

Responses

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

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 200 - Execute OrderSample 1 - 200 - Execute Order

Copy

`{"payer_id": "CR87QHB7JTRSC"

Response samples

application/json

Sample 1 - 200 - Execute OrderSample 1 - 200 - Execute Order

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-3SP845109F051535C",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-9N9834337A9191208KOZOQWI",

"rel": "parent_payment",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-3SP845109F051535C/void",

"rel": "void",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-3SP845109F051535C/authorize",

"rel": "authorization",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-3SP845109F051535C/capture",

"rel": "capture",

"method": "POST"

}

]

}

}

]

}

],

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-9N9834337A9191208KOZOQWI",

"rel": "self",

"method": "GET"

}

]

operation/sale.get Show sale details

get/v1/payments/sale/{sale_id}

Try it

Shows details for a sale, by ID. Returns only sales that were created through the REST API.

SecurityOauth2

Request

path Parameters


sale_id required	string The ID of the sale for which to show details.

Responses

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

Request samples

cURL

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/sale/34P65696MB8050805 \
-H 'Authorization: Bearer access_token6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g'

Response samples

application/json

Sample 1 - 200 - Show Sale DetailsSample 1 - 200 - Show Sale Details

Copy

Expand allCollapse all

`{"id": "PAYID-L22F5TI6U989123YN3449833",

"intent": "sale",

"state": "approved",

"cart": "7FB02792N0577162W",

"payer": {"payment_method": "paypal",

"status": "VERIFIED",

"payer_info": {"email": "testaccountlta@p.com(opens in new tab)",

"first_name": "Edward",

"last_name": "Daphne",

"payer_id": "EY5JYNPZYU43U",

"shipping_address": {"recipient_name": "Hello World",

"line1": "4th Floor,One Lagoon Drive",

"line2": "unit #34",

"city": "Redwood City",

"state": "CA",

"postal_code": "94065",

"country_code": "US"

}

"transactions": [{"amount": {"total": "10.00",

"currency": "USD",

"details": {"subtotal": "0.00",

"tax": "0.00",

"shipping": "0.00",

"insurance": "0.00",

"handling_fee": "0.00",

"shipping_discount": "0.00"

}

},

"payee": {"merchant_id": "D87XQWW2N6V8W",

"email": "_sys_aquarium-2171730659297732@paypal.com(opens in new tab)"

},

"description": "This is the payment transaction description.",

"custom": "Nouphal Custom",

"item_list": {"shipping_address": {"recipient_name": "Hello World",

"line1": "4th Floor,One Lagoon Drive",

"line2": "unit #34",

"city": "Redwood City",

"state": "CA",

"postal_code": "94065",

"country_code": "US"

},

"shipping_phone_number": "4084217591"

},

"related_resources": [{"sale": {"id": "0GP63733UF4238932",

"state": "completed",

"amount": {"total": "10.00",

"currency": "USD",

"details": {"subtotal": "0.00",

"tax": "0.00",

"shipping": "0.00",

"insurance": "0.00",

"handling_fee": "0.00",

"shipping_discount": "0.00"

}

},

"payment_mode": "INSTANT_TRANSFER",

"protection_eligibility": "ELIGIBLE",

"protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",

"transaction_fee": {"value": "0.22",

"currency": "USD"

},

"transaction_fee_in_receivable_currency": {"value": "1",

"currency": "CNY"

},

"receivable_amount": {"value": "59.26",

"currency": "CNY"

},

"exchange_rate": "5.9483297432325",

"parent_payment": "PAYID-L22F5TI6U989123YN3449833",

"create_time": "2020-05-07T19:18:28Z",

"update_time": "2020-05-07T19:18:28Z",

"links": [{"href": "https://www.msmaster.qa.paypal.com:12326/v1/payments/sale/0GP63733UF4238932",

"rel": "self",

"method": "GET"

},

{"href": "https://www.msmaster.qa.paypal.com:12326/v1/payments/sale/0GP63733UF4238932/refund",

"rel": "refund",

"method": "POST"

},

{"href": "https://www.msmaster.qa.paypal.com:12326/v1/payments/payment/PAYID-L22F5TI6U989123YN3449833",

"rel": "parent_payment",

"method": "GET"

}

]

}

}

]

}

],

"failed_transactions": [ ],

"create_time": "2020-05-07T19:17:31Z",

"update_time": "2020-05-07T19:18:28Z",

"links": [{"href": "https://www.msmaster.qa.paypal.com:12326/v1/payments/payment/PAYID-L22F5TI6U989123YN3449833",

"rel": "self",

"method": "GET"

}

]

operation/sale.refund Refund sale

post/v1/payments/sale/{sale_id}/refund

Try it

Refunds a sale, by ID. For a full refund, do not include the amount object in the JSON request body. For a partial refund, include an amount object in the JSON request body.

SecurityOauth2

Request

path Parameters


sale_id required	string The ID of the sale transaction to refund.

header Parameters


PayPal-Request-Id	string<= 78 characters The server stores keys for 30 days.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


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.
amount	object (Amount) The refund amount. Includes both the amount to refund to the payer and the fee amount to refund to the payee.

Responses

201 A successful request returns the HTTP 201 Created status code and a JSON response body that shows details for the refunded sale.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Refund Sale by Invoice IDSample 1 - 201 - Refund Sale by Invoice ID

Copy

Expand allCollapse all

`{"amount": {"total": "2.34",

"currency": "USD"

"using": "INVOICE_ID",

"payer_info": {"email": "payer@example.com"

}

Response samples

application/json

Sample 1 - 201 - Refund Sale by Invoice IDSample 1 - 201 - Refund Sale by Invoice ID

Copy

Expand allCollapse all

`{"id": "4CF18861HF410323U",

"create_time": "2017-01-31T04:13:34Z",

"update_time": "2017-01-31T04:13:36Z",

"state": "COMPLETED",

"amount": {"total": "2.34",

"currency": "USD"

"sale_id": "2MU78835H4515710F",

"parent_payment": "PAY-46E69296BH2194803KEE662Y",

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/refund/4CF18861HF410323U",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-46E69296BH2194803KEE662Y",

"rel": "parent_payment",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/sale/2MU78835H4515710F",

"rel": "sale",

"method": "GET"

}

]

operation/authorization.get Show authorization details

get/v1/payments/authorization/{authorization_id}

Try it

Shows details for an authorization, by ID.

SecurityOauth2

Request

path Parameters


authorization_id required	string The ID of the authorization for which to show details.

Responses

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

Request samples

cURL

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/authorization/2DC87612EK520411B \
-H 'Authorization: Bearer access_token6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g'

Response samples

application/json

Sample 1 - 200 - Shows Authorization DetailsSample 1 - 200 - Shows Authorization Details

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/2DC87612EK520411B",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/2DC87612EK520411B/capture",

"rel": "capture",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/2DC87612EK520411B/void",

"rel": "void",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-36246664YD343335CKHFA4AY",

"rel": "parent_payment",

"method": "GET"

}

]

operation/authorization.capture Capture authorization

post/v1/payments/authorization/{authorization_id}/capture

Try it

Captures and processes an authorization, by ID. The original payment call must specify an intent of authorize.

SecurityOauth2

Request

path Parameters


authorization_id required	string The ID of the authorization to capture.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


is_final_capture	boolean Default:false Indicates whether to release all remaining held funds.
invoice_number	string<= 127 characters The invoice number to track this payment.
note_to_payer	string<= 255 characters A free-form field that clients can use to send a note to the payer.
amount	object (Amount) The amount to capture. If the amount matches the originally authorized amount, the state of the authorization changes to `captured`. Otherwise, the state changes to `partially_captured`.

Responses

201 A successful request returns the HTTP 201 Created status code and a JSON response body that shows details for the captured authorization.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Capture Funds for Authorized PaymentSample 1 - 201 - Capture Funds for Authorized Payment

Copy

Expand allCollapse all

`{"amount": {"currency": "USD",

"total": "4.54"

"is_final_capture": true

Response samples

application/json

Sample 1 - 201 - Capture Funds for Authorized PaymentSample 1 - 201 - Capture Funds for Authorized Payment

Copy

Expand allCollapse all

`{"id": "05L60402VH257294E",

"amount": {"total": "1.10",

"currency": "USD"

"state": "completed",

"reason_code": "NONE",

"custom": "Nouphal Custom",

"transaction_fee": {"value": "0.35",

"currency": "USD"

"transaction_fee_in_receivable_currency": {"value": "0.35",

"currency": "CNY"

"receivable_amount": {"value": "0.07",

"currency": "CNY"

"exchange_rate": "0.009370279361376",

"is_final_capture": false,

"parent_payment": "PAYID-L2ZOT5Y1K876380CL583530L",

"invoice_number": "",

"create_time": "2020-05-06T16:49:32Z",

"update_time": "2020-05-06T16:49:32Z",

"links": [{"href": "https://www.$:12326/v1/payments/capture/05L60402VH257294E",

"rel": "self",

"method": "GET"

},

{"href": "https://www.$:12326/v1/payments/capture/05L60402VH257294E/refund",

"rel": "refund",

"method": "POST"

},

{"href": "https://www.$:12326/v1/payments/authorization/6JD14952FS4103539",

"rel": "authorization",

"method": "GET"

},

{"href": "https://www.$:12326/v1/payments/payment/PAYID-L2ZOT5Y1K876380CL583530L",

"rel": "parent_payment",

"method": "GET"

}

]

operation/authorization.void Void authorization

post/v1/payments/authorization/{authorization_id}/void

Try it

Voids, or cancels, an authorization, by ID. You cannot void a fully captured authorization.

SecurityOauth2

Request

path Parameters


authorization_id required	string The ID of the authorization to void.

header Parameters


PayPal-Request-Id	string<= 78 characters The server stores keys for 30 days.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

any

Responses

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

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 200 - Void AuthorizationSample 1 - 200 - Void Authorization

Copy

{ }

Response samples

application/json

Sample 1 - 200 - Void AuthorizationSample 1 - 200 - Void Authorization

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/6CR34526N64144512",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0PL82432AD7432233KGECOIQ",

"rel": "parent_payment",

"method": "GET"

}

]

operation/authorization.reauthorize Re-authorize payment

post/v1/payments/authorization/{authorization_id}/reauthorize

Try it

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

SecurityOauth2

Request

path Parameters


authorization_id required	string The ID of the authorization to re-authorize.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


fmf_details	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.
processor_response	object (Processor Response) The processor-provided response codes that describe the submitted payment. Supported only when the `payment_method` is `credit_card`.
amount required	object (Amount) The payment amount, with details.

Responses

201 A successful request returns the HTTP 201 Created status code and a JSON response body that shows details for the re-authorized authorization.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Re-authorize AuthorizationSample 1 - 201 - Re-authorize Authorization

Copy

Expand allCollapse all

`{"amount": {"total": "7.00",

"currency": "USD"

}

Response samples

application/json

Sample 1 - 201 - Re-authorize AuthorizationSample 1 - 201 - Re-authorize Authorization

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/8AA831015G517922L",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-7LD317540C810384EKHFAGYA",

"rel": "parent_payment",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/8AA831015G517922L/capture",

"rel": "capture",

"method": "POST"

}

]

operation/orders.get Show order details

get/v1/payments/orders/{order_id}

Try it

Shows details for an order, by ID.

SecurityOauth2

Request

path Parameters


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

Responses

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

Request samples

cURL

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/orders/O-0PW72302W3743444R \
-H 'Authorization: Bearer access_token6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g'

Response samples

application/json

Sample 1 - 200 - Show Order DetailsSample 1 - 200 - Show Order Details

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-0PW72302W3743444R",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-4D805864V5423372TKOQLRUQ",

"rel": "parent_payment",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-0PW72302W3743444R/authorization",

"rel": "authorize",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-0PW72302W3743444R/capture",

"rel": "capture",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-0PW72302W3743444R/void",

"rel": "void",

"method": "POST"

}

]

operation/orders.capture Capture order

post/v1/payments/orders/{order_id}/capture

Try it

Captures a payment for an order, by ID. To use this call, the original payment call must specify an order intent. In the JSON request body, include the payment amount and indicate whether this capture is the final capture for the authorization.

SecurityOauth2

Request

path Parameters


order_id required	string The ID of the order to capture.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


is_final_capture	boolean Default:false Indicates whether to release all remaining held funds.
invoice_number	string<= 127 characters The invoice number to track this payment.
note_to_payer	string<= 255 characters A free-form field that clients can use to send a note to the payer.
amount	object (Amount) The amount to capture. If the amount matches the originally authorized amount, the state of the authorization changes to `captured`. Otherwise, the state changes to `partially_captured`.

Responses

201 A successful request returns the HTTP 201 Created status code and a JSON response body that shows details for the captured order.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Capture Funds for OrderSample 1 - 201 - Capture Funds for Order

Copy

Expand allCollapse all

`{"amount": {"currency": "USD",

"total": "4.54"

"is_final_capture": true

Response samples

application/json

Sample 1 - 201 - Capture Funds for OrderSample 1 - 201 - Capture Funds for Order

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/capture/51366113MA710110S",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/capture/51366113MA710110S/refund",

"rel": "refund",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-3SP845109F051535C",

"rel": "order",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-9N9834337A9191208KOZOQWI",

"rel": "parent_payment",

"method": "GET"

}

]

operation/orders.void Void order

post/v1/payments/orders/{order_id}/do-void

Try it

Voids, or cancels, an order, by ID. You can only void orders that are either in the PENDING or AUTHORIZED states or those in the CAPTURED state that are not fully captured.

SecurityOauth2

Request

path Parameters


order_id required	string The ID of the order to void.

header Parameters


PayPal-Request-Id	string<= 78 characters The server stores keys for 30 days.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

any

Responses

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

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 200 - Void OrderSample 1 - 200 - Void Order

Copy

{ }

Response samples

application/json

Sample 1 - 200 - Void OrderSample 1 - 200 - Void Order

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/O-0NR488530V5211123",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0AY778532K612520BKOXHAKY",

"rel": "parent_payment",

"method": "GET"

}

]

operation/orders.authorize Authorize order

post/v1/payments/orders/{order_id}/authorize

Try it

Authorizes an order, by ID. In the JSON request body, include an amount object.

SecurityOauth2

Request

path Parameters


order_id required	string The ID of the order to authorize.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


fmf_details	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.
amount required	object (Amount) The amount to collect. > Note: For an order authorization, you cannot include amount `details`.

Responses

201 A successful request returns the HTTP 201 Created status code and a JSON response body that shows details for the authorized order.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Authorizes OrderSample 1 - 201 - Authorizes Order

Copy

Expand allCollapse all

`{"amount": {"currency": "USD",

"total": "4.54"

}

Response samples

application/json

Sample 1 - 201 - Authorizes OrderSample 1 - 201 - Authorizes Order

Copy

Expand allCollapse all

`{"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": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/orders/O-0NR488530V5211123",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/0PG032325D352531H",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/authorization/0PG032325D352531H/capture",

"rel": "capture",

"method": "POST"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-0AY778532K612520BKOXHAKY",

"rel": "parent_payment",

"method": "GET"

}

]

operation/capture.get Show captured payment details

get/v1/payments/capture/{capture_id}

Try it

Shows details for a captured payment, by ID.

SecurityOauth2

Request

path Parameters


capture_id required	string The ID of the captured payment for which to show details.

Responses

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

Request samples

cURL

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/capture/26186325LB254292P \
-H 'Authorization: Bearer access_token6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g' \
-d '{}'

Response samples

application/json

Sample 1 - 200 - Shows denied Capture DetailsSample 1 - 200 - Shows denied Capture Details

Copy

Expand allCollapse all

`{"id": "26186325LB254292P",

"amount": {"total": "188.00",

"currency": "USD"

"state": "DENIED",

"custom": "8a26ba02-8b50-4c49-ab53-921e97d2f1a0",

"parent_payment": "PAYID-LIL265Q8YW05382SU050021N",

"invoice_number": "1058763:6563c66a-2254-404e-88c4-333b43a9cbcd",

"create_time": "2017-11-24T05:35:05Z",

"update_time": "2017-11-27T05:38:06Z",

"links": [{"href": "https://api-m.paypal.com/v1/payments/capture/26186325LB254292P",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.paypal.com/v1/payments/capture/26186325LB254292P/refund",

"rel": "refund",

"method": "POST"

},

{"href": "https://api-m.paypal.com/v1/payments/payment/PAYID-LIL265Q8YW05382SU050021N",

"rel": "parent_payment",

"method": "GET"

}

]

operation/capture.refund Refund captured payment

post/v1/payments/capture/{capture_id}/refund

Try it

Refunds a captured payment, by ID. In the JSON request body, include an amount object.

SecurityOauth2

Request

path Parameters


capture_id required	string The ID of the captured payment to refund.

header Parameters


PayPal-Request-Id	string<= 78 characters The server stores keys for 30 days.

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json


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.
amount	object (Amount) The refund amount. Includes both the amount to refund to the payer and the fee amount to refund to the payee.

Responses

201 A successful request returns the HTTP 201 OK status code and a JSON response body that shows details for the captured payment.

Request samples

Payload
cURL

application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Sample 1 - 201 - Refund Capture by Invoice IDSample 1 - 201 - Refund Capture by Invoice ID

Copy

Expand allCollapse all

`{"amount": {"currency": "USD",

"total": "110.54"

"using": "INVOICE_ID",

"payer_info": {"email": "payer@example.com"

}

Response samples

application/json

Sample 1 - 201 - Refund Capture by Invoice IDSample 1 - 201 - Refund Capture by Invoice ID

Copy

Expand allCollapse all

`{"id": "0P209507D6694645N",

"create_time": "2017-05-06T22:11:51Z",

"update_time": "2017-05-06T22:11:51Z",

"state": "COMPLETED",

"amount": {"total": "110.54",

"currency": "USD"

"capture_id": "8F148933LY9388354",

"parent_payment": "PAY-8PT597110X687430LKGECATA",

"links": [{"href": "https://api-m.sandbox.paypal.com/v1/payments/refund/0P209507D6694645N",

"rel": "self",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/payment/PAY-8PT597110X687430LKGECATA",

"rel": "parent_payment",

"method": "GET"

},

{"href": "https://api-m.sandbox.paypal.com/v1/payments/capture/8F148933LY9388354",

"rel": "capture",

"method": "GET"

}

]

operation/refund.get Show refund details

get/v1/payments/refund/{refund_id}

Try it

Shows details for a refund, by ID.

SecurityOauth2

Request

path Parameters


refund_id required	string The ID of the refund for which to show details.

Responses

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

Request samples

cURL

Copy

curl -v -X GET https://api-m.sandbox.paypal.com/v1/payments/refund/6G729074TC0089708 \
-H 'Authorization: Bearer access_token6V7rbVwmlM1gFZKW_8QtzWXqpcwQ6T5vhEGYNJDAAdn3paCgRpdeMdVYmWzgbKSsECednupJ3Zx5Xd-g'

Response samples

application/json

Sample 1 - 200 - Show Refund DetailsSample 1 - 200 - Show Refund Details

Copy

Expand allCollapse all

`{"id": "6G729074TC0089708",

"state": "completed",

"amount": {"total": "2.10",

"currency": "USD"

"refund_from_received_amount": {"value": "2.03",

"currency": "USD"

"refund_from_transaction_fee": {"value": "0.07",

"currency": "USD"

"total_refunded_amount": {"value": "2.10",

"currency": "USD"

"refund_to_payer": {"value": "2.10",

"currency": "USD"

"refund_from_partner_fee": {"value": "1.00",

"currency": "USD"

"invoice_number": "",

"custom": "Custom Order 001",

"parent_payment": "PAYID-LV4N6XY29519853018496600",

"sale_id": "49001682WB0416317",

"create_time": "2019-09-11T12:12:51Z",

"update_time": "2019-09-11T12:12:51Z",

"links": [{"href": "https://www.$:11888/v1/payments/refund/6G729074TC0089708",

"rel": "self",

"method": "GET"

},

{"href": "https://www.$:11888/v1/payments/payment/PAYID-LV4N6XY29519853018496600",

"rel": "parent_payment",

"method": "GET"

},

{"href": "https://www.$:11888/v1/payments/sale/49001682WB0416317",

"rel": "sale",

"method": "GET"

}

],

"refund_reason_code": "REFUND"

tag/Errors Errors

section/AGREEMENT_ALREADY_CANCELLED AGREEMENT_ALREADY_CANCELLED

Message:

The requested agreement is already canceled.

Description: The agreement that was used to make the payment is already canceled.

section/AMOUNT_MISMATCH AMOUNT_MISMATCH

Message:

The totals of the cart item amounts do not match sale amounts.

Description: The amount total does not match the item amount totals.

section/AUTH_SETTLE_NOT_ALLOWED AUTH_SETTLE_NOT_ALLOWED

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.

section/AUTHORIZATION_ALREADY_COMPLETED AUTHORIZATION_ALREADY_COMPLETED

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.

section/AUTHORIZATION_AMOUNT_LIMIT_EXCEEDED AUTHORIZATION_AMOUNT_LIMIT_EXCEEDED

Message:

Authorization amount exceeds allowed order limit.

Description: The authorization amount exceeds the allowed order limit.

section/AUTHORIZATION_CANNOT_BE_VOIDED AUTHORIZATION_CANNOT_BE_VOIDED

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.

section/AUTHORIZATION_EXPIRED AUTHORIZATION_EXPIRED

Message:

Authorization has expired.

Description: The authorization related to this request has expired. You must reauthorize the transaction.

section/AUTHORIZATION_ID_DOES_NOT_EXIST AUTHORIZATION_ID_DOES_NOT_EXIST

Message:

The requested authorization ID does not exist.

Description: The authorization ID in the request does not exist in the PayPal system.

section/AUTHORIZATION_VOIDED AUTHORIZATION_VOIDED

Message:

Authorization has been voided.

Description: This authorization was already voided. You can show authorization details for a voided authorization.

section/BA_TOKEN_CREATION_FAILED BA_TOKEN_CREATION_FAILED

Message:

Billing agreement token creation failed.

Description: The billing agreement token creation failed.

section/BANK_ACCOUNT_VALIDATION_FAILED BANK_ACCOUNT_VALIDATION_FAILED

Message:

Bank account validation failed.

Description: The validation of the bank account failed.

section/BILLING_AGREEMENT_CREATION_FAILED BILLING_AGREEMENT_CREATION_FAILED

Message:

Billing agreement creation failed.

Description: The billing agreement creation failed.

section/BILLING_AGREEMENT_ID_MISMATCH BILLING_AGREEMENT_ID_MISMATCH

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.

section/BUYER_NOT_SET BUYER_NOT_SET

Message:

Buyer is not yet set for this purchase.

Description: The customer cannot make this purchase.

section/CANNOT_PAY_SELF CANNOT_PAY_SELF

Message:

Payer cannot pay him- or herself.

Description: The customer cannot pay him- or herself.

section/CANNOT_REAUTH_CHILD_AUTHORIZATION CANNOT_REAUTH_CHILD_AUTHORIZATION

Message:

Can only reauthorize the original authorization, not a reauthorization.

Description: Reauthorization only works on an original authorization ID.

section/CANNOT_REAUTH_INSIDE_HONOR_PERIOD CANNOT_REAUTH_INSIDE_HONOR_PERIOD

Message:

Reauthorization is not allowed within the honor period.

Description: You can only reauthorize a payment after the three-day honor period concludes.

section/CAPTURE_AMOUNT_LIMIT_EXCEEDED CAPTURE_AMOUNT_LIMIT_EXCEEDED

Message:

Capture amount specified exceeded allowable limit.

Description: You can only capture up to the original authorization amount.

section/CARD_TOKEN_PAYER_MISMATCH CARD_TOKEN_PAYER_MISMATCH

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.

section/COMPLIANCE_VIOLATION COMPLIANCE_VIOLATION

Message:

Transaction is declined due to compliance violation.

Description: The transaction is declined due to a compliance violation.

section/CREDIT_CARD_CVV_CHECK_FAILED CREDIT_CARD_CVV_CHECK_FAILED

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.

section/CREDIT_CARD_REFUSED CREDIT_CARD_REFUSED

Message:

Credit card was refused.

Description: The credit card used for the payment was refused. Resend the request with another credit card.

section/CREDIT_PAYMENT_NOT_ALLOWED CREDIT_PAYMENT_NOT_ALLOWED

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.

section/CURRENCY_MISMATCH CURRENCY_MISMATCH

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.

section/CURRENCY_NOT_ALLOWED CURRENCY_NOT_ALLOWED

Message:

Currency is not supported.

Description: The currency is not currently supported.

section/DOMESTIC_TRANSACTION_REQUIRED DOMESTIC_TRANSACTION_REQUIRED

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.

section/DUPLICATE_REQUEST_ID DUPLICATE_REQUEST_ID

Message:

The value of PayPal-Request-Id header has already been used.

Description: Resend the request with a unique PayPal-Request-Id header value.

section/DUPLICATE_TRANSACTION DUPLICATE_TRANSACTION

Message:

Duplicate invoice Id detected.

Description: Resend the request with a unique invoice_number value.

section/ERROR_AUTH ERROR_AUTH

Message:

Unauthorized payment.

Description: You do not have the proper permissions to complete this request.

section/EXPIRED_CREDIT_CARD_TOKEN EXPIRED_CREDIT_CARD_TOKEN

Message:

Credit card token is expired.

Description: Use the Vault API to store the credit card again.

section/FEATURE_UNSUPPORTED_FOR_PAYEE FEATURE_UNSUPPORTED_FOR_PAYEE

Message:

This feature is unsupported.

Description: This feature is not supported for the payee.

section/FULL_REFUND_NOT_ALLOWED_AFTER_PARTIAL_REFUND FULL_REFUND_NOT_ALLOWED_AFTER_PARTIAL_REFUND

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.

section/IMMEDIATE_PAY_NOT_SUPPORTED IMMEDIATE_PAY_NOT_SUPPORTED

Message:

Immediate pay is not supported for the specified payment intent.

Description: For this payment intent, immediate payment is not supported.

section/INSTRUMENT_DECLINED INSTRUMENT_DECLINED

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.

section/INSUFFICIENT_FUNDS INSUFFICIENT_FUNDS

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.

section/INTERNAL_SERVICE_ERROR INTERNAL_SERVICE_ERROR

Message:

An internal service error has occurred.

Description: Resend the request at another time. If this error persists, contact PayPal Merchant Technical Support.

section/INVALID_ACCOUNT_NUMBER INVALID_ACCOUNT_NUMBER

Message:

Account number does not exist.

Description: Provide a valid account number and resend the request.

section/INVALID_CITY_STATE_ZIP INVALID_CITY_STATE_ZIP

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.

section/INVALID_EXPERIENCE_PROFILE_ID INVALID_EXPERIENCE_PROFILE_ID

Message:

The requested experience profile ID was not found.

Description: To get the profile ID for a merchant, list web experience profiles.

section/INVALID_FACILITATOR_CONFIGURATION INVALID_FACILITATOR_CONFIGURATION

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.

section/INVALID_PAYER_ID INVALID_PAYER_ID

Message:

Payer ID is invalid.

Description: The specified payer_id is not valid. Resend the request with a valid payer_id.

section/INVALID_PAYPAL_PAYMENT_TOKEN INVALID_PAYPAL_PAYMENT_TOKEN

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.

section/INVALID_PICKUP_ADDRESS INVALID_PICKUP_ADDRESS

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

section/INVALID_RESOURCE_ID INVALID_RESOURCE_ID

Message:

The requested resource ID was not found.

Description: Provide a valid resource ID and resend the request.

section/MALFORMED_REQUEST MALFORMED_REQUEST

Message:

JSON request is malformed.

Description: Review the JSON request.

section/MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED MAX_NUMBER_OF_PAYMENT_ATTEMPTS_EXCEEDED

Message:

You have exceeded the maximum number of payment attempts.

Description: The maximum number of payment attempts was reached.

section/MAXIMUM_ALLOWED_AUTHORIZATION_REACHED_FOR_ORDER MAXIMUM_ALLOWED_AUTHORIZATION_REACHED_FOR_ORDER

Message:

You have reached the configured maximum number of authorizations allowed for an order.

Description: You cannot create any more authorizations for this order.

section/MERCHANT_NOT_ENABLED_FOR_CHANNEL_INITIATED_BILLING MERCHANT_NOT_ENABLED_FOR_CHANNEL_INITIATED_BILLING

Message:

Merchant is not enabled for channel-initiated billing.

Description: The merchant cannot use channel-initiated billing.

section/MERCHANT_NOT_ENABLED_FOR_REFERENCE_TRANSACTION MERCHANT_NOT_ENABLED_FOR_REFERENCE_TRANSACTION

Message:

Merchant is not enabled for reference transaction.

Description: The merchant cannot make reference transactions.

section/NEED_CREDIT_CARD NEED_CREDIT_CARD

Message:

Need credit card to complete the payment.

Description: To complete this payment, a credit card is required.

section/NEED_CREDIT_CARD_OR_BANK_ACCOUNT NEED_CREDIT_CARD_OR_BANK_ACCOUNT

Message:

Need bank or credit card to complete the payment.

Description: To complete this payment, a bank card or credit card is required.

section/NOT_IMPLEMENTED NOT_IMPLEMENTED

Message:

Not implemented.

Description: This API capability is not implemented.

section/ORDER_ALREADY_COMPLETED ORDER_ALREADY_COMPLETED

Message:

Order has already been voided, expired, or completed.

Description: This order was already voided, completed, or expired.

section/ORDER_CANNOT_BE_VOIDED ORDER_CANNOT_BE_VOIDED

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.

section/ORDER_IS_EXPIRED ORDER_IS_EXPIRED

Message:

Order has expired.

Description: The order has expired.

section/ORDER_VOIDED ORDER_VOIDED

Message:

Order has been voided.

Description: The order was already voided. For more information, you can show order details.

section/PAYEE_ACCOUNT_INVALID PAYEE_ACCOUNT_INVALID

Message:

Payee account is invalid.

Description: The payee account is not valid.

section/PAYEE_ACCOUNT_LOCKED_OR_CLOSED PAYEE_ACCOUNT_LOCKED_OR_CLOSED

Message:

Payee account is locked or closed.

Description: The recipient account is locked or closed and cannot receive payments.

section/PAYEE_ACCOUNT_NO_CONFIRMED_EMAIL PAYEE_ACCOUNT_NO_CONFIRMED_EMAIL

Message:

Refused - payee account does not have a confirmed email.

Description: For this transaction to proceed, the payment recipient must have a confirmed email.

section/PAYEE_ACCOUNT_RESTRICTED PAYEE_ACCOUNT_RESTRICTED

Message:

Refused - payee account is restricted.

Description: The account receiving this payment is restricted and cannot receive payments at this time.

section/PAYEE_BLOCKED_TRANSACTION PAYEE_BLOCKED_TRANSACTION

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.

section/PAYEE_COUNTRY_NOT_ENABLED PAYEE_COUNTRY_NOT_ENABLED

Message:

Payee country is not enabled for this feature.

Description: The payee country is not enabled for billing product.

section/PAYER_ACCOUNT_LOCKED_OR_CLOSED PAYER_ACCOUNT_LOCKED_OR_CLOSED

Message:

The payer account cannot be used for this transaction.

Description: The payer account is locked or closed.

section/PAYER_ACCOUNT_RESTRICTED PAYER_ACCOUNT_RESTRICTED

Message:

The payer account is restricted.

Description: The payer account cannot be used for this transaction.

section/PAYER_ACTION_REQUIRED PAYER_ACTION_REQUIRED

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.

section/PAYER_CANNOT_PAY PAYER_CANNOT_PAY

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.

section/PAYER_COUNTRY_NOT_ENABLED PAYER_COUNTRY_NOT_ENABLED

Message:

Payer country is not enabled for this feature.

Description: The payer country is not enabled for billing product.

section/PAYER_EMPTY_BILLING_ADDRESS PAYER_EMPTY_BILLING_ADDRESS

Message:

Billing address is empty.

Description: The billing address is required for credit card transactions without a PayPal account.

section/PAYER_ID_MISSING_FOR_CARD_TOKEN PAYER_ID_MISSING_FOR_CARD_TOKEN

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.

section/PAYMENT_ALREADY_DONE PAYMENT_ALREADY_DONE

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.

section/PAYMENT_APPROVAL_EXPIRED PAYMENT_APPROVAL_EXPIRED

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.

section/PAYMENT_CANNOT_BE_INITIATED PAYMENT_CANNOT_BE_INITIATED

Message:

Payment cannot be processed.

Description: PayPal cannot start processing the payment due to an issue with the specified information.

section/PAYMENT_DENIED PAYMENT_DENIED

Message:

PayPal has declined to process this transaction.

Description: PayPal declined the payment due to one or more customer issues.

section/PAYMENT_EXPIRED PAYMENT_EXPIRED

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.

section/PAYMENT_METHOD_UNUSABLE PAYMENT_METHOD_UNUSABLE

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.

section/PAYMENT_NOT_APPROVED_FOR_EXECUTION PAYMENT_NOT_APPROVED_FOR_EXECUTION

Message:

Payer has not approved payment.

Description: The customer must approve all payments that use the PayPal payment method.

section/PAYMENT_REQUEST_ID_INVALID PAYMENT_REQUEST_ID_INVALID

Message:

PayPal request ID is invalid. Please try a different one.

Description: Try a different PayPal request ID.

section/PAYMENT_STATE_INVALID PAYMENT_STATE_INVALID

Message:

This request is invalid due to the current state of the payment.

Description: The payment state does not allow this kind of request.

section/PERMISSION_DENIED PERMISSION_DENIED

Message:

No permission for the requested operation.

Description: You do not have the proper permissions to complete this request.

section/PHONE_NUMBER_REQUIRED PHONE_NUMBER_REQUIRED

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.

section/PLATFORM_FEE_PAYEE_CANNOT_BE_SAME_AS_PAYER PLATFORM_FEE_PAYEE_CANNOT_BE_SAME_AS_PAYER

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.

section/PREVIOUS_REQUEST_IN_PROGRESS PREVIOUS_REQUEST_IN_PROGRESS

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.

section/REAUTH_NOT_SUPPORTED_FOR_ORDER REAUTH_NOT_SUPPORTED_FOR_ORDER

Message:

Re-authorization is not allowed for this type of authorization.

Description: You cannot re-authorize an order.

section/REDIRECT_PAYER_FOR_ALTERNATE_FUNDING REDIRECT_PAYER_FOR_ALTERNATE_FUNDING

Message:

Transaction failed. Redirect the payer to select another funding source.

Description: The transaction failed so try another funding instrument.

section/REFUND_EXCEEDED_TRANSACTION_AMOUNT REFUND_EXCEEDED_TRANSACTION_AMOUNT

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.

section/REFUND_FAILED_INSUFFICIENT_FUNDS REFUND_FAILED_INSUFFICIENT_FUNDS

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.

section/REFUND_TIME_LIMIT_EXCEEDED REFUND_TIME_LIMIT_EXCEEDED

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.

section/REQUESTED_OPERATION_REFUSED_DUE_TO_SELLER_OPT_OUT REQUESTED_OPERATION_REFUSED_DUE_TO_SELLER_OPT_OUT

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.

section/REQUIRED_SCOPE_MISSING REQUIRED_SCOPE_MISSING

Message:

Access token does not have required scope.

Description: You must get user consent with the correct scope for this type of request.

section/SENDING_LIMIT_EXCEEDED SENDING_LIMIT_EXCEEDED

Message:

The transaction exceeds the buyer's sending limit.

Description: The customer cannot make any more transactions.

section/SHIPPING_ADDRESS_INVALID SHIPPING_ADDRESS_INVALID

Message:

Provided shipping address is invalid.

Description: The specified shipping address is not valid.

section/TOO_MANY_REAUTHORIZATIONS TOO_MANY_REAUTHORIZATIONS

Message:

Maximum number of reauthorizations for this authorization has been reached.

Description: You can only reauthorize a payment once.

section/TOO_MANY_SETTLEMENTS TOO_MANY_SETTLEMENTS

Message:

Maximum number of allowable settlements has been reached. No more settlement for the authorization.

Description: The maximum number of settlements was reached.

section/TRANSACTION_ALREADY_REFUNDED TRANSACTION_ALREADY_REFUNDED

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.

section/TRANSACTION_LIMIT_EXCEEDED TRANSACTION_LIMIT_EXCEEDED

Message:

Total payment amount exceeded transaction limit.

Description: The transaction limit was exceeded. For information about the PayPal transaction limits, see PayPal Customer Support.

section/TRANSACTION_RECEIVING_LIMIT_EXCEEDED TRANSACTION_RECEIVING_LIMIT_EXCEEDED

Message:

The transaction exceeds the receiver’s receiving limit.

Description: The amount exceeds the maximum amount for a single transaction.

section/TRANSACTION_REFUSED TRANSACTION_REFUSED

Message:

This request was refused.

Description: The possible reasons for this failure are:

The partial refund amount must be less than or equal to the original transaction amount.
The partial refund amount must be less than or equal to the remaining amount.
The partial refund amount is not valid.
The partial refund must be the same currency as the original transaction.
Because a complaint case exists on this transaction, only a refund of the full or full remaining amount of the transaction can be messaged.
You are over the time limit to complete a refund on this transaction.
Cannot do a full refund after a partial refund.
Transaction was fully refunded.
You cannot refund this type of transaction.
You cannot do a partial refund on this transaction.
The merchant account has limitations or restrictions.
Refunds are not supported for the payer's selected payment method. Contact the payer directly to arrange a refund via alternative means.
The time limit set by the payer's selected payment method to refund this transaction has expired. Contact the payer directly to arrange a refund via alternative means.
We're unable to process refunds for the payer's selected payment method. Contact the payer directly to arrange a refund via alternative means.
Please find alternate means to refund the payment to the buyer.
Please check the amount and the currency of the transaction and try again. Alternately, please find alternate means to refund the payment to the buyer.
Please find alternate means to refund the payment to the buyer as this type of transaction cannot be refunded.
Please find alternate means to refund the payment to the buyer or try again after some time.
The card account is closed or never existed. Please find alternate means to refund the payment to the buyer.
The transaction cannot be refunded. Please find alternate means to refund the payment to the buyer.
The transaction was refused because of suspected fraud. Please find alternate means to refund the payment to the buyer or try again after some time.
The transaction cannot be refunded due to regulatory restrictions that are permanent or temporary. Please find alternate means to refund the payment to the buyer or try again after some time.

section/TRANSACTION_REFUSED_BY_PAYPAL_RISK TRANSACTION_REFUSED_BY_PAYPAL_RISK

Message:

PayPal risk refused this transaction.

Description: PayPal risk assessment refused this transaction.

section/TRANSACTION_REFUSED_PAYEE_PREFERENCE TRANSACTION_REFUSED_PAYEE_PREFERENCE

Message:

Merchant profile preference is set to automatically deny certain transactions.

Description: The merchant account preferences are set to deny this kind of transaction.

section/UNAUTHORIZED_PAYMENT UNAUTHORIZED_PAYMENT

Message:

Unauthorized payment.

Description: This payment was not authorized.

section/UNSUPPORTED_PAYEE_COUNTRY UNSUPPORTED_PAYEE_COUNTRY

Message:

Payee country is not supported for this transaction.

Description: The merchant does not accept payments from this country.

section/UNSUPPORTED_PAYEE_CURRENCY UNSUPPORTED_PAYEE_CURRENCY

Message:

The currency is not accepted by payee.

Description: The merchant does not accept payments in this currency.

section/VALIDATION_ERROR VALIDATION_ERROR

Message:

Invalid request - see details.

Description: A validation error occurred with your request.

tag/Definitions Definitions

schema/address Address

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. | | 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 | string<= 300 characters
The code for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: Argentina, Brazil, Canada, China, India, Italy, Japan, Mexico, Thailand, or United States. | | 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.

Enum Value	Description
UNKNOWN	Unknown.
UNNORMALIZED_USER_PREFERRED	Unnormalized user preferred.
NORMALIZED	Normalized.
UNNORMALIZED	Unnormalized.
type	string The type of address. For example, `HOME_OR_WORK`, `GIFT`, and so on.
country_code required	string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}\|C2)$ The address country code.

Copy

`{"line1": "string",

"line2": "string",

"city": "string",

"postal_code": "string",

"state": "string",

"phone": "string",

"normalization_status": "UNKNOWN",

"type": "string",

"country_code": "st"

schema/amount Amount

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: - Seven digits before the decimal point. - The decimal point. - Two digits after the decimal point. - For currencies like `JPY` do not support decimals.
details	object (Payment Amount Details) The additional details about the payment amount. > Note: For an order authorization or capture, you cannot include the amount `details` object.

Copy

Expand allCollapse all

`{"currency": "string",

"total": "string",

"details": {"subtotal": "string",

"shipping": "string",

"tax": "string",

"handling_fee": "string",

"shipping_discount": "string",

"insurance": "string",

"gift_wrap": "string"

}

schema/apple_pay_attributes apple_pay_attributes

Additional attributes associated with apple pay.


customer	object (customer) The details about a customer in PayPal's system of record.
vault	object (v3_vault_instruction_base) Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.

Copy

Expand allCollapse all

`{"customer": {"id": "string",

"email_address": "string",

"phone": {"phone_type": "FAX",

"phone_number": {"national_number": "string"

}

"vault": {"store_in_vault": "ON_SUCCESS"

}

schema/apple_pay_decrypted_token_data apple_pay_decrypted_token_data

Information about the Payment data obtained by decrypting Apple Pay token.

| device_manufacturer_id | string[ 1 .. 2000 ] characters^.*$
Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode. | | payment_data_type | string[ 1 .. 16 ] characters^[0-9A-Z_]+$

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

Enum Value	Description
3DSECURE	The card was authenticated using 3D Secure (3DS) authentication scheme. While using this value make sure to populate cryptogram and eci_indicator as part of payment data..
EMV	The card was authenticated using EMV method, which is applicable for China. While using this value make sure to pass emv_data and pin as part of payment data.
transaction_amount	object (Money) The transaction amount for the payment that the payer has approved on apple platform.
tokenized_card required	object (card) Apple Pay tokenized credit card used to pay.
payment_data	object (apple_pay_payment_data) Apple Pay payment data object which contains the cryptogram, eci_indicator and other data.

Copy

Expand allCollapse all

`{"device_manufacturer_id": "string",

"payment_data_type": "3DSECURE",

"transaction_amount": {"currency_code": "str",

"value": "string"

"tokenized_card": {"name": "string",

"number": "stringstrings",

"expiry": "string",

"card_type": "VISA",

"type": "CREDIT",

"brand": "VISA",

"billing_address": {"address_line_1": "string",

"address_line_2": "string",

"admin_area_2": "string",

"admin_area_1": "string",

"postal_code": "string",

"country_code": "st"

}

"payment_data": {"cryptogram": "string",

"eci_indicator": "string",

"emv_data": "string",

"pin": "string"

}

schema/apple_pay_payment_data apple_pay_payment_data

Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator.


cryptogram	string[ 1 .. 2000 ] characters^.*$ Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.
eci_indicator	string[ 1 .. 256 ] characters^.*$ ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.
emv_data	string[ 1 .. 2000 ] characters^.*$ Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.
pin	string[ 1 .. 2000 ] characters^.*$ Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.

Copy

`{"cryptogram": "string",

"eci_indicator": "string",

"emv_data": "string",

"pin": "string"

schema/apple_pay_request apple_pay_request

Information needed to pay using ApplePay.


id	string[ 1 .. 250 ] characters^.*$ ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.
stored_credential	object (card_stored_credential) Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: - `payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`. - `usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`. - `previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`. - Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.
attributes	object (apple_pay_attributes) Additional attributes associated with apple pay.
name	string (name) [ 3 .. 300 ] characters Name on the account holder associated with apple pay.
email_address	string<ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.\A-Za...Show pattern The email address of the account holder associated with apple pay.
phone_number	object (Phone) The phone number, in its canonical international [E.164 numbering plan format. Supports only the `national_number` property.
decrypted_token	object (apple_pay_decrypted_token_data) The decrypted payload details for the apple pay token.
vault_id	string (vault_id) [ 1 .. 255 ] characters^[0-9a-zA-Z_-]+$ The PayPal-generated ID for the saved apple pay payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.
\
Copy\
\
Expand allCollapse all\
\
`{"id": "string",\
\
"stored_credential": {"payment_initiator": "CUSTOMER",\
\
"payment_type": "ONE_TIME",\
\
"usage": "FIRST",\
\
"previous_network_transaction_reference": {"id": "stringstr",\
\
"date": "stri",\
\
"acquirer_reference_number": "string",\
\
"network": "VISA"\
\
}\
\
},\
\
"attributes": {"customer": {"id": "string",\
\
"email_address": "string",\
\
"phone": {"phone_type": "FAX",\
\
"phone_number": {"national_number": "string"\
\
}\
\
}\
\
},\
\
"vault": {"store_in_vault": "ON_SUCCESS"\
\
}\
\
},\
\
"name": "string",\
\
"email_address": "string",\
\
"phone_number": {"national_number": "string"\
\
},\
\
"decrypted_token": {"device_manufacturer_id": "string",\
\
"payment_data_type": "3DSECURE",\
\
"transaction_amount": {"currency_code": "str",\
\
"value": "string"\
\
},\
\
"tokenized_card": {"name": "string",\
\
"number": "stringstrings",\
\
"expiry": "string",\
\
"card_type": "VISA",\
\
"type": "CREDIT",\
\
"brand": "VISA",\
\
"billing_address": {"address_line_1": "string",\
\
"address_line_2": "string",\
\
"admin_area_2": "string",\
\
"admin_area_1": "string",\
\
"postal_code": "string",\
\
"country_code": "st"\
\
}\
\
},\
\
"payment_data": {"cryptogram": "string",\
\
"eci_indicator": "string",\
\
"emv_data": "string",\
\
"pin": "string"\
\
}\
\
},\
\
"vault_id": "string"\
\
}`\
\

schema/application_context Application Context\

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 Billing. To use the PayPal account log in landing page, set to Login. |
| shipping_preference | string

Default:"GET_FROM_FILE"

The shipping preference.

| Enum Value | Description |
| --- | --- |
| NO_SHIPPING | Redacts the shipping address from the PayPal pages. Recommended for digital goods. |
| GET_FROM_FILE | Uses the customer-selected shipping address on PayPal pages. |
| SET_PROVIDED_ADDRESS | If available, uses the merchant-provided shipping address, which the customer cannot change on the PayPal pages. If the merchant does not provide an address, the customer can enter the address on PayPal pages. | |
| user_action | string

The user action. Presents the customer with either the Continue or Pay Now checkout flow:

| Flow | Action | Description |
| --- | --- | --- |
| Pay Now | user_action=commit | After the customer is redirected to the PayPal payment page, shows the Pay Now button.
Use this option when you know the final amount when checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now. |
| Continue | user_action=continue | After the customer is redirected to the PayPal payment page, shows the Continue button.
Use this option when you do not know the final amount when you initiate the checkout flow and you want to redirect the customer to the merchant page without processing the payment. | |
| 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.

| Enum Value | 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. | |
| preferred_payment_source | 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. |

Copy

Expand allCollapse all

{"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"\ \ },\ \ "paypal": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "landing_page": "LOGIN",\ \ "user_action": "CONTINUE",\ \ "payment_method_preference": "UNRESTRICTED",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ },\ \ "billing_agreement_id": "string",\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "name": {"given_name": "string",\ \ "surname": "string"\ \ },\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ },\ \ "birth_date": "stringstri",\ \ "tax_info": {"tax_id": "string",\ \ "tax_id_type": "BR_CPF"\ \ },\ \ "address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "merchant_customer_id": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ },\ \ "bancontact": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "blik": {"name": "string",\ \ "country_code": "string",\ \ "email": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string",\ \ "consumer_user_agent": "string",\ \ "consumer_ip": "string"\ \ },\ \ "level_0": {"auth_code": "string"\ \ },\ \ "one_click": {"auth_code": "string",\ \ "consumer_reference": "string",\ \ "alias_label": "stringst",\ \ "alias_key": "string"\ \ }\ \ },\ \ "eps": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "giropay": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "ideal": {"name": "string",\ \ "country_code": "string",\ \ "bic": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "mybank": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "p24": {"name": "string",\ \ "email": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "sofort": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "trustly": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "apple_pay": {"id": "string",\ \ "stored_credential": {"payment_initiator": "CUSTOMER",\ \ "payment_type": "ONE_TIME",\ \ "usage": "FIRST",\ \ "previous_network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "acquirer_reference_number": "string",\ \ "network": "VISA"\ \ }\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS"\ \ }\ \ },\ \ "name": "string",\ \ "email_address": "string",\ \ "phone_number": {"national_number": "string"\ \ },\ \ "decrypted_token": {"device_manufacturer_id": "string",\ \ "payment_data_type": "3DSECURE",\ \ "transaction_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "tokenized_card": {"name": "string",\ \ "number": "stringstrings",\ \ "expiry": "string",\ \ "card_type": "VISA",\ \ "type": "CREDIT",\ \ "brand": "VISA",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ },\ \ "payment_data": {"cryptogram": "string",\ \ "eci_indicator": "string",\ \ "emv_data": "string",\ \ "pin": "string"\ \ }\ \ },\ \ "vault_id": "string"\ \ },\ \ "google_pay": {"name": "string",\ \ "email_address": "string",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string"\ \ },\ \ "card": null,\ \ "decrypted_token": {"message_id": "string",\ \ "message_expiration": "stringstrings",\ \ "payment_method": "CARD",\ \ "authentication_method": "PAN_ONLY",\ \ "cryptogram": "string",\ \ "eci_indicator": "string"\ \ },\ \ "attributes": {"verification": {"method": "SCA_ALWAYS"\ \ }\ \ }\ \ },\ \ "venmo": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE"\ \ },\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ }\ \ }\ \ }
\

schema/authorization Authorization\

The authorization details.

| id | string
The ID of the authorization. |
| payment_mode | string

The payment mode of the authorization.

| Value | Description |
| --- | --- |
| INSTANT_TRANSFER | Instant transfer. | |
| state | string

The authorized payment state.

| Enum Value | Description |
| --- | --- |
| authorized | The authorized payment is authorized. |
| partially_captured | The authorized payment is partially captured. |
| captured | The authorized payment is captured. |
| expired | The authorized payment is expired. |
| denied | PayPal can no longer authorize funds against this authorization. |
| voided | The authorized payment is voided. | |
| reason_code | string

The reason code for the pending transaction state.

| Value | Description |
| --- | --- |
| AUTHORIZATION | Authorization. | |
| pending_reason | string

Deprecated. The reason code for the pending transaction state. Obsolete. Use reason_code instead.

| Value | Description |
| --- | --- |
| AUTHORIZATION | Authorization. | |
| protection_eligibility | string

The level of seller protection present for the transaction. Supported for the PayPal payment method only.

| Enum Value | Description |
| --- | --- |
| ELIGIBLE | Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. |
| PARTIALLY_ELIGIBLE | Merchant is protected by PayPal's Seller Protection Policy for Item Not Received or Unauthorized Payments. For details, see protection_eligibility_type. |
| INELIGIBLE | Merchant is not protected under the Seller Protection Policy. | |
| protection_eligibility_type | string

The type of seller protection for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported for the PayPal payment method only.

| Enum Value | Description |
| --- | --- |
| ITEM_NOT_RECEIVED_ELIGIBLE | Sellers are protected against claims for items not received. |
| UNAUTHORIZED_PAYMENT_ELIGIBLE | Sellers are protected against claims for unauthorized payments. |
| ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE | Sellers are protected against claims for items not received and sellers are protected against claims for unauthorized payments. | |
| fmf_details | 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. |
| processor_response | object (Processor Response)
The processor-provided response codes that describe the submitted payment. Supported only when the payment_method is credit_card. |
| 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| amount
required | object (Amount)
The payment amount, with details. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }\ \ }
\

schema/bancontact_request bancontact_request\

Information needed to pay using Bancontact.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

schema/bic BIC\

The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.

string (BIC) [ 8 .. 11 ] characters^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}(...Show pattern

The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.

Copy

"stringst"
\

[schema/billing_agreement_id billing_agreement_id\

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

string (billing_agreement_id) [ 2 .. 128 ] characters^[a-zA-Z0-9-]+$

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

Copy

"string"
\

schema/blik_experience_context blik_experience_context\

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

| brand_name | string[ 1 .. 127 ] characters^.*$
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. |
| shipping_preference | string[ 1 .. 24 ] characters^[A-Z_]+$

Default:"GET_FROM_FILE"

The location from which the shipping address is derived.

| Enum Value | Description |
| --- | --- |
| GET_FROM_FILE | Get the customer-provided shipping address on the PayPal site. |
| NO_SHIPPING | Redacts the shipping address from the PayPal site. Recommended for digital goods. |
| SET_PROVIDED_ADDRESS | Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages. | |
| locale | string<ppaas_common_language_v3> (language) [ 2 .. 10 ] characters^[a-z]{2}(?:-[A-Z][a-z]{3})?(?😦?:[A-Z]{2}|[...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW. |
| return_url | string<uri> (url)
The URL where the customer is redirected after the customer approves the payment. |
| cancel_url | string<uri> (url)
The URL where the customer is redirected after the customer cancels the payment. |
| consumer_user_agent | string[ 1 .. 256 ] characters^.*$
The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0). |
| consumer_ip | string<ppaas_ip_address_v1> (IP Address) [ 7 .. 39 ] characters^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25...Show pattern
The IP address of the consumer. It could be either IPv4 or IPv6. |

Copy

{"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string",\ \ "consumer_user_agent": "string",\ \ "consumer_ip": "string"\ \ }
\

[schema/blik_seamless blik_level_0\

Information used to pay using BLIK level_0 flow.

| | |
| --- | --- |
| auth_code
required | string= 6 characters^[0-9]{6}$
The 6-digit code used to authenticate a consumer within BLIK. |

Copy

{"auth_code": "string"\ \ }
\

schema/blik_one_click blik_one_click\

Information used to pay using BLIK one-click flow.

| | |
| --- | --- |
| auth_code | string= 6 characters^[0-9]{6}$
The 6-digit code used to authenticate a consumer within BLIK. |
| consumer_reference
required | string[ 3 .. 64 ] characters^[ -~]{3,64}$
The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant. |
| alias_label | string[ 8 .. 35 ] characters^[ -~]{8,35}$
A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts. |
| alias_key | string[ 1 .. 19 ] characters^[0-9]+$
A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference. |

Copy

{"auth_code": "string",\ \ "consumer_reference": "string",\ \ "alias_label": "stringst",\ \ "alias_key": "string"\ \ }
\

schema/blik_request blik_request\

Information needed to pay using BLIK.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| email | string<ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.\A-Za...Show pattern
The email address of the account holder associated with this payment method. |
| experience_context | object (blik_experience_context)
Customizes the payer experience during the approval process for the payment. |
| level_0 | object (blik_level_0)
The level_0 integration flow object. |
| one_click | object (blik_one_click)
The one-click integration flow object. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "email": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string",\ \ "consumer_user_agent": "string",\ \ "consumer_ip": "string"\ \ },\ \ "level_0": {"auth_code": "string"\ \ },\ \ "one_click": {"auth_code": "string",\ \ "consumer_reference": "string",\ \ "alias_label": "stringst",\ \ "alias_key": "string"\ \ }\ \ }
\

[schema/capture Capture\

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.

| Enum Value | Description |
| --- | --- |
| pending | The capture is pending. |
| completed | The capture has successfully completed. |
| refunded | The capture was fully refunded. |
| partially_refunded | The capture was partially refunded. |
| denied | PayPal has declined to process this transaction. | |
| reason_code | string

The reason code that describes why the transaction state is pending or reversed.

| Enum Value | Description |
| --- | --- |
| CHARGEBACK | The transaction state is pending or reversed due to a chargeback. |
| GUARANTEE | The transaction state is pending or reversed due to a guarantee. |
| BUYER_COMPLAINT | The transaction state is pending or reversed due to a customer complaint. |
| REFUND | The transaction state is pending or reversed due to a REFUND. |
| UNCONFIRMED_SHIPPING_ADDRESS | The transaction state is pending or reversed due to an unconfirmed shipping address. |
| ECHECK | The transaction state is pending or reversed due to an e-check. |
| INTERNATIONAL_WITHDRAWAL | The transaction state is pending or reversed due to an international withdrawal. |
| RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION | The transaction state is pending or reversed due to a receiving preference that mandates manual action. |
| PAYMENT_REVIEW | The transaction state is pending or reversed due to a payment review. |
| REGULATORY_REVIEW | The transaction state is pending or reversed due to a regulatory review. |
| UNILATERAL | The transaction state is pending or reversed due to a unilateral action. |
| VERIFICATION_REQUIRED | The transaction state is pending or reversed because verification is required. |
| TRANSACTION_APPROVED_AWAITING_FUNDING | The transaction state is pending or reversed because an approved transaction is awaiting funding. |
| NONE | Returned only when the state is 'completed'. Returned only as part of the 'POST' response. | |
| 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| amount | object (Amount)
The amount to capture. If the amount matches the originally authorized amount, the state of the authorization changes to captured. Otherwise, the state changes to partially_captured. |
| transaction_fee | object (Currency)
The currency and amount of the transaction fee for this payment. Would not be returned for pending transactions where the funds have not been realized in the payee account. |
| transaction_fee_in_receivable_currency | 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 CNY. Would not be returned for pending transactions where the funds have not been realized in the payee account. |
| receivable_amount | object (Currency)
The net amount and currency that the merchant receives for this transaction in the receivable currency. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }
\

schema/customized_card_1 card\

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

| | |
| --- | --- |
| name | string[ 1 .. 300 ] characters^.{1,300}$
The card holder's name as it appears on the card. |
| number | string[ 13 .. 19 ] characters^[0-9]{13,19}$
The primary account number (PAN) for the payment card. |
| security_code | string[ 3 .. 4 ] characters^[0-9]{3,4}$
The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT. |
| expiry | string (date_year_month) = 7 characters^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format. |
| billing_address | object (Portable Postal Address (Medium-Grained))
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. |
| attributes | object (card_attributes)
Additional attributes associated with the use of this card. |

Copy

Expand allCollapse all

{"name": "string",\ \ "number": "stringstrings",\ \ "security_code": "stri",\ \ "expiry": "string",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS"\ \ },\ \ "verification": {"method": "SCA_ALWAYS"\ \ }\ \ }\ \ }
\

schema/customized_card_2 card\

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

| name | string[ 1 .. 300 ] characters^.{1,300}$
The card holder's name as it appears on the card. |
| number | string[ 13 .. 19 ] characters^[0-9]{13,19}$
The primary account number (PAN) for the payment card. |
| expiry | string (date_year_month) = 7 characters^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format. |
| card_type | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| type | string (card_type) [ 1 .. 255 ] characters^[A-Z_]+$

The payment card type.

| Enum Value | Description |
| --- | --- |
| CREDIT | A credit card. |
| DEBIT | A debit card. |
| PREPAID | A Prepaid card. |
| STORE | A store card. |
| UNKNOWN | Card type cannot be determined. | |
| brand | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |
| billing_address | object (Portable Postal Address (Medium-Grained))
The billing address for this card. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. |

Copy

Expand allCollapse all

{"name": "string",\ \ "number": "stringstrings",\ \ "expiry": "string",\ \ "card_type": "VISA",\ \ "type": "CREDIT",\ \ "brand": "VISA",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ }
\

schema/card_verification Card Verification\

The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).

| method | string[ 1 .. 255 ] characters^[0-9A-Z_]+$

Default:"SCA_WHEN_REQUIRED"

The method used for card verification.

| Enum Value | Description |
| --- | --- |
| SCA_ALWAYS | Selecting this option will attempt to force a strong customer authentication for the authorization/transaction. In countries where SCA has been defined and implemented it will result in a contingency and HATEOAS link being returned. The API caller should redirect the payer to that link so that they can authenticate themselves against their issuing bank or other entity. As noted, the HATEOAS link is only available in all regions where strong authentication is supported, (e.g. in European countries where 3DS is live). Merchants can use this setting as an additional layer of security if they choose to. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. |
| SCA_WHEN_REQUIRED | This is the default. When an authorization or transaction is attempted this option will return a contingency and HATEOAS link only when local regulations require strong customer authentication, (e.g. 3DS in countries and use cases where it is mandated). The API caller should redirect the payer to the link so that they can authenticate themselves. In all cases, when an authorization is requested the AVS/CVV results will be returned in the response. |
| 3D_SECURE | The contingency surfaced as an additional security layer that helps prevent unauthorized card-not-present transactions and protects the merchant from exposure to fraud. |
| AVS_CVV | Places a temporary hold on the card to ensure its validity. This process protects the merchant from exposure to fraud. This verification method will confirm that the address information or CVV included matches what the issuing bank has on file for the associated card, ensuring that only authorized card users are able to make purchases from you. | |

Copy

{"method": "SCA_ALWAYS"\ \ }
\

schema/card_attributes card_attributes\

Additional attributes associated with the use of this card.

| | |
| --- | --- |
| customer | object (customer)
The details about a customer in PayPal's system of record. |
| vault | object (vault_instruction_base)
Instruction to vault the card based on the specified strategy. |
| verification | object (Card Verification)
Instruction to optionally verify the card based on the specified strategy. |

Copy

Expand allCollapse all

{"customer": {"id": "string",\ \ "email_address": "string",\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS"\ \ },\ \ "verification": {"method": "SCA_ALWAYS"\ \ }\ \ }
\

schema/customized_card_attributes_1 card_attributes\

Additional attributes associated with the use of this card.

| | |
| --- | --- |
| verification | object (Card Verification)
Instruction to optionally verify the card based on the specified strategy. |

Copy

Expand allCollapse all

{"verification": {"method": "SCA_ALWAYS"\ \ }\ \ }
\

schema/card_brand card_brand\

The card network or brand. Applies to credit, debit, gift, and payment cards.

string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

The card network or brand. Applies to credit, debit, gift, and payment cards.

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. |

Copy

"VISA"
\

schema/card_experience_context card_experience_context\

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

| | |
| --- | --- |
| return_url | string<uri> (url) [ 10 .. 4000 ] characters
The URL where the customer will be redirected upon successfully completing the 3DS challenge. |
| cancel_url | string<uri> (url) [ 10 .. 4000 ] characters
The URL where the customer will be redirected upon cancelling the 3DS challenge. |

Copy

{"return_url": "string",\ \ "cancel_url": "string"\ \ }
\

schema/card_request card_request\

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

schema/card_stored_credential card_stored_credential\

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

Parameter compatibility:
\

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

| payment_initiator
required | string (payment_initiator) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The person or party who initiated or triggered the payment.

| Enum Value | Description |
| --- | --- |
| CUSTOMER | Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website. |
| MERCHANT | Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer. | |
| payment_type
required | string (stored_payment_source_payment_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Indicates the type of the stored payment_source payment.

| Enum Value | Description |
| --- | --- |
| ONE_TIME | One Time payment such as online purchase or donation. (e.g. Checkout with one-click). |
| RECURRING | Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments). |
| UNSCHEDULED | Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments). | |
| usage | string (stored_payment_source_usage_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Default:"DERIVED"

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

| Enum Value | Description |
| --- | --- |
| FIRST | Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment. |
| SUBSEQUENT | Indicates a payment using a stored payment_source which has been successfully used previously for a payment. |
| DERIVED | Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal. | |
| previous_network_transaction_reference | object (network_transaction_reference)
Reference values used by the card network to identify a transaction. |

Copy

Expand allCollapse all

{"payment_initiator": "CUSTOMER",\ \ "payment_type": "ONE_TIME",\ \ "usage": "FIRST",\ \ "previous_network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "acquirer_reference_number": "string",\ \ "network": "VISA"\ \ }\ \ }
\

schema/card_type card_type\

Type of card. i.e Credit, Debit and so on.

string (card_type) [ 1 .. 255 ] characters^[A-Z_]+$

Type of card. i.e Credit, Debit and so on.

| Enum Value | Description |
| --- | --- |
| CREDIT | A credit card. |
| DEBIT | A debit card. |
| PREPAID | A Prepaid card. |
| STORE | A store card. |
| UNKNOWN | Card type cannot be determined. |

Copy

"CREDIT"
\

schema/cart_base Cart Base\

The cart.

| | |
| --- | --- |
| reference_id | string<= 256 characters
The merchant-provided ID for the purchase unit. |
| payee | 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:
<br>22 - len(PAYPAL * (8)) - len(Descriptor in Payment Receiving Preferences of Merchant account + 1)<br>
The PAYPAL prefix uses 8 characters.
The soft descriptor supports the following ASCII characters:
- Alphanumeric characters
- Dashes
- Asterisks
- Periods (.)
- Spaces
For Wallet payments marketplace integrations:
- The merchant descriptor in the Payment Receiving Preferences must be the marketplace name.
- You can't use the remaining space to show the customer service number.
- The remaining spaces can be a combination of seller name and country.
For unbranded payments (Direct Card) marketplace integrations, use a combination of the seller name and phone number. |
| payment_options | object (Payment Options)
The payment options for this transaction. |
| item_list | 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. |
| amount
required | object (Amount)
The payment amount, with details. |

Copy

Expand allCollapse all

{"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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ },\ \ "shipping_phone_number": "string"\ \ },\ \ "notify_url": "http://example.com",\ \ "order_url": "http://example.com",\ \ "amount": {"currency": "string",\ \ "total": "string",\ \ "details": {"subtotal": "string",\ \ "shipping": "string",\ \ "tax": "string",\ \ "handling_fee": "string",\ \ "shipping_discount": "string",\ \ "insurance": "string",\ \ "gift_wrap": "string"\ \ }\ \ }\ \ }
\

schema/country_code country_code\

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

schema/country_code_v4 country_code\

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

schema/country_code_v3 country_code\

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

schema/country_code_v5 country_code\

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

schema/credit_card_token Credit Card Token\

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 payer_id was originally provided when you vaulted the credit card. Use external_customer_id instead. |
| 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 visa, mastercard, discover, or amex. Do not use these lowercase values for display. |
| expire_month | integer[ 1 .. 12 ]
The expiration month with no leading zero. Value is from 1 to 12. |
| expire_year | string= 4 characters^[0-9]{4}$
The four-digit expiration year. |

Copy

{"credit_card_id": "string",\ \ "payer_id": "s",\ \ "external_customer_id": "string",\ \ "last4": "stri",\ \ "type": "string",\ \ "expire_month": 1,\ \ "expire_year": "stri"\ \ }
\

schema/currency Currency\

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

Copy

{"currency": "string",\ \ "value": "string"\ \ }
\

schema/currency_code currency_code\

The three-character ISO-4217 currency code that identifies the currency.

string<ppaas_common_currency_code_v2> (currency_code) = 3 characters

The three-character ISO-4217 currency code that identifies the currency.

Copy

"str"
\

schema/currency_code_v3 currency_code\

schema/customer customer\

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

| | |
| --- | --- |
| id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.\a-zA-...Show pattern
Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer. |
| phone | object (phone_with_type)
The phone number of the buyer as provided to the merchant or on file with the merchant. The phone.phone_number supports only national_number. |

Copy

Expand allCollapse all

{"id": "string",\ \ "email_address": "string",\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }\ \ }
\

[schema/customized_customer_1 customer\

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

| | |
| --- | --- |
| id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.\a-zA-...Show pattern
Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer. |

Copy

{"id": "string",\ \ "email_address": "string"\ \ }
\

[schema/date_no_time date_no_time\

The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

string<ppaas_date_notime_v2> (date_no_time) = 10 characters^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern

The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Copy

"stringstri"
\

schema/date_year_month date_year_month\

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

string (date_year_month) = 7 characters^[0-9]{4}-(0[1-9]|1[0-2])$

The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

Copy

"strings"
\

schema/detailed_refund Detailed Refund\

The refund transaction details.

| id | string
The ID of the refund transaction. Maximum length is 17 characters. |
| state | string

The state of the refund.

| Enum Value | Description |
| --- | --- |
| pending | The refund state is pending. |
| completed | The refund state is completed. |
| cancelled | The refund state is cancelled. |
| failed | The refund state is failed. | |
| 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| amount | object (Amount)
The payment amount, with details. |
| custom | string<= 127 characters
The note to the payer in this transaction. |
| refund_from_transaction_fee | object (Currency)
The currency and amount of the transaction fee that is refunded to original the recipient of payment. |
| refund_from_received_amount | object (Currency)
The currency and amount of the refund that is subtracted from the original payment recipient's PayPal balance. |
| total_refunded_amount | 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. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }
\

schema/eci_flag eci_flag\

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

string (eci_flag) [ 1 .. 255 ] characters^[0-9A-Z_]+$

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

| Enum Value | Description |
| --- | --- |
| MASTERCARD_NON_3D_SECURE_TRANSACTION | Mastercard non-3-D Secure transaction. |
| MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION | Mastercard attempted authentication transaction. |
| MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION | Mastercard fully authenticated transaction. |
| FULLY_AUTHENTICATED_TRANSACTION | VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction. |
| ATTEMPTED_AUTHENTICATION_TRANSACTION | VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction. |
| NON_3D_SECURE_TRANSACTION | VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction. |

Copy

"MASTERCARD_NON_3D_SECURE_TRANSACTION"
\

schema/email email\

The internationalized email address.
\

[schema/email_v1 email\

The internationalized email address.
\

[schema/email_address email_address\

The internationalized email address.
\

[schema/email_address_v5 email_address\

The internationalized email address.
\

[schema/eps_request eps_request\

Information needed to pay using eps.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

schema/error Error\

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. |
| details | Array of objects (Error Details)
An array of additional details about the error. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ ]\ \ }
\

schema/error_details Error Details\

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 body, path, or query. |
| 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. |

Copy

{"field": "string",\ \ "value": "string",\ \ "location": "body",\ \ "issue": "string",\ \ "description": "string"\ \ }
\

schema/error_details_v3 Error Details\

schema/experience_context_base experience_context_base\

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

| brand_name | string[ 1 .. 127 ] characters^.*$
The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. |
| shipping_preference | string[ 1 .. 24 ] characters^[A-Z_]+$

Default:"GET_FROM_FILE"

The location from which the shipping address is derived.

| Enum Value | Description |
| --- | --- |
| GET_FROM_FILE | Get the customer-provided shipping address on the PayPal site. |
| NO_SHIPPING | Redacts the shipping address from the PayPal site. Recommended for digital goods. |
| SET_PROVIDED_ADDRESS | Get the merchant-provided address. The customer cannot change this address on the PayPal site. If merchant does not pass an address, customer can choose the address on PayPal pages. | |
| locale | string<ppaas_common_language_v3> (language) [ 2 .. 10 ] characters^[a-z]{2}(?:-[A-Z][a-z]{3})?(?😦?:[A-Z]{2}|...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW. |
| return_url | string<uri> (url)
The URL where the customer is redirected after the customer approves the payment. |
| cancel_url | string<uri> (url)
The URL where the customer is redirected after the customer cancels the payment. |

Copy

{"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }
\

[schema/customized_experience_context_base_1 experience_context_base\

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

| | |
| --- | --- |
| locale | string<ppaas_common_language_v3> (language) [ 2 .. 10 ] characters^[a-z]{2}(?:-[A-Z][a-z]{3})?(?😦?:[A-Z]{2}|...Show pattern
The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW. |
| return_url | string<uri> (url)
The URL where the customer is redirected after the customer approves the payment. |
| cancel_url | string<uri> (url)
The URL where the customer is redirected after the customer cancels the payment. |

Copy

{"locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }
\

[schema/fmf_details 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.

| filter_type
required | string

The filter type.

| Enum Value | Description |
| --- | --- |
| ACCEPT | The accept filter type. |
| PENDING | The pending filter type. |
| DENY | The deny filter type. |
| REPORT | The report filter type. | |
| filter_id
required | string

The filter ID.

| Enum Value | Description |
| --- | --- |
| AVS_NO_MATCH | AVS no match. |
| AVS_PARTIAL_MATCH | AVS partial match. |
| AVS_UNAVAILABLE_OR_UNSUPPORTED | AVS unavailable or unsupported. |
| CARD_SECURITY_CODE_MISMATCH | Card security code mismatch. |
| MAXIMUM_TRANSACTION_AMOUNT | The maximum transaction amount. |
| UNCONFIRMED_ADDRESS | Unconfirmed address. |
| COUNTRY_MONITOR | Country monitor. |
| LARGE_ORDER_NUMBER | Large order number. |
| BILLING_OR_SHIPPING_ADDRESS_MISMATCH | Billing or shipping address mismatch. |
| RISKY_ZIP_CODE | Risky zip code. |
| SUSPECTED_FREIGHT_FORWARDER_CHECK | Suspected freight forwarder check. |
| TOTAL_PURCHASE_PRICE_MINIMUM | Total purchase price minimum. |
| IP_ADDRESS_VELOCITY | IP address velocity. |
| RISKY_EMAIL_ADDRESS_DOMAIN_CHECK | Risky email address domain check. |
| RISKY_BANK_IDENTIFICATION_NUMBER_CHECK | Risky bank identification number check. |
| RISKY_IP_ADDRESS_RANGE | Risky IP address range. |
| PAYPAL_FRAUD_MODEL | PayPal fraud model. | |
| name | string
The filter name. |
| description | string
The filter description. |

Copy

{"filter_type": "ACCEPT",\ \ "filter_id": "AVS_NO_MATCH",\ \ "name": "string",\ \ "description": "string"\ \ }
\

schema/funding_instrument Funding Instrument\

The funding instrument details. An instance of this schema is valid if and only if it validates against exactly one of these supported properties.

| | |
| --- | --- |
| credit_card_token | object (Credit Card Token)
The tokenized credit card details. You can use this instrument to fund a payment. |

Copy

Expand allCollapse all

{"credit_card_token": {"credit_card_id": "string",\ \ "payer_id": "s",\ \ "external_customer_id": "string",\ \ "last4": "stri",\ \ "type": "string",\ \ "expire_month": 1,\ \ "expire_year": "stri"\ \ }\ \ }
\

schema/giropay_request giropay_request\

Information needed to pay using giropay.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

schema/customized_google_pay_card_1 google_pay_card\

any (google_pay_card)

Copy

null
\

schema/google_pay_decrypted_token_data google_pay_decrypted_token_data\

Details shared by Google for the merchant to be shared with PayPal. This is required to process the transaction using the Google Pay payment method.

| message_id | string[ 1 .. 250 ] characters^.*$
A unique ID that identifies the message in case it needs to be revoked or located at a later time. |
| message_expiration | string= 13 characters\d{13}
Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired. |
| payment_method
required | string= 4 characters

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

| Value | Description |
| --- | --- |
| CARD | CARD is the only value that Google Pay accepts. | |
| authentication_method
required | string[ 1 .. 50 ] characters

Authentication Method which is used for the card transaction.

| Enum Value | Description |
| --- | --- |
| PAN_ONLY | This authentication method is associated with payment cards stored on file with the user's Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year. |
| CRYPTOGRAM_3DS | Returned payment data includes a 3-D Secure (3DS) cryptogram generated on the device. -> If authentication_method=CRYPTOGRAM, it is required that 'cryptogram' parameter in the request has a valid 3-D Secure (3DS) cryptogram generated on the device. | |
| cryptogram | string[ 1 .. 2000 ] characters
Base-64 cryptographic identifier used by card schemes to validate the token verification result. This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS. |
| eci_indicator | string[ 1 .. 256 ] characters^.*$
Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa card network. This value is passed through in the payment authorization request. |

Copy

{"message_id": "string",\ \ "message_expiration": "stringstrings",\ \ "payment_method": "CARD",\ \ "authentication_method": "PAN_ONLY",\ \ "cryptogram": "string",\ \ "eci_indicator": "string"\ \ }
\

schema/google_pay_request google_pay_request\

Information needed to pay using Google Pay.

| | |
| --- | --- |
| name | string (name) [ 3 .. 300 ] characters
Name on the account holder associated with Google Pay. |
| email_address | string<ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.\A-Za...Show pattern
The email address of the account holder associated with Google Pay. |
| phone_number | object (Phone)
The phone number of account holder, in its canonical international [E.164 numbering plan format. Supports only the national_number property. |
| card | any (google_pay_card)
The payment card information. |
| decrypted_token | object (google_pay_decrypted_token_data)
The decrypted payload details for the Google Pay token. |
| attributes | object (card_attributes)
Additional attributes associated with the use of this card. |

Copy

Expand allCollapse all

{"name": "string",\ \ "email_address": "string",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string"\ \ },\ \ "card": null,\ \ "decrypted_token": {"message_id": "string",\ \ "message_expiration": "stringstrings",\ \ "payment_method": "CARD",\ \ "authentication_method": "PAN_ONLY",\ \ "cryptogram": "string",\ \ "eci_indicator": "string"\ \ },\ \ "attributes": {"verification": {"method": "SCA_ALWAYS"\ \ }\ \ }\ \ }
\

schema/ideal_request ideal_request\

Information needed to pay using iDEAL.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| bic | string (BIC) [ 8 .. 11 ] characters^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}(...Show pattern
The bank identification code (BIC). |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "bic": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

[schema/installment_option Installment Option\

The installment option details.

| | |
| --- | --- |
| term
required | integer
The number of installments. |
| monthly_payment
required | object (Currency)
The currency and amount for a transaction. |
| discount_amount | 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 19.99. The allowed number formats are plain decimal numbers and whole numbers. |

Copy

Expand allCollapse all

{"term": 0,\ \ "monthly_payment": {"currency": "string",\ \ "value": "string"\ \ },\ \ "discount_amount": {"currency": "string",\ \ "value": "string"\ \ },\ \ "discount_percentage": "string"\ \ }
\

schema/instrument_authorization_context Instrument Authorization Context\

Instrument related authorization context.

| predicted_approval_score | string[ 1 .. 255 ] characters^[A-Z0-9_]+$

This enum represents category of predicted approval score.

| Enum Value | Description |
| --- | --- |
| LOW | Predicted approval score is low. |
| MEDIUM | Predicted approval score is medium. |
| HIGH | Predicted approval score is high. | |

Copy

{"predicted_approval_score": "LOW"\ \ }
\

schema/instrument_context Instrument context\

Provides context about the funding instrument used.

| | |
| --- | --- |
| authorization_context | object (Instrument Authorization Context)
Instrument related authorization context. |

Copy

Expand allCollapse all

{"authorization_context": {"predicted_approval_score": "LOW"\ \ }\ \ }
\

schema/instrument_id instrument_id\

The identifier of the instrument.

string (instrument_id) [ 1 .. 256 ] characters^[A-Za-z0-9-_.+=]+$

The identifier of the instrument.

Copy

"string"
\

schema/ip_address IP Address\

An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.

string<ppaas_ip_address_v1> (IP Address) [ 7 .. 39 ] characters^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25...Show pattern

An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.

Copy

"strings"
\

[schema/item Item\

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

Copy

{"sku": "string",\ \ "name": "string",\ \ "description": "string",\ \ "quantity": "string",\ \ "price": "string",\ \ "currency": "str",\ \ "tax": "string"\ \ }
\

schema/language language\

The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.

string<ppaas_common_language_v3> (language) [ 2 .. 10 ] characters^[a-z]{2}(?:-[A-Z][a-z]{3})?(?😦?:[A-Z]{2}|...Show pattern

The [language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.

Copy

"string"
\

schema/link_description Link Description\

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 $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call. |
| 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.
Enum:"GET""POST""PUT""DELETE""HEAD""CONNECT""OPTIONS""PATCH" |

Copy

{"href": "string",\ \ "rel": "string",\ \ "method": "GET"\ \ }
\

schema/link_description_v3 Link Description\

schema/merchant_partner_customer_id merchant_partner_customer_id\

The unique ID for a customer generated by PayPal.

string (merchant_partner_customer_id) [ 1 .. 22 ] characters^[0-9a-zA-Z_-]+$

The unique ID for a customer generated by PayPal.

Copy

"string"
\

schema/money Money\

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) = 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:
- An integer for currencies like JPY that are not typically fractional.
- A decimal fraction for currencies like TND that are subdivided into thousandths.
For the required number of decimal places for a currency code, see Currency Codes. |

Copy

{"currency_code": "str",\ \ "value": "string"\ \ }
\

schema/money_v3 Money\

schema/mybank_request mybank_request\

Information needed to pay using MyBank.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

schema/customized_name_1 Name\

The name of the party.

| | |
| --- | --- |
| given_name | string<= 140 characters
When the party is a person, the party's given, or first, name. |
| surname | string<= 140 characters
When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. |

Copy

{"given_name": "string",\ \ "surname": "string"\ \ }
\

schema/customized_name_2 Name\

The name of the party.

| | |
| --- | --- |
| full_name | string<= 300 characters
When the party is a person, the party's full name. |

Copy

{"full_name": "string"\ \ }
\

schema/full_name name\

The full name representation like Mr J Smith.

string (name) [ 3 .. 300 ] characters

The full name representation like Mr J Smith.

Copy

"string"
\

schema/customized_name_3 Name\

The name of the party.

| | |
| --- | --- |
| full_name | string<= 300 characters
When the party is a person, the party's full name. |

Copy

{"full_name": "string"\ \ }
\

schema/network_token_request network_token\

The Third Party Network token used to fund a payment.

| number
required | string[ 13 .. 19 ] characters^[0-9]{13,19}$
Third party network token number. |
| cryptogram | string[ 28 .. 32 ] characters^.*$
An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions. |
| token_requestor_id | string[ 1 .. 11 ] characters^[0-9A-Z_]+$
A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud. |
| expiry
required | string (date_year_month) = 7 characters^[0-9]{4}-(0[1-9]|1[0-2])$
The card expiration year and month, in Internet date format. |
| eci_flag | string (eci_flag) [ 1 .. 255 ] characters^[0-9A-Z_]+$

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

| Enum Value | Description |
| --- | --- |
| MASTERCARD_NON_3D_SECURE_TRANSACTION | Mastercard non-3-D Secure transaction. |
| MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION | Mastercard attempted authentication transaction. |
| MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION | Mastercard fully authenticated transaction. |
| FULLY_AUTHENTICATED_TRANSACTION | VISA, AMEX, JCB, DINERS CLUB fully authenticated transaction. |
| ATTEMPTED_AUTHENTICATION_TRANSACTION | VISA, AMEX, JCB, DINERS CLUB attempted authentication transaction. |
| NON_3D_SECURE_TRANSACTION | VISA, AMEX, JCB, DINERS CLUB non-3-D Secure transaction. | |

Copy

{"number": "stringstrings",\ \ "cryptogram": "stringstringstringstringstri",\ \ "token_requestor_id": "string",\ \ "expiry": "string",\ \ "eci_flag": "MASTERCARD_NON_3D_SECURE_TRANSACTION"\ \ }
\

schema/network_transaction_reference network_transaction_reference\

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

| id
required | string[ 9 .. 36 ] characters^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$
Transaction reference id returned by the scheme. For Visa and Amex, this is the "Tran id" field in response. For MasterCard, this is the "BankNet reference id" field in response. For Discover, this is the "NRID" field in response. The pattern we expect for this field from Visa/Amex/CB/Discover is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric with special character -. |
| date | string= 4 characters^[0-9]+$
The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date. |
| acquirer_reference_number | string[ 1 .. 36 ] characters^[a-zA-Z0-9]+$
Reference ID issued for the card transaction. This ID can be used to track the transaction across processors, card brands and issuing banks. |
| network | string (card_brand) [ 1 .. 255 ] characters^[A-Z_]+$

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

| Enum Value | 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. |
| DINERS | The Diners Club International banking and payment services capability network owned by Discover Financial Services (DFS), one of the most recognized brands in US financial services. |
| ELO | The Brazilian Elo card payment network. |
| HIPER | The Hiper - Ingenico ePayment network. |
| HIPERCARD | The Brazilian Hipercard payment network that's widely accepted in the retail market. |
| RUPAY | The RuPay payment network. |
| GE | The GE Credit Union 3Point card payment network. |
| SYNCHRONY | The Synchrony Financial (SYF) payment network. |
| EFTPOS | The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment network. |
| UNKNOWN | UNKNOWN payment network. | |

Copy

{"id": "stringstr",\ \ "date": "stri",\ \ "acquirer_reference_number": "string",\ \ "network": "VISA"\ \ }
\

schema/order Order\

The order transaction details.

| id | string
The ID of the order transaction. |
| payment_mode | string

The transaction payment mode.

| Enum Value | Description |
| --- | --- |
| INSTANT_TRANSFER | The payment mode is instant transfer. |
| MANUAL_BANK_TRANSFER | The payment mode is manual bank transfer. |
| DELAYED_TRANSFER | The payment mode is delayed transfer. |
| ECHECK | The payment mode is eCheck. | |
| state | string

The state of the order transaction.

| Enum Value | Description |
| --- | --- |
| PENDING | The order was created but no authorizations or captures were made against the order. |
| AUTHORIZED | The order has only been authorized. No capture was made against the order. |
| CAPTURED | The order has at least one capture initiated. |
| COMPLETED | The order is complete. A capture was made against the order with is_final_capture set to TRUE. No more authorizations or captures can be made against this order. |
| VOIDED | The order was voided. No more authorizations or captures can be made against this order. | |
| reason_code | string

The reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments.

| Enum Value | Description |
| --- | --- |
| PAYER_SHIPPING_UNCONFIRMED | The shipping address of the payer is not confirmed. |
| MULTI_CURRENCY | The transaction is in multiple currencies. |
| RISK_REVIEW | The transaction is under risk review. |
| REGULATORY_REVIEW | The transaction is under regulatory review. |
| VERIFICATION_REQUIRED | Verification is required. |
| ORDER | The transaction is an order. |
| OTHER | Other. | |
| pending_reason | string
Deprecated. The reason code for the pending transaction state. Obsolete. Use reason_code instead.
Enum:"payer_shipping_unconfirmed""multi_currency""risk_review""regulatory_review""verification_required""order""other" |
| protection_eligibility | string

The level of seller protection in effect for the transaction.

| Enum Value | Description |
| --- | --- |
| ELIGIBLE | The transaction is eligible for seller protection. |
| PARTIALLY_ELIGIBLE | The transaction is partially eligible for seller protection. |
| INELIGIBLE | The transaction is ineligible for seller protection. | |
| protection_eligibility_type | string

The kind of seller protection in effect for the transaction. Returned only when the protection_eligibility property is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported only for PayPal payments.

| Enum Value | Description |
| --- | --- |
| ITEM_NOT_RECEIVED_ELIGIBLE | Sellers are protected against claims for items not received. |
| UNAUTHORIZED_PAYMENT_ELIGIBLE | Sellers are protected against claims for unauthorized payments. |
| ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE | Sellers are protected against claims for items not received and claims for unauthorized payments. | |
| parent_payment | string
The ID of the payment on which this transaction is based. |
| fmf_details | 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| amount
required | object (Amount)
The amount to collect.
> Note: For an order authorization, you cannot include amount details. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }\ \ }
\

schema/p24_request p24_request\

Information needed to pay using P24 (Przelewy24).

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| email
required | string<ppaas_common_email_address_v2> (email_address) [ 3 .. 254 ] characters^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za...Show pattern
The email address of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "email": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

schema/patch Patch\

The JSON patch object to apply partial updates to resources.

| op
required | string

The operation.

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

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

For more information, see 4.6. test. | |
| path | string
The JSON Pointer to the target document location at which to complete the operation. |
| value | object (Patch Value)
The value to apply. The remove operation does not require a value. |
| from | string
The JSON Pointer to the target document location from which to move the value. Required for the move operation. |

Copy

Expand allCollapse all

{"op": "add",\ \ "path": "string",\ \ "value": { },\ \ "from": "string"\ \ }
\

schema/patch_request Patch Request\

An array of JSON patch objects to apply partial updates to resources.

Array

| op
required | string

The operation.

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

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

For more information, see 4.6. test. | |
| path | string
The JSON Pointer to the target document location at which to complete the operation. |
| value | object (Patch Value)
The value to apply. The remove operation does not require a value. |
| from | string
The JSON Pointer to the target document location from which to move the value. Required for the move operation. |

Copy

Expand allCollapse all

[{"op": "add",\ \ "path": "string",\ \ "value": { },\ \ "from": "string"\ \ }\ \ ]
\

schema/payee Payee\

The payee who receives the funds and fulfills the order.

| | |
| --- | --- |
| email | 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:
- Be associated with a confirmed PayPal personal or business account.
- Not be associated with a PayPal account. |
| merchant_id | string
The PayPal account ID for the payee. |

Copy

{"email": "user@example.com",\ \ "merchant_id": "string"\ \ }
\

schema/payee_base payee_base\

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

Copy

{"email_address": "string",\ \ "merchant_id": "stringstrings"\ \ }
\

schema/payer Payer\

The payer. The payer funds the payment.

| payment_method | string[ 4 .. 17 ] characters

The payment method.

| Value | Description |
| --- | --- |
| paypal | A PayPal Wallet payment. | |
| status | string[ 8 .. 10 ] characters

The status of payer's PayPal account.

| Enum Value | Description |
| --- | --- |
| VERIFIED | |
| UNVERIFIED | | |
| funding_instruments | 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 credit_card or credit_card_token object. If the array contains more than one instrument, the payment is declined. |
| payer_info | object (Payer Information)
The payer information. |

Copy

Expand allCollapse all

{"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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st"\ \ },\ \ "shipping_address": {"line1": "string",\ \ "line2": "string",\ \ "city": "string",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ }\ \ }\ \ }
\

schema/payer_info Payer Information\

The payer information.

| email | 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, 1990-04-12. |
| 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.

| Enum Value | Description |
| --- | --- |
| BR_CPF | BR CPF tax ID type. |
| BR_CNPJ | BR CNPJ tax ID type. | |
| billing_address | object (Address)
The billing address or shipping address for a payment. |
| shipping_address | object (Shipping Address)
The shipping address details. |

Copy

Expand allCollapse all

{"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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st"\ \ },\ \ "shipping_address": {"line1": "string",\ \ "line2": "string",\ \ "city": "string",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ }\ \ }
\

schema/payment Payment\

The payment details.

| | |
| --- | --- |
| id | string
The ID of the payment. |
| intent
required | string
The payment intent. Value is:
- sale. Makes an immediate payment.
- authorize. Authorizes a payment for capture later.
- order. Creates an order.
Enum:"sale""authorize""order" |
| transactions | 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 transactions object accepts the amount object only. |
| state | string
The state of the payment, authorization, or order transaction. Value is:
- created. The transaction was successfully created.
- approved. The customer approved the transaction. The state changes from created to approved on generation of the sale_id for sale transactions, authorization_id for authorization transactions, or order_id for order transactions.
- failed. The transaction request failed.
Enum:"created""approved""failed" |
| 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. |
| redirect_urls | 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.
Enum:"UNABLE_TO_COMPLETE_TRANSACTION""INVALID_PAYMENT_METHOD""PAYER_CANNOT_PAY""CANNOT_PAY_THIS_PAYEE""REDIRECT_REQUIRED""PAYEE_FILTER_RESTRICTIONS" |
| 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| payer
required | object (Payer)
The source of the funds for this payment. Payment method is PayPal Wallet payment or bank direct debit. |
| application_context | object (Application Context)
Use the application context resource to customize payment flow experience for your buyers. |

Copy

Expand allCollapse all

{"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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ },\ \ "shipping_method": "string",\ \ "shipping_phone_number": "string"\ \ },\ \ "notify_url": "http://example.com",\ \ "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",\ \ "redirect_urls": {"return_url": "http://example.com",\ \ "cancel_url": "http://example.com"\ \ },\ \ "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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st"\ \ },\ \ "shipping_address": {"line1": "string",\ \ "line2": "string",\ \ "city": "string",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "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"\ \ },\ \ "paypal": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "landing_page": "LOGIN",\ \ "user_action": "CONTINUE",\ \ "payment_method_preference": "UNRESTRICTED",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ },\ \ "billing_agreement_id": "string",\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "name": {"given_name": "string",\ \ "surname": "string"\ \ },\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ },\ \ "birth_date": "stringstri",\ \ "tax_info": {"tax_id": "string",\ \ "tax_id_type": "BR_CPF"\ \ },\ \ "address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "merchant_customer_id": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ },\ \ "bancontact": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "blik": {"name": "string",\ \ "country_code": "string",\ \ "email": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string",\ \ "consumer_user_agent": "string",\ \ "consumer_ip": "string"\ \ },\ \ "level_0": {"auth_code": "string"\ \ },\ \ "one_click": {"auth_code": "string",\ \ "consumer_reference": "string",\ \ "alias_label": "stringst",\ \ "alias_key": "string"\ \ }\ \ },\ \ "eps": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "giropay": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "ideal": {"name": "string",\ \ "country_code": "string",\ \ "bic": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "mybank": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "p24": {"name": "string",\ \ "email": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "sofort": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "trustly": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "apple_pay": {"id": "string",\ \ "stored_credential": {"payment_initiator": "CUSTOMER",\ \ "payment_type": "ONE_TIME",\ \ "usage": "FIRST",\ \ "previous_network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "acquirer_reference_number": "string",\ \ "network": "VISA"\ \ }\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": null\ \ }\ \ }\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS"\ \ }\ \ },\ \ "name": "string",\ \ "email_address": "string",\ \ "phone_number": {"national_number": "string"\ \ },\ \ "decrypted_token": {"device_manufacturer_id": "string",\ \ "payment_data_type": "3DSECURE",\ \ "transaction_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "tokenized_card": {"name": "string",\ \ "number": "stringstrings",\ \ "expiry": "string",\ \ "card_type": "VISA",\ \ "type": "CREDIT",\ \ "brand": "VISA",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ },\ \ "payment_data": {"cryptogram": "string",\ \ "eci_indicator": "string",\ \ "emv_data": "string",\ \ "pin": "string"\ \ }\ \ },\ \ "vault_id": "string"\ \ },\ \ "google_pay": {"name": "string",\ \ "email_address": "string",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string"\ \ },\ \ "card": null,\ \ "decrypted_token": {"message_id": "string",\ \ "message_expiration": "stringstrings",\ \ "payment_method": "CARD",\ \ "authentication_method": "PAN_ONLY",\ \ "cryptogram": "string",\ \ "eci_indicator": "string"\ \ },\ \ "attributes": {"verification": {"method": "SCA_ALWAYS"\ \ }\ \ }\ \ },\ \ "venmo": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE"\ \ },\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ }\ \ }\ \ }\ \ }
\

schema/payment_execution Payment Execution\

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 return_url. |
| transactions | Array of objects (Cart Base)
An array of transaction details. Includes the amount and item details. For update and execute payment calls, the transactions object accepts only the amount object. |

Copy

Expand allCollapse all

{"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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ },\ \ "shipping_phone_number": "string"\ \ },\ \ "notify_url": "http://example.com",\ \ "order_url": "http://example.com",\ \ "amount": {"currency": "string",\ \ "total": "string",\ \ "details": {"subtotal": "string",\ \ "shipping": "string",\ \ "tax": "string",\ \ "handling_fee": "string",\ \ "shipping_discount": "string",\ \ "insurance": "string",\ \ "gift_wrap": "string"\ \ }\ \ }\ \ }\ \ ]\ \ }
\

schema/payment_history Payment History\

An array of merchant payments that are complete. Payments that you just created with the create payment call do not appear in the list.

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

Copy

Expand allCollapse all

{"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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ },\ \ "shipping_method": "string",\ \ "shipping_phone_number": "string"\ \ },\ \ "notify_url": "http://example.com",\ \ "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",\ \ "redirect_urls": {"return_url": "http://example.com",\ \ "cancel_url": "http://example.com"\ \ },\ \ "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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st"\ \ },\ \ "shipping_address": {"line1": "string",\ \ "line2": "string",\ \ "city": "string",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "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"\ \ },\ \ "paypal": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "landing_page": "LOGIN",\ \ "user_action": "CONTINUE",\ \ "payment_method_preference": "UNRESTRICTED",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ },\ \ "billing_agreement_id": "string",\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "name": {"given_name": "string",\ \ "surname": "string"\ \ },\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": null\ \ }\ \ },\ \ "birth_date": "stringstri",\ \ "tax_info": {"tax_id": "string",\ \ "tax_id_type": "BR_CPF"\ \ },\ \ "address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ },\ \ "attributes": {"customer": {"id": null,\ \ "email_address": null,\ \ "merchant_customer_id": null\ \ },\ \ "vault": {"store_in_vault": null,\ \ "description": null,\ \ "usage_pattern": null,\ \ "usage_type": null,\ \ "customer_type": null,\ \ "permit_multiple_payment_tokens": null\ \ }\ \ }\ \ },\ \ "bancontact": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "blik": {"name": "string",\ \ "country_code": "string",\ \ "email": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string",\ \ "consumer_user_agent": "string",\ \ "consumer_ip": "string"\ \ },\ \ "level_0": {"auth_code": "string"\ \ },\ \ "one_click": {"auth_code": "string",\ \ "consumer_reference": "string",\ \ "alias_label": "stringst",\ \ "alias_key": "string"\ \ }\ \ },\ \ "eps": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "giropay": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "ideal": {"name": "string",\ \ "country_code": "string",\ \ "bic": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "mybank": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "p24": {"name": "string",\ \ "email": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "sofort": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "trustly": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "apple_pay": {"id": "string",\ \ "stored_credential": {"payment_initiator": "CUSTOMER",\ \ "payment_type": "ONE_TIME",\ \ "usage": "FIRST",\ \ "previous_network_transaction_reference": {"id": null,\ \ "date": null,\ \ "acquirer_reference_number": null,\ \ "network": null\ \ }\ \ },\ \ "attributes": {"customer": {"id": null,\ \ "email_address": null,\ \ "phone": null\ \ },\ \ "vault": {"store_in_vault": null\ \ }\ \ },\ \ "name": "string",\ \ "email_address": "string",\ \ "phone_number": {"national_number": "string"\ \ },\ \ "decrypted_token": {"device_manufacturer_id": "string",\ \ "payment_data_type": "3DSECURE",\ \ "transaction_amount": {"currency_code": null,\ \ "value": null\ \ },\ \ "tokenized_card": {"name": null,\ \ "number": null,\ \ "expiry": null,\ \ "card_type": null,\ \ "type": null,\ \ "brand": null,\ \ "billing_address": null\ \ },\ \ "payment_data": {"cryptogram": null,\ \ "eci_indicator": null,\ \ "emv_data": null,\ \ "pin": null\ \ }\ \ },\ \ "vault_id": "string"\ \ },\ \ "google_pay": {"name": "string",\ \ "email_address": "string",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string"\ \ },\ \ "card": null,\ \ "decrypted_token": {"message_id": "string",\ \ "message_expiration": "stringstrings",\ \ "payment_method": "CARD",\ \ "authentication_method": "PAN_ONLY",\ \ "cryptogram": "string",\ \ "eci_indicator": "string"\ \ },\ \ "attributes": {"verification": {"method": null\ \ }\ \ }\ \ },\ \ "venmo": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE"\ \ },\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "attributes": {"customer": {"id": null,\ \ "email_address": null\ \ },\ \ "vault": {"store_in_vault": null,\ \ "description": null,\ \ "usage_pattern": null,\ \ "usage_type": null,\ \ "customer_type": null,\ \ "permit_multiple_payment_tokens": null\ \ }\ \ }\ \ }\ \ }\ \ }\ \ }\ \ ],\ \ "count": 20,\ \ "next_id": "string"\ \ }
\

schema/payment_initiator payment_initiator\

The person or party who initiated or triggered the payment.

string (payment_initiator) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The person or party who initiated or triggered the payment.

| Enum Value | Description |
| --- | --- |
| CUSTOMER | Payment is initiated with the active engagement of the customer. e.g. a customer checking out on a merchant website. |
| MERCHANT | Payment is initiated by merchant on behalf of the customer without the active engagement of customer. e.g. a merchant charging the monthly payment of a subscription to the customer. |

Copy

"CUSTOMER"
\

schema/payment_pattern payment_pattern\

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.

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.

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

Copy

"CUSTOMER_PRESENT_ONETIME_PURCHASE"
\

schema/customized_payment_source_1 payment_source\

The payment source definition.

| | |
| --- | --- |
| token | object (token)
The tokenized payment source to fund a payment. |
| paypal | object (paypal_wallet)
Indicates that PayPal Wallet is the payment source. Main use of this selection is to provide additional instructions associated with this choice like vaulting. |
| bancontact | object (bancontact_request)
Bancontact is the most popular online payment in Belgium. More Details. |
| blik | object (blik_request)
BLIK is a mobile payment system, created by Polish Payment Standard in order to allow millions of users to pay in shops, payout cash in ATMs and make online purchases and payments. More Details. |
| eps | object (eps_request)
The eps transfer is an online payment method developed by many Austrian banks. More Details. |
| giropay | object (giropay_request)
Giropay is an Internet payment System in Germany, based on online banking. More Details. |
| ideal | object (ideal_request)
The Dutch payment method iDEAL is an online payment method that enables consumers to pay online through their own bank. More Details. |
| mybank | object (mybank_request)
MyBank is an e-authorisation solution which enables safe digital payments and identity authentication through a consumer’s own online banking portal or mobile application. More Details. |
| p24 | object (p24_request)
P24 (Przelewy24) is a secure and fast online bank transfer service linked to all the major banks in Poland. More Details. |
| sofort | object (sofort_request)
SOFORT Banking is a real-time bank transfer payment method that buyers use to transfer funds directly to merchants from their bank accounts. More Details. |
| trustly | object (trustly_request)
Trustly is a payment method that allows customers to shop and pay from their bank account. More Details. |
| apple_pay | object (apple_pay_request)
ApplePay payment source, allows buyer to pay using ApplePay, both on Web as well as on Native. |
| google_pay | object (google_pay_request)
Google Pay payment source, allows buyer to pay using Google Pay. |
| venmo | object (venmo_wallet_request)
Information needed to indicate that Venmo is being used to fund the payment. |

Copy

Expand allCollapse all

{"token": {"id": "string",\ \ "type": "BILLING_AGREEMENT"\ \ },\ \ "paypal": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "landing_page": "LOGIN",\ \ "user_action": "CONTINUE",\ \ "payment_method_preference": "UNRESTRICTED",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ },\ \ "billing_agreement_id": "string",\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "name": {"given_name": "string",\ \ "surname": "string"\ \ },\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ },\ \ "birth_date": "stringstri",\ \ "tax_info": {"tax_id": "string",\ \ "tax_id_type": "BR_CPF"\ \ },\ \ "address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "merchant_customer_id": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ },\ \ "bancontact": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "blik": {"name": "string",\ \ "country_code": "string",\ \ "email": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string",\ \ "consumer_user_agent": "string",\ \ "consumer_ip": "string"\ \ },\ \ "level_0": {"auth_code": "string"\ \ },\ \ "one_click": {"auth_code": "string",\ \ "consumer_reference": "string",\ \ "alias_label": "stringst",\ \ "alias_key": "string"\ \ }\ \ },\ \ "eps": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "giropay": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "ideal": {"name": "string",\ \ "country_code": "string",\ \ "bic": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "mybank": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "p24": {"name": "string",\ \ "email": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "sofort": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "trustly": {"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ },\ \ "apple_pay": {"id": "string",\ \ "stored_credential": {"payment_initiator": "CUSTOMER",\ \ "payment_type": "ONE_TIME",\ \ "usage": "FIRST",\ \ "previous_network_transaction_reference": {"id": "stringstr",\ \ "date": "stri",\ \ "acquirer_reference_number": "string",\ \ "network": "VISA"\ \ }\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS"\ \ }\ \ },\ \ "name": "string",\ \ "email_address": "string",\ \ "phone_number": {"national_number": "string"\ \ },\ \ "decrypted_token": {"device_manufacturer_id": "string",\ \ "payment_data_type": "3DSECURE",\ \ "transaction_amount": {"currency_code": "str",\ \ "value": "string"\ \ },\ \ "tokenized_card": {"name": "string",\ \ "number": "stringstrings",\ \ "expiry": "string",\ \ "card_type": "VISA",\ \ "type": "CREDIT",\ \ "brand": "VISA",\ \ "billing_address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ },\ \ "payment_data": {"cryptogram": "string",\ \ "eci_indicator": "string",\ \ "emv_data": "string",\ \ "pin": "string"\ \ }\ \ },\ \ "vault_id": "string"\ \ },\ \ "google_pay": {"name": "string",\ \ "email_address": "string",\ \ "phone_number": {"country_code": "str",\ \ "national_number": "string"\ \ },\ \ "card": null,\ \ "decrypted_token": {"message_id": "string",\ \ "message_expiration": "stringstrings",\ \ "payment_method": "CARD",\ \ "authentication_method": "PAN_ONLY",\ \ "cryptogram": "string",\ \ "eci_indicator": "string"\ \ },\ \ "attributes": {"verification": {"method": "SCA_ALWAYS"\ \ }\ \ }\ \ },\ \ "venmo": {"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE"\ \ },\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ }\ \ }
\

schema/PaymentsCommonComponentsSpecification-v1-schema-common_components-v3-schema-json-openapi-2.0-currency_code.json PaymentsCommonComponentsSpecification-v1-schema-common_components-v3-schema-json-openapi-2.0-currency_code.json\

The three-character ISO-4217 currency code that identifies the currency.

string<ppaas_common_currency_code_v2> (PaymentsCommonComponentsSpecification-v1-schema-common_components-v3-schema-json-openapi-2.0-currency_code.json) = 3 characters

The three-character ISO-4217 currency code that identifies the currency.

Copy

"str"
\

schema/account_id PayPal Account Identifier\

The account identifier for a PayPal account.

string<ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters^[2-9A-HJ-NP-Z]{13}$

The account identifier for a PayPal account.

Copy

"stringstrings"
\

schema/paypal_wallet paypal_wallet\

A resource that identifies a PayPal Wallet is used for payment.

| | |
| --- | --- |
| experience_context | object (paypal_wallet_experience_context)
Customizes the payer experience during the approval process for payment with PayPal.
> Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values. |
| billing_agreement_id | string (billing_agreement_id) [ 2 .. 128 ] characters^[a-zA-Z0-9-]+$
The PayPal billing agreement ID. References an approved recurring payment for goods or services. |
| vault_id | string (vault_id) [ 1 .. 255 ] characters^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the payment_source stored within the Vault. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.\a-zA-...Show pattern
The email address of the PayPal account holder. |
| name | object (Name)
The name of the PayPal account holder. Supports only the given_name and surname properties. |
| phone | object (phone_with_type)
The phone number of the customer. Available only when you enable the Contact Telephone Number option in the [Profile & Settings for the merchant's PayPal account. The phone.phone_number supports only national_number. |
| birth_date | string<ppaas_date_notime_v2> (date_no_time) = 10 characters^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...Show pattern
The birth date of the PayPal account holder in YYYY-MM-DD format. |
| tax_info | object (tax_info)
The tax information of the PayPal account holder. Required only for Brazilian PayPal account holder's. Both tax_id and tax_id_type are required. |
| address | object (Portable Postal Address (Medium-Grained))
The address of the PayPal account holder. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. Also referred to as the billing address of the customer. |
| attributes | object (paypal_wallet_attributes)
Additional attributes associated with the use of this wallet. |

Copy

Expand allCollapse all

{"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "landing_page": "LOGIN",\ \ "user_action": "CONTINUE",\ \ "payment_method_preference": "UNRESTRICTED",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ },\ \ "billing_agreement_id": "string",\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "name": {"given_name": "string",\ \ "surname": "string"\ \ },\ \ "phone": {"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ },\ \ "birth_date": "stringstri",\ \ "tax_info": {"tax_id": "string",\ \ "tax_id_type": "BR_CPF"\ \ },\ \ "address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ },\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string",\ \ "merchant_customer_id": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ }
\

schema/paypal_wallet_attributes paypal_wallet_attributes\

Additional attributes associated with the use of this PayPal Wallet.

| | |
| --- | --- |
| customer | object (paypal_wallet_customer)
The details about a customer in PayPal's system of record. |
| vault | object (vault_paypal_wallet_base)
Attributes used to provide the instructions during vaulting of the PayPal Wallet. |

Copy

Expand allCollapse all

{"customer": {"id": "string",\ \ "email_address": "string",\ \ "merchant_customer_id": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }
\

schema/customized_paypal_wallet_customer_1 paypal_wallet_customer\

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

| | |
| --- | --- |
| id | string (merchant_partner_customer_id) [ 1 .. 22 ] characters^[0-9a-zA-Z_-]+$
The unique ID for a customer generated by PayPal. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...Show pattern
Email address of the buyer as provided to the merchant or on file with the merchant. Email Address is required if you are processing the transaction using PayPal Guest Processing which is offered to select partners and merchants. For all other use cases we do not expect partners/merchant to send email_address of their customer. |
| merchant_customer_id | string[ 1 .. 64 ] characters^[0-9a-zA-Z-_.^*$@#]+$
Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer. |

Copy

{"id": "string",\ \ "email_address": "string",\ \ "merchant_customer_id": "string"\ \ }
\

schema/paypal_wallet_experience_context paypal_wallet_experience_context\

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

[schema/percentage Percentage\

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<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 19.99. The allowed number formats are plain decimal numbers and whole numbers.

Copy

"string"
\

schema/customized_phone_1 Phone\

The phone number, in its canonical international E.164 numbering plan format.

| | |
| --- | --- |
| national_number
required | string[ 1 .. 14 ] characters^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). |

Copy

{"national_number": "string"\ \ }
\

schema/customized_phone_2 Phone\

schema/customized_phone_3 Phone\

The phone number in its canonical international E.164 numbering plan format.

| | |
| --- | --- |
| country_code | string[ 1 .. 3 ] characters^[0-9]{1,3}?$
The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). |
| national_number
required | string[ 1 .. 14 ] characters^[0-9]{1,14}?$
The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN). |

Copy

{"country_code": "str",\ \ "national_number": "string"\ \ }
\

schema/phone_type Phone Type\

The phone type.

string (Phone Type)

The phone type.

Enum:"FAX""HOME""MOBILE""OTHER""PAGER"

Copy

"FAX"
\

schema/phone_with_type phone_with_type\

The phone information.

| | |
| --- | --- |
| phone_type | string (Phone Type)
The phone type.
Enum:"FAX""HOME""MOBILE""OTHER""PAGER" |
| phone_number
required | object (Phone)
The phone number, in its canonical international E.164 numbering plan format. Supports only the national_number property. |

Copy

Expand allCollapse all

{"phone_type": "FAX",\ \ "phone_number": {"national_number": "string"\ \ }\ \ }
\

schema/customized_address_portable_1 Portable Postal Address (Medium-Grained)\

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

| | |
| --- | --- |
| address_line_1 | string<= 300 characters
The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address. |
| address_line_2 | string<= 300 characters
The second line of the address, for example, a suite or apartment number. |
| admin_area_2 | string<= 120 characters
A city, town, or village. Smaller than admin_area_level_1. |
| admin_area_1 | string<= 300 characters
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:
- UK. A county.
- US. A state.
- Canada. A province.
- Japan. A prefecture.
- Switzerland. A kanton. |
| postal_code | string<= 60 characters
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The 2-character ISO 3166-1 code that identifies the country or region.
> Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions. |

Copy

{"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }
\

schema/customized_address_portable_2 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_3 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_4 Portable Postal Address (Medium-Grained)\

schema/customized_address_portable_5 Portable Postal Address (Medium-Grained)\

schema/processor_response Processor Response\

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.

| Enum Value | Description |
| --- | --- |
| 01_NEW_ACCOUNT_INFORMATION | 01 New account information. |
| 02_TRY_AGAIN_LATER | 02 Try again later. |
| 02_STOP_SPECIFIC_PAYMENT | 02 Stop specific payment. |
| 03_DO_NOT_TRY_AGAIN | 03 Do not try again. |
| 03_REVOKE_AUTHORIZATION_FOR_FUTURE_PAYMENT | 03 Revoke authorization for future payment. |
| 21_DO_NOT_TRY_AGAIN_CARD_HOLDER_CANCELLED_RECURRRING_CHARGE | 21 Do not try again. Card holder cancelled recurring charge. |
| 21_CANCEL_ALL_RECURRING_PAYMENTS | 21 Cancel all recurring payments. | |
| eci_submitted | string
The processor-provided authorization response. |
| vpas | string
The processor-provided Visa Payer Authentication Service (VPAS) status. |

Copy

{"response_code": "stri",\ \ "avs_code": "s",\ \ "cvv_code": "s",\ \ "advice_code": "01_NEW_ACCOUNT_INFORMATION",\ \ "eci_submitted": "string",\ \ "vpas": "string"\ \ }
\

schema/refund Refund\

The refund details.

| id | string
The ID of the refund transaction. Maximum length is 17 characters. |
| state | string

The state of the refund.

| Enum Value | Description |
| --- | --- |
| pending | The refund state is pending. |
| completed | The refund state is completed. |
| cancelled | The refund state is cancelled. |
| failed | The refund state is failed. | |
| 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| amount | object (Amount)
The payment amount, with details. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }\ \ }
\

schema/refund_request Refund Request\

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. |
| amount | object (Amount)
The refund amount. Includes both the amount to refund to the payer and the fee amount to refund to the payee. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }\ \ }
\

schema/refund.json refund_transaction_details\

The refund transaction details.

| | |
| --- | --- |
| id | string<= 17 characters
The ID of the refund transaction. |
| state | string
The state of the refund.
Enum:"pending""completed""cancelled""failed" |
| 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| amount | object (Amount)
The refund amount. Includes both the amount refunded to the payer and the fee refunded to the payee. |

Copy

Expand allCollapse all

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

| | |
| --- | --- |
| sale | object (Sale)
The sale transaction details. |
| authorization | object (Authorization)
The authorization details. |
| order | object (Order)
The order transaction details. |
| capture | object (Capture)
The capture transaction details. |
| refund | object (Refund)
The refund details. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }\ \ }\ \ }
\

schema/rewards_decimal_precision Rewards Decimal Precision\

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.

| Enum Value | Description |
| --- | --- |
| AMOUNT_TO_REWARDS | An amount-to-rewards conversion. |
| REWARDS_TO_AMOUNT | A rewards-to-amount conversion. | |

Copy

{"length": "string",\ \ "conversion_type": "AMOUNT_TO_REWARDS"\ \ }
\

schema/rewards_rounding_mode Rewards Rounding Mode\

The rounding mode to use to compute rewards.

| value | string (rounding_mode_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The rewards amount rounding mode.

| Enum Value | 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. | |
| conversion_type | string (rewards_conversion_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The list of conversion types.

| Enum Value | Description |
| --- | --- |
| AMOUNT_TO_REWARDS | An amount-to-rewards conversion. |
| REWARDS_TO_AMOUNT | A rewards-to-amount conversion. | |

Copy

{"value": "UP",\ \ "conversion_type": "AMOUNT_TO_REWARDS"\ \ }
\

schema/rewards_conversion_type rewards_conversion_type\

The list of conversion types.

string (rewards_conversion_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The list of conversion types.

| Enum Value | Description |
| --- | --- |
| AMOUNT_TO_REWARDS | An amount-to-rewards conversion. |
| REWARDS_TO_AMOUNT | A rewards-to-amount conversion. |

Copy

"AMOUNT_TO_REWARDS"
\

schema/rounding_mode_type rounding_mode_type\

The rewards amount rounding mode.

string (rounding_mode_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The rewards amount rounding mode.

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

Copy

"UP"
\

schema/sale Sale\

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.
Enum:"INSTANT_TRANSFER""MANUAL_BANK_TRANSFER""DELAYED_TRANSFER""ECHECK" |
| state
required | string
The state of the sale transaction.
Enum:"completed""partially_refunded""pending""refunded""denied" |
| reason_code | string
A reason code that describes why the transaction state is pending or reversed. Supported only for PayPal payments.
Enum:"CHARGEBACK""GUARANTEE""BUYER_COMPLAINT""REFUND""UNCONFIRMED_SHIPPING_ADDRESS""ECHECK""INTERNATIONAL_WITHDRAWAL""RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION""PAYMENT_REVIEW""REGULATORY_REVIEW""UNILATERAL""VERIFICATION_REQUIRED""TRANSACTION_APPROVED_AWAITING_FUNDING" |
| protection_eligibility | string
The merchant protection level in effect for the transaction. Supported only for PayPal payments.
Enum:"ELIGIBLE""PARTIALLY_ELIGIBLE""INELIGIBLE" |
| protection_eligibility_type | string
The merchant protection type in effect for the transaction. Returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Supported only for PayPal payments.
Enum:"ITEM_NOT_RECEIVED_ELIGIBLE""UNAUTHORIZED_PAYMENT_ELIGIBLE""ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE" |
| 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 held.
Value:"HELD" |
| payment_hold_reasons | Array of objects (Related Resources)
An array of reasons that PayPal holds the recipient fund. Set only if the payment hold status is HELD. |
| 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. |
| fmf_details | 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. |
| processor_response | object (Processor Response)
The processor-provided response codes that describe the submitted payment. Supported only when the payment_method is credit_card. |
| 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. |
| links | Array of objects (Link Description)
An array of request-related HATEOAS links. |
| amount
required | object (Amount)
The amount to collect. |
| transaction_fee | object (Currency)
The currency and amount of the transaction fee for this payment. Would not be returned for pending transactions where the funds have not been realized in the payee account. |
| receivable_amount | 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. |
| transaction_fee_in_receivable_currency | 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 CNY. Would not be returned for pending transactions where the funds have not been realized in the payee account. |

Copy

Expand allCollapse all

{"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"\ \ }\ \ }
\

schema/shipping_address Shipping Address\

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. |
| 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 | string<= 300 characters
The code for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: Argentina, Brazil, Canada, China, India, Italy, Japan, Mexico, Thailand, or United States. |
| 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.

| Enum Value | Description |
| --- | --- |
| UNKNOWN | Unknown. |
| UNNORMALIZED_USER_PREFERRED | Unnormalized user preferred. |
| NORMALIZED | Normalized. |
| UNNORMALIZED | Unnormalized. | |
| type | string
The type of address. For example, HOME_OR_WORK, GIFT, and so on. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The address country code. |
| recipient_name | string<= 127 characters
The name of the recipient at this address. |

Copy

{"line1": "string",\ \ "line2": "string",\ \ "city": "string",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ }
\

schema/customized_shipping_detail_1 shipping_detail\

The shipping details.

| type | string (Fullfillment Type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both.

| Enum Value | Description |
| --- | --- |
| SHIPPING | The payer intends to receive the items at a specified address. |
| PICKUP_IN_PERSON | DEPRECATED. Please use "PICKUP_FROM_PERSON" instead. |
| PICKUP_IN_STORE | The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. |
| PICKUP_FROM_PERSON | The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. | |
| name | object (Name)
The name of the person to whom to ship the items. Supports only the full_name property. |
| address | object (Portable Postal Address (Medium-Grained))
The address of the person to whom to ship the items. Supports only the address_line_1, address_line_2, admin_area_1, admin_area_2, postal_code, and country_code properties. |

Copy

Expand allCollapse all

{"type": "SHIPPING",\ \ "name": {"full_name": "string"\ \ },\ \ "address": {"address_line_1": "string",\ \ "address_line_2": "string",\ \ "admin_area_2": "string",\ \ "admin_area_1": "string",\ \ "postal_code": "string",\ \ "country_code": "st"\ \ }\ \ }
\

schema/shipping_option shipping_option\

The options that the payee or merchant offers to the payer to ship or pick up their items.

| id
required | string<= 127 characters
A unique ID that identifies a payer-selected shipping option. |
| label
required | string<= 127 characters
A description that the payer sees, which helps them choose an appropriate shipping option. For example, Free Shipping, USPS Priority Shipping, Expédition prioritaire USPS, or USPS yōuxiān fā huò. Localize this description to the payer's locale. |
| selected
required | boolean
If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. As part of the response if a shipping.option contains selected=true, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one shipping.option can be set to selected=true. |
| type | string (shipping_type)

A classification for the method of purchase fulfillment.

| Enum Value | Description |
| --- | --- |
| SHIPPING | The payer intends to receive the items at a specified address. |
| PICKUP | DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). |
| PICKUP_IN_STORE | The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. |
| PICKUP_FROM_PERSON | The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. | |
| amount | object (Money)
The shipping cost for the selected option. |

Copy

Expand allCollapse all

{"id": "string",\ \ "label": "string",\ \ "selected": true,\ \ "type": "SHIPPING",\ \ "amount": {"currency_code": "str",\ \ "value": "string"\ \ }\ \ }
\

schema/shipping_type shipping_type\

A classification for the method of purchase fulfillment.

string (shipping_type)

A classification for the method of purchase fulfillment.

| Enum Value | Description |
| --- | --- |
| SHIPPING | The payer intends to receive the items at a specified address. |
| PICKUP | DEPRECATED. To ensure that seller protection is correctly assigned, please use 'PICKUP_IN_STORE' or 'PICKUP_FROM_PERSON' instead. Currently, this field indicates that the payer intends to pick up the items at a specified address (ie. a store address). |
| PICKUP_IN_STORE | The payer intends to pick up the item(s) from the payee's physical store. Also termed as BOPIS, "Buy Online, Pick-up in Store". Seller protection is provided with this option. |
| PICKUP_FROM_PERSON | The payer intends to pick up the item(s) from the payee in person. Also termed as BOPIP, "Buy Online, Pick-up in Person". Seller protection is not available, since the payer is receiving the item from the payee in person, and can validate the item prior to payment. |

Copy

"SHIPPING"
\

schema/sofort_request sofort_request\

Information needed to pay using Sofort.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

schema/store_in_vault_instruction store_in_vault_instruction\

Defines how and when the payment source gets vaulted.

string (store_in_vault_instruction) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Defines how and when the payment source gets vaulted.

| Value | Description |
| --- | --- |
| ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. |

Copy

"ON_SUCCESS"
\

schema/stored_payment_source_payment_type stored_payment_source_payment_type\

Indicates the type of the stored payment_source payment.

string (stored_payment_source_payment_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Indicates the type of the stored payment_source payment.

| Enum Value | Description |
| --- | --- |
| ONE_TIME | One Time payment such as online purchase or donation. (e.g. Checkout with one-click). |
| RECURRING | Payment which is part of a series of payments with fixed or variable amounts, following a fixed time interval. (e.g. Subscription payments). |
| UNSCHEDULED | Payment which is part of a series of payments that occur on a non-fixed schedule and/or have variable amounts. (e.g. Account Topup payments). |

Copy

"ONE_TIME"
\

schema/stored_payment_source_usage_type stored_payment_source_usage_type\

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

string (stored_payment_source_usage_type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Default:"DERIVED"

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

| Enum Value | Description |
| --- | --- |
| FIRST | Indicates the Initial/First payment with a payment_source that is intended to be stored upon successful processing of the payment. |
| SUBSEQUENT | Indicates a payment using a stored payment_source which has been successfully used previously for a payment. |
| DERIVED | Indicates that PayPal will derive the value of FIRST or SUBSEQUENT based on data available to PayPal. |

Copy

"FIRST"
\

schema/tax_info tax_info\

The tax ID of the customer. The customer is also known as the payer. Both tax_id and tax_id_type are required.

| tax_id
required | string[ 1 .. 14 ] characters([a-zA-Z0-9])
The customer's tax ID value. |
| tax_id_type
required | string[ 1 .. 14 ] characters^[A-Z0-9_]+$

The customer's tax ID type.

| Enum Value | Description |
| --- | --- |
| BR_CPF | The individual tax ID type, typically is 11 characters long. |
| BR_CNPJ | The business tax ID type, typically is 14 characters long. | |

Copy

{"tax_id": "string",\ \ "tax_id_type": "BR_CPF"\ \ }
\

schema/token token\

The tokenized payment source to fund a payment.

| id
required | string[ 1 .. 255 ] characters^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the token. |
| type
required | string[ 1 .. 255 ] characters^[0-9A-Z_-]+$

The tokenization method that generated the ID.

| Value | Description |
| --- | --- |
| BILLING_AGREEMENT | The PayPal billing agreement ID. References an approved recurring payment for goods or services. | |

Copy

{"id": "string",\ \ "type": "BILLING_AGREEMENT"\ \ }
\

schema/transaction Transaction\

An array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment.

| | |
| --- | --- |
| payee | 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<= 255 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. |
| payment_options | object (Payment Options)
The payment options for this transaction. |
| item_list | object (Item List)
An array of items that are being purchased. |
| notify_url | string<uri><= 2048 characters
The URL to send payment notifications. |
| related_resources | Array of objects (Related Resources)
An array of payment-related transactions. A transaction defines what the payment is for and who fulfills the payment. |
| amount | object (Amount)
The payment amount, with details. |

Copy

Expand allCollapse all

{"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",\ \ "postal_code": "string",\ \ "state": "string",\ \ "phone": "string",\ \ "normalization_status": "UNKNOWN",\ \ "type": "string",\ \ "country_code": "st",\ \ "recipient_name": "string"\ \ },\ \ "shipping_method": "string",\ \ "shipping_phone_number": "string"\ \ },\ \ "notify_url": "http://example.com",\ \ "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"\ \ }\ \ }\ \ }
\

schema/trustly_request trustly_request\

Information needed to pay using Trustly.

| | |
| --- | --- |
| name
required | string (name) [ 3 .. 300 ] characters
The name of the account holder associated with this payment method. |
| country_code
required | string<ppaas_common_country_code_v2> (country_code) = 2 characters^([A-Z]{2}|C2)$
The two-character ISO 3166-1 country code. |
| experience_context | object (experience_context_base)
Customizes the payer experience during the approval process for the payment. |

Copy

Expand allCollapse all

{"name": "string",\ \ "country_code": "string",\ \ "experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE",\ \ "locale": "string",\ \ "return_url": "string",\ \ "cancel_url": "string"\ \ }\ \ }
\

schema/url url\

Describes the URL.

string<uri> (url)

Describes the URL.

Copy

"http://example.com"
\

schema/v3_vault_instruction_base v3_vault_instruction_base\

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

| store_in_vault
required | string (store_in_vault_instruction) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Defines how and when the payment source gets vaulted.

| Value | Description |
| --- | --- |
| ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. | |

Copy

{"store_in_vault": "ON_SUCCESS"\ \ }
\

schema/vault_id vault_id\

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

string (vault_id) [ 1 .. 255 ] characters^[0-9a-zA-Z_-]+$

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

Copy

"string"
\

schema/vault_instruction_base vault_instruction_base\

Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.

| store_in_vault | string (store_in_vault_instruction) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Defines how and when the payment source gets vaulted.

| Value | Description |
| --- | --- |
| ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. | |

Copy

{"store_in_vault": "ON_SUCCESS"\ \ }
\

schema/customized_vault_paypal_wallet_base_1 vault_paypal_wallet_base\

Resource consolidating common request and response attributes for vaulting PayPal Wallet.

| store_in_vault | string (store_in_vault_instruction) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Defines how and when the payment source gets vaulted.

| Value | Description |
| --- | --- |
| ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. | |
| description | string[ 1 .. 128 ] characters
The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com. |
| usage_pattern | string (PayPal Payment Token Usage Pattern) [ 1 .. 30 ] characters

Expected business/pricing model for the billing agreement.

| Enum Value | Description |
| --- | --- |
| IMMEDIATE | On-demand instant payments - non-recurring, pre-paid, variable amount, variable frequency. |
| DEFERRED | Pay after use, non-recurring post-paid, variable amount, irregular frequency. |
| RECURRING_PREPAID | Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. |
| RECURRING_POSTPAID | Pay on a fixed date based on usage or consumption after the goods/service is delivered. |
| THRESHOLD_PREPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. |
| THRESHOLD_POSTPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. | |
| usage_type
required | string (PayPal Payment Token Usage Type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The usage type associated with the PayPal payment token.

| Enum Value | Description |
| --- | --- |
| MERCHANT | The PayPal Payment Token will be used for future transaction directly with a merchant. |
| PLATFORM | The PayPal Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants. | |
| customer_type | string (PayPal Payment Token Customer Type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Default:"CONSUMER"

The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

| Enum Value | Description |
| --- | --- |
| CONSUMER | The customer vaulting the PayPal payment token is a consumer on the merchant / platform. |
| BUSINESS | The customer vaulting the PayPal payment token is a business on merchant / platform. | |
| permit_multiple_payment_tokens | boolean
Default:false
Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source. |

Copy

{"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }
\

schema/vault_venmo_wallet_base vault_Venmo_wallet_base\

Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.

| store_in_vault
required | string (store_in_vault_instruction) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Defines how and when the payment source gets vaulted.

| Value | Description |
| --- | --- |
| ON_SUCCESS | Defines that the payment_source will be vaulted only when at least one authorization or capture using that payment_source is successful. | |
| description | string[ 1 .. 128 ] characters^[a-zA-Z0-9_'\-., :;\!?"]*$
The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com. |
| usage_pattern | string (Venmo Payment Token Usage Pattern) [ 1 .. 30 ] characters^[0-9A-Z_]+$

Expected business/pricing model for the billing agreement.

| Enum Value | Description |
| --- | --- |
| IMMEDIATE | On-demand instant payments - non-recurring, pre-paid, variable amount, variable frequency. |
| DEFERRED | Pay after use, non-recurring post-paid, variable amount, irregular frequency. |
| RECURRING_PREPAID | Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered. |
| RECURRING_POSTPAID | Pay on a fixed date based on usage or consumption after the goods/service is delivered. |
| THRESHOLD_PREPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered. |
| THRESHOLD_POSTPAID | Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered. | |
| usage_type
required | string (Venmo Payment Token Usage Type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

The usage type associated with the Venmo payment token.

| Enum Value | Description |
| --- | --- |
| MERCHANT | The Venmo Payment Token will be used for future transaction directly with a merchant. |
| PLATFORM | The Venmo Payment Token will be used for future transaction on a platform. A platform is typically a marketplace or a channel that a payer can purchase goods and services from multiple merchants. | |
| customer_type | string (Venmo Payment Token Customer Type) [ 1 .. 255 ] characters^[0-9A-Z_]+$

Default:"CONSUMER"

The customer type associated with the Venmo payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

| Enum Value | Description |
| --- | --- |
| CONSUMER | The customer vaulting the Venmo payment token is a consumer on the merchant / platform. |
| BUSINESS | The customer vaulting the Venmo payment token is a business on merchant / platform. | |
| permit_multiple_payment_tokens | boolean
Default:false
Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same Venmo account. |

Copy

{"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }
\

schema/venmo_wallet_attributes venmo_wallet_attributes\

Additional attributes associated with the use of this Venmo Wallet.

| | |
| --- | --- |
| customer | object (customer)
The details about a customer in PayPal's system of record. |
| vault | object (vault_Venmo_wallet_base)
Attributes used to provide the instructions during vaulting of the Venmo Wallet. |

Copy

Expand allCollapse all

{"customer": {"id": "string",\ \ "email_address": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }
\

schema/venmo_wallet_experience_context venmo_wallet_experience_context\

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

schema/venmo_wallet_request venmo_wallet_request\

Information needed to pay using Venmo.

| | |
| --- | --- |
| experience_context | object (venmo_wallet_experience_context)
Customizes the buyer experience during the approval process for payment with Venmo.
> Note: Partners and Marketplaces might configure shipping_preference during partner account setup, which overrides the request values. |
| vault_id | string (vault_id) [ 1 .. 255 ] characters^[0-9a-zA-Z_-]+$
The PayPal-generated ID for the saved Venmo wallet payment_source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions. |
| email_address | string<merchant_common_email_address_v2> (email) [ 3 .. 254 ] characters(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-...Show pattern
The email address of the payer. |
| attributes | object (venmo_wallet_attributes)
Additional attributes associated with the use of this wallet. |

Copy

Expand allCollapse all

{"experience_context": {"brand_name": "string",\ \ "shipping_preference": "GET_FROM_FILE"\ \ },\ \ "vault_id": "string",\ \ "email_address": "string",\ \ "attributes": {"customer": {"id": "string",\ \ "email_address": "string"\ \ },\ \ "vault": {"store_in_vault": "ON_SUCCESS",\ \ "description": "string",\ \ "usage_pattern": "IMMEDIATE",\ \ "usage_type": "MERCHANT",\ \ "customer_type": "CONSUMER",\ \ "permit_multiple_payment_tokens": false\ \ }\ \ }\ \ }
\

Payments(1) ​

operation/payment.create Create payment ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/payment.list List payments ​

query Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/payment.get Show payment details ​

path Parameters ​

operation/payment.update Partially update payment ​

path Parameters ​

Request Body schema: application/json ​

operation/payment.execute Execute approved PayPal payment ​

path Parameters ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/sale.get Show sale details ​

path Parameters ​

operation/sale.refund Refund sale ​

path Parameters ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/authorization.get Show authorization details ​

path Parameters ​

operation/authorization.capture Capture authorization ​

path Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/authorization.void Void authorization ​

path Parameters ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/authorization.reauthorize Re-authorize payment ​

path Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/orders.get Show order details ​

path Parameters ​

operation/orders.capture Capture order ​

path Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/orders.void Void order ​

path Parameters ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/orders.authorize Authorize order ​

path Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/capture.get Show captured payment details ​

path Parameters ​

operation/capture.refund Refund captured payment ​

path Parameters ​

header Parameters ​

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json ​

operation/refund.get Show refund details ​

path Parameters ​

tag/Errors Errors ​

section/AGREEMENT_ALREADY_CANCELLED AGREEMENT_ALREADY_CANCELLED ​

section/AMOUNT_MISMATCH AMOUNT_MISMATCH ​

section/AUTH_SETTLE_NOT_ALLOWED AUTH_SETTLE_NOT_ALLOWED ​

section/AUTHORIZATION_ALREADY_COMPLETED AUTHORIZATION_ALREADY_COMPLETED ​

section/AUTHORIZATION_AMOUNT_LIMIT_EXCEEDED AUTHORIZATION_AMOUNT_LIMIT_EXCEEDED ​

section/AUTHORIZATION_CANNOT_BE_VOIDED AUTHORIZATION_CANNOT_BE_VOIDED ​

section/AUTHORIZATION_EXPIRED AUTHORIZATION_EXPIRED ​

section/AUTHORIZATION_ID_DOES_NOT_EXIST AUTHORIZATION_ID_DOES_NOT_EXIST ​

section/AUTHORIZATION_VOIDED AUTHORIZATION_VOIDED ​

section/BA_TOKEN_CREATION_FAILED BA_TOKEN_CREATION_FAILED ​

section/BANK_ACCOUNT_VALIDATION_FAILED BANK_ACCOUNT_VALIDATION_FAILED ​

section/BILLING_AGREEMENT_CREATION_FAILED BILLING_AGREEMENT_CREATION_FAILED ​

section/BILLING_AGREEMENT_ID_MISMATCH BILLING_AGREEMENT_ID_MISMATCH ​

section/BUYER_NOT_SET BUYER_NOT_SET ​

section/CANNOT_PAY_SELF CANNOT_PAY_SELF ​

section/CANNOT_REAUTH_CHILD_AUTHORIZATION CANNOT_REAUTH_CHILD_AUTHORIZATION ​

section/CANNOT_REAUTH_INSIDE_HONOR_PERIOD CANNOT_REAUTH_INSIDE_HONOR_PERIOD ​

section/CAPTURE_AMOUNT_LIMIT_EXCEEDED CAPTURE_AMOUNT_LIMIT_EXCEEDED ​

section/CARD_TOKEN_PAYER_MISMATCH CARD_TOKEN_PAYER_MISMATCH ​

section/COMPLIANCE_VIOLATION COMPLIANCE_VIOLATION ​

section/CREDIT_CARD_CVV_CHECK_FAILED CREDIT_CARD_CVV_CHECK_FAILED ​

section/CREDIT_CARD_REFUSED CREDIT_CARD_REFUSED ​

section/CREDIT_PAYMENT_NOT_ALLOWED CREDIT_PAYMENT_NOT_ALLOWED ​

section/CURRENCY_MISMATCH CURRENCY_MISMATCH ​

section/CURRENCY_NOT_ALLOWED CURRENCY_NOT_ALLOWED ​

Payments(1)

operation/payment.create Create payment

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/payment.list List payments

query Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/payment.get Show payment details

path Parameters

operation/payment.update Partially update payment

path Parameters

Request Body schema: application/json

operation/payment.execute Execute approved PayPal payment

path Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/sale.get Show sale details

path Parameters

operation/sale.refund Refund sale

path Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/authorization.get Show authorization details

path Parameters

operation/authorization.capture Capture authorization

path Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/authorization.void Void authorization

path Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/authorization.reauthorize Re-authorize payment

path Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/orders.get Show order details

path Parameters

operation/orders.capture Capture order

path Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/orders.void Void order

path Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/orders.authorize Authorize order

path Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/capture.get Show captured payment details

path Parameters

operation/capture.refund Refund captured payment

path Parameters

header Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

operation/refund.get Show refund details

path Parameters

tag/Errors Errors

section/AGREEMENT_ALREADY_CANCELLED AGREEMENT_ALREADY_CANCELLED

section/AMOUNT_MISMATCH AMOUNT_MISMATCH

section/AUTH_SETTLE_NOT_ALLOWED AUTH_SETTLE_NOT_ALLOWED

section/AUTHORIZATION_ALREADY_COMPLETED AUTHORIZATION_ALREADY_COMPLETED

section/AUTHORIZATION_AMOUNT_LIMIT_EXCEEDED AUTHORIZATION_AMOUNT_LIMIT_EXCEEDED

section/AUTHORIZATION_CANNOT_BE_VOIDED AUTHORIZATION_CANNOT_BE_VOIDED

section/AUTHORIZATION_EXPIRED AUTHORIZATION_EXPIRED

section/AUTHORIZATION_ID_DOES_NOT_EXIST AUTHORIZATION_ID_DOES_NOT_EXIST

section/AUTHORIZATION_VOIDED AUTHORIZATION_VOIDED

section/BA_TOKEN_CREATION_FAILED BA_TOKEN_CREATION_FAILED

section/BANK_ACCOUNT_VALIDATION_FAILED BANK_ACCOUNT_VALIDATION_FAILED

section/BILLING_AGREEMENT_CREATION_FAILED BILLING_AGREEMENT_CREATION_FAILED

section/BILLING_AGREEMENT_ID_MISMATCH BILLING_AGREEMENT_ID_MISMATCH

section/BUYER_NOT_SET BUYER_NOT_SET

section/CANNOT_PAY_SELF CANNOT_PAY_SELF

section/CANNOT_REAUTH_CHILD_AUTHORIZATION CANNOT_REAUTH_CHILD_AUTHORIZATION

section/CANNOT_REAUTH_INSIDE_HONOR_PERIOD CANNOT_REAUTH_INSIDE_HONOR_PERIOD

section/CAPTURE_AMOUNT_LIMIT_EXCEEDED CAPTURE_AMOUNT_LIMIT_EXCEEDED

section/CARD_TOKEN_PAYER_MISMATCH CARD_TOKEN_PAYER_MISMATCH

section/COMPLIANCE_VIOLATION COMPLIANCE_VIOLATION

section/CREDIT_CARD_CVV_CHECK_FAILED CREDIT_CARD_CVV_CHECK_FAILED

section/CREDIT_CARD_REFUSED CREDIT_CARD_REFUSED

section/CREDIT_PAYMENT_NOT_ALLOWED CREDIT_PAYMENT_NOT_ALLOWED

section/CURRENCY_MISMATCH CURRENCY_MISMATCH

section/CURRENCY_NOT_ALLOWED CURRENCY_NOT_ALLOWED