Xtrempay Api Documentation

List & Search Beneficiaries

Testing

Cloud Mock

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

GET

v1/user/beneficiaries

Maintainer:Tomi Orisatuyi

This endpoint allows clients to query the beneficiaries (e.g., recipient accounts for transactions) linked to a given account number. It is lused to fetch saved beneficiary details for transactions like bank transfers or internal transfers enabling users to select from previously added recipients without re-entering details

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://mock.apidog.com/m1/918700-0-defaultv1/user/beneficiaries?accountNumber' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success

application/json

Body

Example

{
    "timestamp": "2025-05-18T18:00:00Z",
    "status": 200,
    "success": true,
    "message": "Matched beneficiaries",
    "data": [
        {
            "id": "b8f5c9e2-3a7d-4fb2-92e1-12a3456789ab",
            "bankCode": "058",
            "accountNumber": "1782839290",
            "name": "Paul Ogechukwu"
        },
        {
            "id": "d3e7b4a1-9c6d-4f23-b2c9-45d67890abcd",
            "bankCode": "011",
            "accountNumber": "1782000000",
            "name": "Patience Emeka"
        }
    ]
}

🟠401Unauthorized

🟠404Record not found

Modified at 2025-08-30 04:25:32

Cancel Transaction

List Billers by Service Type