Bank counterparties
A bank counterparty is a US account a withdrawal pays: ACH, a domestic wire, or an international wire sent from the US product. Mexico, Colombia, Argentina, Brazil and Nigeria stay on the v2 country endpoints.
These routes replace the US / international counterparty endpoints. A counterparty saved here is the same record a v2 withdrawal pays, and one saved through v2 is listed and edited here, with its id as a bcp_… TypeID. Previewing and executing the withdrawal stay on POST /api/v2/banking/withdrawal-preview and POST /api/v2/banking/withdrawal.
There is no feature flag and no webhook for these routes.
The rails
| Rail | What the body must carry |
|---|---|
ACH (instrument: "ach") | A 9-digit ABA routing number whose check digit holds (for example 021000021), an account number of 4 to 17 digits, and account_type checking or savings. |
Domestic wire (instrument: "wire", wire_type: "domestic") | A 9-digit ABA routing number whose check digit holds, and an account number of 1 to 17 characters. |
International wire (instrument: "wire", wire_type: "international") | A routing number (any non-empty string; it is not checked as an ABA), a SWIFT code of 8 or 11 letters and digits, and an account number (at most 34 characters) or an IBAN (15 to 34 letters and digits). |
coin is always USD. It is not a request field.
The checks run when a counterparty is saved, and on an update only when the patch sends a payment field. A destination v2 saved with a routing number this API would refuse can still be renamed.
Status
Creates write active. The client cannot set a status.
status | Meaning |
|---|---|
active | Payable. |
inactive | Set aside. v2 wrote it. |
pending | Not finished. v2 wrote it. |
needs_update | A wire to it came back, and the account it pays has to be corrected. Changing that account (the routing number, account number, SWIFT or IBAN) sets the status back to active and drops status_reason. |
blocked | Not payable. v2 wrote it. |
closed | Not payable. v2 wrote it. |
status_reason is present only when v2 recorded one.
Who can call it
Every API key can call these endpoints. customer_id names the account the counterparty belongs to.
- An account-scoped key acts for its own account. Naming another account is
403 forbidden, and another account's counterparty reads as404 bank_counterparty_not_found. - A workspace-scoped key names any account of the workspace on create, and may leave
customer_idout of a list to see the whole workspace. An account that is not in the workspace is403 forbidden.
Save a Bank Counterparty requires the Idempotency-Key header from every caller, API keys included, with no grace period. The other four routes do not take it. See API v3 overview.
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!