On this page
No Headings
A captured payment.
objectstatusstring"COMPLETED", "DECLINED", "PARTIALLY_REFUNDED", "PENDING", "REFUNDED", "FAILED"The status of the captured payment.
status_detailsobjectThe details of the captured payment status.
The details of the captured payment status.
reasonstring"BUYER_COMPLAINT", "CHARGEBACK", "ECHECK", "INTERNATIONAL_WITHDRAWAL", "OTHER", "PENDING_REVIEW", "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION", "REFUNDED", "TRANSACTION_APPROVED_AWAITING_FUNDING", "UNILATERAL", "VERIFICATION_REQUIRED", "DECLINED_BY_RISK_FRAUD_FILTERS"The reason why the captured payment status is PENDING or DENIED.
idstring^[\S\s]*$The PayPal-generated ID for the captured payment.
amountobjectThe total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount.
The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.
The amount for this captured payment.
invoice_idstring^[\S\s]*$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_idstring^[\S\s]*$The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
network_transaction_referenceobjectReference values used by the card network to identify a transaction.
idstring^[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 -.
datestring^[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". For some specific networks, such as MasterCard and Discover, this date field is mandatory when the previous_network_transaction_reference_id is passed.
networkobject"VISA", "MASTERCARD", "DISCOVER", "AMEX", "SOLO", "JCB", "STAR", "DELTA", "SWITCH", "MAESTRO", "CB_NATIONALE", "CONFIGOGA", "CONFIDIS", "ELECTRON", "CETELEM", "CHINA_UNION_PAY", "DINERS", "ELO", "HIPER", "HIPERCARD", "RUPAY", "GE", "SYNCHRONY", "EFTPOS", "CARTE_BANCAIRE", "STAR_ACCESS", "PULSE", "NYCE", "ACCEL", "UNKNOWN"The card network or brand. Applies to credit, debit, gift, and payment cards.
Name of the card network through which the transaction was routed.
acquirer_reference_numberstring^[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.
seller_protectionobjectThe level of protection offered as defined by PayPal Seller Protection for Merchants.
statusstring"ELIGIBLE", "PARTIALLY_ELIGIBLE", "NOT_ELIGIBLE"Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.
dispute_categoriesarrayAn array of conditions that are covered for the transaction.
itemsstring"ITEM_NOT_RECEIVED", "UNAUTHORIZED_TRANSACTION"The condition that is covered for the transaction.
final_capturebooleanfalseIndicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.
seller_receivable_breakdownobjectThe detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
gross_amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The amount for this captured payment in the currency of the transaction.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.paypal_feeobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The applicable fee for this captured payment in the currency of the transaction.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.paypal_fee_in_receivable_currencyobjectThe currency and amount for a financial transaction, such as a balance or payment due.
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'.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.net_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The net amount that the payee receives for this captured payment in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee minus the platform_fees.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.receivable_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
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 net_amount times exchange_rate.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.exchange_rateobjectThe exchange rate that determines the amount to convert from one currency to another currency.
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.
source_currencyobject^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
The source currency from which to convert an amount.
target_currencyobject^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
The target currency to which to convert an amount.
valuestring^[\S\s]*$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.
platform_feesarrayAn array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.
itemsobjectThe 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.
amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The fee for this transaction.
currency_coderequiredstring^[\S\s]*$The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.payeeobjectThe details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
The recipient of the fee for this transaction.
email_addressobject^.*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\]).*$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 email address of merchant.
merchant_idobject^[2-9A-HJ-NP-Z]{13}$The account identifier for a PayPal account.
The encrypted PayPal account ID of the merchant.
disbursement_modeobject"INSTANT", "DELAYED""INSTANT"The funds that are held on behalf of the merchant.
linksarrayAn array of related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^[\S\s]*$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.
relrequiredstring^[\S\s]*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
titlestring^[\S\s]*$The link title.
mediaTypestring^[\S\s]*$The media type, as defined by RFC 2046. Describes the link target.
encTypestring^[\S\s]*$"application/json"The media type in which to submit the request data.
schemaobjectThe request data or link target.
The schema that describes the request data.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
definitionsobjectDefinitions.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
targetSchemaobjectThe request data or link target.
The schema that describes the link target.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
definitionsobjectDefinitions.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
processor_responseobjectThe processor response information for payment requests, such as direct credit card transactions.
An object that provides additional processor information for a direct credit card transaction.
avs_codestring"A", "B", "C", "D", "E", "F", "G", "I", "M", "N", "P", "R", "S", "U", "W", "X", "Y", "Z", "Null", "0", "1", "2", "3", "4"The address verification code for Visa, Discover, Mastercard, or American Express transactions.
cvv_codestring"E", "I", "M", "N", "P", "S", "U", "X", "All others", "0", "1", "2", "3", "4"The card verification value code for for Visa, Discover, Mastercard, or American Express.
response_codestring"0000", "00N7", "0100", "0390", "0500", "0580", "0800", "0880", "0890", "0960", "0R00", "1000", "10BR", "1300", "1310", "1312", "1317", "1320", "1330", "1335", "1340", "1350", "1352", "1360", "1370", "1380", "1382", "1384", "1390", "1393", "5100", "5110", "5120", "5130", "5135", "5140", "5150", "5160", "5170", "5180", "5190", "5200", "5210", "5400", "5500", "5650", "5700", "5710", "5800", "5900", "5910", "5920", "5930", "5950", "6300", "7600", "7700", "7710", "7800", "7900", "8000", "8010", "8020", "8030", "8100", "8110", "8220", "9100", "9500", "9510", "9520", "9530", "9540", "9600", "PCNR", "PCVV", "PP06", "PPRN", "PPAD", "PPAB", "PPAE", "PPAG", "PPAI", "PPAR", "PPAU", "PPAV", "PPAX", "PPBG", "PPC2", "PPCE", "PPCO", "PPCR", "PPCT", "PPCU", "PPD3", "PPDC", "PPDI", "PPDV", "PPDT", "PPEF", "PPEL", "PPER", "PPEX", "PPFE", "PPFI", "PPFR", "PPFV", "PPGR", "PPH1", "PPIF", "PPII", "PPIM", "PPIT", "PPLR", "PPLS", "PPMB", "PPMC", "PPMD", "PPNC", "PPNL", "PPNM", "PPNT", "PPPH", "PPPI", "PPPM", "PPQC", "PPRE", "PPRF", "PPRR", "PPS0", "PPS1", "PPS2", "PPS3", "PPS4", "PPS5", "PPS6", "PPSC", "PPSD", "PPSE", "PPTE", "PPTF", "PPTI", "PPTR", "PPTT", "PPTV", "PPUA", "PPUC", "PPUE", "PPUI", "PPUP", "PPUR", "PPVC", "PPVE", "PPVT"Processor response code for the non-PayPal payment processor errors.
payment_advice_codestring"01", "02", "03", "04", "21", "22", "24", "25", "26", "27", "28", "29", "30", "40", "43"The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.