Cards

Overview

The Cards module in the customer API provides essential functionalities related to the financial cards of the customers. It offers two primary endpoints that facilitate the retrieval of card balances and transaction histories.

Here is an overview of the endpoints available within the Cards module:

Card Creation

1. Review Customer Details for Card Creation: Customers / managees that are older than 6 months are required to review and confirm that certain details are up to date. This endpoint will provide details for relevant endpoints

2. Upload Document: This endpoint is used when clients need to upload missing documents in order to create a card.

3. Create Customer Card: Enables users to create a new card for a customer. This is usually the first step in providing a customer with transactional capabilities.

Card Management

1. Activate Card: Used to activate a card for use, this endpoint should only be used once the physical / virtual card is intended to be used.

2. Deactivate Card: Used to deactivate a card, in cases where a card is lost or stolen. Cards may be reactivated at a later date.

3. Change Card PIN - A POST request where users can change the pin of an existing card

Card Analytics

1. Get Customer Cards By Customer: Retrieves a list of all cards issued under the customer's account, offering a consolidated view of the card inventory.

2. Get Card Details by ID: Retrieves details of a single card, including relevant account details.

3. Get Sensitive Card Details by ID: Retrieves sensitive card details of a single card by its ID.

4. Get Card Balances - This GET endpoint allows users to retrieve a list of all the cards available on the customer's account, providing details such as card ID, currency, total balance, available balance, and the status of any pending transactions. Users can also obtain information on whether a card is currently enabled or disabled.

5. Get Card Transactions - A GET request where users can access a detailed list of transactions for a specific card over a defined time period. This endpoint supplies information like transaction ID, card ID, amount, currency, description, transaction date and time, as well as the pending status of the transaction. It is crucial for customers who need to track their spending or review their transaction history for accounting or budgeting purposes.

Money Movement

1. Add Funds to a Card: Facilitates moving of funds between a customer asset account and a card.

2. Move Funds Between Cards: Facilitates movement of funds between two different cards.