Account Config

This document describes the API that can be used to update the account configuration for a specific bank account. This can be used to enable payment form factors, set limits, fallback accounts, and Incoming blocked/allowed originators. See The Config sub-object.

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

ENDPOINT

1. PATCH /v1/account/:id/

SAMPLE CARD CONFIG REQUEST

In this section, we are focused on configuring settings for virtual and physical cards for an account. You can enable/disable each type of card as well as specify the limit on the number of each card that the account can issue.

1. {
2.  "config": {
3.    "card": {
4.      "virtual": {
5.        "enabled": true,
6.        "count": "15"
7.      },
8.      "physical": {
9.        "enabled": true,
10.        "count": "5"
11.      }
12.    }
13.  }
14. }

SAMPLE REQUEST FOR SEND, RECEIVE, AND LIMITS

In this section, we are focused on configuring account settings to enable Send and Receive payment form factors as well as set limits for each of those form factors for the designated account. If a field is not included in the request, it will inherit the values from the Program Config.

1. {
2.  "config": {
3.    "send": {
4.      "intrabank": {
5.        "enabled": true
6.      },
7.      "ach": {
8.        "enabled": true,
9.        "sameDay": true
10.      },
11.      "wire": {
12.        "enabled": true
13.      },
14.      "check": {
15.        "enabled": true
16.      },
17.      "card": {
18.        "enabled": true
19.      },
20.      "debitCard": {
21.        "enabled": true
22.      },
23.      "internationalWire": {
24.        "enabled": true
25.      },
26.      "digitalCheck": {
27.        "enabled": false
28.      },
29.      "physicalCard": {
30.        "enabled": false
31.      },
32.      "crossBorder": {
33.        "enabled": true
34.      }
35.    },
36.    "receive": {
37.      "intrabank": {
38.        "enabled": true
39.      },
40.      "ach": {
41.        "enabled": true,
42.        "sameDay": true
43.      },
44.      "check": {
45.        "enabled": true
46.      },
47.      "debitCard": {
48.        "enabled": true
49.      }
50.    },
51.    "limits": {
52.      "receive": {
53.        "daily": "2000.00",
54.        "monthly": "20000.00",
55.        "intrabank": {
56.          "daily": "",
57.          "monthly": ""
58.        },
59.        "ach": {
60.          "daily": "",
61.          "monthly": ""
62.        },
63.        "check": {
64.          "daily": "",
65.          "monthly": ""
66.        },
67.        "debitCard": {
68.          "daily": "",
69.          "monthly": ""
70.        }
71.      },
72.      "send": {
73.        "daily": "2000.00",
74.        "monthly": "20000.00",
75.        "intrabank": {
76.          "daily": "",
77.          "monthly": ""
78.        },
79.        "ach": {
80.          "daily": "",
81.          "monthly": ""
82.        },
83.        "domesticWire": {
84.          "daily": "",
85.          "monthly": ""
86.        },
87.        "internationalWire": {
88.          "daily": "",
89.          "monthly": ""
90.        },
91.        "check": {
92.          "daily": "",
93.          "monthly": ""
94.        },
95.        "card": {
96.          "daily": "",
97.          "monthly": ""
98.        },
99.        "debitCard": {
100.          "daily": "",
101.          "monthly": ""
102.        },
103.        "crossBorder": {
104.          "daily": "",
105.          "monthly": ""
106.        }
107.      }
108.    }
109.  }
110. }

SAMPLE FALLBACK REQUEST

In this section we are focused on setting up account level fallbacks for ACH and Cards. Fallback account IDs specified must be for accounts of type fallbackAccount. The Fallback is used in overdraft scenarios when funds are being debited from an account. For Cards this would be on authorizations from the card network and for ACH it would be for incoming ACH debits originated outside of Solid. ACH and Card fallbacks can be used independently from each other.

1. {
2.  "config": {
3.    "fallback": {
4.      "received": {
5.        "ach": {
6.          "enabled": true,
7.          "fallbackId": "acc-300cd547-aac9-4381-87e6-0798c1a9faa5"
8.        },
9.        "card": {
10.          "enabled": true,
11.          "fallbackId": "acc-300cd547-aac9-4381-87e6-0798c1a9faa5"
12.        }
13.      }
14.    }
15.  }
16. }

SAMPLE INCOMING CONFIG REQUEST

In this section, we are focused on setting up allowed and blocked originators for ACH Pull transactions.

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

SAMPLE 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": "76203.18",
17.  "sponsorBankName": "Evolve Bank & Trust",
18.  "createdAt": "2022-06-21T14:23:48Z",
19.  "modifiedAt": "2023-01-25T18:22:12Z",
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": "15"
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.      "crossBorder": {
66.        "enabled": true
67.      }
68.    },
69.    "receive": {
70.      "intrabank": {
71.        "enabled": true
72.      },
73.      "ach": {
74.        "enabled": true,
75.        "sameDay": true
76.      },
77.      "check": {
78.        "enabled": true
79.      },
80.      "debitCard": {
81.        "enabled": true
82.      }
83.    },
84.    "limits": {
85.      "receive": {
86.        "daily": "2000.00",
87.        "monthly": "20000.00",
88.        "intrabank": {
89.          "daily": "",
90.          "monthly": ""
91.        },
92.        "ach": {
93.          "daily": "",
94.          "monthly": ""
95.        },
96.        "check": {
97.          "daily": "",
98.          "monthly": ""
99.        },
100.        "debitCard": {
101.          "daily": "",
102.          "monthly": ""
103.        }
104.      },
105.      "send": {
106.        "daily": "2000.00",
107.        "monthly": "20000.00",
108.        "intrabank": {
109.          "daily": "",
110.          "monthly": ""
111.        },
112.        "ach": {
113.          "daily": "",
114.          "monthly": ""
115.        },
116.        "domesticWire": {
117.          "daily": "",
118.          "monthly": ""
119.        },
120.        "internationalWire": {
121.          "daily": "",
122.          "monthly": ""
123.        },
124.        "check": {
125.          "daily": "",
126.          "monthly": ""
127.        },
128.        "card": {
129.          "daily": "",
130.          "monthly": ""
131.        },
132.        "debitCard": {
133.          "daily": "",
134.          "monthly": ""
135.        },
136.        "crossBorder": {
137.          "daily": "",
138.          "monthly": ""
139.        }
140.      }
141.    },
142.    "fallback": {
143.      "received": {
144.        "intrabank": null,
145.        "ach": {
146.          "enabled": true,
147.          "fallbackId": "acc-300cd547-aac9-4381-87e6-0798c1a9faa5"
148.        },
149.        "card": {
150.          "enabled": true,
151.          "fallbackId": "acc-300cd547-aac9-4381-87e6-0798c1a9faa5"
152.        }
153.      }
154.    },
155.    "incoming": {
156.      "achPull": {
157.        "enabled": true,
158.        "allowedOriginators": [
159.          "citi",
160.          "pge"
161.        ],
162.        "blockedOriginators": null
163.      }
164.    }
165.  },
166.  "familyId": "fam-d8b5d10e-9bc0-4c5d-9ecd-3ef95bf8f2fa"
167. }