v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Account Collection Flow

Create a new Account Collection Flow

post/account_collection_flows

Request body

counterparty_idstring required

The ID of a counterparty. An external account created with this flow will be associated with this counterparty.

payment_typesstring[] required

An array of payment types. An external account created with this flow will support all of these payment types. Note this is currently restricted to domestic US rails (ach, wire or check).

receiving_countriesstring[]

An array of ISO 3166-1 alpha-3 country codes. This field is required for international wire transfers. Usage is currently limited to one receiving country.

Response

200

idstring

objectstring

live_modeboolean

client_tokenstring

payment_typesstring[]

counterparty_idstring

{"stackTrail":"paths:/account_collection_flows:post:responses:200:content:application/json:schema:properties:external_account_id","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "6e294fe8-10b2-4047-8d09-01cbb5ad85c2",
  "object": "account_collection_flow",
  "live_mode": true,
  "client_token": "ac-live-1odHAQgJTMEom27Pe5MJe8vpwb6wyn2zFYE51DtGkCjqeyU87PvJhMaMYSVuH",
  "payment_types": [
    "ach"
  ],
  "counterparty_id": "48373199-caec-48e5-82f1-a17329354357",
  "created_at": "2023-01-30T23:51:30Z",
  "updated_at": "2023-01-30T23:51:30Z"
}