An account_collection_flow is an object that can be used to embed a pre-built Account Collection UI in your application. The properties configured on the account_collection_flow dictate which fields to collect from your end-user. Account collection flows currently only support collecting domestic US account information, but in the future, global payments will be supported.
Check out our Embed Account Collection guide to learn how to embed this pre-built UI in your application.
| Attribute | Description |
|---|---|
| id string | The ID of the account collection flow. |
| client_token string | The client token of the account collection flow. This token is used to embed an account collection UI in your client-side application. |
| status string | One of pending, completed, expired, or cancelled.The current status of the account collection flow. |
| counterparty_id string | The ID of a counterparty. An external account created with this flow will be associated with this counterparty. |
| external_account_id string | If present, the ID of the external account created using this flow. |
| payment_types array | An array of payment types. An external account created with this flow must support ALL of these payment types. Note this is currently restricted to domestic US rails (ach, wire or check). |
{
"id": "454e874b-ff1d-46e8-9d22-0464615cf1e0",
"object": "account_collection_flow",
"live_mode": true,
"client_token": "ac-live-QVj2yTSt6qRNAzXQGKLHS9qfLF7Gs5JcCYHT5xztgjucGRbS6VfrJBpaNo5SrmfZ",
"status": "pending",
"payment_types": ["ach"],
"counterparty_id": "c03581a8-c948-41a9-889a-e5228390fd80",
"external_account_id": null,
"created_at": "2023-02-18T03:23:48Z",
"updated_at": "2023-02-18T03:23:48Z"
}