API Reference
Virtual Cards
Card withdrawal [POST]

Withdrawal


https://sandboxapi.onbrails.com/api/v1/virtualcards/withdraw (opens in a new tab)

Withdraw funds from a card

Body Parameters

ParametertypeRequired
amountint32
cardId
ID of the card to be charged
string
referencestring

Request

Virtual Cards/Withdrawal [POST]
curl --request POST \
   --url https://sandboxapi.onbrails.com/api/v1/virtualcards/withdraw \
   --header 'Authorization: Bearer API-KEY' \
   --header 'accept: application/json' \
   --header 'content-type: application/json' \
   --data '
{
"amount": 0,
"cardId": "string",
"reference": "string"
}
'

Responses

🟢 200 - Result example
{
"status": true,
"message": "withdrawal from card in progress",
"data": {
  "id": "22082e24-8a0a-4ea2-9a7d-3a633cdaf206",
  "createdAt": "2022-12-20T09:33:12.025Z",
  "updatedAt": "2022-12-20T09:33:12.025Z",
  "amount": 5,
  "centAmount": 500,
  "type": "credit",
  "method": "withdrawal",
  "status": "pending",
  "currency": "usd",
  "reference": "kdjhdjwjodfw",
  "cardId": "4f644a2c-3c4f-48c7-a3fa-e896b544d546"
  }
}