Skip to navigation

Update customer details

Updates the bank record of a customer your business opened an account for. Only these keys in params are applied: FirstName, LastName, OtherNames, City, Address, Gender, DateOfBirth, PlaceOfBirth, PhoneNo, Email. Other keys are ignored. Use update-customer-bvn to change a BVN.

If the customer also banks with Halo outside your business, only Halo support can change their details and the answer is 403.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
paramsobjectRequired
The fields to change.
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
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error