Reverse a recorded payment
Reverse a recorded payment. Append-only ledger correction with a reason; reopens bill balances. Does not claw back or move money and cannot be undone. Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `write` scope. Requires an Idempotency-Key. Money values are exact decimal strings; dates are ISO calendar dates.
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Path Parameters
Header Parameters
Caller-generated UUID/ULID. Same key + same body replays the original response; the key also derives the durable operation identity, so a retried payment, reversal or draft is never applied twice.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/team-payouts/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08/reverse" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "reason": "string" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "currency": "string", "amount": "string", "paidDate": "2019-08-24", "method": "string", "savedMethodId": "string", "reference": "string", "note": "string", "createdAt": "2019-08-24T14:15:22Z", "status": "RECORDED", "reversedAt": "2019-08-24T14:15:22Z", "reversalReason": "string", "settlementCurrency": "string", "settlementAmount": "string", "exchangeRate": "string", "settlementMode": "string", "allocations": [ { "billId": "b9de0a53-2363-44cf-9760-a7ddf29fedb4", "number": "string", "currency": "string", "amount": "string", "cashAmount": "string", "cashCurrency": "string", "links": { "app": "string", "payee": "string", "project": "string", "task": "string" } } ], "links": { "app": "string", "payee": "string", "project": "string", "task": "string" }, "bills": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": "string", "currency": "string", "status": "DRAFT", "total": "string", "amountPaid": "string", "remaining": "string", "paymentStatus": "UNPAID", "links": { "app": "string", "payee": "string" } } ] }, "warnings": [ "string" ]}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}Create bulk draft bills
Creates the previewed drafts (reviewToken required). Never approves, reserves time or pays; each draft needs its own approval. Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `write` scope. Requires an Idempotency-Key. Money values are exact decimal strings; dates are ISO calendar dates.
List saved payout methods
Read-only. Active saved method labels (id, name, type) for savedMethodId. No account numbers or bank details. Query parameters are rejected (422). Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `read` scope. Money values are exact decimal strings; dates are ISO calendar dates.