CreddotDocsCreddot Docs
API referencePublic checkout

Read public checkout payment status

No authentication. Poll this payer-safe endpoint after starting a Pay Link, event, Split Pay, or storefront order payment. It returns current database status immediately after callback or reconciliation settlement and never exposes payer contact details, provider references, or internal IDs.

GET
/api/v1/checkout/payments/{reference}

No authentication. Poll this payer-safe endpoint after starting a Pay Link, event, Split Pay, or storefront order payment. It returns current database status immediately after callback or reconciliation settlement and never exposes payer contact details, provider references, or internal IDs.

Path Parameters

reference*string

Opaque pl_, evt_, sp_, or sf_ checkout reference returned by payment initialization.

Response Body

application/json
  1. response
reference*string
status*string
Value in"PENDING""PROCESSING""SUCCESS""FAILED"
amountMinor*string

Integer minor units encoded as a string.

currency*string
channel*|
Value in"BANK_TRANSFER""CARD""USSD""QR"
merchantName*string
paidAt*|
Formatdate-time
failureReason*string|null
redirectUrl*|
Formaturi
kind*string
Value in"PAYMENT_LINK""EVENT""SPLIT_PAY""STOREFRONT""SUBSCRIPTION"
orderCode*|

Event ticket or storefront order code. Null for Pay Links and Split Pay.

Example Request
curl -X GET 'https://api.creddot.com/api/v1/checkout/payments/string'
Example Response
{  "reference": "pl_cmv7uxfry000mnz074ljtuh7e_6dc9360a-c028-421d-a176-8559dc56b9f2",  "status": "PENDING",  "amountMinor": "10000",  "currency": "NGN",  "channel": "BANK_TRANSFER",  "merchantName": "string",  "paidAt": "2019-08-24T14:15:22Z",  "failureReason": "string",  "redirectUrl": "http://example.com",  "kind": "PAYMENT_LINK",  "orderCode": "string"}