Virtual Cards – API Endpoint Reference
action | method & endpoint | description |
|---|---|---|
Create Card | POST /api/cards | Issues a new virtual or physical card for a customer. |
Get Card | GET /api/cards/:cardId | Retrieves general card information including balance and status. |
Get Card Secure Details | GET /api/cards/:cardId/secure | Retrieves sensitive card details including full card number, expiry, and CVV. |
List Cards | GET /api/cards | Retrieves a paginated list of all cards under your company. |
Fund or Withdraw Card | POST /api/cards/:cardId/balance | Adjusts a card's balance. Include a required 'type' field set to 'fund' or 'withdraw' along with a positive 'amount' — 'fund' loads the card, 'withdraw' returns funds to your account. |
Freeze or Unfreeze Card | POST /api/cards/:cardId/status | Toggles the card between 'active' and 'frozen'. Freezing suspends transacting; unfreezing resumes it. |
Terminate Card | DELETE /api/cards/:cardId | Permanently deactivates the card. Cannot be reversed, and cannot be called within 24 hours of card creation. |
Update Spending Limits | PUT /api/cards/:cardId/spend-limits | Updates the spending limits on a card. |
Base URL for all endpoints: https://api.bitnob.com