Get Card by Barcode

Endpoint: https://rest.virtualincentives.com/{version}/{format}/instant/cards/barcode/{barcode}

Method: GET

Definitions

FieldTypeDescription
barcoderesponse only
integer
The unique id assigned to the card carrier’s barcode.
recipientidresponse only
integer
The unique id for this recipient.
balanceresponse only
decimal
Remaining card balance
stateresponse only
string(50)
Current state of the card after activation request: Active, Suspended, or Terminated.

Examples

Response XML

<card>
   <barcode>5789654132687</barcode>
   <recipientid>2654789</recipientid>
   <balance>1.00</balance>
   <state>ACTIVE</state>
</card>

Response JSON

{
  "card": {
    "barcode": "5789654132687",
    "recipientid" : "2654789",
    "balance": 1.00,
    "state": "ACTIVE"
  }
}