List all Transactions (Program)

Retrieves list of all transactions that belong to a program
List all Transactions (Program)
 last updated: 
August 15, 2022

ENDPOINT

  1. GET /v1/program/:id/transaction

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)
export enum export options include: pdf, csv, json (default)
id string transaction ID
txnType enum credit, debit
status enum transaction status code
transferId string transfer ID
accountId string account ID
cardId string card ID
contactId string contact ID
personId string person ID
businessId string business ID
parentTransactionId string parent transaction ID
transferType enum intrabank, ach, card, domesticWire, internationalWire, debitCard, solidCard, physicalCheck, buy, sell, send, receive
subType enum see Transaction Subtype Matrix
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)
modifiedStartTime string modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedEndTime string modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "txn-047b10b5-65e1-41ca-900f-5f6051389078",
  6.             "txnType": "credit",
  7.             "title": "Received from James Murray",
  8.             "amount": "1.00",
  9.             "transferType": "intrabank",
  10.             "subType": "received",
  11.             "description": "Invoice 111",
  12.             "accountId": "acc-11955f53-feee-4a10-b346-feb71309697f",
  13.             "businessId": "bus-8e591a8b-3e7b-4702-9b4f-41c6bbc45730",
  14.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  15.             "personId": "per-7f490a5e-e90d-45a9-9384-619303b452ca",
  16.             "balance": "996.07",
  17.             "intrabank": {
  18.                 "transferId": "tra-c8d128ec-78ea-4de4-8b55-8ff3d7f98492",
  19.                 "contactId": "",
  20.                 "name": "Superbank",
  21.                 "routingNumber": "084106768"
  22.             },
  23.             "ach": null,
  24.             "card": null,
  25.             "createdAt": "2021-12-20T05:31:42Z",
  26.             "txnDate": "2021-12-20T05:31:42Z",
  27.             "status": "settled",
  28.             "domesticWire": null,
  29.             "internationalWire": null,
  30.             "digitalCheck": null,
  31.             "physicalCheck": null,
  32.             "parentTxnId": "",
  33.             "reviewCode": "",
  34.             "reviewMessage": "",
  35.             "debitCard": null,
  36.             "solidCard": null,
  37.             "parentTransferId": ""
  38.         },
  39.         {
  40.             "id": "txn-e78f7693-9d95-41cb-b071-ca074b55c9e9",
  41.             "txnType": "credit",
  42.             "title": "CVS PHARMACY",
  43.             "amount": "1.00",
  44.             "transferType": "card",
  45.             "subType": "reversal",
  46.             "description": "Credited V2 Card at CVS PHARMACY",
  47.             "accountId": "acc-a4f0b443-1a47-4c73-8b53-72cdcad6aacc",
  48.             "businessId": "bus-8365324d-3243-422f-b7c3-66f3be28ca57",
  49.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  50.             "personId": "per-7f490a5e-e90d-45a9-9384-619303b452ca",
  51.             "balance": "792.05",
  52.             "intrabank": null,
  53.             "ach": null,
  54.             "card": {
  55.                 "id": "crd-df63aaf4-d537-4a1a-9b20-ae89805b832f",
  56.                 "transferId": "tra-f4458512-e667-4e65-a327-1b716886ae75",
  57.                 "label": "V2 Card",
  58.                 "merchant": {
  59.                     "merchantName": "CVS PHARMACY",
  60.                     "merchantCity": "SAN JOSE",
  61.                     "merchantState": "CA",
  62.                     "merchantCountry": "CAN",
  63.                     "postalCode": "",
  64.                     "merchantCategory": "Bakeries",
  65.                     "merchantCategoryCode": "5462"
  66.                 }
  67.             },
  68.             "createdAt": "2021-12-20T05:30:50Z",
  69.             "txnDate": "2021-12-20T05:30:50Z",
  70.             "status": "settled",
  71.             "domesticWire": null,
  72.             "internationalWire": null,
  73.             "digitalCheck": null,
  74.             "physicalCheck": null,
  75.             "parentTxnId": "txn-1dd2ac09-0344-4337-aee1-f45cfbf2fec8",
  76.             "reviewCode": "",
  77.             "reviewMessage": "",
  78.             "debitCard": null,
  79.             "solidCard": null,
  80.             "parentTransferId": "tra-5d9b430d-4fe1-4b33-96fa-ece3aa12ad0a"
  81.         }
  82.     ]
  83. }