Xtrempay Api Documentation

Generate a quote for any transaction type

Cloud Mock

https://mock.apidog.com/m1/918700-0-default

POST

/v1/transactions/quote

Maintainer:Xtrempay Devs

This endpoint allows clients to request a quote for a transaction before executing it. The quote provides details such as the transaction amount, associated fees, total cost, and an expiration time for the quote. It supports three transaction types: internal transfers, bank transfers, and bill payments.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Internal Transfer QuoteBank Transfer QuoteBill Payment QuoteAIRTIME Quote

{
  "transactionType": "BANK_TRANSFER",
  "amount": 5800,
  "beneficiary": "{{beneficiary}}",
  "accountNumber": "0147787856",
  "bankCode": "000013",
  "narration": "Invoice payment"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Internal Transfer QuoteBank Transfer QuoteBill Payment QuoteAIRTIME Quote

curl --location --request POST 'https://mock.apidog.com/m1/918700-0-default/v1/transactions/quote' \
--header 'X-Idempotency-Key: {{$string.uuid}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "transactionType": "BANK_TRANSFER",
  "amount": 5800,
  "beneficiary": "{{beneficiary}}",
  "accountNumber": "0147787856",
  "bankCode": "000013",
  "narration": "Invoice payment"
}'

Responses

🟢200OK

application/json

A quote with fees and expiry

Body

Examples

ElectricityBILL PAYMENTTv Subscription

{"timestamp":"2025-07-26T18:40:36.930898","status":200,"success":true,"message":"Transaction quote successfully","data":{"transactionReference":"7edf996c-5940-44b1-9eee-e418a841e14a","transactionType":"BILL_PAYMENT","status":"PENDING","beneficiary":null,"accountNumber":"1111111111111","amount":6000,"fee":0,"total":6000}}

🟠400Bad Request

Modified at 2025-07-28 19:06:31

Lookup Account Holder

Initiate Money Transfer