Get Recipient Transactions

Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/card/transactions

Method: GET

📘

This endpoint requires approval prior to access. Please contact your Virtual Incentives Client Success Manager to discuss your use case.

Definitions

FieldTypeDescription
dateresponse only
datetime
Event date for this event. Format: MM/dd/yyyy HH:mm
amountresponse only
decimal
The amount Denomination of the transaction.

Note: Currency is determined by the SKU issued.
merchantresponse only
string
The retailer in which goods/services were purchased.
statusresponse only
string
The current state of the transaction.

Note: See Appendix D for definitions.

Examples

Response XML

<transactions>
    <transaction>
      <date>04/01/2021 14:03</date>
      <amount>-3.23</amount>
      <merchant>AMZN Mktp US (Amzn.com/bill, 53)</merchant>
      <status>PENDING</status>
    </transaction>
    <transaction>
      <date>04/01/2021 13:44</date>
      <amount>-1.07</amount>
      <merchant>TARGET.COM  * (800-591-3869, MN)</merchant>
      <status>COMPLETION</status>
    </transaction>
    <transaction>
      <date>04/01/2021 13:44</date>
      <amount>-1.07</amount>
      <merchant>TARGET.COM (BROOKLYN PARK, 27)</merchant>
      <status>CLEARED</status>
    </transaction>
    <transaction>
      <date>04/01/2021 13:40</date>
      <amount>-3.23</amount>
      <merchant>BESTBUYCOM806442757502 (888-BESTBUY, MN)</merchant>
      <status>COMPLETION</status>
    </transaction>
    <transaction>
      <date>04/01/2021 13:40</date>
      <amount>-3.23</amount>
      <merchant>BESTBUY.COM (RICHFIELD, 27)</merchant>
      <status>CLEARED</status>
    </transaction>
    <transaction>
      <date>04/01/2021 13:34</date>
      <amount>0.00</amount>
      <merchant>AMAZON.COM (AMZN.COM/BILL, 53)</merchant>
      <status>CLEARED</status>
    </transaction>
    <transaction>
      <date>04/01/2021 13:28</date>
      <amount>0.00</amount>
      <merchant>AMAZON.COM (AMZN.COM/BILL, 53)</merchant>
      <status>CLEARED</status>
    </transaction>
        <transaction>
      <date>04/01/2021 13:16</date>
      <amount>9.00</amount>
      <merchant>Opening Balance</merchant>
      <status>COMPLETION</status>
    </transaction>
  </transactions>
</card>

Response JSON

{
  "card": {
    "transactions": [
      {
        "date": "04/01/2021 14:03",
        "amount": -3.23,
        "merchant": "AMZN Mktp US (Amzn.com/bill, 53)",
        "status": "PENDING"
      },
      {
        "date": "04/01/2021 13:44",
        "amount": -1.07,
        "merchant": "TARGET.COM  * (800-591-3869, MN)",
        "status": "COMPLETION"
      },
      {
        "date": "04/01/2021 13:44",
        "amount": -1.07,
        "merchant": "TARGET.COM (BROOKLYN PARK, 27)",
        "status": "CLEARED"
      },
      {
        "date": "04/01/2021 13:40",
        "amount": -3.23,
        "merchant": "BESTBUYCOM806442757502 (888-BESTBUY, MN)",
        "status": "COMPLETION"
      },
      {
        "date": "04/01/2021 13:40",
        "amount": -3.23,
        "merchant": "BESTBUY.COM (RICHFIELD, 27)",
        "status": "CLEARED"
      },
      {
        "date": "04/01/2021 13:34",
        "amount": 0,
        "merchant": "AMAZON.COM (AMZN.COM/BILL, 53)",
        "status": "CLEARED"
      },
      {
        "date": "04/01/2021 13:28",
        "amount": 0,
        "merchant": "AMAZON.COM (AMZN.COM/BILL, 53)",
        "status": "CLEARED"
      },
            {
        "date": "04/01/2021 13:16",
        "amount": 9,
        "merchant": "Opening Balance",
        "status": "COMPLETION"
      }
    ]
  }
}