Customer Validation
This endpoint validates a customer's identity and payment information before completing a transaction.
Headers
Authorization: Bearer TOKEN
Content-type: application/json
Terminal: 3PBL0001
See Documentation on how to Generate Token
Endpoint
POST https://qa.interswitchng.com/quicktellerservice/api/v5/Transactions/validatecustomers
Request Parameter
| Field | M/O | Length | Description | |
|---|---|---|---|---|
| Customers | M | Contains the array for customer to be validated | ||
| PaymentCode | M | <=20 | Unique payment code for a biller | |
| CustomerId | M | <=50 | Customer’s Unique Identifier |
Sample Request
curl https://qa.interswitchng.com/quicktellerservice/api/v5/Transactions/validatecustomers \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json" \
-H "TerminalID: <your_terminal_id>" \
-D '{
"customers": [
{
"PaymentCode": "0488051528",
"CustomerId": "08124888436"
}
],
"TerminalId": "3pbl0001"
} ''
-X POST
Response Parameter
| Field | Length | Description |
|---|---|---|
| Customers | Contains the array for customer to be validated | |
| paymentCode | <=20 | Unique payment code for a biller |
| customerId | <=50 | Customer’s Unique Identifier |
| fullName | Customers Name | |
| responseCode | Response code for the request made | |
| amount | Amount returned | |
| amountType | amountType returned | |
| amountTypeDescription | Description of the amountType returned concerning the amount payable |
{
"Customers": [
{
"BillerId": 0,
"PaymentCode": "0488051528",
"CustomerId": "08124888436",
"ResponseCode": "90000",
"FullName": "adubiaro deborah",
"Amount": 0,
"AmountType": 0,
"AmountTypeDescription": "AnyAmount",
"Surcharge": 0
}
],
"ResponseCode": "90000",
"ResponseCodeGrouping": "SUCCESSFUL"
}
How to Determine Expected Amount to be Passed in Send Bill Payment Advice Call for Bill payment
Pay attention to the amount and amount Type fields returned in the validate customer response.
If the amount and amount Type fields are populated, it means the figure passed in the amount field should be used to determine the expected amount to be paid by the customer.
You are expected to validate this on your system. See few samples below.
For example:
“amount”: “1500000”,
“amountType”: “5”
Customer is expected to pay exact amount (N15,000) as returned.
“amount”: “1500000”,
“amountType”: “4”
Customer is expected to pay less than the maximum amount returned which in this case is N15,000, Customer can pay any amount below N15,000
Find below details for amount types in the table below.
| Value | Label | Meaning |
|---|---|---|
| 0 | None | Any amount can be paid |
| 1 | Minimum | If the returned amount is 1000, customer can pay any amount from 1000 |
| 2 | Greater than Minimum | If the returned amount is 1000, customer can pay any amount greater than 1000 |
| 3 | Maximum | If the amount returned is 1000, customer can pay any amount below or equal to 1000 |
| 4 | Less than Maximum | If the amount returned is 1000, customer can pay any amount below to 1000 |
| 5 | Exact | The exact amount returned must be paid |
Updated 11 months ago