Operation

List refunds

GET/payments/{paymentId}/refunds

List all refunds for a specific payment

Path parameters

paymentIdstringRequired: Payment ID

Headers

X-Ticketlayer-ChannelstringOptional: Slug of the sales channel to act through. A channel-scoped credential supplies its own channel and this header, when sent, must agree with it. On a read it filters to what that channel sells, at its resolved prices; on a cart it is required; on an order operation it is derived from the order and may only confirm it, never contradict it.

Returns

Refunds retrieved successfully

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 GET "https://api.ticketlayer.com/v1/payments/pay_abc123xyz789/refunds" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"

Response 200

{
  "refunds": [
    {
      "id": "ref_abc123xyz789",
      "paymentId": "pay_abc123xyz789",
      "externalRefundId": "re_xxx",
      "refundRequestId": "rfr_2mK9xB4nQ7rT1pLd3vZs",
      "source": "platform",
      "destination": "original",
      "storedValueAccountId": null,
      "amount": 4850,
      "status": "succeeded",
      "reason": "requested_by_customer",
      "notes": "Customer unable to attend",
      "failureCode": null,
      "failureMessage": null,
      "completedAt": "2024-01-15T11:00:00Z",
      "failedAt": null,
      "metadata": {
        "ticketNumber": "T-001"
      },
      "createdAt": "2024-01-15T10:50:00Z",
      "updatedAt": "2024-01-15T11:00:00Z"
    }
  ]
}

List refunds

Path parameters

Headers

Returns

Errors

Try it in test mode

Path parameters