GuidesChangelog
Guides

About Cards

Suggest Edits

Overview

A debit card is a card that is associated with a deposit account and can be used to withdraw money via an ATM or make electronic purchases at a merchant.

Card Creation

To create a debit card, a valid deposit account number must be supplied along with debit card specific information. The initial status of a newly submitted card will be PendingCardIssuance. When the card is successfully created the status will be CardIssued. The first card created is the primary card on the account. Once the first card is created, secondary cards can be added to the account.

AccountNumber - Deposit account number
Name – Name of Card User
MailingAddress – Mailing address for the card
Phone – Preferred contact number
EmailAddress – Preferred contact email address

POST /debitcards/v1/cards 
{
  "accountNumber": "1234567890",
  "name": {
    "firstName": "John",
    "middleInitial": "J",
    "lastName": "Smith",
    "suffix": "Jr",
    "title": "Mr"
  },
  "mailingAddress": {
    "street1": "123 Maple Lane",
    "street2": "Apt. 1",
    "city": "New York",
    "state": "NY",
    "postalCode": "10025",
    "countryCode": "US"
  },
  "phone": {
    "phoneType": "Home",
    "phoneNumber": "2015551234"
  },
  "emailAddress": "[email protected]"
}

{
  "id": "00000000-0000-0000-0000-000000000000",
  "accountNumber": "1234567890",
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "productId": "00000000-0000-0000-0000-000000000000",
  "status": "PendingCardIssuance",
  "openedAt": "2019-11-05T06:34:37.595Z",
  "lastModifiedAt": "2019-11-05T06:34:37.595Z",
  "name": {
    "firstName": "John",
    "middleInitial": "J",
    "lastName": "Smith",
    "suffix": "Jr",
    "title": "Mr"
  },
  "mailingAddress": {
    "street1": "123 Maple Lane",
    "street2": "Apt. 1",
    "city": "New York",
    "state": "NY",
    "postalCode": "10025",
    "countryCode": "US"
  },
  "phone": {
    "phoneType": "Home",
    "phoneNumber": "2015551234"
  },
  "emailAddress": "[email protected]",
  "panLastFour": "9999",
  "isPrimary": true,
  "enrollmentStatus": "NotSubmitted",
  "previousCardId": "00000000-0000-0000-0000-000000000000",
  "isPinSet": true,
  "expirationDate": "2021-11-05T06:34:37.595Z"
}

Card Activation

Cards cannot be used until activated. They are initially set to a status of CardIssued. Once you are ready to activate the card for use, call the Activate Card endpoint.

POST /debitcards/v1/cards/{id}/activate

Cards can alternately be activated using the card number and CVV2 number. A common usage of this would be to allow the cardholder to enter the details of the card they've received by mail into an online form in order to activate it.

POST /debitcards/v1/cardholder/card/activate
{
  "pan": "9999999999999999",
  "cvv2": "123",
  "postalCode": "10025"
}

Card Status Changes

Call the Suspend endpoint to temporarily make a card inactive:

POST /debitcards/v1/cards/{id}/suspend

Cards can be changed from Suspended to Active by using the Reactivate endpoint:

POST /debitcards/v1/cards/{id}/reactivate

Use the Close endpoint to close the card. Note that once the card is closed, it cannot be reactivated.

POST /debitcards/v1/cards/{id}/close

❗️

Caution

If the primary card on the account closed, all seconardary cards on an account will also closed, primary cards can be identified by the property IsPrimary = true

Card Profile

Card Name, Mailing Address, Phone and Email Address can be modified using the profile endpoint:

PUT /debitcards/v1/cards/{id}/profile 
{
  "name": {
    "firstName": "John",
    "middleInitial": "J",
    "lastName": "Smith",
    "suffix": "Jr",
    "title": "Mr"
  },
  "mailingAddress": {
    "street1": "456 Maple Lane",
    "street2": "Apt. 5",
    "city": "New York",
    "state": "NY",
    "postalCode": "10025",
    "countryCode": "US"
  },
  "phone": {
    "phoneType": "Home",
    "phoneNumber": "2015551234"
  },
  "emailAddress": "[email protected]"
}

Card Replacement

Damaged lost or stolen cards can be replaced using the Replace endpoint. Damaged cards remain active until the cardholder activates the replacement card. Lost and stolen cards are immediately closed and a replacement card is issued.

POST /debitcards/v1/cards/{id}/replace 
{
  "replaceType": "LostCard",
  "notes": "Customer states card left at restaurant"
}

Set PIN

To initially set a card's PIN number for the first time, the set PIN endpoint should be used:

PUT /debitcards/v1/cards/{id}/pin
{
  "pin": "1234"
}

Note there is a different endpoint (see below) for changing the PIN after initial setup.

PIN Reset

Cards with an existing PIN number can be changed using the PIN Reset endpoint. The isPinSet property will be true for cards which already have a PIN number set.

POST /debitcards/v1/cards/{id}/resetpin 
{
  "pin": "1234"
}

Updated 13 days ago