Payments API

The account identifier for a PayPal account.

The date and time when the transaction occurred, in Internet date and time format.

The date and time when the transaction was last updated, in Internet date and time format.

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.

A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.

The delivery service. Post office box, bag number, or post office name.

The street name. Just Drury in Drury Lane.

The street number.

The street type. For example, avenue, boulevard, road, or expressway.

The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.

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

The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

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, CA and not California. Value, by country, is:

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

A city, town, or village. Smaller than admin_area_level_1.

A sub-locality, suburb, neighborhood, or district. Smaller than admin_area_level_2. Value is:

• Brazil. Suburb, bairro, or neighborhood.
• India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

The neighborhood, ward, or district. Smaller than admin_area_level_3 or sub_locality. Value is:

• The postal sorting code for Guernsey and many French territories, such as French Guiana.
• The fine-grained administrative levels in China.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

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.

The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, address_portable.address_line_1 is usually a combination of address_details.street_number, street_name, and street_type.

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.

The second line of the address, for example, a suite or apartment number.

The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as next to Walmart, or a landmark in an Indian address.

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.

A city, town, or village. Smaller than admin_area_level_1.

The sub-locality, suburb, neighborhood, or district. This is smaller than admin_area_level_2. Value is:

• Brazil. Suburb, bairro, or neighborhood.
• India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.

The neighborhood, ward, or district. This is smaller than admin_area_level_3 or sub_locality. Value is:

• The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
• The fine-grained administrative levels in China.

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

The discount for all items within a given purchase_unit. discount.value can not be a negative number.

The handling fee for all items within a given purchase_unit. handling.value can not be a negative number.

The insurance fee for all items within a given purchase_unit. insurance.value can not be a negative number.

The subtotal for all items. Required if the request includes purchase_units[].items[].unit_amount. Must equal the sum of (items[].unit_amount * items[].quantity) for all items. item_total.value can not be a negative number.

The shipping fee for all items within a given purchase_unit. shipping.value can not be a negative number.

The shipping discount for all items within a given purchase_unit. shipping_discount.value can not be a negative number.

The total tax for all items. Required if the request includes purchase_units.items.tax. Must equal the sum of (items[].tax * items[].quantity) for all items. tax_total.value can not be a negative number.

Apple Pay Hex-encoded device manufacturer identifier.

Apple Pay payment data object which contains the cryptogram, eci_indicator and other data.

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

The possible values are:

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

Apple Pay tokenized credit card used to pay.

The transaction amount for the payment that the payer has approved on apple platform.

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.

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

The possible values are:

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

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

The possible values are:

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

The card expiration year and month, in Internet date format.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

The payment card type.

The possible values are:

• CREDIT. A credit card.
• DEBIT. A debit card.
• PREPAID. A Prepaid card.
• STORE. A store card.
• UNKNOWN. Card type cannot be determined.

Online payment cryptogram, as defined by 3D Secure.

ECI indicator, as defined by 3- Secure.

Encoded Apple Pay EMV Payment Structure used for payments in China.

Bank Key encrypted Apple Pay PIN.

Instrument Id for the asset.

The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.

The possible values are:

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

An object that provides supplementary/additional data related to a payment transaction.

The status for the authorized payment.

The details of the authorized order pending status.

The amount for this authorized payment.

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

The date and time when the authorized payment expires, in Internet date and time format.

The PayPal-generated ID for the authorized payment.

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.

An array of related HATEOAS links.

The level of protection offered as defined by PayPal Seller Protection for Merchants.

The date and time when the transaction occurred, in Internet date and time format.

The date and time when the transaction was last updated, in Internet date and time format.

The status for the authorized payment.

The possible values are:

• CREATED. The authorized payment is created. No captured payments have been made for this authorized payment.
• CAPTURED. The authorized payment has one or more captures against it. The sum of these captured payments is greater than the amount of the original authorized payment.
• DENIED. PayPal cannot authorize funds for this authorized payment.
• EXPIRED. The authorized payment has expired.
• PARTIALLY_CAPTURED. A captured payment was made for the authorized payment for an amount that is less than the amount of the original authorized payment.
• VOIDED. The authorized payment was voided. No more captured payments can be made against this authorized payment.
• PENDING. The created authorization is in pending state. For more information, see status.details.

