Cancel an ACH Pull
Cancels a pull still waiting out its five-minute grace period: it becomes cancelled and the pending amount leaves the balance. Once the grace period is over the pull is being submitted to the bank and can no longer be cancelled.
New in v3: v2 has no equivalent.
An account-scoped key cancels only its own account's pulls; another account's reads as 404. A workspace-scoped key cancels any pull of the workspace.
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/{ach_pull_id}/cancel
Path parameters
| Parameter | Type | Description |
|---|---|---|
ach_pull_id | string (ach_…) | Required. The pull. |
No request body. No Idempotency-Key: cancelling twice answers 409 the second time and changes nothing.
Response Schema
The cancelled pull, with the fields of a Request an ACH Pull response.
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | ach_pull_id is not an ach_… id. |
401 | unauthorized | Missing or invalid signature. |
404 | ach_pull_not_found | No such pull, or it belongs to another account. |
409 | ach_pull_not_cancellable | The grace period is over, or the pull is no longer pending. |
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!