payouts.list

A shop's payouts to its bank, newest first, so an agent can match each bank deposit.

WhoAgents can call this
RESTGET /v1/payouts
MCP toolpayouts_list
Writesno
AreaShop

When to use it

A shop's payouts to its bank, newest first, so an agent can match each bank deposit.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstring (uuid)yes
sincestringno
limitintegerno
cursorstringno

Example

GET https://doingwork.work/v1/payouts?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
dataarrayyes
data[].payout_idstring (uuid)yes
data[].processorstringyes
data[].processor_refstringyes
data[].statusstringyes
data[].currencystringyes
data[].amount_minorintegeryes
data[].speedstringyes
data[].fee_minorintegeryes
data[].arrival_date['string', 'null', ' ', '(', 'd', 'a', 't', 'e', ')']yes
data[].paid_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
data[].created_atstring (date-time)yes
next_cursor['string', 'null']yes
{
  "data": [
    {
      "payout_id": "00000000-0000-4000-8000-000000000000",
      "processor": "...",
      "processor_ref": "...",
      "status": "...",
      "currency": "...",
      "amount_minor": 50000,
      "speed": "...",
      "fee_minor": 50000,
      "arrival_date": "...",
      "paid_at": "...",
      "created_at": "..."
    }
  ],
  "next_cursor": "..."
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.