Xtrempay Api Documentation

Initiate Money Transfer

Cloud Mock

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

POST

/v1/transactions/execute

Maintainer:Xtrempay Devs

Execute a previously reserved transfer: validates the user’s PIN, submits to the gateway, and returns the up-to-date transfer status.

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

Example

{
    "transactionReference": "{{transactionReference}}",
    "transactionType":"BANK_TRANSFER",
    "pin": "{{transactionPin}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/918700-0-default/v1/transactions/execute' \
--header 'X-Idempotency-Key: {{x-idempotency}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transactionReference": "{{transactionReference}}",
    "transactionType":"BANK_TRANSFER",
    "pin": "{{transactionPin}}"
}'

Responses

🟢201Created

application/json

Body

Example

{
    "timestamp": "{{$timestamp}}",
    "status": 201,
    "success": true,
    "message": "Transfer initiated",
    "data": {
        "transactionReference": "a5b7d5b9-0d25-4a73-ab7e-9e2c48b7f6be",
        "status": "SUCCESS",
        "beneficiary": null,
        "accountNumber": null,
        "amount": 9000,
        "fee": 180,
        "total": 9180
    }
}

🟠400Invalid input

Modified at 2026-01-07 07:09:53

Generate a quote for any transaction type

Fetch Transaction Receipt