Transactions
Endpoint
- Method:
GET - Path:
/v1/transactions - Purpose: List merchant transactions with optional filtering
Request Payload
No request body.
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
type | string | No | Filter by transaction type: payin or payout |
limit | number | No | Number of records to return (example: 20) |
offset | number | No | Pagination offset (example: 0) |
Example URL
/v1/transactions?type=payin&limit=10
Response
Success (200)
| Field | Type | Description |
|---|---|---|
items | object[] | Transaction list |
items[].id | string | Transaction id |
items[].type | string | payin or payout |
items[].status | string | Transaction status |
items[].amount | string | Requested amount |
items[].paidAmount | string | null | Paid amount (if applicable) |
items[].platformOrderId | string | Platform reference id |
items[].createdAt | string (ISO datetime) | Creation timestamp |
items[].completedAt | string | null (ISO datetime) | Completion timestamp |
total | number | Total matching records |
limit | number | Returned page size |
offset | number | Returned page offset |
{
"items": [
{
"id": "uuid",
"type": "payin",
"status": "success",
"amount": "500",
"paidAmount": "500",
"platformOrderId": "...",
"createdAt": "...",
"completedAt": "..."
}
],
"total": 1,
"limit": 20,
"offset": 0
}