payouts.get
One payout broken down: each payment and refund in it, the processor fee and the Doing Work fee on each, and the net. The items add up to the payout amount.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/payouts/get |
| MCP tool | payouts_get |
| Writes | no |
| Area | Shop |
When to use it
One payout broken down: each payment and refund in it, the processor fee and the Doing Work fee on each, and the net. The items add up to the payout amount.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
payout_id | string (uuid) | yes |
Example
GET https://doingwork.work/v1/payouts/get?payout_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
payout_id | string (uuid) | yes |
processor | string | yes |
processor_ref | string | yes |
status | string | yes |
currency | string | yes |
amount_minor | integer | yes |
speed | string | yes |
fee_minor | integer | yes |
arrival_date | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', ')'] | yes |
paid_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
created_at | string (date-time) | yes |
items | array | yes |
items[].kind | string | yes |
items[].processor_ref | string | yes |
items[].description | ['string', 'null'] | yes |
items[].charge_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].refund_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].invoice_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].amount_minor | integer | yes |
items[].processor_fee_minor | integer | yes |
items[].platform_fee_minor | integer | yes |
items[].net_minor | integer | yes |
totals | object | yes |
totals.amount_minor | integer | yes |
totals.processor_fee_minor | integer | yes |
totals.platform_fee_minor | integer | yes |
totals.net_minor | integer | yes |
{
"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": "...",
"items": [
{
"kind": "...",
"processor_ref": "...",
"description": "40 gallon gas heater, installed",
"charge_id": "00000000-0000-4000-8000-000000000000",
"refund_id": "00000000-0000-4000-8000-000000000000",
"invoice_id": "00000000-0000-4000-8000-000000000000",
"amount_minor": 50000,
"processor_fee_minor": 50000,
"platform_fee_minor": 50000,
"net_minor": 50000
}
],
"totals": {
"amount_minor": 50000,
"processor_fee_minor": 50000,
"platform_fee_minor": 50000,
"net_minor": 50000
}
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |