Bulk Card Operations
Overview
Bulk Card Operations enables clients to create, update, or cancel multiple cards in a single request, rather than submitting individual API calls per card.
This functionality is designed to:
- Improve operational efficiency
- Support large-scale card issuance or maintenance activities
- Simplify batch updates and cancellations
Bulk Card Operations is a feature that requires enabling first, speak to the account manager in the first instance to get this set up.
How it works
There's two ways in which a request can be made:
- API
- CSV Upload
The CSV template can be downloaded from the Portal if you are a Portal user, if not please upload your own CSV using the Header Descriptions below.
Once the request has been made, the request will be processed asynchronously and you will be notified when completed.
To send the request use either Bulk Operations Requestfor API requests and Upload CSVfor CSV's requirements, you will get returned an ID that can be used to track Bulk Operation requests as well as the related webhooks for actions completed on cards in the same way you do for standard requests.
Headers in CSV
The headers within the CSV will need to be as follows:
- Operation - This must be either CREATE, UPDATE or CANCEL (required)
- Card ID - This is the VBID for the card (Only required for UPDATE or CANCEL) (required)
- Usage - This must be either SINGLE_USE or MULTI_USE (default is MULTI_USE if left blank) (optional)
- Alias - This is the EXTERNALREF from the create card endpoint (required)
- Account ID - This is the ABID required to do any action on cards (required)
- Product Code - This is the OBID relating to the card product that you have been assigned to create cards (required)
- Limit - This is the limit you wish the card to be used for (required)
- Auth Start - If you are using an Auth Window then add the start date to this header (optional)
- Auth End - If you are using an Auth Window then add the end date to this header (optional)
- Cancel Date - Date you wish to the card to cancel if earlier than expiry date (optional)
- Expiry Date - The expiry date of the card (required)
If you utilise Custom Fields then you can add extra columns as headers in the csv just ensure that the header is named after the Custom Field key you have created
Limitations on any of the headers can be found under the details within the standard API calls
Bulk Operations Management
Along with being able to submit the requests for Bulk Operations you can also manage these items with the following endpoints:
- GET Bulk Operations - to get all active Bulk Operation requests
- GET Bulk Operations by ID - to get back a specific Bulk Operation request
- DELETE Bulk Operations Request - to delete a specific request that has been submitted
Updated about 19 hours ago
