Get ACH Pull Limits
What an account may pull now: the largest single pull, the most its open pulls (pending, processing or posted) may add up to, what they add up to now, and so the most the next pull may be. Show it when the holder asks for a pull — the authorization they accepted promises the per-transfer limit is shown then.
New in v3: v2 has no equivalent.
A workspace-scoped key names the account with account_id; an account-scoped key acts for its own account.
Authorization:
Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.
Headers:
Authorization: APIKey {SIGNED_JWT}
How to build and sign the JWT: Authentication.
Endpoint
/v3/banking/ach-pulls/limits
Query parameters
| Parameter | Type | Description |
|---|---|---|
account_id | string (cst_…) | The account. Required for a workspace-scoped key; an account-scoped key reads its own and may omit it. |
Response Sample
200 OK
{
"per_pull": { "amount": "5000.00", "currency": "USD" },
"per_customer": { "amount": "10000.00", "currency": "USD" },
"open": { "amount": "6000.00", "currency": "USD" },
"available": { "amount": "4000.00", "currency": "USD" },
"reserve_percent": "10"
}
Response Schema
| Field | Type | Description |
|---|---|---|
per_pull | object | The largest single pull, as { amount, currency }. Absent when the workspace sets no per-pull limit. |
per_customer | object | The most the account's open pulls may add up to. Absent when there is no such limit. |
open | object | What the account's open pulls — pending, processing or posted — add up to now. |
available | object | The most the next pull may be: per_pull, or what per_customer leaves when that is less; 0.00 when nothing is left. A larger request is refused with 422 ach_pull_amount_above_limit or 422 ach_pull_customer_limit_exceeded. Absent when neither limit is set. |
reserve_percent | string | The percent of each pull set aside in the account's reserve when it completes, as a decimal string ("10"). "0" when nothing is. Show it with the request form, next to the amount. |
The figures are read when asked: another pull requested, completed or returned meanwhile changes them.
Errors
| Status | message | When |
|---|---|---|
400 | account_id_required | A workspace-scoped key did not name the account. |
401 | unauthorized | Missing or invalid signature. |
403 | forbidden | An account-scoped key named another account in account_id. |
Support and Resources
If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.
Stay Updated
Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!