Transaction

The Transactions API let's to fetch transactions for a given card id.

NameRequiredDefinition
CustIdYCustomer ID
ProgramIdYProgram ID
StartDateNStartDate of when you want to fetch the transactions from
EndDateNEndDate of when you want to fetch the transactions to
TransactionTypeNInclude all the types of transactions you need, i.e. Payment, VoidPayment, Approved, Authorization, Returns (leaving blank would return all transactions)
OrderByNby default it's DESC and provides the most recent transactions first, change it to ASC to receive transactions in the ASC order.

Authorization

  • Name
    Bearer Token
    Type
    e865a1e59daa629a8ade53bdae8ae659
    Description

Header

  • Name
    Content-Type
    Type
    application/json
    Description

Body

  • Name
    raw
    Type
    json
    Description

    JSON

    {
  "ServiceName": "Transactions",
  "data": {
      "CustId": "E7D22940-E873-4DA4-8F29-5250B1272CE1",
      "ProgramId": "EFBF92FE-600C-499D-B561-61D47B57E16C",
      "StartDate": "2022-05-01",
      "EndDate": "2022-05-18",
      "TransactionType": [
          "Payment",
          "VoidPayment",
          "Declined",
          "Approved",
          "Authorization",
          "Reversal"
      ],
      "OrderBy":"DESC"
  }
}

Request

POST
https://YOURENDPOINT.virtualrx.co/jsonapi.php
curl
--location 'https://YOURENDPOINT.virtualrx.co/jsonapi.php' \
--header 'Content-Type: application/json' \
--data '{
    "ServiceName": "Transactions",
    "data": {
        "CustId": "E7D22940-E873-4DA4-8F29-5250B1272CE1",
        "ProgramId": "EFBF92FE-600C-499D-B561-61D47B57E16C",
        "StartDate": "2022-05-01",
        "EndDate": "2022-05-18",
        "TransactionType": [
            "Payment",
            "VoidPayment",
            "Declined",
            "Approved",
            "Authorization",
            "Reversal"
        ],
        "OrderBy":"DESC"
    }
}'

Response200 OK 

{
  "ResponseDetails": {
      "ServiceName": "Transactions",
      "SessionId": "13a24748-7722-45b7-9e71-61d4d802b32c",
      "StatusCode": "0",
      "StatusName": "StatusOK",
      "StatusDescription": "NA",
      "ServiceDate": "2022-05-10 08:01:19",
      "ServiceId": "13a24748-7722-45b7-9e71-61d4d802b32c"
  },
  "ResponseParams": {
      "CustId": "E7D22940-E873-4DA4-8F29-5250B1272CE1",
      "ProgramId": "EFBF92FE-600C-499D-B561-61D47B57E16C",
      "Count": 11,
      "Transactions": [
        {
            "transaction_type": "Payment",
            "time_stamp": "2022-12-31 23:59:59",
            "vrx_id": "1234567",
            "transaction_id": "67ff3398-59c0-4b86-a49b-d4eff0b274c5",
            "amount": "10356",
            "holds_amount": "10356",
            "posted_balance": "0",
            "merchant_id": "program_user_name",
            "merchant_name": "Program Name",
            "merchant_city": "New Jersey",
            "merchant_state": "NJ",
            "mcc": "1234",
            "mcc_desc": "MCC code description",
            "reason_code": "0",
            "transaction_code": "XP20DS",
            "transaction_description": "VRX Reload"
        },
        {
            "transaction_type": "VodPayment",
            "time_stamp": "2022-12-31 23:59:59",
            "vrx_id": "1234567",
            "transaction_id": "d4eff0b274c5-59c0-4b86-a49b-67ff3398",
            "amount": "10356",
            "holds_amount": "10356",
            "posted_balance": "0",
            "merchant_id": "program_user_name",
            "merchant_name": "Program Name",
            "merchant_city": "New Jersey",
            "merchant_state": "NJ",
            "mcc": "1234",
            "mcc_desc": "MCC code description",
            "reason_code": "0",
            "transaction_code": "XP20DS",
            "transaction_description": "VRX Reload"
        }
      ]
  }
}

Transaction