Verify smartcard
Bearer ds_live_ / ds_test_POST
/api/v1/merchant/cable/verifyLooks up the customer on a DStv / GOtv / StarTimes smartcard (IUC). Where the provider supports it you also get the current bouquet and renewal amount.
Language
curl -X POST "https://finaldatasub.com/api/v1/merchant/cable/verify" \
-H "Authorization: Bearer ds_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"biller": "dstv",
"customer_ref": "7034567890"
}'Authentication
Send your secret API key in the header. Authorization: Token … and X-API-Key: … are also accepted.
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer ds_live_YOUR_KEY | Yes |
| Content-Type | application/json | Yes |
| Accept | application/json | Recommended |
Authentication failures (401 UNAUTHORIZED, 403 IP_NOT_ALLOWED / ACCOUNT_SUSPENDED / API_ACCESS_NOT_APPROVED, 429 RATE_LIMITED) are listed in Authentication.
Parameters
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
| biller | string | Yes | Biller slug, code or id from List billers. |
| customer_ref | string | Conditional | Account / meter / smartcard number (max 60). Required unless customer_id is sent. |
| customer_id | string | Conditional | Alias for customer_ref (max 60). |
| meter_type | string | No | prepaid or postpaid (electricity; defaults to the disco's type). |
| product_id | integer | string | No | Plan you intend to buy, for providers that validate per plan. |
| product_code | string | No | Product code, as an alternative to product_id. |
Responses
200 OK — Verified · 400 Bad Request — Not verified
{
"status": "successful",
"biller": "dstv",
"customer_ref": "7034567890",
"customer_name": "JOHN DOE",
"current_plan": "DStv Compact",
"renewal_amount": 15700
}Errors
Errors specific to this endpoint, in addition to the authentication and validation errors common to every request.
| Code | HTTP | When |
|---|---|---|
| BILLER_NOT_FOUND | 404 | Unknown or inactive biller for this category. |
| VERIFICATION_FAILED | 400 | The provider could not verify the number. Check it and try again. |