Skip to content
Docs
Open Backstage
Operation

Process an approved refund request

POST/refund-requests/{requestId}/process
Executes an approved refund: reverses the payments behind the order through the payments domain and reports the refunds it created. Once they have succeeded the order is refunded in full (less the booking fee, when the policy keeps it): it moves to `refunded`, its passes are cancelled, and `order.refunded` is sent.

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.

Returns

Refund processed

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 POST "https://api.ticketlayer.com/v1/refund-requests/{requestId}/process" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"
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"
  },
  "refunds": [
    {
      "id": "ref_abc123",
      "paymentId": "pay_abc123",
      "amount": 2500,
      "currency": "GBP",
      "status": "succeeded"
    }
  ]
}

Try it in test mode

Path parameters