🌍Understanding the API

Note: all requests should have your API Token as a bearer token in authorization header. Content-Type application/json

Virtual Accounts

Generating Virtual Accounts

To generate a virtual account the following request is should be sent

POST https://portal.echomoney.com.ng/emoney/api/generate_account

You're to send Account Name and Customer ID to be used to identify the customer on your system

Headers

Name	Type	Description
Bearer token*		your-api-token

Request Body

Name	Type	Description
Body*		{"account_name":"Musa Chukwudi","customer_id":"gnm2345knjmnjz"}

200: OK { "response_code": "00", "account_name": "E-PAYMENT INT(Kolawole Idiaro)", "account_number": "9909999036", "customer_id": "EPAYMENT10001" }

{
    // Response
}

Notification Endpoint

Our API uses the REST ter

The EchoMoney API allows you to setup a webhook to accept notifications for incoming transfers for all transactions to your virtual account.

Your webhook endpoint can be configured at any time from your profile page on EchoMoney portal.

The notification request to your endpoint will be in the format

POST yoururl.com/whateveryoudecide

We expect to get a response back on every notification for it to be marked as successful at our end. It is advisable to use the transaction ref to control duplicate notification incase your system did not respond back on first attempt of notification.

Request Body

Name	Type	Description
Body*		{"account_number":"accountNumber","reference":"ref","initial_amount":"am1","settled_amount":"am2"}

200: OK Logged Successfully

{
    // Response
}

Funds Transfer

Get Bank List and Bank Codes

To get the list of Banks and their codes, use the following

GET https://portal.echomoney.com.ng/emoney/api/GetNIPBanks

Headers

Name	Type	Description
Bearer Token*		your-api-token

Validating Accounts

To validate an account, use the following:

POST https://portal.echomoney.com.ng/emoney/api/3pvalidate

Headers

Name	Type	Description
Bearer token*		your-api-token

Request Body

Name	Type	Description
Body*		{"accountnumber":"9008172126","bankcode":"000013"}

200: OK {"status":"200","name":"Mr Kolawole Idiaro"}

{
    // Response
}

Commit Funds Transfer

To commit a transfer, use the following:

POST https://portal.echomoney.com.ng/emoney/api/3ptransfer

Headers

Name	Type	Description
Bearer token*		your-api-token

Request Body

Name	Type	Description
Body*		{ "accountnumber":"2059920565", "amount":"2000", "customer_reference":"ECHO2021120401002", "bankcode":"000004", "narration":"IDIARO Test", "beneficiary_name":"RASAQ K IDIARO" }

200: OK { "responseCode": "00", "responseStatus": "Successful", "responseMessage": "Transaction processed successfully" }

{
    // Response
}

Verify Completed Transfer

To verify completed transfers, use the following:

POST https://portal.echomoney.com.ng/emoney/api/3pbank_verify

Headers

Name	Type	Description
Bearer Token*		your-api-token

Request Body

Name	Type	Description
Body*		{ "customer_reference":"EPAYMENT|EASE|2021120300001" }

200: OK { "responseCode": "00", "responseStatus": "Successful", "responseMessage": "Transaction processed successfully" }

{
    // Response
}

EchoMoney Wallet Balance Enquiry

This allows you to check your EchoMoney wallet balance realtime

GET https://portal.echomoney.com.ng/emoney/api/balance_inquiry

Headers

Name	Type	Description
Bearer Token*		your-api-token

200: OK { "responseCode": "00", "name": "ABC Nigeria Limited", "balance": "612,031.00" }

{
    // Response
}