Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Customers are created when you create a reserved account or initialise initialize a transaction. This API can be used to update a customer's email and name.

Info
titleEndpoint
PUT: https://sandbox.monnify.com/

This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here

Endpoint URL: {{base_url}}/api/v1/customer/update/{currentCustomerEmail}

Please note that this endpoint is protected by OAuth 2.0 Bearer Token

...

HTTP Method: PUT

Info

The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url

Sample Request

Update Customer Details Request
Code Block
languagejs
themeRDark
titleUpdate Customer Details Request
json
{
    "customerFullName":"Chidera Nwoke",
    "customerEmail":"chima@gmail.com"
}

Sample Response

Get Transaction Status Request
Code Block
languagejs
themeRDark
titleGet Transaction Status Requestjson
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "customerFullName": "Chidera Nwoke",
        "customerEmail": "chima@gmail.com"
    }
}

...

Field Reference

Request



Field

Description

Compulsory

currentCustomerEmail

Current email for configured for the customer on Monnify. This email currently identifies the customer.

Yes

customerEmail

Updated customer's email. Could be same thing as the current customer email.

Yes

customerFullName

Updated customer's name. Could be the same if customer's name is not changing.

No