Operation
Change where a refund request pays out
PATCH
/refund-requests/{requestId}Sets where the money goes when the request is processed (`refundTo`): back to how the order was paid, or into the customer's account credit. Staff use it to override what the requester asked for, while the request is requested or approved (an auto-approved request included); a processed or rejected request is REFUND_REQUEST_CLOSED. Account credit needs a customer on the order (STORED_VALUE_CUSTOMER_REQUIRED). Needs refundrequests.decide on the account that decides the request.
Path parameters
requestIdstringRequired
Headers
Idempotency-KeystringOptional- Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.
Body
Returns
Refund request updated
Errors
- 400
- Bad Request - Invalid input
- 401
- Unauthorized - Authentication required
- 403
- Forbidden - Insufficient permissions
- 404
- Not Found - Resource not found
- 500
- Internal Server Error
Every error names its code and links to it. All error codes
curl -X PATCH "https://api.ticketlayer.com/v1/refund-requests/{requestId}" \ -H "Authorization: Bearer tlak_..." \ -H "X-Ticketlayer-Org: your-org-slug" \ -H "Content-Type: application/json" \ -d '{ "refundTo": "original" }'Response 200
{
"request": {
"id": "rfr_abc123",
"organisationId": "org_abc123",
"orderId": "ord_abc123",
"accountId": "acc_abc123",
"type": "refund",
"status": "pending",
"reason": "Customer cannot attend",
"refundTo": "original",
"notes": null,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}