Operation

List payments

GET/payments

List all payments with optional filtering and pagination

Query parameters

orderIdstringOptional: Filter by order ID
statusstringOptional: Filter by payment status
paymentTypestringOptional: Filter by payment type
paymentProviderIdstringOptional: Filter by payment provider
fromDatestringOptional: Filter by created date (from)
toDatestringOptional: Filter by created date (to)
pagestringOptional: Page number
limitstringOptional: Items per page (max 100)

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

Payments 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" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"

Response 200

{
  "payments": [
    {
      "id": "pay_abc123",
      "organisationId": "org_abc123",
      "invoiceId": "inv_abc123",
      "amount": 2500,
      "currency": "USD",
      "status": "succeeded",
      "method": "card",
      "paidAt": "2024-01-15T10:35:00Z",
      "failedAt": null,
      "failureCode": null,
      "failureMessage": null,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:35:00Z"
    }
  ]
}

List payments

Query parameters

Headers

Returns

Errors

Try it in test mode

Query parameters