GET
/api/v1/wallet/

Returns your organisation's wallet: current balance, currency, and the account details funding it.

Verification and screening calls debit this wallet, so a 402 on any billable endpoint means the balance here is below that service's price.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Response Body

application/json

curl -X GET "https://example.com/api/v1/wallet/"
{  "data": {},  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel