On this page
No Headings
The payment card to use to fund a payment. Card can be a credit or debit card.
objectnamestring^[\S\s]*$The card holder's name as it appears on the card.
last_digitsstring^.*[0-9]{2,}.*$The last digits of the payment card.
brandobject"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.
The card brand or network. Typically used in the response.
available_networksarrayArray of brands or networks associated with the card.
itemsobject"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.
typeobject"CREDIT", "DEBIT", "PREPAID", "STORE", "UNKNOWN"Type of card. i.e Credit, Debit and so on.
The payment card type.
authentication_resultobjectResults of Authentication such as 3D Secure.
liability_shiftstring"NO", "POSSIBLE", "UNKNOWN"Liability shift indicator. The outcome of the issuer's authentication.
three_d_secureobjectResults of 3D Secure Authentication.
authentication_statusobject"Y", "N", "U", "A", "C", "R", "D", "I"Transactions status result identifier. The outcome of the issuer's authentication.
The outcome of the issuer's authentication.
enrollment_statusobject"Y", "N", "U", "B"Status of Authentication eligibility.
Status of authentication eligibility.
attributesobjectAdditional attributes associated with the use of this card.
vaultobjectThe details about a saved Card payment source.
customerobjectThe details about a customer in PayPal's system of record.
from_requestobjectRepresentation of card details as received in the request.
expiryobject^[0-9]{4}-(0[1-9]|1[0-2])$The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
The card expiration year and month, in Internet date format.
last_digitsstring^.*[0-9]{2,}.*$The last digits of the payment card.
expiryobject^[0-9]{4}-(0[1-9]|1[0-2])$The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.
The card expiration year and month, in Internet date format.
bin_detailsobjectBank Identification Number (BIN) details used to fund a payment.
Bank Identification Number (BIN) details used to fund a payment.
binstring^[0-9]+$The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card.
issuing_bankstring^[\S\s]*$The issuer of the card instrument.
bin_country_codeobject^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO-3166-1 country code of the bank.
productsarrayThe type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE.
itemsstring^[\S\s]*$This value provides the category of the BIN.
stored_credentialobjectProvides 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_initiatorrequiredstring"CUSTOMER", "MERCHANT"The person or party who initiated or triggered the payment.
payment_typerequiredstring"ONE_TIME", "RECURRING", "UNSCHEDULED"Indicates the type of the stored payment_source payment.
usagestring"FIRST", "SUBSEQUENT", "DERIVED""DERIVED"Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file).
previous_network_transaction_referenceobjectReference values used by the card network to identify a transaction.
idrequiredstring^[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.