Skip to main content
POST
Simulate a stored credential

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
user_id
string
required

The push identifier for the user

Example:

"user_28CJjV7P4Go5PNJvfzghiD"

type
enum<string>
required

The type of credential to create

Available options:
secure_debit,
card_only_credit,
card_only_debit,
apple_pay,
apple_pay_debit
card_last4
string

The last 4 digits of the card number to display for the credential. Must be exactly 4 digits; generated when omitted.

Pattern: ^[0-9]{4}$
Example:

"9010"

Response

The created credential

id
string
required

The unique identifier assigned by Push

created_at
string<date-time>
required

When the payment credential was created (ISO 8061 date string)

card_last4
string
required

The last 4 digits of the card number

authenticated
boolean
required

For secure_debit credentials, whether the user has authenticated with the bank.

type
enum<string>
required

The type of payment credential:

  • secure_debit: A debit card which can be used for withdrawals and deposits
  • card_only_credit: A credit card which can be used for deposits alone
  • card_only_debit: A debit card which can be used for deposits alone
  • apple_pay_debit: A debit card stored via Apple Pay which can be used for withdrawals alone
Available options:
secure_debit,
card_only_credit,
card_only_debit,
apple_pay_debit
account_last4
string | null
required

For authenticated secure_debit credentials, the last 4 digits of the bank account number for the user's account. This field is null otherwise.

bank_name
string | null
required

For secure_debit credentials, the name of the user's bank. This field is null otherwise.