Card Response

The payment card to use to fund a payment. Card can be a credit or debit card.

bin_detailsobject<bin_details>Optional

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

stored_credentialobject<card_stored_credential>Optional

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.

card_stored_credential properties

4 properties

payment_typeenum<stored_payment_source_payment_type>Required

Indicates the type of the stored payment_source payment.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"ONE_TIME"
"RECURRING"
"UNSCHEDULED"

usageenum<stored_payment_source_usage_type>Optional

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

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"FIRST"
"SUBSEQUENT"
"DERIVED"Default

previous_network_transaction_referenceobject<network_transaction_reference>Optional

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

The payment card to use to fund a payment. Card can be a credit or debit card.

bin_detailsobject<bin_details>Optional

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

stored_credentialobject<card_stored_credential>Optional

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.

card_stored_credential properties

4 properties

payment_typeenum<stored_payment_source_payment_type>Required

Indicates the type of the stored payment_source payment.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"ONE_TIME"
"RECURRING"
"UNSCHEDULED"

usageenum<stored_payment_source_usage_type>Optional

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

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"FIRST"
"SUBSEQUENT"
"DERIVED"Default

previous_network_transaction_referenceobject<network_transaction_reference>Optional

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

Card Response

authentication_response properties

three_d_secure_authentication_response properties

card_attributes_response properties

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

card_from_request properties

bin_details properties

card_stored_credential properties

network_transaction_reference properties

Back to top

On this page

On this page

Card Response

authentication_response properties

three_d_secure_authentication_response properties

card_attributes_response properties

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

card_from_request properties

bin_details properties

card_stored_credential properties

network_transaction_reference properties

Back to top

On this page

Card Response

authentication_response properties

three_d_secure_authentication_response properties

card_attributes_response properties

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

card_from_request properties

bin_details properties

card_stored_credential properties

network_transaction_reference properties

Back to top

On this page

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

authentication_response properties

three_d_secure_authentication_response properties

card_attributes_response properties

card_vault_response properties

link_description properties

card_customer properties

phone_with_type properties

Phone properties

card_from_request properties

bin_details properties

card_stored_credential properties

network_transaction_reference properties

Back to top

On this page