Get Specific Swap History

Get Specific Swap History

Retrieves the details of a specific swap transaction using the transaction merchant reference and user reference.

Request

MethodEndpoint
GET/api/v1/swap/data


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
txn_merchant_refstringYesUnique merchant reference of the swap transaction.SWP_001245
user_refstringYesReference of the user associated with the transaction.USR_001234

Example Request

{{base_url}}/api/v1/swap/data?txn_merchant_ref=SWP_001245&user_ref=USR_001234

Example Response

{
  "status": "success",
  "message": "Retrieved successfully",
  "data": {
    "base_amount": 25000,
    "base_currency": "NGN",
    "collection_channel": "BANK_TRANSFER",
    "created_at": "2026-09-10T10:25:35.758476Z",
    "failure_reason": "",
    "kind": "BUY",
    "notification_url": "https://example.com/webhook/swap",
    "payment_ref": "PAY_8f72a91c",
    "payout_channel": "BANK_TRANSFER",
    "quote_amount": 25.2016129,
    "quote_currency": "CAD",
    "rate_used": 992,
    "status": "COMPLETED",
    "swap_type": "DIRECT_SWAP",
    "txn_merchant_ref": "SWP_001245",
    "updated_at": "2026-09-10T10:28:45.758476Z"
  }
}

Response

FieldTypeDescription
statusstringIndicates whether the request was successful.
messagestringResponse message.
dataobjectDetails of the requested swap transaction.
data.base_amountnumberAmount of the base currency involved in the swap.
data.base_currencystringCurrency being exchanged.
data.collection_channelstringChannel through which the base amount is collected.
data.created_atstringDate and time the transaction was created.
data.failure_reasonstringReason for failure, if applicable.
data.kindstringSwap direction, such as BUY or SELL.
data.notification_urlstringURL configured to receive transaction notifications.
data.payment_refstringUnique payment reference for the transaction.
data.payout_channelstringChannel used to deliver the quote amount.
data.quote_amountnumberAmount received in the quote currency.
data.quote_currencystringCurrency received from the swap.
data.rate_usednumberExchange rate applied to the transaction.
data.statusstringCurrent status of the swap transaction.
data.swap_typestringType of swap transaction.
data.txn_merchant_refstringMerchant reference for the swap transaction.
data.updated_atstringDate and time the transaction was last updated.

Did this page help you?