Payments

Check payment status

Retrieve the current status of a payment request by ID.

The Check Payment Status endpoint allows you to confirm the current state of a payment transaction using its unique ID. This is especially useful for order fulfillment, customer support, or retrying failed payments.

Endpoint

GET /v1/payments/{payment_id}/status

Path Parameters

Parameter	Type	Required	Description
payment_id	string	Yes	The unique ID of the payment to check.

Headers

Key	Value	Required
Authorization	Bearer <access_token>	Yes

Response

Successful Response (200 OK)

{
  "id": "pay_001",
  "status": "succeeded",
  "amount": 5000,
  "currency": "USD",
  "reference": "order_12345",
  "updated_at": "2025-09-18T20:42:00Z"
}

Field	Type	Description
id	string	Payment ID.
status	string	Current status (pending, succeeded, failed, canceled).
amount	int	Payment amount in minor units (e.g., 5000 = $50.00).
currency	string	ISO 4217 currency code.
reference	string	External order or invoice reference.
updated_at	string	Last update timestamp in ISO 8601 format.

Error Response (404 / 401)

{
  "error": "not_found",
  "message": "Payment with ID pay_999 could not be found."
}

Error Code	Meaning
not_found	Payment does not exist.
unauthorized	Invalid or missing access token.

Example Usage

cURL

curl -X GET "https://api.example.com/v1/payments/pay_001/status" \
  -H "Authorization: Bearer your_access_token"

JavaScript (Fetch)

const response = await fetch("https://api.example.com/v1/payments/pay_001/status", {
  method: "GET",
  headers: {
    "Authorization": "Bearer your_access_token"
  }
});

const data = await response.json();
console.log(data.status); // succeeded

Always check the status field before confirming service delivery. For failed or canceled payments, consider retrying the transaction or prompting the customer to update payment details.

List all transactions

Create a payment request

Need help? Contact Support

Join our Discord Community

Questions? Contact Sales

On this page

Title