Sign in

v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
Cards

Get a Card by an ID

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint retrieves a specific Debit Card for a User based on the unique Card ID.

get/v1/cards/{id}

Path parameters

idstring required

The unique ID of the Card

Response

Successful response

idstring

Unique card ID

activeboolean

Whether or not the card is active with the issuing bank

address_verifiedboolean

AVS response from debit networks

card_companystring

Name of card company

card_fingerprintstring

A unique identifier derived from the card number

card_type'debit' | 'prepaid' | 'credit' | 'unknown'

The type of card

citystring

The city of the card billing address

createdstring date-time

Date and time of card creation

expiration_datestring

Month/Year of card expiration

first_namestring

The first name of card user

first_six_digitsstring

The provided Bank Identification Number (BIN)

last_four_digitsstring

Last 4 digits of the card number

last_namestring

The last name of card user

name_verification_result'Match' | 'No Match' | 'Partial Match' | 'Unknown'

The ANI results from the issuing bank of the card

product_type'Consumer' | 'Business' | 'Commercial' | 'Unknown'

The product type of the card

pull_enabledboolean

Whether or not the card is enabled for pull transactions

push_enabledboolean

Whether or not the card is enabled for push transactions

aft_enabledboolean

If true, this card is allowed to be used as a source in routines.

oct_enabledboolean

If true, this card is allowed to be used as a desetination in routines.

removedboolean

Whether or not the user has removed the card

reviewed_atstring date-time

The date and time the Card was reviewed

review_status'approved' | 'flagged' | 'rejected'

(Deprecated) Review status of the card

statestring

Card address state

status'approved' | 'flagged' | 'rejected' | 'removed'

The status of the card (Card Statuses)

street_line_1string

The street line 1 of the card billing address

street_line_2string

The street line 2 of the card billing address

zip_codestring

The zip code of the card billing address