Retrieve a Program

Retrieves the program information by passing the program id.
Program
Retrieve a Program
 last updated: 
November 30, 2023

ENDPOINT

  1. GET /v1/program/:id

RESPONSE

  1. {
  2.   "id": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  3.   "productName": "acme fintech",
  4.   "accountNumberPrefix": "8871",
  5.   "status": "active",
  6.   "description": "This program is for acme",
  7.   "programType": "platform",
  8.   "identity": {
  9.     "themeId": "",
  10.     "templateId": "",
  11.     "enabled": true
  12.   },
  13.   "company": {
  14.     "name": "Acme, Inc.",
  15.     "domain": "acme.com",
  16.     "description": "acme is fintech super app for the gen z",
  17.     "tin": "21345",
  18.     "entityType": "unlistedCorporation",
  19.     "address": {
  20.       "addressType": "mailing",
  21.       "line1": "123 Main St",
  22.       "line2": "",
  23.       "city": "New York",
  24.       "state": "NY",
  25.       "country": "US",
  26.       "postalCode": "10001"
  27.     },
  28.     "contact": {
  29.       "name": "Jake Thompson",
  30.       "email": "jake@acme.com",
  31.       "phoneNumber": "+14083908321"
  32.     },
  33.     "subDomain": "app.acme.com"
  34.   },
  35.   "brand": {
  36.     "id": "pbr-e581be56-0785-449c-877f-2ad01164d5d4",
  37.     "primaryColor": "#141414",
  38.     "squareLogo": "",
  39.     "landscapeLogo": "",
  40.     "fontName": "helvatica",
  41.     "fontURL": "",
  42.     "cardArtPhysical": "",
  43.     "cardArtVirtual": "",
  44.     "cardArtVirtualBack": "",
  45.     "cardArtPhysicalBack": "",
  46.     "secondaryColor": "",
  47.     "supportEmail": "",
  48.     "darkPrimaryColor": "",
  49.     "darkSecondaryColor": "",
  50.     "darkSquareLogo": "",
  51.     "darkLandscapeLogo": "",
  52.     "redirectUrl": "https://acme.app/",
  53.     "createdAt": "2021-03-30T13:43:51Z",
  54.     "modifiedAt": "2021-12-17T08:24:37.148261994Z"
  55.   },
  56.   "bank": {
  57.     "sponsor": "Evolve",
  58.     "fdicInsurance": true,
  59.     "maxAccounts": {
  60.       "personal": "10",
  61.       "business": "10"
  62.     },
  63.     "accountType": {
  64.       "personalChecking": true,
  65.       "personalSavings": false,
  66.       "businessChecking": true,
  67.       "businessSavings": false
  68.     },
  69.     "accountSubType": {
  70.       "dda": true,
  71.       "interest": true,
  72.       "clearing": false,
  73.       "reserve": false,
  74.       "accrue": false
  75.     },
  76.     "accountInterest": "0.00",
  77.     "accountFees": "0.00",
  78.     "accountInterestFrequency": "annual",
  79.     "accountCreationCredit": "00.00"
  80.   },
  81.   "card": {
  82.     "type": {
  83.       "virtual": {
  84.         "enabled": true,
  85.         "count": "1000"
  86.       },
  87.       "physical": {
  88.         "enabled": true,
  89.         "count": "100"
  90.       }
  91.     },
  92.     "bin": {
  93.       "personalDebit": {
  94.         "enabled": true,
  95.         "sponsor": "Evolve",
  96.         "issuerProcessor": "i",
  97.         "embosser": "",
  98.         "issuerProcessorData": null
  99.       },
  100.       "personalCredit": {
  101.         "enabled": true,
  102.         "sponsor": "Evolve",
  103.         "issuerProcessor": "",
  104.         "embosser": "",
  105.         "issuerProcessorData": null
  106.       },
  107.       "businessDebit": {
  108.         "enabled": true,
  109.         "sponsor": "Evolve",
  110.         "issuerProcessor": "",
  111.         "embosser": "",
  112.         "issuerProcessorData": null
  113.       },
  114.       "businessCredit": {
  115.         "enabled": true,
  116.         "sponsor": "Evolve",
  117.         "issuerProcessor": "",
  118.         "embosser": "",
  119.         "issuerProcessorData": null
  120.       }
  121.     }
  122.   },
  123.   "send": {
  124.     "intrabank": {
  125.       "enabled": true,
  126.       "via": "Test Bank"
  127.     },
  128.     "ach": {
  129.       "enabled": true,
  130.       "via": "Test Bank",
  131.       "sameDay": true
  132.     },
  133.     "wire": {
  134.       "enabled": true,
  135.       "via": "Test Bank"
  136.     },
  137.     "check": {
  138.       "enabled": true,
  139.       "via": "Test Bank"
  140.     },
  141.     "card": {
  142.       "enabled": true,
  143.       "via": "Test Bank"
  144.     },
  145.     "debitCard": {
  146.       "enabled": false,
  147.       "via": ""
  148.     }
  149.   },
  150.   "receive": {
  151.     "intrabank": {
  152.       "enabled": true,
  153.       "via": "Test Bank"
  154.     },
  155.     "ach": {
  156.       "enabled": true,
  157.       "via": "Test Bank",
  158.       "sameDay": true
  159.     },
  160.     "check": {
  161.       "enabled": true,
  162.       "via": "Test Bank"
  163.     },
  164.     "debitCard": {
  165.       "enabled": false,
  166.       "via": ""
  167.     }
  168.   },
  169.   "limits": {
  170.     "receive": {
  171.       "daily": "400000.00",
  172.       "monthly": "1200000.00"
  173.     },
  174.     "send": {
  175.       "daily": "20000.00",
  176.       "monthly": "300000.53"
  177.     }
  178.   },
  179.   "legal": {
  180.     "bank": "",
  181.     "program": "",
  182.     "solid": "",
  183.     "help": "",
  184.     "disclosure": ""
  185.   },
  186.   "billing": {
  187.     "platformFee": "0.00",
  188.     "perAccountFee": "0.00",
  189.     "interestRate": "0.00",
  190.     "interchangeRevShare": "0.00",
  191.     "perCardFee": "0.00"
  192.   },
  193.   "createdAt": "2021-03-30T13:43:51Z",
  194.   "modifiedAt": "2021-12-17T08:24:37.210849425Z",
  195.   "language": "",
  196.   "notification": {
  197.     "ntfSmsEnabled": true,
  198.     "solidNtfSenderNumber": "",
  199.     "smsSenderNumber": "",
  200.     "twilioSenderSid": "",
  201.     "twilioSenderToken": "",
  202.     "ntfEmailEnabled": true,
  203.     "ntfSenderEmail": "",
  204.     "ntfSenderName": "",
  205.     "sendgridKey": "",
  206.     "segmentId": ""
  207.   },
  208.   "ops": {
  209.     "kyc": true,
  210.     "kyb": true
  211.   },
  212.   "allowedIpList": null,
  213.   "fallback": {
  214.     "originated": null,
  215.     "received": null
  216.   },
  217.   "realTimeAuth": {
  218.     "notification": null,
  219.     "card": null,
  220.     "ach": null,
  221.     "intrabank": null
  222.   }
  223. }