This Endpoint is to accept a loan offer. On calling this endpoint, the service will mark an offer as accepted and then notify the provider of this decision while providing them with the account details of the customer.
Request Message description
Field# | Field name | Data type | Max length | Required | Description |
---|---|---|---|---|---|
1 | customerId | String | true | The Email or Mobile Number of the Customer. | |
3 | creditMethod | Object | The Object containing the properties of the account to be credited for the loan amount. This is required when the creditMethodId is not provided. | ||
3a. | accountNumber | Numeric String | true | The Account Number to be credited. | |
3b. | bankCode | Numeric String | true | The CBN Bank Code representing the Bank of the Account to be credited. E.g 011 | |
3c. | id | Numeric | false | The ID of the Account to be credited. | |
4 | debitMethod | Object | The Object containing the properties of the Card to be debited when the loan is due. This is required when the debitMethodId is not provided. | ||
4a. | identifier | String | false | The Payment Method Identifier (GUID) of the Card to be debited. | |
4b. | authData | String | true | The AuthData of the Card to be debited. It is the encryption of the Card PAN or Identifier, Expiry Date, PIN, and CVV. | |
4c. | useCreditMethod | Boolean | false | A flag to indicate whether to use account number as means of collection (payback) as opposed to the card details. This is strictly for USSD Channel integration that supports direct to account debit functionalities. | |
5 | channelCode | String | true | The Code of the Channel from which this request is being sent. | |
6 | providerCode | String | true | The Code of the provider from which this offer was retrieved. |
Endpoint
POST /offers/{offerId}/accept
Headers
Authorization: Bearer {{token}}
Sample Request One ( accept offer with Payment Method Identifier )
{
"customerId": "2348123456789",
"channelCode": "0002",
"providerCode": "ABCREDIT",
"debitMethod": {
"identifier": "0123456789"
},
"creditMethod": {
"id": "9876543210"
}
}
Sample Request Two ( accept offer with Payment Method Identifier or card)
{
"customerId": "2348123456789",
"channelCode": "0002",
"providerCode": "ABCREDIT",
"debitMethod": {
"identifier": "ADA4C1FFE6DE40C584ABD3CBAFDA0D08",
"authData": "OjlDC8aB24QNtbc654TAmTC7s/J4WG7LVf3HursqxMj9Kx0iMLWg8chKuQrB3E4SaBoegl7znXDTZ0QTwS+gr5IrFX+7LplB5My/eJ9a3VgY7SL9izhXWPowDIT7y2SZzgJIpYgGp2bTKZcDO0vUPREV/0NMxPOktxFlXHKkeYe3nn2WrP877Tw09XCN4eZfe7M5dD4wdb0IRcMktHCdbbdyZa60UTkxhTDWk9t5Nm3opWda5zV+ERQhgpod99rG61odZE0brQ9iGf5KPYmaoynfL00I6CQYjnANoEnjOTh5Kt7uhaRrhUSk9zKIV4woME8LXetvdvQUee+ZXcbXPg=="
},
"creditMethod": {
"id": "9876543210"
}
}
Sample Request Three (accept offer with card)
{
"customerId": "2348123456789",
"channelCode": "0002",
"providerCode": "ABCREDIT",
"debitMethod": {
"authData": "NQkmlsofwtUI/h8M9jN8xYjCYRmzdIfM/v2X2q9eVjnuU75E31MPKTYYlinxuzSthjY0C1S2i4+A0vyAAFwth6sJx6p9ekp9H4hsiO3iG+x587KqVwhBY5DC76oArxINzzxP4F09Aw/a527jVb4Agx5aTDQiyAKV8WSTzjHY7KH8XB2/lI+WwUEOhs49yCRPXh+tXJCGdefZgZYFyI09WNp2w8AWDQUZvRpzPFzS09QAeiI4qWuFZ01F/HAF4D09I8Gg+61lWwclw4zcPLXWB17zzb/BrMZcjJvyrouCbbn6n7zaUqyFG4H4r3NTRAcuVxCnDCC2wjRO9ZRq2la4lA=="
},
"creditMethod": {
"accountNumber": "0123456789",
"bankCode": "058"
}
}
Sample Request Four (accept offer with account number)
{
"customerId": "2348123456789",
"channelCode": "0002",
"providerCode": "ABCREDIT",
"debitMethod": {
"useCreditMethod": true
},
"creditMethod": {
"accountNumber": "0123456789",
"bankCode": "058"
}
}
Response Message field description
Field
# | Field name | Description |
1 | responseCode | The Code representing the result of the request processing. |
2 | responseMessage | The Description of the responseCode. |
Sample Response (success)
{
"responseCode": "00",
"responseMessage": "Transaction successful. Account would be credited shortly"
}
Sample Response (failure)
{
"responseCode": "96",
"responseMessage": "Oops. Something went wrong. Please try again later"
}