Send a Card

Sends a visa card to a contact.
Send
Send a Card
 last updated: 
November 22, 2022

The Send a Card feature is useful to issue a prepaid Visa card as a form of payment. Funds are debited from the specified account and loaded as an available balance on the card that is issued.

Send a card is done by passing the required account id, contact id, type, amount and description. Currently, only virtual card ("type": "virtual") is supported. Response is a transfer object with a transferType of solidCard.

ENDPOINT

  1. POST v1/send/card

REQUEST

  1. {
  2.     "accountId": "{{accountId}}",
  3.     "contactId": "{{contactId}}",
  4.     "type": "virtual",
  5.     "bin": "debit",
  6.     "amount": "20.00",
  7.     "description": "Gift Card"
  8. }

Notes:
- Currently, only virtual card ("type": "virtual") is supported.
- If configured, both "credit" and "debit" can be passed in the "bin" field. If not supplied, bin will default to "debit"

RESPONSE

  1. {
  2.     "id": "tra-466201d4-058d-4581-bda9-8ea67483f445",
  3.     "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  4.     "contactId": "con-ab8e4ddc-cf09-448d-aa19-f71527b8393c",
  5.     "name": "Bright Might LLC",
  6.     "accountNumber": "",
  7.     "routingNumber": "",
  8.     "address": {
  9.         "addressType": "card",
  10.         "line1": "123 Main St",
  11.         "line2": "",
  12.         "city": "New York",
  13.         "state": "NY",
  14.         "country": "US",
  15.         "postalCode": "10001"
  16.     },
  17.     "amount": "20.00",
  18.     "status": "completed",
  19.     "description": "Gift Card",
  20.     "txnType": "debit",
  21.     "transferType": "solidCard",
  22.     "transferSubType": "originated",
  23.     "createdAt": "2021-12-16T08:43:49Z",
  24.     "modifiedAt": "2021-12-16T08:43:49Z",
  25.     "transferredAt": "2021-12-16T08:43:49Z",
  26.     "accountType": "",
  27.     "iban": "",
  28.     "valid": "",
  29.     "parentTransferId": "",
  30.     "reviewCode": "",
  31.     "reviewMessage": "",
  32.     "type": "",
  33.     "metadata": null,
  34.     "bin": "debit"
  35. }

Additional APIs  related to SolidCard (Send aCard API)

Note the send a card returns the card ID inside a card sub-object. The card ID returned can only be used with Send Card APIs. As usual, calls should be made with your API Key.

Get Transactions on a SolidCard

Retrieves transactions on an existing issued SolidCard created via the /v1/send/card API

ENDPOINT

  1. GET /v1/send/card/transaction?cardId=

FILTERS

The table below describes various filters that can be passed as query parameters to narrow the response.

Filter Type Description
offset int start index (default = 0)
limit int number of records to return (default = 25, max = 100)
txnType enum credit, debit
subType enum see Transaction Subtype Matrix
status enum transaction status code
transferId string transfer ID
minAmount num minimum amount (up two decimal places)
maxAmount num maximum amount (up two decimal places)
startTime string created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
endTime string created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)


SAMPLE REPSONSE

  1. {
  2.   "total": 1,
  3.   "data": [
  4.     {
  5.       {{transaction object}}
  6.     }
  7.   ]
  8. }


Show a SolidCard

Just like normal cards, you can show a SolidCard by first creating a Show Token using the /v1/send/card API, then use that token to show the card in your application.

ENDPOINT

  1. POST /v1/send/card/showtoken

SAMPLE REQUEST

  1. {
  2.   "cardId": "crd-db866eea-c302-4236-8bce-54e5549ead27"
  3. }

Once you have created the token, follow the instructions in Step 2 of this document to implement VGS in your app.

Top Up a SolidCard

Adds funds to an existing issued SolidCard created via the /v1/send/card API

ENDPOINT

  1. POST /v1/send/card/topup

REQUEST

  1. {
  2.   "accountId": "{{accountId}}",
  3.   "cardId": "{{cardId}}",
  4.   "amount": "40.00"
  5. }

SAMPLE RESPONSE

  1. {
  2.   "id": "tra-44291e77-d76a-4365-8a6b-726f231d618c",
  3.   "bankName": "",
  4.   "accountId": "acc-cdc4ca0a-2f1b-4c0b-9964-2339268c2d7b",
  5.   "contactId": "con-41b5c690-d14d-4fe0-9f9a-e787bd01f102",
  6.   "name": "Solid Cards Testing",
  7.   "accountNumber": "",
  8.   "routingNumber": "",
  9.   "address": {},
  10.   "amount": "40.00",
  11.   "status": "completed",
  12.   "description": "",
  13.   "txnType": "debit",
  14.   "transferType": "solidCard",
  15.   "transferSubType": "topup",
  16.   "createdAt": "2022-11-09T19:49:57Z",
  17.   "modifiedAt": "2022-11-09T19:49:57Z",
  18.   "transferredAt": "2022-11-09T19:49:57Z",
  19.   "accountType": "",
  20.   "iban": "",
  21.   "valid": "",
  22.   "parentTransferId": "tra-05d53419-ffa8-4a12-8884-838ff43ab85e",
  23.   "reviewCode": "",
  24.   "reviewMessage": "",
  25.   "type": "",
  26.   "metadata": null,
  27.   "title": "Top up",
  28.   "card": {}
  29. }


Cancel a SolidCard

Cancels an existing issued SolidCard created via the /v1/send/card API. The funds are returned to the source account that was debited from. Funds are also returned when the card expires.

ENDPOINT

  1. POST /v1/send/card/cancel

REQUEST

  1. {
  2.   "cardId": "{{card-id}}",
  3. }

SAMPLE RESPONSE

  1. {
  2.   "id": "tra-e6552407-1c80-48c1-a7dc-b2b48e972407",
  3.   "bankName": "",
  4.   "accountId": "acc-cdc4ca0a-2f1b-4c0b-9964-2339268c2d7b",
  5.   "contactId": "con-41b5c690-d14d-4fe0-9f9a-e787bd01f102",
  6.   "name": "Solid Cards Testing",
  7.   "accountNumber": "999000052587716",
  8.   "routingNumber": "084106768",
  9.   "address": {},
  10.   "amount": "60.00",
  11.   "status": "completed",
  12.   "description": "Reversal - Gift Card",
  13.   "txnType": "credit",
  14.   "transferType": "solidCard",
  15.   "transferSubType": "reversal",
  16.   "createdAt": "2022-11-09T20:08:16Z",
  17.   "modifiedAt": "2022-11-09T20:08:17Z",
  18.   "transferredAt": "2022-11-09T20:08:16Z",
  19.   "parentTransferId": "tra-05d53419-ffa8-4a12-8884-838ff43ab85e",
  20.   "reviewCode": "sendCardCancelledBySender",
  21.   "reviewMessage": "Send Card cancelled by Jane",
  22.   "type": "",
  23.   "metadata": null,
  24.   "title": "",
  25.   "card": null
  26. }

Webhooks

The following webhooks are available for the Send a Card (aka solidcard) feature:

solidcard.canceled
solidcard.delivered
solidcard.originated.debit
solidcard.reversal.credit
solidcard.topup