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.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/payments |
| MCP tool | payments_list |
| Writes | no |
| Area | Shop |
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.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
limit | integer | no |
cursor | string | no |
Example
GET https://doingwork.work/v1/payments?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].id | string (uuid) | yes |
data[].invoice_id | string (uuid) | yes |
data[].amount_minor | integer | yes |
data[].method | string | yes |
data[].status | string | yes |
data[].paid_at | string (date-time) | yes |
data[].refunded_minor | integer | yes |
data[].refunds | array | yes |
data[].refunds[].id | string (uuid) | yes |
data[].refunds[].amount_minor | integer | yes |
data[].refunds[].created_at | string (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
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |