Get account | Halo Partner API

{
  "status": true,
  "message": "Account Retrieved Successfully",
  "data": {
    "age": "0",
    "BVN": "22200000001",
    "branchCode": "001",
    "customerID": "003622",
    "dateOfBirth": "",
    "email": "ada@example.com",
    "gender": "Female",
    "name": "Ada Example",
    "phoneNumber": "08000000001",
    "state": "",
    "Accounts": [
      {
        "accessLevel": "1",
        "accountNumber": "01150011070003622",
        "accountStatus": "Active",
        "accountType": "SavingsOrCurrent",
        "availableBalance": "0.00",
        "branch": "HEAD OFFICE MINT",
        "customerID": "003622",
        "accountName": "Ada Example",
        "productCode": "107",
        "dateCreated": "9/4/2022 1:41:41 AM",
        "lastActivityDate": "",
        "ledgerBalance": "0.00",
        "NUBAN": "1100000001",
        "referenceNo": "AO1A2B3C4D5E",
        "withdrawableAmount": "0.00",
        "kycLevel": "1"
      }
    ]
  },
  "status_code": 200
}

Returns a customer and the accounts your business opened for them. Find the customer by email or account number.

Authentication

AuthorizationBearer

Your Halo partner API key, sent as Authorization: Bearer <key>.

Request

This endpoint expects an object.

emailstringOptional

The customer email. Required when account_number is not sent.

account_numberstringOptional

An account number your business opened. Required when email is not sent.

Response

Success.

statusbooleanOptional

messagestringOptional

dataobjectOptional

status_codeintegerOptional

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error