This API endpoint enables lenders to generate virtual accounts for their customers or get already existing customer virtual account information.
Request Message description
Field# | Field name | Data type | Max length | Required | Description |
---|---|---|---|---|---|
1 | customerId | String | required | The unique customer identifier / phone number | |
2 | customerName | String | required | The customer’s full name | |
3 | providerCode | String | required | The provider’s unique code | |
4 | currencyCode | String | required | The currency code for the virtual account |
Endpoint
POST /api/v1/payments/customer-virtual-account
Headers
"Authorization": "Bearer {token}"
Sample request
{"customerId": "2348161286594","customerName": "Tobi M Odemona","providerCode": "FER"}
Response Message field description
Field# | Field name | Description |
---|---|---|
1 | id | The virtual account id in IPG |
2 | merchantCode | The merchant code |
3 | accountName | The virtual account name |
4 | bankName | The virtual bank name |
5 | bankCode | The virtual bank code |
6 | payableCode | The unique payable code |
7 | dateCreated | The timestamp at creation |
Sample Response (success)
{
"id": 74422,"merchantCode": "VNA","payableCode": "VIRTUAL_ACCOUNTVNA1623317477940","accountName": "Tobi M Odemona","accountNumber": "7610002844","bankName": "Wema Bank","bankCode": "WEMA","dateCreated": 1623317485430
}
Sample Response (failure)
{ "responseCode": "104", "responseMessage": "Invalid Provider Code." } |