The details of the authorized order pending status.

The reason why the authorized status is PENDING.

The possible values are:

• PENDING_REVIEW. Authorization is pending manual review.

The two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

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

The two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

The email address of the account holder associated with this payment method.

An object that provides supplementary/additional data related to a payment transaction.

The status of the captured payment.

The details of the captured payment status.

The amount for this captured payment.

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

The funds that are held on behalf of the merchant.

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

The PayPal-generated ID for the captured payment.

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.

An array of related HATEOAS links.

An object that provides additional processor information for a direct credit card transaction.

The level of protection offered as defined by PayPal Seller Protection for Merchants.

The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.

The date and time when the transaction occurred, in Internet date and time format.

The date and time when the transaction was last updated, in Internet date and time format.

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.

An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

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.

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

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.

An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

The payment descriptor on the payer's account statement.

The status of the captured payment.

The possible values are:

• COMPLETED. The funds for this captured payment were credited to the payee's PayPal account.
• DECLINED. The funds could not be captured.
• PARTIALLY_REFUNDED. An amount less than this captured payment's amount was partially refunded to the payer.
• PENDING. The funds for this captured payment was not yet credited to the payee's PayPal account. For more information, see status.details.
• REFUNDED. An amount greater than or equal to this captured payment's amount was refunded to the payer.
• FAILED. There was an error while capturing payment.

The details of the captured payment status.

The reason why the captured payment status is PENDING or DENIED.

The possible values are:

• BUYER_COMPLAINT. The payer initiated a dispute for this captured payment with PayPal.
• CHARGEBACK. The captured funds were reversed in response to the payer disputing this captured payment with the issuer of the financial instrument used to pay for this captured payment.
• ECHECK. The payer paid by an eCheck that has not yet cleared.
• INTERNATIONAL_WITHDRAWAL. Visit your online account. In your **Account Overview**, accept and deny this payment.
• OTHER. No additional specific reason can be provided. For more information about this captured payment, visit your account online or contact PayPal.
• PENDING_REVIEW. The captured payment is pending manual review.
• RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION. The payee has not yet set up appropriate receiving preferences for their account. For more information about how to accept or deny this payment, visit your account online. This reason is typically offered in scenarios such as when the currency of the captured payment is different from the primary holding currency of the payee.
• REFUNDED. The captured funds were refunded.
• TRANSACTION_APPROVED_AWAITING_FUNDING. The payer must send the funds for this captured payment. This code generally appears for manual EFTs.
• UNILATERAL. The payee does not have a PayPal account.
• VERIFICATION_REQUIRED. The payee's PayPal account is not verified.

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.

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

The possible values are:

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

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

The possible values are:

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

The card expiration year and month, in Internet date format.

The PayPal-generated ID for the card.

The last digits of the payment card.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

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.

The payment card type.

The possible values are:

• CREDIT. A credit card.
• DEBIT. A debit card.
• PREPAID. A Prepaid card.
• STORE. A store card.
• UNKNOWN. Card type cannot be determined.

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.

The card expiration year and month, in Internet date format.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

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.

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.

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

The possible values are:

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

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

The possible values are:

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

The card expiration year and month, in Internet date format.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

The payment card type.

The possible values are:

• CREDIT. A credit card.
• DEBIT. A debit card.
• PREPAID. A Prepaid card.
• STORE. A store card.
• UNKNOWN. Card type cannot be determined.

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

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

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, CA and not California. Value, by country, is:

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

A city, town, or village. Smaller than admin_area_level_1.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

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

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

The second line of the address. For example, suite or apartment number.

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, CA and not California. Value, by country, is:

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

A city, town, or village. Smaller than admin_area_level_1.

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

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

The possible values are:

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

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.

The card expiration year and month, in Internet date format.

The card holder's name as it appears on the card.

The primary account number (PAN) for the payment card.

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.

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.

The PayPal-generated ID for the saved card payment source. Typically stored on the merchant's server.

The person or party who initiated or triggered the payment.

The possible values are:

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

