Skip to content
Docs
Operation

Get payment

GET/payments/{paymentId}
Get a specific payment by ID

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

Payment 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" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"
Response 200
{
  "payment": {
    "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"
  }
}

Try it in test mode

Path parameters
Payment ID