GET
/v1/admin/payouts/{payout}/ticketThe tab Ticket of the website's Payouts screen: the ticket linked to this payout, with its last six messages, so the reviewer reads where it stands. The ticket itself is answered on Tickets.
A trader has one open ticket at a time. open_ticket names the one they
have, which is the one to link rather than opening another; trader_gone
says there is nobody to write to.
Needs a firm. Our own staff name one with the Propper-Workspace header.
Request
curl "https://api.proppertrading.com/v1/admin/payouts/po_pk2jjt25cw5swbwv/ticket" \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
-H "Propper-Workspace: acme"
Response
{
"data": {
"object": "payout_ticket",
"ticket": null,
"trader_gone": false,
"open_ticket": null
},
"meta": {
"request_id": "req_01m50qhen5aqebcdw3jptbm8b5"
}
}
| Field | Description |
|---|---|
ticket | The linked ticket, or null. With subject, status, open, priority, assignee, created_at, last_message_at, total (messages) and messages |
ticket.messages | The last six, oldest first: from (trader, admin, ai or system), author, body (cut at 1200 characters), image, internal and created_at |
trader_gone | The trader deleted their account |
open_ticket | The trader's open ticket, with id and subject, or null |
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | workspace_required | Asked by our own staff without naming a firm |
| 401 | invalid_token | Not a token, or the secret does not match |
| 401 | revoked_token | Signed out here or from another device |
| 401 | expired_token | Ninety days without use, or a set expiry passed |
| 403 | admin_access_required | This account no longer helps run the environment |
| 403 | insufficient_scope | This device does not hold admin:read |
| 403 | workspace_not_permitted | The Propper-Workspace header names an environment this account cannot act in |
| 403 | forbidden | Without view_payouts, and view_tickets or manage_tickets |
| 404 | resource_not_found | No payout with that id in this firm |