Indicates the type of the stored payment_source payment.

The possible values are:

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

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

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

The possible values are:

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

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

The possible values are:

• CREDIT. A credit card.
• DEBIT. A debit card.
• PREPAID. A Prepaid card.
• STORE. A store card.
• UNKNOWN. Card type cannot be determined.

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

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.

The cryptocurrency symbol or code ticker options. Assigned by liquidity providers and exchanges.

The possible values are:

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

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

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

The contact address for the merchant's customer service.

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.

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.

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 year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.

The funds that are held on behalf of the merchant.

The possible values are:

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

The condition that is covered for the transaction.

The possible values are:

• ITEM_NOT_RECEIVED. The payer paid for an item that they did not receive.
• UNAUTHORIZED_TRANSACTION. The payer did not authorize the payment.

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.

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 two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

The PayPal internal ID. Used for correlation purposes.

The message that describes the error.

The human-readable, unique name of the error.

An array of additional details about the error.

The information link, or URI, that shows detailed information about this error for the developer.

An array of request-related HATEOAS links.

The unique, fine-grained application-level error code.

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.

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.

The location of the field that caused the error. Value is body, path, or query.

The value of the field that caused the error.

The source currency from which to convert an amount.

The target currency to which to convert an amount.

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.

The label that overrides the business name in the PayPal account on the PayPal site.

The URL where the customer is redirected after the customer cancels the payment.

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.

The URL where the customer is redirected after the customer approves the payment.

The location from which the shipping address is derived.

The possible values are:

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

The identifier of the instrument.

Describes the URL.

The two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

The two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

The bank identification code (BIC).

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

The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.

The HTTP method required to make the related call.

The unique ID for a customer generated by PayPal.

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

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.

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

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.

The two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

When the party is a person, the party's full name.

When the party is a person, the party's given, or first, name.

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

The prefix, or title, to the party's name.

The suffix for the party's name.

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.

DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.

When the party is a person, the party's full name.

When the party is a person, the party's given, or first, name.

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

The prefix, or title, to the party's name.

The suffix for the party's name.

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.

The full name representation like Mr J Smith.

The converted payable amount.

The exchange rate that determines the amount that was debited from the merchant's PayPal account.

The net amount debited from the merchant's PayPal account.

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.

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

The possible values are:

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

The date that the transaction was authorized by the scheme. For MasterCard, this is the "BankNet reference date" field in response.

The API caller-provided external invoice number for the order. It appears in the payer's transaction history.

The API caller-provided information about the store. It is supported only for Point of Sale transactions.

Custom memo about the transaction.

Indicates merchant's preference of the payment methods to fund the transaction.

The possible values are:

• ANY. The merchant does not have a preference. Use any available funding source.
• INSTANT. Use the merchant's balance as the funding source.
• ECHECK. The merchant prefers using the eCheck funding source. If the merchant's PayPal balance can cover the refund amount, use the PayPal balance.

The two-character ISO 3166-1 country code.

The email address of the account holder associated with this payment method.

The name of the account holder associated with this payment method.

The operation.

The possible values are:

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

The JSON Pointer to the target document location from which to move the value. Required for the move operation.

The JSON Pointer to the target document location at which to complete the operation.

The value to apply. The remove operation does not require a value.

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

The label that overrides the business name in the PayPal account on the PayPal site.

The URL where the customer is redirected after the customer cancels the payment.

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.

The URL where the customer is redirected after the customer approves the payment.

The location from which the shipping address is derived.

The payee's customer service contact instructions provided to the payer.

The URL to the logo of the payment method.

The email address of merchant.

The encrypted PayPal account ID of the merchant.

The person or party who initiated or triggered the payment.

The possible values are:

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

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.

The possible values are:

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

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.

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.

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.

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.

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

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

The extension number.

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

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

The extension number.

The fee for this transaction.

The recipient of the fee for this transaction. If you omit this value, the default is the API caller.

The fee for this transaction.

The API caller-provided external store identification number.

The API caller-provided external terminal identification number.

The address verification code for Visa, Discover, Mastercard, or American Express transactions.

The possible values are:

• A. For Visa, Mastercard, or Discover transactions, the address matches but the zip code does not match. For American Express transactions, the card holder address is correct.
• B. For Visa, Mastercard, or Discover transactions, the address matches. International A.
• C. For Visa, Mastercard, or Discover transactions, no values match. International N.
• D. For Visa, Mastercard, or Discover transactions, the address and postal code match. International X.
• E. For Visa, Mastercard, or Discover transactions, not allowed for Internet or phone transactions. For American Express card holder, the name is incorrect but the address and postal code match.
• F. For Visa, Mastercard, or Discover transactions, the address and postal code match. UK-specific X. For American Express card holder, the name is incorrect but the address matches.
• G. For Visa, Mastercard, or Discover transactions, global is unavailable. Nothing matches.
• I. For Visa, Mastercard, or Discover transactions, international is unavailable. Not applicable.
• M. For Visa, Mastercard, or Discover transactions, the address and postal code match. For American Express card holder, the name, address, and postal code match.
• N. For Visa, Mastercard, or Discover transactions, nothing matches. For American Express card holder, the address and postal code are both incorrect.
• P. For Visa, Mastercard, or Discover transactions, postal international Z. Postal code only.
• R. For Visa, Mastercard, or Discover transactions, re-try the request. For American Express, the system is unavailable.
• S. For Visa, Mastercard, Discover, or American Express, the service is not supported.
• U. For Visa, Mastercard, or Discover transactions, the service is unavailable. For American Express, information is not available. For Maestro, the address is not checked or the acquirer had no response. The service is not available.
• W. For Visa, Mastercard, or Discover transactions, whole ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.
• X. For Visa, Mastercard, or Discover transactions, exact match of the address and the nine-digit ZIP code. For American Express, the card holder name, address, and postal code are all incorrect.
• Y. For Visa, Mastercard, or Discover transactions, the address and five-digit ZIP code match. For American Express, the card holder address and postal code are both correct.
• Z. For Visa, Mastercard, or Discover transactions, the five-digit ZIP code matches but no address. For American Express, only the card holder postal code is correct.
• Null. For Maestro, no AVS response was obtained.
• 0. For Maestro, all address information matches.
• 1. For Maestro, none of the address information matches.
• 2. For Maestro, part of the address information matches.
• 3. For Maestro, the merchant did not provide AVS information. It was not processed.
• 4. For Maestro, the address was not checked or the acquirer had no response. The service is not available.

The card verification value code for for Visa, Discover, Mastercard, or American Express.

The possible values are:

• E. For Visa, Mastercard, Discover, or American Express, error - unrecognized or unknown response.
• I. For Visa, Mastercard, Discover, or American Express, invalid or null.
• M. For Visa, Mastercard, Discover, or American Express, the CVV2/CSC matches.
• N. For Visa, Mastercard, Discover, or American Express, the CVV2/CSC does not match.
• P. For Visa, Mastercard, Discover, or American Express, it was not processed.
• S. For Visa, Mastercard, Discover, or American Express, the service is not supported.
• U. For Visa, Mastercard, Discover, or American Express, unknown - the issuer is not certified.
• X. For Visa, Mastercard, Discover, or American Express, no response. For Maestro, the service is not available.
• All others. For Visa, Mastercard, Discover, or American Express, error.
• 0. For Maestro, the CVV2 matched.
• 1. For Maestro, the CVV2 did not match.
• 2. For Maestro, the merchant has not implemented CVV2 code handling.
• 3. For Maestro, the merchant has indicated that CVV2 is not present on card.
• 4. For Maestro, the service is not available.

The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes.

The possible values are:

• 01. For Mastercard, expired card account upgrade or portfolio sale conversion. Obtain new account information before next billing cycle.
• 02. For Mastercard, over credit limit or insufficient funds. Retry the transaction 72 hours later. For Visa, the card holder wants to stop only one specific payment in the recurring payment relationship. The merchant must NOT resubmit the same transaction. The merchant can continue the billing process in the subsequent billing period.
• 03. For Mastercard, account closed as fraudulent. Obtain another type of payment from customer due to account being closed or fraud. Possible reason: Account closed as fraudulent. For Visa, the card holder wants to stop all recurring payment transactions for a specific merchant. Stop recurring payment requests.
• 21. For Mastercard, the card holder has been unsuccessful at canceling recurring payment through merchant. Stop recurring payment requests. For Visa, all recurring payments were canceled for the card number requested. Stop recurring payment requests.

Processor response code for the non-PayPal payment processor errors.

The possible values are:

• 0000. APPROVED.
• 00N7. CVV2_FAILURE_POSSIBLE_RETRY_WITH_CVV.
• 0100. REFERRAL.
• 0390. ACCOUNT_NOT_FOUND.
• 0500. DO_NOT_HONOR.
• 0580. UNAUTHORIZED_TRANSACTION.
• 0800. BAD_RESPONSE_REVERSAL_REQUIRED.
• 0880. CRYPTOGRAPHIC_FAILURE.
• 0R00. CANCELLED_PAYMENT.
• 1000. PARTIAL_AUTHORIZATION.
• 10BR. ISSUER_REJECTED.
• 1300. INVALID_DATA_FORMAT.
• 1310. INVALID_AMOUNT.
• 1312. INVALID_TRANSACTION_CARD_ISSUER_ACQUIRER.
• 1317. INVALID_CAPTURE_DATE.
• 1320. INVALID_CURRENCY_CODE.
• 1330. INVALID_ACCOUNT.
• 1335. INVALID_ACCOUNT_RECURRING.
• 1340. INVALID_TERMINAL.
• 1350. INVALID_MERCHANT.
• 1360. BAD_PROCESSING_CODE.
• 1370. INVALID_MCC.
• 1380. INVALID_EXPIRATION.
• 1382. INVALID_CARD_VERIFICATION_VALUE.
• 1384. INVALID_LIFE_CYCLE_OF_TRANSACTION.
• 1390. INVALID_ORDER.
• 1393. TRANSACTION_CANNOT_BE_COMPLETED.
• 5100. GENERIC_DECLINE.
• 5110. CVV2_FAILURE.
• 5120. INSUFFICIENT_FUNDS.
• 5130. INVALID_PIN.
• 5135. DECLINED_PIN_TRY_EXCEEDED.
• 5140. CARD_CLOSED.
• 5150. PICKUP_CARD_SPECIAL_CONDITIONS. Try using another card. Do not retry the same card.
• 5160. UNAUTHORIZED_USER.
• 5170. AVS_FAILURE.
• 5180. INVALID_OR_RESTRICTED_CARD. Try using another card. Do not retry the same card.
• 5190. SOFT_AVS.
• 5200. DUPLICATE_TRANSACTION.
• 5210. INVALID_TRANSACTION.
• 5400. EXPIRED_CARD.
• 5500. INCORRECT_PIN_REENTER.
• 5650. DECLINED_SCA_REQUIRED.
• 5700. TRANSACTION_NOT_PERMITTED. Outside of scope of accepted business.
• 5710. TX_ATTEMPTS_EXCEED_LIMIT.
• 5800. REVERSAL_REJECTED.
• 5900. INVALID_ISSUE.
• 5910. ISSUER_NOT_AVAILABLE_NOT_RETRIABLE.
• 5920. ISSUER_NOT_AVAILABLE_RETRIABLE.
• 5930. CARD_NOT_ACTIVATED.
• 6300. ACCOUNT_NOT_ON_FILE.
• 7600. APPROVED_NON_CAPTURE.
• 7700. ERROR_3DS.
• 7710. AUTHENTICATION_FAILED.
• 7800. BIN_ERROR.
• 7900. PIN_ERROR.
• 8000. PROCESSOR_SYSTEM_ERROR.
• 8010. HOST_KEY_ERROR.
• 8020. CONFIGURATION_ERROR.
• 8030. UNSUPPORTED_OPERATION.
• 8100. FATAL_COMMUNICATION_ERROR.
• 8110. RETRIABLE_COMMUNICATION_ERROR.
• 8220. SYSTEM_UNAVAILABLE.
• 9100. DECLINED_PLEASE_RETRY. Retry.
• 9500. SUSPECTED_FRAUD. Try using another card. Do not retry the same card.
• 9510. SECURITY_VIOLATION.
• 9520. LOST_OR_STOLEN. Try using another card. Do not retry the same card.
• 9530. HOLD_CALL_CENTER. The merchant must call the number on the back of the card. POS scenario.
• 9540. REFUSED_CARD.
• 9600. UNRECOGNIZED_RESPONSE_CODE.
• PCNR. CONTINGENCIES_NOT_RESOLVED.
• PCVV. CVV_FAILURE.
• PPAD. BILLING_ADDRESS.
• PPAE. AMEX_DISABLED.
• PPAG. ADULT_GAMING_UNSUPPORTED.
• PPAI. AMOUNT_INCOMPATIBLE.
• PPAR. AUTH_RESULT.
• PPAU. MCC_CODE.
• PPAV. ARC_AVS.
• PPAX. AMOUNT_EXCEEDED.
• PPBG. BAD_GAMING.
• PPC2. ARC_CVV.
• PPCE. CE_REGISTRATION_INCOMPLETE.
• PPCO. COUNTRY.
• PPCR. CREDIT_ERROR.
• PPCT. CARD_TYPE_UNSUPPORTED.
• PPCU. CURRENCY_USED_INVALID.
• PPD3. SECURE_ERROR_3DS.
• PPDC. DCC_UNSUPPORTED.
• PPDI. DINERS_REJECT.
• PPDV. AUTH_MESSAGE.
• PPEF. EXPIRED_FUNDING_INSTRUMENT.
• PPEL. EXCEEDS_FREQUENCY_LIMIT.
• PPER. INTERNAL_SYSTEM_ERROR.
• PPEX. EXPIRY_DATE.
• PPFE. FUNDING_SOURCE_ALREADY_EXISTS.
• PPFI. INVALID_FUNDING_INSTRUMENT.
• PPFR. RESTRICTED_FUNDING_INSTRUMENT.
• PPFV. FIELD_VALIDATION_FAILED.
• PPGR. GAMING_REFUND_ERROR.
• PPH1. H1_ERROR.
• PPIF. IDEMPOTENCY_FAILURE.
• PPII. INVALID_INPUT_FAILURE.
• PPIM. ID_MISMATCH.
• PPIT. INVALID_TRACE_ID.
• PPLR. LATE_REVERSAL.
• PPLS. LARGE_STATUS_CODE.
• PPMB. MISSING_BUSINESS_RULE_OR_DATA.
• PPMC. BLOCKED_Mastercard.
• PPMD. PPMD.
• PPNC. NOT_SUPPORTED_NRC.
• PPNL. EXCEEDS_NETWORK_FREQUENCY_LIMIT.
• PPNT. NETWORK_ERROR.
• PPPH. NO_PHONE_FOR_DCC_TRANSACTION.
• PPPI. INVALID_PRODUCT.
• PPPM. INVALID_PAYMENT_METHOD.
• PPQC. QUASI_CASH_UNSUPPORTED.
• PPRE. UNSUPPORT_REFUND_ON_PENDING_BC.
• PPRF. INVALID_PARENT_TRANSACTION_STATUS.
• PPRR. MERCHANT_NOT_REGISTERED.
• PPS0. BANKAUTH_ROW_MISMATCH.
• PPS1. BANKAUTH_ROW_SETTLED.
• PPS2. BANKAUTH_ROW_VOIDED.
• PPS3. BANKAUTH_EXPIRED.
• PPS4. CURRENCY_MISMATCH.
• PPS5. CREDITCARD_MISMATCH.
• PPS6. AMOUNT_MISMATCH.
• PPSC. ARC_SCORE.
• PPSD. STATUS_DESCRIPTION.
• PPSE. AMEX_DENIED.
• PPTE. VERIFICATION_TOKEN_EXPIRED.
• PPTF. INVALID_TRACE_REFERENCE.
• PPTI. INVALID_TRANSACTION_ID.
• PPTR. VERIFICATION_TOKEN_REVOKED.
• PPTT. TRANSACTION_TYPE_UNSUPPORTED.
• PPTV. INVALID_VERIFICATION_TOKEN.
• PPUA. USER_NOT_AUTHORIZED.
• PPUC. CURRENCY_CODE_UNSUPPORTED.
• PPUE. UNSUPPORT_ENTITY.
• PPUI. UNSUPPORT_INSTALLMENT.
• PPUP. UNSUPPORT_POS_FLAG.
• PPUR. UNSUPPORTED_REVERSAL.
• PPVC. VALIDATE_CURRENCY.
• PPVE. VALIDATION_ERROR.
• PPVT. VIRTUAL_TERMINAL_UNSUPPORTED.

