v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB

Payments

Get payment by ID

Retrieve detailed payment information including the associated invoice and customer.

get/api/payments/{id}

Path parameters

idstring required

Payment ID

Response

Payment details

idstring required

invoiceIdstring required

providerstring required

providerTransactionIdstring

amountstring required

Decimal amount as string

currencystring required

status'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'REFUNDED' required

failureReasonstring

metadataobject

createdAtstring required

updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "invoiceId": "clxinv123",
  "provider": "paystack",
  "providerTransactionId": "PAY_txn_abc123",
  "amount": "99.9900",
  "currency": "USD",
  "status": "SUCCEEDED",
  "failureReason": "Insufficient funds"
}