Account Lookup

GET

/bank/{bank_slug}/account/lookup/

Last modified:2023-05-13 09:17:47

This page returns the customer account and the customer name giving the customer ID or account number.

The endpoints takes the bank slug and the account_number as query string and returns the client name and his formatted account number.
The account_number query parameter accepts the customer account number, the email or the phone number.

Note that this endpoint is used only for banks that accepts lookup function.
To know that bank accepts lookup, please check the has_lookup variable in the api_values attribute in every bank body.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

bank_slug

string

required

Example:

MF1-0001

Query Params

account_number

string

optional

Example:

16-01

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

response_code

string

required

response_data

object

required

account_number

string

required

name

string

required

response_message

string

required

success

boolean

required

Example

{
    "response_code": "00",
    "response_data": {
        "account_number": "30001-01-00-0000000001-01-95",
        "name": "Bizimana Jean Claude"
    },
    "response_message": "Success",
    "success": true
}

Modified at 2023-05-13 09:17:47

Cashout Payment banks

Bills operations flow