Manage Cards

Cards must have a PIN set after they are issued, and the card must be ACTIVE in order to set the PIN. Cardholders can update their PIN after it has been initially set.

• For web-based integrations, Highnote recommends you change a PIN with the Secure Inputs SDK.
• For iOS and Android based integrations, you can securely change a PIN from the API with a Client Token.

Use the following mutation to set a PIN for a Payment Card:

Financial accounts with the DIRECT_DEPOSIT feature have an associated account and routing number used for funds movements originating outside of Highnote.

To display the account and routing number, you can fetch them from the API by generating a Client Token and using that token to view the restricted details.

Use the following query to view direct deposit information:

Once a card is active, you can provide an interface for your Account Holders to "lock" their payment card.

You can connect the mutation SuspendPaymentCard to a toggle element to create the lock card functionality:

You can also provide an interface for your account holders to "unlock" their payment cards.

You can use the ActivatePaymentCard mutation to create the unlock card functionality:

The default maximum expiration date is four years.

When you reissue a card, do not close the first card until you or the cardholder activates the new card. If you are replacing a lost or stolen card, we recommend issuing a new card instead. If the first card is closed before activation, both cards may be closed.

There are several reasons that you may need to reissue a card:

• You need to order a Physical Card with a different expiration date than your existing Virtual Card.
• You need to suspend, terminate and reissue, or replace a card if it is lost, damaged, or stolen.

Reissue allows you to create a new card with the same card number or a different card number for the following use cases:

Example

The following steps outline an example of how you would reissue a card:

1. Call reissuePaymentCard (see example below) to create a new Payment Card. By default, the new Payment Card is a Virtual Card and will be attached to the same Financial Account as the original Payment Card. You may choose to copy the card number and/or PIN from the original Payment Card. You can also choose to reissue a Physical Card if necessary, using an existing or new address for shipping.
2. If copyNumber is true, the new Payment Card will have the same card number as the original Payment Card. You may then also choose to set copyPin to true. If you choose to update the card number, you will not be able to copy the PIN. Note, in this case, the expiration date cannot be in the same month/year as the original Payment Card. Additionally, the original Payment Card cannot be in the CLOSED state.
3. If you are reissuing a Physical Card, while the Physical Card is being printed and shipped to the account holder it is not active, as activateOnCreate is set to false. Note that even if it has the same card number, it will have a different expiration date and CVV. The Virtual Card remains active.
4. When the Physical Card is delivered to the account holder, you may want to activate it. You can only maintain one active reissued payment card at a time. As such, when you activate a reissued card, the old card will immediately be deactivated and no longer accept authorizations.

Closing a Payment Card is permanent and impacts both the Virtual and Physical form factors.

A maximum of 50 locations will be returned per request.

If you are offering Physical Payment Cards with cash withdrawal capabilities, you may want to provide your account holders with the ability to locate ATMs that do not have surcharges.

You can allow your customer to set a PIN for their card. This will be required if you want customers to be able to access ATMs and/or receive cashback at checkout.

Search by radius

Use a radius search when searching around a specific place (address, postal code, landmark, etc.) and you have the locations' map coordinates latitude and longitude. Set distance to the radius of the search circle. The distance is expected to be in miles unless overridden.

Filters allow you to refine your search by including or excluding certain ATM features.

By default, the ATM features included are:

• OPEN_24_HOURS
• DEPOSIT_AVAILABLE
• ACCESSIBLE

When using the include parameter, the list will be filtered to only the included values of available ATM features.

In this example, since the includes field was provided with the value of OPEN_24_HOURS, the results from the API will return only the matching locations.