DocumentationPOST Verify Power/Cable TV data
SafeHaven Bills API
POST
/safehaven/vas/verifyVerify Power/Cable TV data
Verify Power/Cable TV data through this project environment’s SafeHaven account. Uses snake_case fields and NGN minor units. Requires bills:read.
Use your sandbox environment to start. Understand error codes and payment statuses before handling a live payment.
Verify Power/Cable TV data
curl --request POST "https://api.veyqo.org/api/v1/safehaven/vas/verify" \
--header "Authorization: Bearer $VEYQO_SECRET_KEY" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '{
"service_category_id": "000000000000000000000001",
"entity_number": "example"
}'{
"success": true,
"data": {
"disco_code": "example",
"vend_type": "example",
"meter_no": "example",
"min_vend_amount": 0,
"max_vend_amount": 0,
"outstanding": 0,
"debt_repayment": 0,
"name": "example",
"address": "example",
"order_id": "000000000000000000000001"
}
}Illustrative examples. Replace IDs and environment variables with your own values. Keep secret keys on your server.
Headers
Authorizationstringrequired- Bearer <secret-key>. This key determines your project environment and must stay on your server.
Content-Typestringrequired- application/json
Acceptstringoptional- application/json
Endpoint
POST https://api.veyqo.org/api/v1/safehaven/vas/verify
Server secret key required. Scope: bills:read. The key determines the project and environment; no project-selection header is accepted.
Request body
service_category_idstringrequired- The `_id` of the service category.
entity_numberstringrequired- This is the Card number for cable tv and the Meter number for utility
Response fields
disco_codestringoptional- See the JSON example.
vend_typestringoptional- See the JSON example.
meter_nostringoptional- See the JSON example.
min_vend_amountintegeroptional- Amount in NGN minor units (kobo).
max_vend_amountintegeroptional- Amount in NGN minor units (kobo).
outstandingintegeroptional- Amount in NGN minor units (kobo).
debt_repaymentintegeroptional- Amount in NGN minor units (kobo).
namestringoptional- See the JSON example.
addressstringoptional- See the JSON example.
order_idstringoptional- See the JSON example.
Errors and recovery
| Code | HTTP | Recovery | Retry policy |
|---|---|---|---|
| VALIDATION_FAILED | 422 | Read error.details when present, correct the named fields and retry only after correction. Validation messages may describe state/capability errors without field details. | No automatic retry. |
| INVALID_API_KEY | 401 | Use a current kc_test_ or kc_live_ secret key on /api/v1. Use a pk_test_ or pk_live_ publishable key only on browser checkout. | After fixing credentials. |
| INSUFFICIENT_PERMISSION | 403 | Grant the required scope or use a suitably scoped key. Dashboard organization roles and staff permissions are separate. | After permission changes. |
| RESOURCE_NOT_FOUND | 404 | Check the ID, project and environment. Do not guess another project’s IDs. An inactive payment link is also not-found. | No blind retry. |
| PROVIDER_NOT_CONNECTED | 422 | Connect a provider, choose the project default, or explicitly pass provider. An account shared with another project still needs its own assignment here. | After configuration changes. |
| PROVIDER_AUTHENTICATION_FAILED | 502 | The merchant must check/rotate the provider credentials in the dashboard. Do not expose those secrets to your application users. | After credential correction; reconcile existing payment first. |
| PROVIDER_REQUEST_FAILED | 422 | Read the safe message, inspect the payment’s failure details and correct the request or provider account. Never repeatedly retry a business rejection. | Only after resolving the cause. |
| PROVIDER_UNAVAILABLE | 503 | Check the existing payment and verify its state before starting another attempt. Retry safe reads with backoff; preserve operation identity for retried writes. | Conditional: reconcile unknown outcomes first. |
| RATE_LIMIT_EXCEEDED | 429 | Honor Retry-After, use bounded exponential backoff with jitter, and reduce concurrent requests. Read X-RateLimit headers. | Yes, after Retry-After; preserve write idempotency. |
| IDEMPOTENCY_KEY_REUSED | 409 | Reuse the exact original request to recover that operation, or use a new key only for a genuinely different operation. | Do not retry a changed body with that key. |
| IDEMPOTENCY_IN_PROGRESS | 409 | Wait briefly, retry with the same key and unchanged request, then reconcile by reference if the result remains uncertain. | Back off with jitter; preserve key/body. |