Cards provide a mechanism to easily conduct transactions with merchants both online and in-person. Using our API, the entire card lifecycle—from issuing, to activation, to deactivation—can be managed programmatically. With the ability to issue virtual cards, you can get to market quickly while providing incredible digital experiences for your customers.
id
for the account that the card will be issued against. This can be accomplished by making a GET
request to the account
endpoint.
id
for the account that the card will be issued against.
cardproduct
endpoint is available for reference purposes, but will not allow you to directly configure a card product at this time.
To obtain the id
for the card product that the card will be modeled after, make a GET
request to the cardproduct
endpoint.
id
for the card product that the card will be modeled after.
GET
request to the accounts
endpoint, passing in the ID (shown here as :id) of the account that this card will be issued against (which was retrieved earlier in this exercise).
primary_person_id
which contains the Person ID of the primary account holder. The second is person_ids
which contains an Array of Person IDs representing each of the listed owners for this account.
POST
request to the card
endpoint, passing along the account_id
, card_product_id
, and person_id
.
You may also include optional creation_options
sub-object with name_line_two
text to be printed under the cardholder name, up to a maximum of 21 characters.
status
is set to “unactivated”. Before transactions can be made with this card, the card will need to be activated, which we will cover in the next section.
reissue_pan_from_card_id
field and input an existing card object when creating a card.
{% alert severity=“warning” %} Reissuing a card is a great option when a card may be damaged or about to expire. If a card has been compromised, lost, or stolen it is best to create an entirely new card and PAN. {% /alert %}
PATCH
request to the card
endpoint passing the id
of the card to be updated, and set the status
property to “active” in the request body.