Skip to navigation
Customers

Fetch Single Customer

View as Markdown

Fetch one customer that belongs to your company by their customer ID.

Path parameter: customer (string, required) - the customer ID, or the customer’s email address. Any value containing @ is treated as an email.

Behaviour notes

  • bankAccount is null until Generate Customer Account succeeds.
  • bankAccount.balance is in Naira (float).
  • An unknown customer does not return 404: you get 200 with "data": null.
  • BVN is never returned.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Path parameters

customerstringRequired
The customer ID returned by Create Customer.

Response

Success / Success (no account generated yet) / Customer not found

statusstringOptional
dataobject or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error