Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the Orders API. For more information, see the PayPal Checkout Overview.
Shows details for an authorized payment, by ID.
OK
curl -v -X GET https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046 \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer A21AAFs9YK9gWL6Vl6AqeoPtm-nf6JmtPOwAc8kfzHVdeigPEhrOJLCvbeIt3fJ4NKvyZo_iWic7sC3RIQrVUdu7igagcuMVQ'
{- "id": "0VF52814937998046",
- "status": "CREATED",
- "amount": {
- "value": "10.99",
- "currency_code": "USD"
}, - "invoice_id": "INVOICE-123",
- "seller_protection": {
- "status": "ELIGIBLE",
- "dispute_categories": [
- "ITEM_NOT_RECEIVED",
- "UNAUTHORIZED_TRANSACTION"
]
}, - "expiration_time": "2017-10-10T23:23:45Z",
- "create_time": "2017-09-11T23:23:45Z",
- "update_time": "2017-09-11T23:23:45Z",
- "links": [
- {
- "rel": "self",
- "method": "GET",
}, - {
- "rel": "capture",
- "method": "POST",
}, - {
- "rel": "void",
- "method": "POST",
}, - {
- "rel": "reauthorize",
- "method": "POST",
}
]
}
Captures an authorized payment, by ID.
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows captured payment details.
{- "amount": {
- "value": "10.99",
- "currency_code": "USD"
}, - "invoice_id": "INVOICE-123",
- "final_capture": true,
- "note_to_payer": "If the ordered color is not available, we will substitute with a different color free of charge.",
- "soft_descriptor": "Bob's Custom Sweaters"
}
{- "id": "2GG279541U471931P",
- "status": "COMPLETED",
- "links": [
- {
- "rel": "self",
- "method": "GET",
}, - {
- "rel": "refund",
- "method": "POST",
}, - {
- "rel": "up",
- "method": "GET",
}
]
}
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.
If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.
A reauthorized payment itself has a new honor period of three days.
You can reauthorize an authorized payment once for up to 115% of the original authorized amount, not to exceed an increase of $75 USD.
Supports only the amount
request parameter.
Note: This request is currently not supported for Partner use cases.
object (Money) The amount to reauthorize for an authorized payment. |
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows the reauthorized payment details.
{- "amount": {
- "value": "10.99",
- "currency_code": "USD"
}
}
{- "id": "8AA831015G517922L",
- "status": "CREATED",
- "links": [
- {
- "rel": "self",
- "method": "GET",
}, - {
- "rel": "capture",
- "method": "POST",
}, - {
- "rel": "void",
- "method": "POST",
}, - {
- "rel": "reauthorize",
- "method": "POST",
}
]
}
Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.
Authorization required | string To make REST API calls, include the bearer token in the |
Content-Type required | string Required for operations with a request body. The value is application/ |
PayPal-Auth-Assertion | string An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject. |
A successful request returns the HTTP 204 No Content
status code with no JSON response body.
curl -v -X POST https://api-m.sandbox.paypal.com/v2/payments/authorizations/0VF52814937998046/void \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer A21AAFs9YK9gWL6Vl6AqeoPtm-nf6JmtPOwAc8kfzHVdeigPEhrOJLCvbeIt3fJ4NKvyZo_iWic7sC3RIQrVUdu7igagcuMVQ'
Shows details for a captured payment, by ID.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows captured payment details.
curl -v -X GET https://api-m.sandbox.paypal.com/v2/payments/captures/2GG279541U471931P \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer A21AAFs9YK9gWL6Vl6AqeoPtm-nf6JmtPOwAc8kfzHVdeigPEhrOJLCvbeIt3fJ4NKvyZo_iWic7sC3RIQrVUdu7igagcuMVQ'
{- "id": "2GG279541U471931P",
- "status": "COMPLETED",
- "status_details": { },
- "amount": {
- "total": "10.99",
- "currency": "USD"
}, - "final_capture": true,
- "seller_protection": {
- "status": "ELIGIBLE",
- "dispute_categories": [
- "ITEM_NOT_RECEIVED",
- "UNAUTHORIZED_TRANSACTION"
]
}, - "seller_receivable_breakdown": {
- "gross_amount": {
- "total": "10.99",
- "currency": "USD"
}, - "paypal_fee": {
- "value": "0.33",
- "currency": "USD"
}, - "net_amount": {
- "value": "10.66",
- "currency": "USD"
}, - "receivable_amount": {
- "currency_code": "CNY",
- "value": "59.26"
}, - "paypal_fee_in_receivable_currency": {
- "currency_code": "CNY",
- "value": "1.13"
}, - "exchange_rate": {
- "source_currency": "USD",
- "target_currency": "CNY",
- "value": "5.9483297432325"
}
}, - "invoice_id": "INVOICE-123",
- "create_time": "2017-09-11T23:24:01Z",
- "update_time": "2017-09-11T23:24:01Z",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "refund",
- "method": "POST"
}, - {
- "rel": "up",
- "method": "GET"
}
]
}
Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount
object in the JSON request body.
PayPal-Request-Id | string The server stores keys for 45 days. |
Prefer | string Default: return=minimal The preferred server response upon successful completion of the request. Value is:
|
Authorization required | string To make REST API calls, include the bearer token in the |
Content-Type required | string Required for operations with a request body. The value is application/ |
PayPal-Auth-Assertion | string An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject. |
A successful request returns the HTTP 201 Created
status code and a JSON response body that shows refund details.
{- "amount": {
- "value": "10.00",
- "currency_code": "USD"
}, - "invoice_id": "INVOICE-123",
- "note_to_payer": "DefectiveProduct",
- "payment_instruction": {
- "platform_fees": [
- {
- "amount": {
- "currency_code": "USD",
- "value": "1.00"
}
}
]
}
}
{- "id": "1JU08902781691411",
- "amount": {
- "value": "10.00",
- "currency_code": "USD"
}, - "status": "COMPLETED",
- "note": "Defective product",
- "seller_payable_breakdown": {
- "gross_amount": {
- "value": "10.00",
- "currency_code": "USD"
}, - "paypal_fee": {
- "value": "0",
- "currency_code": "USD"
}, - "platform_fees": [
- {
- "amount": {
- "currency_code": "USD",
- "value": "1.00"
}
}
], - "net_amount": {
- "value": "9.00",
- "currency_code": "USD"
}, - "total_refunded_amount": {
- "value": "10.00",
- "currency_code": "USD"
}
}, - "invoice_id": "INVOICE-123",
- "create_time": "2022-04-23T23:24:19Z",
- "update_time": "2022-04-23T23:24:19Z",
- "links": [
- {
- "rel": "self",
- "method": "GET",
}, - {
- "rel": "up",
- "method": "GET",
}
]
}
Shows details for a refund, by ID.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows refund details.
curl -v -X GET https://api-m.sandbox.paypal.com/v2/payments/refunds/1JU08902781691411 \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer A21AAFs9YK9gWL6Vl6AqeoPtm-nf6JmtPOwAc8kfzHVdeigPEhrOJLCvbeIt3fJ4NKvyZo_iWic7sC3RIQrVUdu7igagcuMVQ'
{- "id": "1JU08902781691411",
- "amount": {
- "value": "10.99",
- "currency_code": "USD"
}, - "status": "COMPLETED",
- "note_to_payer": "Defective product",
- "seller_payable_breakdown": {
- "gross_amount": {
- "value": "10.99",
- "currency_code": "USD"
}, - "paypal_fee": {
- "value": "0",
- "currency_code": "USD"
}, - "net_amount": {
- "value": "10.99",
- "currency_code": "USD"
}, - "total_refunded_amount": {
- "value": "10.99",
- "currency_code": "USD"
}
}, - "invoice_id": "INVOICE-123",
- "create_time": "2018-09-11T23:24:19Z",
- "update_time": "2018-09-11T23:24:19Z",
- "links": [
- {
- "rel": "self",
- "method": "GET",
}, - {
- "rel": "up",
- "method": "GET",
}
]
}
Currency of capture must be the same as currency of authorization.
Verify the currency of the capture and try the request again.
The currency specified during reauthorization should be the same as the currency specified in the original authorization. Please check the currency of the authorization for which you are trying to reauthorize and try again.
Authentication failed due to missing authorization header, or invalid authentication credentials.
Account validations failed for the user.
Authorization has already been captured.
If final_capture
is set to to true
, additional captures are not possible against the authorization.
A denied authorization cannot be captured.
You cannot capture a denied authorization.
An expired authorization cannot be captured.
You cannot capture an expired authorization.
A voided authorization cannot be captured or reauthorized.
You cannot capture or reauthorize a voided authorization.
A reauthorization cannot be voided. Please void the original parent authorization.
You cannot void a reauthorized payment. You must void the original parent authorized payment.
Must be greater than zero. If the currency supports decimals, only two decimal place precision is supported.
Specify a different value and try the request again.
The capture has already been fully refunded.
You cannot capture additional refunds against this capture.
Specified country is not currently supported for payment processing.
Refund cannot be issued to this card. The card brand card_brand
is not supported. Please try again with another card.
Card is issued by a financial institution for a country (e.g. Cuba, Iran, North Korea, Syria) that is not current supported for payment processing.
All amounts specified should be in the same currency. Please ensure that the currency for the 'amount' and that of 'platform_fees.amount' is the same.
Currency not supported for card specified. Card is card_brand
. Only currency_code
is supported for this brand of card.
The value of the field should not be more than two decimal places.
If the currency supports decimals, only two decimal place precision is supported.
Currency does not support decimals.
Currency does not support decimals. Please refer to https://developer.paypal.com/docs/api/reference/currency-codes/ for more information.
Requested invoice number has been previously captured. Possible duplicate transaction.
Payment for this invoice was already captured.
The instrument presented was either declined by the processor or bank, or it can't be used for this payment.
Account validations failed for the user.
The user account could not be validated.
Currency code should be a three-character ISO-4217 currency code.
Currency code is invalid or is not currently supported. Please refer https://developer.paypal.com/docs/api/reference/currency-codes/ for list of supported currency codes.
The value of the field does not conform to the expected format.
Verify the specification for supported pattern
and try the request again.
The value of a field is invalid.
Verify the specification for the allowed values and try the request again.
Payee account is invalid.
Verify the payee account information and try the request again.
The platform_fees
amount cannot be greater than the capture amount.
Verify the platform_fees
amount and try the request again.
Specified resource ID does not exist. Please check the resource ID and try again.
Verify the resource ID and try the request again.
The value of a field is either too short or too long.
Verify the specification for the supported min
and max
values and try the request again.
Capture amount exceeds allowable limit. Please contact customer service or your account manager to request the change to your overage limit. The default overage limit is 115%, which allows the sum of all captures to be up to 115% of the order amount. Local regulations (e.g. in PSD2 countries) prohibit overages above the amount authorized by the payer.
Specify a different amount and try the request again. Alternately, contact Customer Support to increase your limits.
Maximum number of allowable captures has been reached. No additional captures are possible for this authorization. Please contact customer service or your account manager to change the number of captures that be made for a given authorization.
You cannot make additional captures.
You have exceeded the number of refunds that can be processed per capture.
Please contact customer support or your account manager to review the number of refunds that can be processed per capture.
Refund amount exceeds the allowed cumulative limit that the payee can receive.
Refund amount exceeds the allowed cumulative limit that the payer can refund.
Refund amount exceeds allowable limit. Specify a different amount and try the request again. Alternately, contact Customer Support to increase your limits.
A required field / parameter is missing.
Verify the specification for required
fields and try the request again.
Cannot void multiple authorizations.
Specified invoice_id is associated with more than one authorization.
You do not have permission to access or perform operations on this resource.
To make API calls on behalf of a merchant, ensure that you have sufficient permissions to proceed with this transaction.
You cannot do a refund for an amount less than the original capture amount.
Specify an amount equal to the capture amount or omit the amount
object from the request. Then, try the request again.
Transaction could not complete because payee account is locked or closed.
To get more information about the status of the account, call Customer Support.
Payee account is restricted.
To get more information about the status of the account, call Customer Support.
Refund amount exceeds per transaction limit that the payee can receive.
The payer account cannot be used for this transaction.
Contact the payer for an alternate payment method.
Payer account is restricted.
To get more information about the status of the account, call Customer Support.
Payer cannot pay for this transaction.
Please contact the payer to find other ways to pay for this transaction.
Refund amount exceeds per transaction limit that the payer can refund.
Cannot initiate a refund as the capture is pending.
Capture is typically pending when the payer has funded the transaction by using an e-check or bank account.
You do not have permission to access or perform operations on this resource.
To make API calls on behalf of a merchant, ensure that you have sufficient permissions to proceed with this transaction.
Payee of the authorization has not granted permission to perform capture on the authorization.
To make API calls on behalf of a merchant, ensure that you have sufficient permissions to capture the authorization.
Platform fee amount specified exceeds the amount that is available for refund. You can only refund up to the available platform fee amount. This error is also returned when no platform_fee was specified or was zero when the payment was captured.
The API Caller account is not setup to be able to process refunds with 'platform_fees'. Please contact your Account Manager. This feature is useful when you want to contribute a portion of the 'platform_fees' you had capture as part of the refund being processed.
A previous request on this resource is currently in progress. Please wait for sometime and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error.
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.
Authorization has been previously captured and hence cannot be voided.
This authorized payment was already captured. You cannot capture it again.
Authorization has been previously voided and hence cannot be voided again.
This authorized payment was already voided. You cannot void it again.
A reauthorize cannot be attempted on an authorization_id that is the result of a prior reauthorization or on an authorization made on an Order saved using the v2/orders/id/save
API.
The refund amount must be less than or equal to the capture amount that has not yet been refunded.
Verify the refund amount and try the request again.
The amount after applying currency conversion is zero and hence the capture cannot be refunded. The currency conversion is required because the currency of the capture is different than the currency in which the amount was settled into the payee account.
The amount after applying currency conversion is zero and hence the capture cannot be refunded. The currency conversion is required because the currency of the capture is different than the currency in which the amount was settled into the payee account.
Refund must be in the same currency as the capture.
Verify the currency of the refund and try the request again.
Refund was refused by the payment source.
We're unable to process refunds for the payer's selected payment source. Contact the payer directly to arrange a refund via alternative means.
Refund cannot be processed due to insufficient funds.
Verify that either you have sufficient funds in your PayPal account or the bank account that is linked to your PayPal account is verified and has sufficient funds.
There is no valid funding instrument linked to the account from which refund can be processed.
This refund can only be processed by the API caller that had 'captured' the transaction. If you facilitate your transactions via a platform/partner, please initiate a refund through them.
The requested action could not be performed, semantically incorrect, or failed business validation.
Refunds not allowed on this capture due to a chargeback on the card or bank. Please contact the payee to resolve the chargeback.
Refund was refused by the payment source.
Refunds are not supported for the payer's selected payment source. Contact the payer directly to arrange a refund via alternative means.
The funding instrument linked to the account has been declined by either the processor or PayPal internal system.
Refund was refused by the payment source.
The time limit set by the payer's selected payment source to refund this transaction has expired. Contact the payer directly to arrange a refund via alternative means.
You are over the time limit to perform a refund on this capture.
The refund cannot be issued at this time.
PayPal's internal controls or user account settings prevent refund from being processed.
Partial refunds cannot be offered at this time because there is an open case on this transaction. Visit the PayPal Resolution Center to review this case.
Refund for an amount less than the remaining transaction amount cannot be processed at this time because of an open dispute on the capture. Please visit the PayPal Resolution Center to view the details.
PayPal's internal controls prevent authorization from being captured.
For more information about this transaction, contact customer support.
Update authorization is not allowed for this type of authorization.
The date and time stamps that are common to authorized payment, captured payment, and refund transactions.
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction occurred, in Internet date and time format. |
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction was last updated, in Internet date and time format. |
{- "create_time": "stringstringstringst",
- "update_time": "stringstringstringst"
}
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. |
eci_indicator | string [ 1 .. 256 ] characters ECI indicator, as defined by 3- Secure. |
emv_data | string [ 1 .. 2000 ] characters Encoded Apple Pay EMV Payment Structure used for payments in China. |
pin | string [ 1 .. 2000 ] characters Bank Key encrypted Apple Pay PIN. |
{- "cryptogram": "string",
- "eci_indicator": "string",
- "emv_data": "string",
- "pin": "string"
}
The authorized payment transaction.
status | string The status for the authorized payment.
| ||||||||||||||||
object (authorization_status_details) The details of the authorized order pending status. | |||||||||||||||||
id | string The PayPal-generated ID for the authorized payment. | ||||||||||||||||
invoice_id | string The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | ||||||||||||||||
custom_id | string <= 127 characters The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. | ||||||||||||||||
Array of objects (Link Description) An array of related HATEOAS links. | |||||||||||||||||
object (Money) The amount for this authorized payment. | |||||||||||||||||
object (seller_protection) The level of protection offered as defined by PayPal Seller Protection for Merchants. | |||||||||||||||||
expiration_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the authorized payment expires, in Internet date and time format. | ||||||||||||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction occurred, in Internet date and time format. | ||||||||||||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction was last updated, in Internet date and time format. |
{- "status": "CREATED",
- "status_details": {
- "reason": "PENDING_REVIEW"
}, - "id": "string",
- "invoice_id": "string",
- "custom_id": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency_code": "str",
- "value": "string"
}, - "seller_protection": {
- "status": "ELIGIBLE",
- "dispute_categories": [
- "string"
]
}, - "expiration_time": "string",
- "create_time": "stringstringstringst",
- "update_time": "stringstringstringst"
}
The authorized payment transaction.
status | string The status for the authorized payment.
| ||||||||||||||||
object (authorization_status_details) The details of the authorized order pending status. | |||||||||||||||||
id | string The PayPal-generated ID for the authorized payment. | ||||||||||||||||
invoice_id | string The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | ||||||||||||||||
custom_id | string <= 127 characters The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. | ||||||||||||||||
Array of objects (Link Description) An array of related HATEOAS links. | |||||||||||||||||
object (Money) The amount for this authorized payment. | |||||||||||||||||
object (seller_protection) The level of protection offered as defined by PayPal Seller Protection for Merchants. | |||||||||||||||||
expiration_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the authorized payment expires, in Internet date and time format. | ||||||||||||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction occurred, in Internet date and time format. | ||||||||||||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction was last updated, in Internet date and time format. | ||||||||||||||||
object (Supplementary Data) An object that provides supplementary/additional data related to a payment transaction. |
{- "status": "CREATED",
- "status_details": {
- "reason": "PENDING_REVIEW"
}, - "id": "string",
- "invoice_id": "string",
- "custom_id": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency_code": "str",
- "value": "string"
}, - "seller_protection": {
- "status": "ELIGIBLE",
- "dispute_categories": [
- "string"
]
}, - "expiration_time": "string",
- "create_time": "stringstringstringst",
- "update_time": "stringstringstringst",
- "supplementary_data": {
- "related_ids": {
- "order_id": "string",
- "authorization_id": "string",
- "capture_id": "string"
}
}
}
The status fields for an authorized payment.
status | string The status for the authorized payment.
| ||||||||||||||||
object (authorization_status_details) The details of the authorized order pending status. |
{- "status": "CREATED",
- "status_details": {
- "reason": "PENDING_REVIEW"
}
}
The details of the authorized payment status.
reason | string [ 1 .. 24 ] characters ^[A-Z_]+$ The reason why the authorized status is
|
{- "reason": "PENDING_REVIEW"
}
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.
"stringst"
A captured payment.
status | string The status of the captured payment.
| ||||||||||||||
object (capture_status_details) The details of the captured payment status. | |||||||||||||||
id | string The PayPal-generated ID for the captured payment. | ||||||||||||||
invoice_id | string The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | ||||||||||||||
custom_id | string <= 127 characters The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. | ||||||||||||||
final_capture | boolean Default: false Indicates whether you can make additional captures against the authorized payment. Set to | ||||||||||||||
disbursement_mode | string (disbursement_mode) [ 1 .. 16 ] characters ^[A-Z_]+$ Default: "INSTANT" The funds that are held on behalf of the merchant.
| ||||||||||||||
Array of objects (Link Description) An array of related HATEOAS links. | |||||||||||||||
object (Money) The amount for this captured payment. | |||||||||||||||
object (seller_protection) The level of protection offered as defined by PayPal Seller Protection for Merchants. | |||||||||||||||
object (Seller Receivable Breakdown) The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | |||||||||||||||
object (processor_response) An object that provides additional processor information for a direct credit card transaction. | |||||||||||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction occurred, in Internet date and time format. | ||||||||||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction was last updated, in Internet date and time format. |
{- "status": "COMPLETED",
- "status_details": {
- "reason": "BUYER_COMPLAINT"
}, - "id": "string",
- "invoice_id": "string",
- "custom_id": "string",
- "final_capture": false,
- "disbursement_mode": "INSTANT",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency_code": "str",
- "value": "string"
}, - "seller_protection": {
- "status": "ELIGIBLE",
- "dispute_categories": [
- "string"
]
}, - "seller_receivable_breakdown": {
- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
], - "gross_amount": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee_in_receivable_currency": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount": {
- "currency_code": "str",
- "value": "string"
}, - "receivable_amount": {
- "currency_code": "str",
- "value": "string"
}, - "exchange_rate": {
- "value": "string",
- "source_currency": "str",
- "target_currency": "str"
}
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E",
- "response_code": "0000",
- "payment_advice_code": "01"
}, - "create_time": "stringstringstringst",
- "update_time": "stringstringstringst"
}
A captured payment.
status | string The status of the captured payment.
| ||||||||||||||
object (capture_status_details) The details of the captured payment status. | |||||||||||||||
id | string The PayPal-generated ID for the captured payment. | ||||||||||||||
invoice_id | string The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | ||||||||||||||
custom_id | string <= 127 characters The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports. | ||||||||||||||
final_capture | boolean Default: false Indicates whether you can make additional captures against the authorized payment. Set to | ||||||||||||||
disbursement_mode | string (disbursement_mode) [ 1 .. 16 ] characters ^[A-Z_]+$ Default: "INSTANT" The funds that are held on behalf of the merchant.
| ||||||||||||||
Array of objects (Link Description) An array of related HATEOAS links. | |||||||||||||||
object (Money) The amount for this captured payment. | |||||||||||||||
object (seller_protection) The level of protection offered as defined by PayPal Seller Protection for Merchants. | |||||||||||||||
object (Seller Receivable Breakdown) The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | |||||||||||||||
object (processor_response) An object that provides additional processor information for a direct credit card transaction. | |||||||||||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction occurred, in Internet date and time format. | ||||||||||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction was last updated, in Internet date and time format. | ||||||||||||||
object (Supplementary Data) An object that provides supplementary/additional data related to a payment transaction. |
{- "status": "COMPLETED",
- "status_details": {
- "reason": "BUYER_COMPLAINT"
}, - "id": "string",
- "invoice_id": "string",
- "custom_id": "string",
- "final_capture": false,
- "disbursement_mode": "INSTANT",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency_code": "str",
- "value": "string"
}, - "seller_protection": {
- "status": "ELIGIBLE",
- "dispute_categories": [
- "string"
]
}, - "seller_receivable_breakdown": {
- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
], - "gross_amount": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee_in_receivable_currency": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount": {
- "currency_code": "str",
- "value": "string"
}, - "receivable_amount": {
- "currency_code": "str",
- "value": "string"
}, - "exchange_rate": {
- "value": "string",
- "source_currency": "str",
- "target_currency": "str"
}
}, - "processor_response": {
- "avs_code": "A",
- "cvv_code": "E",
- "response_code": "0000",
- "payment_advice_code": "01"
}, - "create_time": "stringstringstringst",
- "update_time": "stringstringstringst",
- "supplementary_data": {
- "related_ids": {
- "order_id": "string",
- "authorization_id": "string",
- "capture_id": "string"
}
}
}
The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor.
invoice_id | string [ 1 .. 127 ] characters ^.{1,127}$ The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. |
note_to_payer | string [ 1 .. 255 ] characters ^.{1,255}$ An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives. |
{- "invoice_id": "string",
- "note_to_payer": "string"
}
Captures either a portion or the full authorized amount of an authorized payment.
invoice_id | string [ 1 .. 127 ] characters ^.{1,127}$ The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. |
note_to_payer | string [ 1 .. 255 ] characters ^.{1,255}$ An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives. |
final_capture | boolean Default: "false" Indicates whether you can make additional captures against the authorized payment. Set to |
object (payment_instruction) Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. | |
soft_descriptor | string <= 22 characters The payment descriptor on the payer's account statement. |
object (Money) The amount to capture. To capture a portion of the full authorized amount, specify an amount. If amount is not specified, the full authorized amount is captured. The amount must be a positive number and in the same currency as the authorization against which the payment is being captured. |
{- "invoice_id": "string",
- "note_to_payer": "string",
- "final_capture": "false",
- "payment_instruction": {
- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
], - "payee_pricing_tier_id": "string",
- "payee_receivable_fx_rate_id": "string",
- "disbursement_mode": "INSTANT"
}, - "soft_descriptor": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
The status of a captured payment.
status | string The status of the captured payment.
| ||||||||||||||
object (capture_status_details) The details of the captured payment status. |
{- "status": "COMPLETED",
- "status_details": {
- "reason": "BUYER_COMPLAINT"
}
}
The details of the captured payment status.
reason | string [ 1 .. 64 ] characters ^[A-Z_]+$ The reason why the captured payment status is
|
{- "reason": "BUYER_COMPLAINT"
}
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 |
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. |
object (Portable Postal Address (Medium-Grained)) The billing address for this card. Supports only the |
{- "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"
}
}
The card network or brand. Applies to credit, debit, gift, and payment cards.
The card network or brand. Applies to credit, debit, gift, and payment cards.
Enum: | Description |
---|---|
VISA | Visa card. |
MASTERCARD | Mastecard card. |
DISCOVER | Discover card. |
AMEX | American Express card. |
SOLO | Solo debit card. |
JCB | Japan Credit Bureau card. |
STAR | Military Star card. |
DELTA | Delta Airlines card. |
SWITCH | Switch credit card. |
MAESTRO | Maestro credit card. |
CB_NATIONALE | Carte Bancaire (CB) credit card. |
CONFIGOGA | Configoga credit card. |
CONFIDIS | Confidis credit card. |
ELECTRON | Visa Electron credit card. |
CETELEM | Cetelem credit card. |
CHINA_UNION_PAY | China union pay credit card. |
"VISA"
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
.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.
| ||||||||
payment_type required | string (stored_payment_source_payment_type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Indicates the type of the stored payment_source payment.
| ||||||||
usage | string (stored_payment_source_usage_type) [ 1 .. 255 ] characters ^[0-9A-Z_]+$ Default: "DERIVED" Indicates if this is a
| ||||||||
object (network_transaction_reference) Reference values used by the card network to identify a transaction. |
{- "payment_initiator": "CUSTOMER",
- "payment_type": "ONE_TIME",
- "usage": "FIRST",
- "previous_network_transaction_reference": {
- "id": "stringstr",
- "date": "stri",
- "network": "VISA"
}
}
Type of card. i.e Credit, Debit and so on.
Type of card. i.e Credit, Debit and so on.
Enum: | Description |
---|---|
CREDIT | A credit card. |
DEBIT | A debit card. |
PREPAID | A Prepaid card. |
STORE | A store card. |
UNKNOWN | Card type cannot be determined. |
"CREDIT"
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The 2-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.
Enum: | Description |
---|---|
BTC | The ticker symbol for Bitcoin. https://en.wikipedia.org/wiki/Bitcoin. |
ETH | The ticker symbol for Ethereum. https://en.wikipedia.org/wiki/Ethereum. |
BCH | The ticker symbol for Bitcoin Cash. https://en.wikipedia.org/wiki/Bitcoin_Cash. |
LTC | The ticker symbol for Litecoin. https://en.wikipedia.org/wiki/Litecoin. |
"BTC"
The three-character ISO-4217 currency code that identifies the currency.
The three-character ISO-4217 currency code that identifies the currency.
"str"
The 3-character ISO-4217 currency code that identifies the currency.
The 3-character ISO-4217 currency code that identifies the currency.
"str"
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
"stringstringstringst"
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
The year and month, in ISO-8601 YYYY-MM
date format. See Internet date and time format.
"strings"
The funds that are held on behalf of the merchant.
The funds that are held on behalf of the merchant.
Enum: | Description |
---|---|
INSTANT | The funds are released to the merchant immediately. |
DELAYED | The funds are held for a finite number of days. The actual duration depends on the region and type of integration. You can release the funds through a referenced payout. Otherwise, the funds disbursed automatically after the specified duration. |
"INSTANT"
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
"string"
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@
sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@
sign exists.
"string"
The error details.
name required | string The human-readable, unique name of the error. |
message required | string The message that describes the error. |
debug_id required | string The PayPal internal ID. Used for correlation purposes. |
information_link | string The information link, or URI, that shows detailed information about this error for the developer. |
Array of objects (Error Details) An array of additional details about the error. | |
Array of objects (Link Description) An array of request-related HATEOAS links. |
{- "name": "string",
- "message": "string",
- "debug_id": "string",
- "information_link": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
], - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The error details. Required for client-side 4XX
errors.
field | string The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. |
value | string The value of the field that caused the error. |
location | string Default: "body" The location of the field that caused the error. Value is |
issue required | string The unique, fine-grained application-level error code. |
description | string The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
The exchange rate that determines the amount to convert from one currency to another currency.
value | string The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point. |
source_currency | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters The source currency from which to convert an amount. |
target_currency | string <ppaas_common_currency_code_v2> (currency_code) = 3 characters The target currency to which to convert an amount. |
{- "value": "string",
- "source_currency": "str",
- "target_currency": "str"
}
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. | ||||||||
shipping_preference | string [ 1 .. 24 ] characters ^[A-Z_]+$ Default: "GET_FROM_FILE" The location from which the shipping address is derived.
| ||||||||
locale | string <ppaas_common_language_v3> (language) [ 2 .. 10 ] characters ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[... The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, | ||||||||
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. |
{- "brand_name": "string",
- "shipping_preference": "GET_FROM_FILE",
- "locale": "string",
- "return_url": "string",
- "cancel_url": "string"
}
The identifier of the instrument.
The identifier of the instrument.
"string"
The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
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"
The request-related HATEOAS link information.
href required | string The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the |
rel required | string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. |
method | string The HTTP method required to make the related call. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
The currency and amount for a financial transaction, such as a balance or payment due.
currency_code required | string <ppaas_common_currency_code_v2> (currency_code_v4) = 3 characters The 3-character ISO-4217 currency code that identifies the currency. |
value required | string <= 32 characters ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ The value, which might be:
|
{- "currency_code": "str",
- "value": "string"
}
The 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:
|
{- "currency_code": "str",
- "value": "string"
}
The full name representation like Mr J Smith.
The full name representation like Mr J Smith.
"string"
The net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the merchant holds their funds.
object (Money) The net amount debited from the merchant's PayPal account. | |
object (Money) The converted payable amount. | |
object (exchange_rate) The exchange rate that determines the amount that was debited from the merchant's PayPal account. |
{- "payable_amount": {
- "currency_code": "str",
- "value": "string"
}, - "converted_amount": {
- "currency_code": "str",
- "value": "string"
}, - "exchange_rate": {
- "value": "string",
- "source_currency": "str",
- "target_currency": "str"
}
}
Reference values used by the card network to identify a transaction.
id required | string [ 9 .. 15 ] 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. | ||||||||||||||||||||||||||||||||||
date | string = 4 characters ^[0-9]+$ The date that the transaction was authorized by the scheme. For MasterCard, this is the "BankNet reference date" field in response. | ||||||||||||||||||||||||||||||||||
network required | string (card_brand) [ 1 .. 255 ] characters ^[A-Z_]+$ Name of the card network through which the transaction was routed.
|
{- "id": "stringstr",
- "date": "stri",
- "network": "VISA"
}
The JSON patch object to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | object (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
{- "op": "add",
- "path": "string",
- "value": { },
- "from": "string"
}
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) <= 254 characters (?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-... The email address of merchant. |
merchant_id | string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$ The encrypted PayPal account ID of the merchant. |
{- "email_address": "string",
- "merchant_id": "stringstrings"
}
The person or party who initiated or triggered the payment.
The person or party who initiated or triggered the payment.
Enum: | 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. |
"CUSTOMER"
Any additional payments instructions during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability.
Array of objects (platform_fee) [ 0 .. 1 ] items Specifies the amount that the API caller will contribute to the refund being processed. The amount needs to be lower than platform_fees amount originally captured or the amount that is remaining if multiple refunds have been processed. This field is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability. |
{- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
]
}
Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
Array of objects (platform_fee) [ 0 .. 1 ] items An array of various fees, commissions, tips, or donations. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. | |||||||
payee_pricing_tier_id | string [ 1 .. 20 ] characters This field is only enabled for selected merchants/partners to use and provides the ability to trigger a specific pricing rate/plan for a payment transaction. The list of eligible 'payee_pricing_tier_id' would be provided to you by your Account Manager. Specifying values other than the one provided to you by your account manager would result in an error. | ||||||
payee_receivable_fx_rate_id | string [ 1 .. 4000 ] characters FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account. | ||||||
disbursement_mode | string (disbursement_mode) [ 1 .. 16 ] characters ^[A-Z_]+$ Default: "INSTANT" The funds that are held payee by the marketplace/platform. This field is only applicable to merchants that been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability.
|
{- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
], - "payee_pricing_tier_id": "string",
- "payee_receivable_fx_rate_id": "string",
- "disbursement_mode": "INSTANT"
}
The account identifier for a PayPal account.
The account identifier for a PayPal account.
"stringstrings"
The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external perspective. The platform fee is limited in scope and is always associated with the original payment for the purchase unit.
required | object (Money) The fee for this transaction. |
object (payee_base) The recipient of the fee for this transaction. If you omit this value, the default is the API caller. |
{- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
The API caller-provided information about the store.
store_id | string [ 1 .. 50 ] characters ^[A-Za-z0-9-]{1,50}$ The API caller-provided external store identification number. |
terminal_id | string [ 1 .. 50 ] characters ^[A-Za-z0-9-]{1,50}$ The API caller-provided external terminal identification number. |
{- "store_id": "string",
- "terminal_id": "string"
}
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. For example, number or street. For example, |
address_line_2 | string <= 300 characters The second line of the address. For example, suite or apartment number. |
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
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. Format for postal delivery. For example,
|
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 two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is |
{- "address_line_1": "string",
- "address_line_2": "string",
- "admin_area_2": "string",
- "admin_area_1": "string",
- "postal_code": "string",
- "country_code": "st"
}
The processor information. Might be required for payment requests, such as direct credit card transactions.
avs_code | string The address verification code for Visa, Discover, Mastercard, or American Express transactions.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cvv_code | string The card verification value code for for Visa, Discover, Mastercard, or American Express.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
response_code | string Processor response code for the non-PayPal payment processor errors.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_advice_code | string The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.
|
{- "avs_code": "A",
- "cvv_code": "E",
- "response_code": "0000",
- "payment_advice_code": "01"
}
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. You can reauthorize a payment only once from days four to 29.
If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.
A reauthorized payment itself has a new honor period of three days.
You can reauthorize an authorized payment once for up to 115% of the original authorized amount, not to exceed an increase of $75 USD.
Supports only the amount
request parameter.
Note: This request is currently not supported for Partner use cases.
object (Money) The amount to reauthorize for an authorized payment. |
{- "amount": {
- "currency_code": "str",
- "value": "string"
}
}
The refund information.
status | string The status of the refund.
| ||||||||||
object (refund_status_details) The details of the refund status. | |||||||||||
id | string The PayPal-generated ID for the refund. | ||||||||||
invoice_id | string The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | ||||||||||
note_to_payer | string The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. | ||||||||||
object (Merchant Payable Breakdown) The breakdown of the refund. | |||||||||||
Array of objects (Link Description) An array of related HATEOAS links. | |||||||||||
object (Money) The amount that the payee refunded to the payer. | |||||||||||
create_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction occurred, in Internet date and time format. | ||||||||||
update_time | string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|... The date and time when the transaction was last updated, in Internet date and time format. |
{- "status": "CANCELLED",
- "status_details": {
- "reason": "ECHECK"
}, - "id": "string",
- "invoice_id": "string",
- "note_to_payer": "string",
- "seller_payable_breakdown": {
- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
], - "net_amount_breakdown": [
- {
- "payable_amount": {
- "currency_code": "str",
- "value": "string"
}, - "converted_amount": {
- "currency_code": "str",
- "value": "string"
}, - "exchange_rate": {
- "value": "string",
- "source_currency": "str",
- "target_currency": "str"
}
}
], - "gross_amount": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee_in_receivable_currency": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount_in_receivable_currency": {
- "currency_code": "str",
- "value": "string"
}, - "total_refunded_amount": {
- "currency_code": "str",
- "value": "string"
}
}, - "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "amount": {
- "currency_code": "str",
- "value": "string"
}, - "create_time": "stringstringstringst",
- "update_time": "stringstringstringst"
}
Refunds a captured payment, by ID. For a full refund, include an empty request body. For a partial refund, include an amount
object in the request body.
invoice_id | string [ 1 .. 127 ] characters The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. |
note_to_payer | string [ 1 .. 255 ] characters The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives. |
object (Money) The amount to refund. To refund a portion of the captured amount, specify an amount. If amount is not specified, an amount equal to | |
object (payment_instruction) Any additional refund instructions to be set during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce Platform for Marketplaces and Platforms capability. Please speak to your account manager if you want to use this capability. |
{- "invoice_id": "string",
- "note_to_payer": "string",
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payment_instruction": {
- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
], - "payee_pricing_tier_id": "string",
- "payee_receivable_fx_rate_id": "string",
- "disbursement_mode": "INSTANT"
}
}
The refund status.
status | string The status of the refund.
| ||||||||||
object (refund_status_details) The details of the refund status. |
{- "status": "CANCELLED",
- "status_details": {
- "reason": "ECHECK"
}
}
The details of the refund status.
reason | string The reason why the refund has the
|
{- "reason": "ECHECK"
}
Identifiers related to a specific resource.
order_id | string [ 1 .. 20 ] characters ^[A-Z0-9]+$ Order ID related to the resource. |
authorization_id | string [ 1 .. 20 ] characters ^[A-Z0-9]+$ Authorization ID related to the resource. |
capture_id | string [ 1 .. 20 ] characters ^[A-Z0-9]+$ Capture ID related to the resource. |
{- "order_id": "string",
- "authorization_id": "string",
- "capture_id": "string"
}
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
Array of objects (platform_fee) [ 0 .. 1 ] items An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment. | |
required | object (Money) The amount for this captured payment in the currency of the transaction. |
object (Money) The applicable fee for this captured payment in the currency of the transaction. | |
object (Money) The applicable fee for this captured payment in the receivable currency. Returned only in cases the fee is charged in the receivable currency. Example 'CNY'. | |
object (Money) The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as | |
object (Money) The net amount that is credited to the payee's PayPal account. Returned only when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. The amount is computed as | |
object (exchange_rate) The exchange rate that determines the amount that is credited to the payee's PayPal account. Returned when the currency of the captured payment is different from the currency of the PayPal account where the payee wants to credit the funds. |
{- "platform_fees": [
- {
- "amount": {
- "currency_code": "str",
- "value": "string"
}, - "payee": {
- "email_address": "string",
- "merchant_id": "stringstrings"
}
}
], - "gross_amount": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee": {
- "currency_code": "str",
- "value": "string"
}, - "paypal_fee_in_receivable_currency": {
- "currency_code": "str",
- "value": "string"
}, - "net_amount": {
- "currency_code": "str",
- "value": "string"
}, - "receivable_amount": {
- "currency_code": "str",
- "value": "string"
}, - "exchange_rate": {
- "value": "string",
- "source_currency": "str",
- "target_currency": "str"
}
}
The level of protection offered as defined by PayPal Seller Protection for Merchants.
status | string Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.
| ||||||||
dispute_categories | Array of strings An array of conditions that are covered for the transaction. |
{- "status": "ELIGIBLE",
- "dispute_categories": [
- "string"
]
}
Indicates the type of the stored payment_source payment.
Indicates the type of the stored payment_source payment.
Enum: | 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). |
"ONE_TIME"
Indicates if this is a first
or subsequent
payment using a stored payment source (also referred to as stored credential or card on file).
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: | 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"