List all Checks Sent

‍Retrieves list of all checks sent from an account.
Send
List all Checks Sent
 last updated: 
September 8, 2022

ENDPOINT

  1. GET v1/send/check?accountId={{accountId}}

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)
accountId string account ID
txnType enum credit, debit
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)
externalId string Matches the externalId key if set in the object's metadata


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "tra-edc1deaf-138a-465d-8a15-a146bbe9d466",
  6.             "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  7.             "contactId": "con-ab8e4ddc-cf09-448d-aa19-f71527b8393c",
  8.             "name": "Bright Might LLC",
  9.             "accountNumber": "",
  10.             "routingNumber": "",
  11.             "address": {
  12.                 "addressType": "check",
  13.                 "line1": "123 Main St",
  14.                 "line2": "",
  15.                 "city": "New York",
  16.                 "state": "NY",
  17.                 "country": "US",
  18.                 "postalCode": "10001"
  19.             },
  20.             "amount": "80.00",
  21.             "status": "completed",
  22.             "description": "Payment",
  23.             "txnType": "debit",
  24.             "transferType": "physicalCheck",
  25.             "transferSubType": "originated",
  26.             "createdAt": "2021-12-16T08:37:23Z",
  27.             "modifiedAt": "2021-12-16T08:37:34Z",
  28.             "transferredAt": "2021-12-16T08:37:23Z",
  29.             "accountType": "",
  30.             "iban": "",
  31.             "valid": "",
  32.             "parentTransferId": "",
  33.             "reviewCode": "invalidCheckAddress",
  34.             "reviewMessage": "invalid check address",
  35.             "type": "",
  36.             "metadata": null
  37.         },
  38.         {
  39.             "id": "tra-16ec5085-213a-49ee-b434-1c50a2ec16fc",
  40.             "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  41.             "contactId": "con-ab8e4ddc-cf09-448d-aa19-f71527b8393c",
  42.             "name": "Bright Might LLC",
  43.             "accountNumber": "",
  44.             "routingNumber": "",
  45.             "address": {
  46.                 "addressType": "check",
  47.                 "line1": "123 Main St",
  48.                 "line2": "",
  49.                 "city": "New York",
  50.                 "state": "NY",
  51.                 "country": "US",
  52.                 "postalCode": "10001"
  53.             },
  54.             "amount": "80.00",
  55.             "status": "completed",
  56.             "description": "Payment",
  57.             "txnType": "debit",
  58.             "transferType": "physicalCheck",
  59.             "transferSubType": "originated",
  60.             "createdAt": "2021-12-16T08:33:20Z",
  61.             "modifiedAt": "2021-12-16T08:33:33Z",
  62.             "transferredAt": "2021-12-16T08:33:20Z",
  63.             "accountType": "",
  64.             "iban": "",
  65.             "valid": "",
  66.             "parentTransferId": "",
  67.             "reviewCode": "invalidCheckAddress",
  68.             "reviewMessage": "invalid check address",
  69.             "type": "",
  70.             "metadata": null
  71.         }
  72.     ]
  73. }