Get All Swap Transaction
Query Swap Transactions
Retrieves swap transaction records for a merchant within a specified date range. Supports pagination, sorting, and filtering by merchant user reference.
Request
| Method | Endpoint |
|---|---|
GET | /api/v1/transaction/internal-swap-query |
Authentication & Headers
| Header | Required | Description | Example |
|---|---|---|---|
Authorization | Yes | Bearer token used to authenticate the request. | Bearer {{api_key}} |
x-merchant-ref | Yes | Unique reference identifying the merchant. | MERCHANT_001 |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
date_from | string | Yes | Start date for the transaction query. | 2026-09-01 |
date_to | string | Yes | End date for the transaction query. | 2026-09-23 |
page | integer | Yes | Page number to retrieve. | 1 |
no_records | integer | Yes | Number of records to return per page. | 10 |
sort | string | Yes | Sort order. Accepts asc or desc. | asc |
user_ref | string | Yes | Merchant user's reference. | {{vault:Merchant-user-ref}} |
Example Request
{{base_url}}/api/v1/transaction/internal-swap-query?date_from=2026-09-01&date_to=2026-09-23&page=1&no_records=10&sort=asc&user_ref={{vault:Merchant-user-ref}}Response
200 — Success
Example Response
{
"status": "success",
"message": "Retrieved successfully",
"data": [
{
"base_amount": 10000,
"base_currency": "NGN",
"collection_channel": "BLOCK_PAY_LINK",
"created_at": "2026-09-03T12:43:45.758476Z",
"failure_reason": "",
"kind": "BUY",
"notification_url": "string",
"payment_ref": "2f65285b-d12a-4cf3-a118-97cf67111976",
"payout_channel": "BANK_TRANSFER",
"quote_amount": 10.08064516,
"quote_currency": "CAD",
"rate_used": 992,
"status": "PENDING_COLLECTION",
"swap_type": "CHECKOUT_LINK",
"txn_merchant_ref": "trf000001_0122_1",
"updated_at": "2026-09-03T12:43:45.758476Z"
}
]
}Notes
date_fromanddate_todefine the transaction date range.- Use
pageandno_recordsto control pagination. sortdetermines the ordering of returned transactions.kindindicates whether the transaction is aBUYorSELL.statusreflects the current state of the swap transaction.
Updated 19 days ago
Did this page help you?
