Card Response

Full representation of a Card Payment Token including network token.

Schema Information

Type:object

Properties

name

Type: string

Pattern: ^[A-Za-z ]+$

Min length: 2

Max length: 300

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

last_digits

Type: string

Pattern: [0-9]{2,}

Min length: 2

Max length: 4

The last digits of the payment card.

brand

Type: string

Enum:

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

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

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

expiry

Type: string

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$

Min length: 7

Max length: 7

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

billing_address

Type: object

Address request details.

address_line_1

Type: string

Max length: 300

The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

address_line_2

Type: string

Max length: 300

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

admin_area_2

Type: string

Max length: 120

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

admin_area_1

Type: string

Max length: 300

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:

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

postal_code

Type: string

Max length: 60

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_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

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.

id

Type: string

Pattern: ^[0-9A-Za-z-_]+$

Min length: 1

Max length: 36

The resource ID of the address.

verification_status

Type: string

Enum: "VERIFIED", "FAILED"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Card Verification status.

verification

Type: object

Card Verification details including the authorization details and 3D SECURE details.

network_transaction_id

Type: string

Pattern: ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

Min length: 1

Max length: 1024

DEPRECATED. This field is DEPRECATED. Please find the network transaction id data in the 'id' field under the 'network_transaction_reference' object instead of the 'verification' object.

date

Type: string

Pattern: ^[0-9]+$

Min length: 4

Max length: 4

DEPRECATED. This field is DEPRECATED. Please find the date data in the 'date' field under the 'network_transaction_reference' object instead of the 'verification' object.

network

Type: string

Enum:

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

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

DEPRECATED. This field is DEPRECATED. Please find the network data in the 'network' field under the 'network_transaction_reference' object instead of the 'verification' object.

time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

DEPRECATED. This field is DEPRECATED. Please find the time data in the 'time' field under the 'network_transaction_reference' object instead of the 'verification' object.

amount

Type: object

The amount used for card verification.

currency_coderequired

Type: string

Min length: 3

Max length: 3

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

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

processor_response

Type: object

The processor response information for payment requests, such as direct credit card transactions.

avs_code

Type: string

Enum:

"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_code

Type: string

Enum: "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.

three_d_secure

DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in the 'three_d_secure' object under the 'authentication_result' object instead of the 'verification' object.

network_transaction_reference

Type: object

Previous network transaction reference including id in response.

authentication_result

Type: object

Results of Authentication such as 3D Secure.

three_d_secure

Type: object

Results of 3D Secure Authentication.

authentication_status

Type: string

Enum: "Y", "N", "U", "A", "C", "R", "D", "I"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The outcome of the issuer's authentication.

enrollment_status

Type: string

Enum: "Y", "N", "U", "B"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Status of authentication eligibility.

authentication_id

Type: string

Pattern: ^[0-9a-zA-Z_-]+$

Min length: 1

Max length: 255

The externally received 3ds authentication id, to be returned in card detokenization response.

bin_details

Type: object

Bank Identification Number (BIN) details used to fund a payment.

bin

Type: string

Pattern: ^[0-9]+$

Min length: 1

Max length: 25

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_bank

Type: string

Min length: 1

Max length: 64

The issuer of the card instrument.

bin_country_code

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO-3166-1 country code of the bank.

products

Type: array

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

Array Items

items

Type: string

Min length: 1

Max length: 255

This value provides the category of the BIN.

type

Type: string

Enum: "CREDIT", "DEBIT", "PREPAID", "STORE", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The payment card type.

network_token

Properties

name

Type: string

Pattern: ^[A-Za-z ]+$

Min length: 2

Max length: 300

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

last_digits

Type: string

Pattern: [0-9]{2,}

Min length: 2

Max length: 4

The last digits of the payment card.

brand

Type: string

Enum:

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

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

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

expiry

Type: string

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$

Min length: 7

Max length: 7

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

billing_address

Type: object

Address request details.

address_line_1

Type: string

Max length: 300

The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

address_line_2

Type: string

Max length: 300

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

admin_area_2

Type: string

Max length: 120

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

admin_area_1

Type: string

Max length: 300

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

postal_code

Type: string

Max length: 60

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_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

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.

id

Type: string

Pattern: ^[0-9A-Za-z-_]+$

Min length: 1

Max length: 36

The resource ID of the address.

verification_status

Type: string

Enum: "VERIFIED", "FAILED"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Card Verification status.

verification

Type: object

Card Verification details including the authorization details and 3D SECURE details.

network_transaction_id

Type: string

Pattern: ^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$

Min length: 1

Max length: 1024

DEPRECATED. This field is DEPRECATED. Please find the network transaction id data in the 'id' field under the 'network_transaction_reference' object instead of the 'verification' object.

date

Type: string

Pattern: ^[0-9]+$

Min length: 4

Max length: 4

DEPRECATED. This field is DEPRECATED. Please find the date data in the 'date' field under the 'network_transaction_reference' object instead of the 'verification' object.

network

Type: string

Enum:

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

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

DEPRECATED. This field is DEPRECATED. Please find the network data in the 'network' field under the 'network_transaction_reference' object instead of the 'verification' object.

time

Type: string

Format: ppaas_date_time_v3

Pattern:

^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$

Min length: 20

Max length: 64

DEPRECATED. This field is DEPRECATED. Please find the time data in the 'time' field under the 'network_transaction_reference' object instead of the 'verification' object.

amount

Type: object

The amount used for card verification.

currency_coderequired

Type: string

Min length: 3

Max length: 3

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

valuerequired

Type: string

Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Max length: 32

The value, which might be:

An integer for currencies like JPY that are not typically fractional.
A decimal fraction for currencies like TND that are subdivided into thousandths.

For the required number of decimal places for a currency code, see Currency Codes.

processor_response

Type: object

The processor response information for payment requests, such as direct credit card transactions.

avs_code

Type: string

Enum:

"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_code

Type: string

Enum: "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.

three_d_secure

DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in the 'three_d_secure' object under the 'authentication_result' object instead of the 'verification' object.

network_transaction_reference

Type: object

Previous network transaction reference including id in response.

authentication_result

Type: object

Results of Authentication such as 3D Secure.

three_d_secure

Type: object

Results of 3D Secure Authentication.

authentication_status

Type: string

Enum: "Y", "N", "U", "A", "C", "R", "D", "I"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The outcome of the issuer's authentication.

enrollment_status

Type: string

Enum: "Y", "N", "U", "B"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Status of authentication eligibility.

authentication_id

Type: string

Pattern: ^[0-9a-zA-Z_-]+$

Min length: 1

Max length: 255

The externally received 3ds authentication id, to be returned in card detokenization response.

bin_details

Type: object

Bank Identification Number (BIN) details used to fund a payment.

bin

Type: string

Pattern: ^[0-9]+$

Min length: 1

Max length: 25

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_bank

Type: string

Min length: 1

Max length: 64

The issuer of the card instrument.

bin_country_code

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO-3166-1 country code of the bank.

products

Type: array

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

Array Items

items

Type: string

Min length: 1

Max length: 255

This value provides the category of the BIN.

type

Type: string

Enum: "CREDIT", "DEBIT", "PREPAID", "STORE", "UNKNOWN"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

The payment card type.

network_token

Card Response

Schema Information

Properties

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Card Response

Schema Information

Properties