Skip to main content
POST
/
lookup
Lookup account
curl --request POST \
  --url https://processor-prod.up.railway.app/lookup \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "bank_code": "100004",
  "currency": "ngn",
  "account_number": "1234567890"
}
'
{
  "success": true,
  "status": 200,
  "message": "Bank account lookup successfully",
  "timestamp": "2025-09-10T01:20:03.033Z",
  "data": {
    "bank_code": "100004",
    "bank_name": "Opay",
    "account_number": "1234567890",
    "account_name": "John Doe"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
bank_code
string
required

Bank code for account lookup

Example:

"100004"

​
currency
enum<string>
required

Currency code for the account

Available options:
NGN
Example:

"ngn"

​
account_number
string
required

Bank account number to lookup

Example:

"1234567890"

Response

200 - application/json

Bank account lookup successful

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Bank account lookup successfully"

​
timestamp
string<date-time>
Example:

"2025-09-10T01:20:03.033Z"

​
data
object