v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Update Account Collection Flow

Update an account collection flow

patch/account_collection_flows/{id}

Path parameters

idstring required

The ID of an account collection flow.

Request body

statusstring required

The status of the account collection flow. You may only transition a flow from pending to cancelled.

Response

200

idstring

objectstring

live_modeboolean

client_tokenstring

statusstring

payment_typesstring[]

counterparty_idstring

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

created_atstring

updated_atstring

Example response

{
  "id": "454e874b-ff1d-46e8-9d22-0464615cf1e0",
  "object": "account_collection_flow",
  "live_mode": true,
  "client_token": "ac-live-QVj2yTSt6qRNAzXQGKLHS9qfLF7Gs5JcCYHT5xztgjucGRbS6VfrJBpaNo5SrmfZ",
  "status": "cancelled",
  "payment_types": [
    "ach"
  ],
  "counterparty_id": "c03581a8-c948-41a9-889a-e5228390fd80",
  "created_at": "2023-02-18T03:23:48Z",
  "updated_at": "2023-02-18T03:23:48Z"
}