Public API

Response envelopes and shapes

Every public-API response follows a predictable shape, so parsing is simple. Reads return a resource object (often with a generated timestamp); a successful enquiry returns {id, status}; and every error returns an {error:{code, message}} envelope. Parse defensively — ignore unknown fields — and your integration survives additive change.

2 min read

{error:{...}}Error envelope
{id,status}Enquiry success
generatedFreshness field

Success shapes

Reads return the resource directly — a tiers array, a billers list, a CMS {key,title,html,updated}. Cacheable reads add a generated UTC timestamp. An enquiry returns {id, status:"new"}.

The error envelope

Every non-2xx response is {"error":{"code":"...","message":"..."}}. Branch on the stable code; treat message as human-facing. See Errors and status codes.

Parse defensively

Ignore fields you do not recognise, do not assume array order beyond what is documented, and never fail on an added field. That is how you stay compatible with additive change. See Versioning.

Frequently asked questions

Is the error shape the same for every endpoint?

Yes. Every non-2xx returns {error:{code,message}}. The code is stable and safe to branch on across all public endpoints.

Should I fail if a response has an unexpected field?

No. Ignore unknown fields. Additive change within v1 may add them, and a tolerant parser keeps working.

Funding for UK limited companies

Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.