Virtual Cards

Reload Card

It’s pretty simple to reload a virtual card. Check the example in the box below for details.


Parameter Type Presence Description Example
vcard_id uuid_v4 Virtual Card ID 42e012cf-0000-0000-0000-8a1806bcaf6e  
vcard object Virtual Card Object “vcard”: {…}  
vcard.reload_amount number Reload Amount Desired “reload_amount” : 123.45  
Field Type Description Example
vcard object Virtual Card object “vcard”: {…} uuid_v4 Virtual Card ID “id”: “42e012cf-0000-0000-0000-8a1806bcaf6e”
vcard.type string The activity type “type”: “reload”
vcard.provider_id uuid_v4 The provider ID “provider_id”: “096f8c5e-0000-0000-0000-8e21db9e60f0”
vcard.merchant_id uuid_v4 The merchant ID “merchant_id”: “9b2d85b4-0000-0000-0000-16e99a124970”
vcard.first_name string Person’s name “first_name”: “John”
vcard.last_name string Person’s last name “last_name”: “Doe”
vcard.street_address_1 string Address 1 “street_address_1”: “17770 Any Street”
vcard.street_address_2 string Address 2 “street_address_2”: “Suite 1” string Zip code “zip”:”90001” string City name “city”:”Any City”
vcard.state string Alpha-2 state code “state”:”CA” string Alpha-2 country code “country”:”US” string Person’s email “email”:”[email protected] string Person’s phone “phone”:”5555551234”
vcard.external_id uuid_v4 External ID “external_id”:”5d0640b5-0000-0000-0000-f1b6d7a93752”
vcard.card_number string Virtual Card number “card_number”:”4111111111111111”
vcard.card_expiry_month string Virtual Card expiry month “card_expiry_month”:”01”
vcard.card_expiry_year string Virtual Card expiry year “card_expiry_year”:”2020”
vcard.card_brand string Virtual Card brand “card_brand”:”visa”
vcard.amount float Virtual Card limit “amount”: 200.50
vcard.status string Virtual card status “status”:”active”
vcard.available_amount float Virtual card available amount “available_amount”: 100.50
vcard.actions[] array[object] Action history on Virtual Card “actions”: [{…},{…}]
vcard.actions[].id uuid_v4 ID of action “id”:”0866c4e5-0000-0000-0000-7f9a66a91775”
vcard.actions[].virtual_card_id uuid_v4 Virtual Card ID “virtual_card_id”:”42e012cf-0000-0000-0000-8a1806bcaf6e”
vcard.actions[].type string Action type “action”:”refill”
vcard.actions[].data object Data about the action “data”: {…}
vcard.actions[].data.previous_amount_balance float The previous card balance “previous_amount_balance”:100.50
vcard.actions[].data.virtual_card_previous_amount float The previous card limit “virtual_card_previous_amount”:200.50
vcard.actions[].created_at string(date-time) The time of the action event “created_at”:”2020-04-03 09:09:53”
vcard.actions[].updated_at string(date-time) The time when the action event was updated “updated_at”:”2020-04-03 09:09:53”
vcard.actions[].deleted_at string(date-time) The time when the action event was deleted “deleted_at”:””
vcard.is_cancelable boolean Indicates if the card can be cancelled “is_cancelable”: 1
vcard_meta object Metadata about virtual card “meta”:{}
vcard.created_at string(date-time) Time when virtual card was created “created_at”:”2020-04-03T09:09:53+0000”
curl -X PUT \ \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "vcard" : {
        "reload_amount": 123.45

Responds with:

"vcard": {
    "id": "42e012cf-0000-0000-0000-8a1806bcaf6e",
    "type": "reload",
    "provider_id": "096f8c5e-0000-0000-0000-8e21db9e60f0",
    "merchant_id": "9b2d85b4-0000-0000-0000-16e99a124970",
    "first_name": "John",
    "last_name": "Doe",
    "street_address1": "17770 Any Street",
    "street_address2": "Suite 1",
    "zip": "90001",
    "city": "Any City",
    "state": "CA",
    "country": "US",
    "email": "[email protected]",
    "phone": "5555551234",
    "external_id": "0866c4e5-0000-0000-0000-7f9a66a91775",
    "card_number": "4111111111111111",
    "card_expiry_month": 01,
    "card_expiry_year": 2020,
    "card_brand": "visa",
    "amount": 200.50,
    "status": "active",
    "available_amount": 100.50,
    "actions": [{
        "id": "df413355-0000-0000-0000-7f4aa8534561",
        "virtual_card_id": "42e012cf-0000-0000-0000-8a1806bcaf6e",
        "type": "refill",
        "data": {
            "previous_amount_balance": 100.50,
            "virtual_card_previous_amount": 200.50,
        "created_at": "2020-04-03 09:09:53",
        "updated_at": "2020-04-03 09:09:53",
        "deleted_at": "",
    "is_cancelable": 1,
    "meta": {},
    "created_at": "2020-04-03T09:09:53+0000",