Deposit transactions add funds to your payout balance. Deposits are created when payments are settled, refunds are reversed, or manual deposits are made.List Deposit Transactions#
Get a paginated list of deposit transactions that added funds to your payout balance.Endpoint: GET /v1/payouts/deposits| Name | Type | Required | Description |
|---|
offset | integer | No | Pagination offset (default: 0) |
limit | integer | No | Pagination limit (default: 20, max: 100) |
start_date | string | No | Filter deposits after this date (ISO 8601 format) |
end_date | string | No | Filter deposits before this date (ISO 8601 format) |
Success Response (200 OK):{
"data": {
"items": [
{
"id": "txn_abc123",
"amount": "5000.00",
"currency": "GMD",
"source": "payment",
"source_id": "pay_xyz789",
"description": "Settlement from payment",
"status": "completed",
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T10:30:05Z"
},
{
"id": "txn_def456",
"amount": "2500.00",
"currency": "GMD",
"source": "refund",
"source_id": "ref_abc123",
"description": "Refund reversal",
"status": "completed",
"created_at": "2024-01-14T14:20:00Z",
"completed_at": "2024-01-14T14:20:03Z"
}
],
"count": 2,
"offset": 0,
"limit": 20
}
}
Error (401 Unauthorized):{
"error": "Invalid API key"
}
Filter by Date Range#
Get Deposit Transaction#
Retrieve detailed information about a specific deposit transaction.Endpoint: GET /v1/payouts/deposits/{transaction_id}| Name | Type | Required | Description |
|---|
transaction_id | string | Yes | Deposit transaction ID |
Success Response (200 OK):{
"data": {
"id": "txn_abc123",
"amount": "5000.00",
"currency": "GMD",
"source": "payment",
"source_id": "pay_xyz789",
"description": "Settlement from payment",
"status": "completed",
"created_at": "2024-01-15T10:30:00Z",
"completed_at": "2024-01-15T10:30:05Z"
}
}
{
"error": "Deposit transaction not found"
}
Error (401 Unauthorized):{
"error": "Invalid API key"
}
Modified at 2025-12-25 21:44:15