Skip to main content
Returns details for a single charge, including amounts, settlement information, metadata, and a complete timeline of status transitions.

​
Request

GET /api/v1/payments/charges/{charge_id}
Requires API key authentication via the Authorization: Bearer <api_key> header. Path parameters
​
charge_id
string
required
The ID of the charge to retrieve.

​
Response

​
charge_id
string
required
Unique identifier for the charge.
​
organization_id
string
required
Your organization ID.
​
customer_id
string
required
Identifier for the customer who made the payment.
​
amount
string
required
The amount charged, as a decimal string in currency.
​
currency
string
required
The charge currency code (e.g., NGN, USD).
​
settlement_currency
string
required
The currency in which your organization is settled (e.g., USD).
​
settlement_amount
string
required
The amount credited to your balance in settlement_currency, as a decimal string.
​
status
string
required
Current charge status. Common values: pending, succeeded, failed, underpaid, accepted.
​
metadata
object
Key-value metadata attached to the checkout at creation time.
​
status_history
object[]
Chronological list of status transitions.
​
created_at
string
required
ISO 8601 creation timestamp.
​
updated_at
string
required
ISO 8601 timestamp of the last update.
{
  "charge_id": "ch_a1b2c3d4e5f6",
  "organization_id": "org_xyz789",
  "customer_id": "cus_abc123",
  "amount": "50.00",
  "currency": "USD",
  "settlement_currency": "USD",
  "settlement_amount": "48.50",
  "status": "succeeded",
  "metadata": {
    "order_id": "ord_12345"
  },
  "status_history": [
    {
      "status": "pending",
      "occurred_at": "2024-01-15T10:00:00Z",
      "provider_reference": null,
      "reason": null
    },
    {
      "status": "succeeded",
      "occurred_at": "2024-01-15T10:02:30Z",
      "provider_reference": "prov_ref_987654",
      "reason": null
    }
  ],
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-15T10:02:30Z"
}

​
Error codes

StatusDescription
401Invalid or missing API key.
403Charge belongs to a different organization.
404Charge not found.

​
Example

curl --request GET \
  --url https://api.syncgrampay.com/api/v1/payments/charges/ch_a1b2c3d4e5f6 \
  --header 'Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0'