CreddotDocsCreddot Docs

List bill payments

The API-key environment is authoritative; an environment query value is ignored.

GET
/api/v1/bills

The API-key environment is authoritative; an environment query value is ignored.

Authorization

api-key
headerx-api-key<token>

Your API key: ck_test_... for test mode, ck_live_... for live. Send it with x-api-secret (or Authorization: Bearer ).

Query Parameters

provider?string
Value in"VTPASS""FLUTTERWAVE"
category?string
Value in"AIRTIME""DATA""ELECTRICITY""TV""INTERNET""OTHER"
status?string
Value in"PENDING""PROCESSING""SUCCESS""FAILED"
page?number
Range1 <= value
Default1
pageSize?number
Range1 <= value <= 100
Default20

Header Parameters

x-api-secret?string

Recommended: API secret sent over HTTPS. You may send it as Authorization: Bearer instead. If supplied, x-timestamp and x-signature are not required.

x-timestamp?string

Legacy signed mode: Unix time in milliseconds; maximum clock skew five minutes.

x-signature?string

Legacy signed mode: HMAC-SHA256(secret, timestamp.METHOD.url.idempotencyKey.bodyHash).

Response Body

application/json
  1. response
items*array<>
total*number
page*number
pageSize*number
Example Request
curl -X GET 'https://api.creddot.com/api/v1/bills'
Example Response
{  "items": [    {      "id": "string",      "transactionId": "string",      "reference": "string",      "status": "PENDING",      "amountMinor": "string",      "currency": "string",      "environment": "SANDBOX",      "provider": "VTPASS",      "category": "string",      "serviceCode": "string",      "productCode": {},      "customerIdMasked": "string",      "providerReference": {},      "token": {},      "requiresReconciliation": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "pageSize": 0}