This endpoint is provisioned for providers to use when they want to credit the user’s account for a specified amount.
Request Message description
Field# | Field name | Data type | Max length | Required | Description |
---|---|---|---|---|---|
1 | customerId | String | 50 | true | The Email or Mobile Number of the User to the credited. |
3 | amount | Long | true | The Amount to be credited to the user’s account (in minor). | |
4 | currencyCode | Numeric String | 3 | false | ISO 4217 standard currency code. Default to 566 |
5 | accountNumber | String | 20 | true | The NUBAN Account Number of the Beneficiary |
6 | accountType | Numeric String | 2 | true | The Account Type of the Beneficiary Account. E.g 10 |
7 | bankCode | Numeric String | 5 | true | The CBN Bank Code of the bank holding the Beneficiary account. E.g 058 |
8 | transactionId | String | 50 | true | The Client Transaction ID. This is the reference that the client will use to re-query for the transaction status in case of an unresolved state. |
9 | qtTerminalId | String | false | The quickteller terminal Id to be used for the transaction | |
10 | loanId | String | false | The loanId for a loan taking through Lending Service | |
11 | loanReferenceId | String | false | A unique identifier assigned to the loan taken through Lending Service. It should be the same loan reference id that was sent to the provider in the AcceptOffer request body. | |
12 | transferType | String | false | Relevant for transfer payments, valid values are ‘AGENCY’ and ‘LOAN’ |
Endpoint
POST /payments/transfer
Headers
Authorization: Bearer {{token}}
Sample Request
{
"customerId": "2348123456789",
"amount": 1250000, // Twelve thousand naira only
"currencyCode": "566",
"accountNumber": "0123456789",
"accountType": "20",
"bankCode": "058",
"transactionId": "09389877487857",
"qtTerminalId" : "3PBL"
}
Response Message field description
Field
# | Field name | Data type | Max length | Required | Description |
1 | responseCode | Numeric String | 5 | true | The code representing the status of the processing of this request |
2 | responseMessage | String | 255 | true | The description of the responseCode. |
3 | transactionRef | string | 50 | true | The Quickteller Transaction Reference for the transfer request. |
Sample Response (success)
{
"responseCode" : "00",
"responseMessage" : "Transaction Successful",
"transactionRef" : "UBN|WEB|ILS|20170501091282|01238797"
}
Sample Response (failure)
{
"responseCode" : "96",
"responseMessage" : "Issuer or Switch Inoperative."
}