List all Transfers (Program)

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

ENDPOINT

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

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)
id string transfer ID
transferType enum intrabank, ach, card, domesticWire, internationalWire, debitCard, solidCard, physicalCheck, buy, sell, send, receive
status enum transfer status code
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
txnType enum credit, debit
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)
externalId string Matches the externalId key if set in the object's metadata


RESPONSE

  1. {
  2.     "total": 4,
  3.     "data": [
  4.         {
  5.             "id": "tra-9e6fe3ba-7b9f-472d-baa0-e9f5bbfc9ada",
  6.             "bankName": "",
  7.             "accountId": "acc-cdc4ca0a-2f1b-4c0b-9964-2339268c2d7b",
  8.             "contactId": "con-41b5c690-d14d-4fe0-9f9a-e787bd01f102",
  9.             "name": "Prepaid Cardholder",
  10.             "accountNumber": "",
  11.             "routingNumber": "",
  12.             "address": {
  13.                 "addressType": "card",
  14.                 "line1": "123 Main St",
  15.                 "line2": "",
  16.                 "city": "Los Angeles",
  17.                 "state": "CA",
  18.                 "country": "US",
  19.                 "postalCode": "90001"
  20.             },
  21.             "amount": "20.00",
  22.             "status": "completed",
  23.             "description": "Prepaid Card",
  24.             "txnType": "debit",
  25.             "transferType": "solidCard",
  26.             "transferSubType": "originated",
  27.             "createdAt": "2022-08-02T19:01:38Z",
  28.             "modifiedAt": "2022-08-02T19:01:47Z",
  29.             "transferredAt": "2022-08-02T19:01:38Z",
  30.             "accountType": "",
  31.             "iban": "",
  32.             "valid": "",
  33.             "parentTransferId": "",
  34.             "reviewCode": "",
  35.             "reviewMessage": "",
  36.             "type": "",
  37.             "metadata": null,
  38.             "title": "",
  39.             "card": {
  40.                 "id": "crd-51612a77-45f6-4a28-9514-b036eef01ff3",
  41.                 "accountId": "",
  42.                 "businessId": "",
  43.                 "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  44.                 "cardholder": {
  45.                     "id": "chd-3294337d-89bb-4b0d-91fb-c1152aa6a573",
  46.                     "personId": "per-537d730c-1d63-4f3b-aa41-4c23df974749",
  47.                     "billingAddress": {
  48.                         "addressType": "billing",
  49.                         "line1": "123 Main St",
  50.                         "line2": "",
  51.                         "city": "Los Angeles",
  52.                         "state": "CA",
  53.                         "country": "US",
  54.                         "postalCode": "90001"
  55.                     },
  56.                     "createdAt": "2022-02-01T14:54:05Z",
  57.                     "modifiedAt": "2022-08-02T19:01:46Z",
  58.                     "name": "Prepaid Cardholder"
  59.                 },
  60.                 "cardType": "virtual",
  61.                 "label": "Jane",
  62.                 "limitAmount": "20.00",
  63.                 "limitInterval": "allTime",
  64.                 "shipping": null,
  65.                 "currency": "USD",
  66.                 "expiryMonth": "08",
  67.                 "expiryYear": "2023",
  68.                 "last4": "3816",
  69.                 "cardStatus": "active",
  70.                 "activatedAt": "2022-08-02T19:01:46Z",
  71.                 "createdAt": "2022-08-02T19:01:46Z",
  72.                 "modifiedAt": "2022-08-02T19:01:46Z",
  73.                 "createdPersonId": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  74.                 "metadata": null,
  75.                 "bin": "debit",
  76.                 "allowedCategories": null,
  77.                 "availableLimit": "20.00",
  78.                 "blockedCategories": null,
  79.                 "embossingPerson": "",
  80.                 "embossingBusiness": "",
  81.                 "theme": "",
  82.                 "atmAccess": true,
  83.                 "allowedMerchants": null,
  84.                 "blockedMerchants": null,
  85.                 "walletId": "",
  86.                 "familyId": ""
  87.             }
  88.         }
  89.     ]
  90. }