Get Payment

Retrieves the latest status and details of an existing payment.

This endpoint is commonly used to verify the status of a payment after creating it or to recover from a network interruption.

Recommendation

Treat the Merchant Callback as the primary source of payment updates. Use this endpoint when you need to manually verify a payment or synchronize your records.

Endpoint

GET /api/payments/{referenceNumber}

Path Parameters

Parameter	Description
referenceNumber	The Overdrive Connect payment reference returned when the payment was created.

Request Headers

Header	Value
Authorization	`Basic API_KEY:API_SECRET`
Accept	`application/json`

Example Request

curl \
-u YOUR_API_KEY:YOUR_API_SECRET \
-H "Accept: application/json" \
https://api.example.com/api/payments/0197d3fd-f9e8-7f90-8e5c-bcba2a57fef8

Example Response

{
    "referenceNumber": "0197d3fd-f9e8-7f90-8e5c-bcba2a57fef8",
    "merchantPaymentReference": "ORDER-100001",
    "provider": "maya",
    "providerReference": "pay_xxxxxxxxx",
    "status": "pending",
    "redirectUrl": "https://checkout.example.com/pay/0197d3fd-f9e8-7f90-8e5c-bcba2a57fef8",
    "createdAt": "2026-07-06T12:30:15+08:00",
    "updatedAt": "2026-07-06T12:30:15+08:00"
}

Payment Statuses

Status	Description
`pending`	The payment has been created and is awaiting customer action.
`paid`	The payment completed successfully.
`failed`	The payment could not be completed.
`cancelled`	The customer cancelled the payment before completion.

Possible Errors

HTTP Status	Error Code
401	`INVALID_CREDENTIALS`
404	`PAYMENT_NOT_FOUND`
429	`RATE_LIMIT_EXCEEDED`

Next Step

Continue to the POST Redirect guide to learn how to initiate a payment without using the Merchant API.