Retrieve a Payment by ID

Overview

Retrieve a single payment by its ID. Includes full details for reconciliation or display.

Path

GET /api/v1/payments/{id}

Path parameter: id (integer, required) - The unique ID of the payment.

Query Parameters

None.

Request Headers

Content-Type: application/json
Authorization: Bearer <token> (OAuth 2.0 token)

Request Body

None.

Response

Success (200 OK)

Returns the payment object.

Response Body Schema

{
  "data": {
    "id": integer,
    "reference": string,
    "invoice_id": integer,
    "channel": string,
    "amount": {
      "cents": integer,
      "currency_iso": string
    },
    "paid_at": string (ISO 8601 datetime),
    "emailed_at": string|null (ISO 8601 datetime),
    "created_at": string (ISO 8601 datetime),
    "updated_at": string (ISO 8601 datetime),
    "url": string (full API URL to the payment)
  }
}

Example Response

{
  "data": {
    "id": 28,
    "reference": "PYM-7C0F-6335",
    "invoice_id": 59,
    "channel": "card",
    "amount": {
      "cents": 4300,
      "currency_iso": "USD"
    },
    "paid_at": "2025-08-28T18:47:46.394Z",
    "emailed_at": "2025-08-28T18:48:36.154Z",
    "created_at": "2025-08-28T18:47:46.407Z",
    "updated_at": "2025-08-28T18:49:03.796Z",
    "url": "http://localhost:3000/api/v1/payments/28.json"
  }
}

Errors

Status Code	Description	Example Body
401 Unauthorized	Invalid or missing token.	`{"error": "Unauthorized"}`
403 Forbidden	Insufficient permissions.	`{"error": "Forbidden"}`
404 Not Found	Payment not found.	`{"error": "Payment not found"}`
500 Internal Server Error	Server error.	`{"error": "Internal Server Error"}`

Usage Notes

Use the url field for self-referential links in integrations.
This endpoint is read-only and lightweight.

We are using cookies to improve your experience!