Incoming Config

API used to update the incocming configuration for a bank account
Incoming Config
 last updated: 
September 14, 2022

This document describes the API that can be used to update the config section for a specific bank account.

The config object contains the configuration information for a specified account. In this section, we are focused on setting up allowed and blocked originators for ACH Pull transactions.

Required HTTP Headers:
- sd-api-key: {{sd-api-key}}
- sd-person-id: {{sd-person-id}}

ENDPOINT

  1. PATCH /v1/account/:id/

SAMPLE REQUEST

  1. {
  2.   "incoming": {
  3.     "achPull": {
  4.       "allowedOriginators": [
  5.         "citi",
  6.         "pge"
  7.       ]
  8.     }
  9.   }
  10. }

RESPONSE

  1. {
  2.   "id": "acc-cdc4ca0a-2f1b-4c0b-9964-2339268c2d7b",
  3.   "businessId": "",
  4.   "label": "Doe Money",
  5.   "routingNumber": "084106768",
  6.   "accountNumber": "9991238158805732",
  7.   "status": "active",
  8.   "type": "personalChecking",
  9.   "programId": "prg-ddb08641-6565-465d-ba94-ed199497299f",
  10.   "isVerified": false,
  11.   "verifiedAt": "",
  12.   "acceptedTerms": true,
  13.   "interest": "0.00",
  14.   "fees": "0.00",
  15.   "currency": "USD",
  16.   "availableBalance": "170.00",
  17.   "sponsorBankName": "Test Bank",
  18.   "createdAt": "2022-06-21T14:23:48Z",
  19.   "modifiedAt": "2022-09-08T15:38:49Z",
  20.   "pendingDebit": "0.00",
  21.   "pendingCredit": "0.00",
  22.   "createdPersonId": "per-c1df28cb-a889-41ea-9ab3-6b33c8985c0f",
  23.   "accountInterestFrequency": "monthly",
  24.   "metadata": null,
  25.   "config": {
  26.     "card": {
  27.       "virtual": {
  28.         "enabled": true,
  29.         "count": "25"
  30.       },
  31.       "physical": {
  32.         "enabled": true,
  33.         "count": "5"
  34.       }
  35.     },
  36.     "send": {
  37.       "intrabank": {
  38.         "enabled": true
  39.       },
  40.       "ach": {
  41.         "enabled": true,
  42.         "sameDay": true
  43.       },
  44.       "wire": {
  45.         "enabled": true
  46.       },
  47.       "check": {
  48.         "enabled": true
  49.       },
  50.       "card": {
  51.         "enabled": true
  52.       },
  53.       "debitCard": {
  54.         "enabled": true
  55.       },
  56.       "internationalWire": {
  57.         "enabled": true
  58.       },
  59.       "digitalCheck": {
  60.         "enabled": false
  61.       },
  62.       "physicalCard": {
  63.         "enabled": false
  64.       }
  65.     },
  66.     "receive": {
  67.       "intrabank": {
  68.         "enabled": true
  69.       },
  70.       "ach": {
  71.         "enabled": true,
  72.         "sameDay": true
  73.       },
  74.       "check": {
  75.         "enabled": true
  76.       },
  77.       "debitCard": {
  78.         "enabled": true
  79.       }
  80.     },
  81.     "limits": {
  82.       "receive": {
  83.         "daily": "1000.00",
  84.         "monthly": "10000.00",
  85.         "intrabank": {
  86.           "daily": "",
  87.           "monthly": ""
  88.         },
  89.         "ach": {
  90.           "daily": "",
  91.           "monthly": ""
  92.         },
  93.         "check": {
  94.           "daily": "",
  95.           "monthly": ""
  96.         },
  97.         "debitCard": {
  98.           "daily": "",
  99.           "monthly": ""
  100.         }
  101.       },
  102.       "send": {
  103.         "daily": "1000.00",
  104.         "monthly": "10000.00",
  105.         "intrabank": {
  106.           "daily": "",
  107.           "monthly": ""
  108.         },
  109.         "ach": {
  110.           "daily": "",
  111.           "monthly": ""
  112.         },
  113.         "domesticWire": {
  114.           "daily": "",
  115.           "monthly": ""
  116.         },
  117.         "internationalWire": {
  118.           "daily": "",
  119.           "monthly": ""
  120.         },
  121.         "check": {
  122.           "daily": "",
  123.           "monthly": ""
  124.         },
  125.         "card": {
  126.           "daily": "",
  127.           "monthly": ""
  128.         },
  129.         "debitCard": {
  130.           "daily": "",
  131.           "monthly": ""
  132.         }
  133.       }
  134.     },
  135.     "fallback": {
  136.       "originated": null,
  137.       "received": null
  138.     },
  139.     "incoming": {
  140.       "achPull": {
  141.         "enabled": true,
  142.         "allowedOriginators": [
  143.           "citi",
  144.           "pge"
  145.         ],
  146.         "blockedOriginators": null
  147.       }
  148.     }
  149.   }
  150. }