Card Management API

The Card Management API provides a comprehensive set of endpoints for managing various aspects of VISA cards. This documentation outlines each endpoint, including its purpose and usage.

Endpoints Overview

1. List Card Offers

• Endpoint: GET /card-holder/cardoffer
• Description: Retrieves a list of available card offers, including details about card providers, designs, and pricing.

2. List Card Requests

• Endpoint: GET /card-holder/cardrequest/card
• Description: Retrieves all card requests associated with the current user, including their status and details.

3. Create Card Request

• Endpoint: POST /card-holder/cardrequest
• Description: Initiates a new card issuance request for either a virtual or physical card.

4. List Cards

• Endpoint: GET /card-holder/card
• Description: Lists all cards issued to the current user, including their status and type.

5. Reset Card PIN

• Endpoint: POST /card-holder/card/pin/reset
• Description: Resets the PIN for a specific card.

6. Get Card Limits

• Endpoint: GET /card-holder/card/limits/{card_id}
• Description: Retrieves the spending limits for a specified card.

7. Update Card Limits

• Endpoint: PUT /card-holder/card/limits/{card_id}
• Description: Updates the spending limits for a specified card.

8. Change Card Type

• Endpoint: POST /card-holder/card/change-type
• Description: Changes the type of an existing card (e.g., from virtual to physical).

9. Update Card Status

• Endpoint: POST /card-holder/card/status
• Description: Updates the status of a card, such as activating, blocking, or closing it.

10. Activate Card

• Endpoint: POST /card-holder/card/activate
• Description: Activates a physical card for use.

11. Get Card

• Endpoint: GET /card-holder/card/{card_id}
• Description: Retrieves detailed information about a specific card.

12. Get Card Transactions by Card

• Endpoint: GET /card-holder/card/transactions/{card_id}
• Description: Retrieves all transactions for a specific card.

13. Get Top-Up Information

• Endpoint: GET /card-holder/card/topup
• Description: Retrieves information related to top-ups for a card.

14. Get Card Sensitive Details

• Endpoint: GET /card-holder/card/sensitive-details/{card_id}
• Description: Retrieves sensitive details about a card, such as card number and CVV.

15. Get PIN

• Endpoint: GET /card-holder/card/pin/{card_id}
• Description: Retrieves the PIN for a specific card.

16. Get Card Details

• Endpoint: GET /card-holder/card/details/{card_id}
• Description: Retrieves detailed information about a specific card.

17. Get Card Balance

• Endpoint: GET /card-holder/card/balance/{card_id}
• Description: Retrieves the balance for a specific card.

18. Get Card Transactions

• Endpoint: GET /card-holder/card/transactions
• Description: Retrieves all transactions for all cards of the current user.

19. Process Webhook Event

• Endpoint: POST /card-holder/webhook/process

• Description: Processes webhook events related to cardholder management. The provider parameter specifies the card provider identifier.

• Path Parameters:

  • provider (string): Identifier of the specific card provider.

• Body Parameters:

  • newKey (string): New value for adding a field to the event.

• Response:

  • 200 OK:
    JSON

    {
      "authorization_id": "string", // authorization id for the request.
      "response_code": "string" // response code from the webhook event.
    }
    

20. Simulate Callback

• Endpoint: POST /card-holder/callback/simulate

• Description: Simulates a callback for cardholder webhook events for testing purposes.

• Body Parameters:

  • id (string): Unique ID for the request.

  • card_id (string): ID of the card.

  • amount (number): Transaction amount.

  • currency (string): Currency code in ISO 4217 format.

  • merchant_amount (number): Amount for the merchant.

  • merchant_currency (string): Merchant's currency code in ISO 4217 format.

  • merchant_data (object): Merchant-specific data.

  • Merchant Data Object:

    • mcc_category (string): Merchant Category Code category.
    • mcc_code (string): Merchant Category Code.
    • city (string): City of the merchant.
    • country (string): Country of the merchant.
    • name (string): Name of the merchant.
    • network_id (string): Network ID.
    • postal_code (string): Postal code of the merchant.
    • state (string): State of the merchant.
    • authorization_method (string): Authorization method.

• Response:

  • 200 OK:
    JSON

    {
      "authorization_id": "string", // authorization id for the request.
      "response_code": "string" // response code from the webhook event.
    }
    

These webhooks allow integrations to receive and process notifications about events such as transactions, card status changes, and other actions related to card management.

21. Card Request Invoice Webhook

• Endpoint: POST /card-holder/invoice/webhook

• Description: Handles webhook events related to card request invoices.

---

Conclusion

The Card Management API provides a robust set of tools for handling various aspects of card management. Whether you're issuing new cards, managing existing ones, or handling transactions, these endpoints offer the functionality you need to effectively manage and monitor card-related activities.

For more detailed information on each endpoint, refer to the provided links.