v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

List Payment Flows

List payment flows

get/payment_flows

Query parameters

after_cursorstring

per_pageinteger

client_tokenstring

statusstring

One of pending, completed, expired, or cancelled.

counterparty_idstring

Specify counterparty_id to see payment_flows for a specific counterparty.

receiving_account_idstring

An external account id. Specify receiving_account_id to see payment_flows where the given external account is the receiving account.

originating_account_idstring

An internal account id. Specify originating_account_id to see payment_flows where your internal account is the originating account.

payment_order_idstring

Specify payment_order_id to see payment_flows that created a specific payment order.

Response

200

idstring

objectstring

live_modeboolean

client_tokenstring

statusstring

amountinteger

currencystring

directionstring

counterparty_idstring

{"stackTrail":"paths:/payment_flows:get:responses:200:content:application/json:schema:properties:receiving_account_id","oasType":"schema","type":"unknown"}

originating_account_idstring

{"stackTrail":"paths:/payment_flows:get:responses:200:content:application/json:schema:properties:payment_order_id","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "d93b8ae4-b30e-42ce-bc5d-e1ca5785f863",
  "object": "payment_flow",
  "live_mode": true,
  "client_token": "pay-live-fmsXHyYikKHstYHeSB6Co5AjezMqKoFKFhKmwnY2tvJMUFmndkarJY7GcwYkcBvr",
  "status": "pending",
  "amount": 10000,
  "currency": "USD",
  "direction": "debit",
  "counterparty_id": "34b33f71-daaa-4ce3-b9f3-a275e7b9a6f7",
  "originating_account_id": "ceab8d17-1312-44fe-94e2-a858370c3f10",
  "created_at": "2023-02-18T03:50:54Z",
  "updated_at": "2023-02-18T03:50:54Z"
}