The amount to reauthorize for an authorized payment.

The status of the refund.

The details of the refund status.

The amount that the payee refunded to the payer.

The PayPal-generated ID for the refund.

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.

An array of related HATEOAS links.

The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

The breakdown of the refund.

The date and time when the transaction occurred, in Internet date and time format.

The date and time when the transaction was last updated, in Internet date and time format.

The amount to refund. To refund a portion of the captured amount, specify an amount. If amount is not specified, an amount equal to captured amount - previous refunds is refunded. The amount must be a positive number and in the same currency as the one in which the payment was captured.

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.

The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.

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.

The status of the refund.

The possible values are:

• CANCELLED. The refund was cancelled.
• FAILED. The refund could not be processed.
• PENDING. The refund is pending. For more information, see status_details.reason.
• COMPLETED. The funds for this transaction were debited to the customer's account.

The details of the refund status.

The reason why the refund has the PENDING or FAILED status.

The possible values are:

• ECHECK. The customer's account is funded through an eCheck, which has not yet cleared.

Authorization ID related to the resource.

Capture ID related to the resource.

Order ID related to the resource.

The amount that the payee refunded to the payer.

The net amount that the payee's account is debited in the transaction currency. The net amount is calculated as gross_amount minus paypal_fee minus platform_fees.

