Returns all charges (payins) associated with your organization in the current API key environment, with pagination and optional status filtering.
List payins
GET /api/v1/payments/payins
Authorization: Bearer <api_key> header.
Query parameters
Maximum number of results to return. Accepts 1–100.
Number of results to skip for pagination.
Filter results to a specific charge status (e.g., succeeded, pending, failed, underpaid).
Total number of payins matching the query (before pagination).
Array of payin objects.
Checkout reference, if one was set at checkout creation.
Current charge status (e.g., succeeded, pending, failed).
Whether this charge is eligible for a refund.
Requested charge amount as a decimal string.
Amount actually received from the customer.
Amount still outstanding (non-zero for underpaid charges).
Amount collected in your settlement currency.
ISO 8601 timestamp when the charge was created.
ISO 8601 timestamp when the charge reached a terminal status, or null if not yet complete.
{
"total": 142,
"items": [
{
"id": "ch_a1b2c3d4e5f6",
"reference": "ord_12345",
"status": "succeeded",
"is_refundable": true,
"customer_email": "customer@example.com",
"customer_name": "John Doe",
"amount": "50.00",
"amount_paid": "50.00",
"amount_remaining": "0.00",
"amount_collected": "48.50",
"currency": "USD",
"transaction_date": "2024-01-15T10:00:00Z",
"completed_at": "2024-01-15T10:02:30Z"
}
]
}
Get a single payin
GET /api/v1/payments/payins/{charge_id}
The ID of the charge to retrieve.
Whether this charge is eligible for a refund.
Requested amount as a decimal string.
Amount actually received.
Amount still outstanding.
Payment method type (e.g., bank_transfer, mobile_money, card).
Internal payment method identifier.
Originating channel (e.g., api, checkout).
Payment description or narration.
Public metadata attached to the charge.
ISO 8601 creation timestamp.
ISO 8601 last-updated timestamp.
ISO 8601 completion timestamp.
Error codes
| Status | Description |
|---|
401 | Invalid or missing API key. |
403 | Charge belongs to a different organization. |
404 | Charge not found. |
Example
List payins
curl --request GET \
--url 'https://api.syncgrampay.com/api/v1/payments/payins?limit=10&offset=0&status_filter=succeeded' \
--header 'Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0'
curl --request GET \
--url https://api.syncgrampay.com/api/v1/payments/payins/ch_a1b2c3d4e5f6 \
--header 'Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0'