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

MethodEndpoint
GET/api/v1/transaction/internal-swap-query

Authentication & Headers

HeaderRequiredDescriptionExample
AuthorizationYesBearer token used to authenticate the request.Bearer {{api_key}}
x-merchant-refYesUnique reference identifying the merchant.MERCHANT_001



Query Parameters

ParameterTypeRequiredDescriptionExample
date_fromstringYesStart date for the transaction query.2026-09-01
date_tostringYesEnd date for the transaction query.2026-09-23
pageintegerYesPage number to retrieve.1
no_recordsintegerYesNumber of records to return per page.10
sortstringYesSort order. Accepts asc or desc.asc
user_refstringYesMerchant 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_from and date_to define the transaction date range.
  • Use page and no_records to control pagination.
  • sort determines the ordering of returned transactions.
  • kind indicates whether the transaction is a BUY or SELL.
  • status reflects the current state of the swap transaction.

Did this page help you?