An array of breakdown values for the net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the payee holds their funds.

The net amount that the payee's account is debited in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

The PayPal fee that was refunded to the payer in the currency of the transaction. This fee might not match the PayPal fee that the payee paid when the payment was captured.

The PayPal fee that was refunded to the payer in the receivable currency. Returned only in cases when the receivable currency is different from transaction currency. Example 'CNY'.

An array of platform or partner fees, commissions, or brokerage fees for the refund.

The total amount refunded from the original capture to date. For example, if a payer makes a $100 purchase and was refunded $20 a week ago and was refunded $30 in this refund, the gross_amount is $30 for this refund and the total_refunded_amount is $50.

An array of conditions that are covered for the transaction.

Indicates whether the transaction is eligible for seller protection. For information, see PayPal Seller Protection for Merchants.

The possible values are:

• ELIGIBLE. Your PayPal balance remains intact if the customer claims that they did not receive an item or the account holder claims that they did not authorize the payment.
• PARTIALLY_ELIGIBLE. Your PayPal balance remains intact if the customer claims that they did not receive an item.
• NOT_ELIGIBLE. This transaction is not eligible for seller protection.

The amount for this captured payment in the currency of the transaction.

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.

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.

The applicable fee for this captured payment in the currency of the transaction.

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

An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.

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.

The method by which the payer wants to get their items.

The possible values are:

• SHIPPING. The payer intends to receive the items at a specified address.
• PICKUP. The payer intends to pick up the items at a specified address. For example, a store address.

The two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

Indicates the type of the stored payment_source payment.

The possible values are:

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

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

The possible values are:

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

Identifiers related to a specific resource.

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.

An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.

The customer's tax ID value.

The customer's tax ID type.

The possible values are:

• BR_CPF. The individual tax ID type, typically is 11 characters long.
• BR_CNPJ. The business tax ID type, typically is 14 characters long.

The ISO-8601-formatted length of time in years, months, weeks, days, hours, minutes, and seconds.

Note: The format is PyYmMdDThHmMsS. When an amount is zero, you can omit it. Because week cannot co-exist with other time components in ISO-8601 duration, specify P7D. Make provisions to incorporate the effects of daylight savings time.

The PayPal-generated ID for the token.

The tokenization method that generated the ID.

The possible values are:

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

The two-character ISO 3166-1 country code.

The name of the account holder associated with this payment method.

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.