payments.list

Card and bank payments in one shop, newest first. Each id is the charge_id invoices.refund takes. Read only. A shop you are not a member of is refused. Amounts need see_prices.

WhoAgents can call this
RESTGET /v1/payments
MCP toolpayments_list
Writesno
AreaShop

When to use it

Card and bank payments in one shop, newest first. Each id is the charge_id invoices.refund takes.

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
limitintegerno
cursorstringno

Example

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

Output

FieldTypeAlways there
dataarrayyes
data[].idstring (uuid)yes
data[].invoice_idstring (uuid)yes
data[].amount_minorintegeryes
data[].methodstringyes
data[].statusstringyes
data[].paid_atstring (date-time)yes
data[].refunded_minorintegeryes
data[].refundsarrayyes
data[].refunds[].idstring (uuid)yes
data[].refunds[].amount_minorintegeryes
data[].refunds[].created_atstring (date-time)yes
next_cursor['string', 'null']yes
{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "invoice_id": "00000000-0000-4000-8000-000000000000",
      "amount_minor": 50000,
      "method": "...",
      "status": "...",
      "paid_at": "...",
      "refunded_minor": 50000,
      "refunds": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "amount_minor": 50000,
          "created_at": "..."
        }
      ]
    }
  ],
  "next_cursor": "..."
}

Errors

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