Swap
The Swap verification endpoint allows you to verify a specific swap transaction using its transaction merchant reference and user reference.
Request
Method: GET
Endpoint:
{{base_url}}/api/v1/swap/dataAuthentication & Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | String | Yes | Bearer <token> — your activated authentication token. |
Content-Type | String | Yes | Must be set to application/json. |
x-merchant-ref | String | Yes | Your unique merchant reference. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
txn_merchant_ref | String | Yes | Unique merchant reference for the swap transaction. |
user_ref | String | Yes | Unique reference identifying the user associated with the transaction. |
Example Request
{{base_url}}/api/v1/swap/data?txn_merchant_ref=T123ASDEWSSSAQWES&user_ref=URF12333Query Swap Transactions
The Swap Query endpoint allows you to retrieve swap transaction records using filters such as date range, user reference, pagination, and sort order.
Use this endpoint when you need to search for or retrieve multiple swap transactions, rather than verifying one specific transaction.
Request
Method: GET
Endpoint:
{{base_url}}/api/v1/transaction/swap-queryAuthentication & Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | String | Yes | Bearer <token> — your activated authentication token. |
Content-Type | String | Yes | Must be set to application/json. |
x-merchant-ref | String | Yes | Your unique merchant reference. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
date_from | String | Yes | Start date for the transaction search. |
date_to | String | Yes | End date for the transaction search. |
page | Integer | Yes | Page number for paginated results. |
no_records | Integer | Yes | Number of records to return per page. |
sort | String | Yes | Sort order. Use asc or desc. |
user_ref | String | No | Filter transactions by a specific user reference. |
Example Request
{{base_url}}/api/v1/transaction/swap-query?date_from=2026-01-01&date_to=2026-02-01&page=1&no_records=10&sort=asc&user_ref=URFX2333When to Use Each Endpoint
| Endpoint | Use Case |
|---|---|
| Swap Data | Verify or retrieve details for a specific swap transaction using txn_merchant_ref and user_ref. |
| Swap Query | Search and retrieve multiple swap transactions using date, pagination, sorting, and user filters. |
Updated 25 days ago
Did this page help you?

