Activate Card The endpoint /cards/v1/activation enables you to activate a physical card and also set up a PIN.

We will validate that you meet the requirements detailed in the documentation.

Card events Add this endpoint to your service so that we can communicate the latest news about your cards in real time.

If you have doubts about how to set up a webhook, visit our documentation.

Considerations# We expect a response in the 2XX range to ensure that you've received the notification. Otherwise, we'll resend it.

Types of Events#

• ACTIVATION: We will notify you every time one of your customers activates their card.

Create Batch of Innominate Cards The endpoint /cards/v1/batches enables you to create a batch of innominate cards.

We will validate that you meet the requirements detailed in the documentation.

Considerations

• Each batch can contain a maximum of 1,000 cards.
• The shipping address is mandatory when distribution type is CLIENT.
• We will process the call asynchronously, i.e. the cards may not be available immediately.

Create Card The endpoint /cards/v1/ enables you to create a new physical or virtual card.

We will validate that you meet the requirements detailed in the documentation.

Create Multiple Batches of Innominates The endpoint /cards/v1/batches/bulk allows you to create up to 15 batches of innominate cards at the same time.

We will validate that you meet the requirements detailed in the documentation.

Considerations#

• Each batch can contain a maximum of 1,000 cards.
• The shipping address is mandatory when distribution type is CLIENT.
• We will process the call asynchronously, i.e. the cards may not be available immediately.

Get Affinity Group The endpoint '/config/affinity-groups/{id}' allows to obtain information about a particular affinity group.

Get Card The endpoint /cards/v1/{id} enables retrieving information about a particular card.

Considerations

• The extend parameter is used to obtain additional data from a card, and to use it, you must have a valid and current PCI-DSS certification, backed by the ROC report. If you do not have the certification, follow the steps in this documentation.
• If you have contracted dynamic CVV, you will see the cvv_expiration_time field that determines the validity of the new code. Learn more about dynamic CVV.

Search Cards The endpoint /cards/v1/ enables searching for a group of cards based on the attributes specified.

You can filter and sort cards by following this documentation.

The possible sorting attributes are:

• card_type
• user_id
• status
• affinity_group_id
• status_detail
• shipment_id
• innominate
• start_date.

Update Card The endpoint /cards/v1/{id} enables updating a card’s status, affinity group, and PIN.

Considerations# You will need to specify a reason from the list below in order to update a card status:

Update Card Batch Shipping The endpoint /cards/v1/batches/shipments/{shipmentId} enables updating the shipping address of a batch of cards.

Considerations# The card batch must be physical, innominate and have a CREATED status.

Update Card Shipping The endpoint /cards/v1/{id}/shipment enables updating the shipping address of a card.

Considerations# The card must be physical, nominate and have a CREATED status.