Guides overview
End-to-end, opinionated walkthroughs. Where the reference tells you what each endpoint does, guides show you how to put them together — from a first sandbox call through to a production integration.
There are three ways to build with Credicorp, plus one cross-cutting practice every integration needs. Pick the guide that matches your goal — each is self-contained, runs against the sandbox first, and links back to the exact reference pages it uses.
Choose by goal
| If you want to… | Start with | Core APIs |
|---|---|---|
| Offer Credicorp finance inside your own product — checkout, dashboard or invoicing tool | Integrate lending | Apply, Decisioning, Payments, Webhooks |
| Refer or resell Credicorp to your business customers and earn on funded loans | Distribute Credicorp | Partner, Apply, Webhooks |
| List a service in the marketplace and act on lending events from many merchants | Extend the marketplace | OAuth 2.0, Accounts, Webhooks |
| Make every write safe to retry across timeouts and redeliveries | Idempotency | All write endpoints |
Before any guide. You'll need a developer account, a sandbox client_id/client_secret, and a grounding in the object model. If you haven't yet, run the quickstart (about five minutes) and skim Core concepts — rings, environments and the application lifecycle.
All guides
Integrate lending
Embed apply → decision → payments end-to-end inside your product.
Distribute Credicorp
Refer or resell with tracked introductions and commission payouts.
Extend the marketplace
List your service and receive scoped event hooks across merchants.
Idempotency
Make writes safe to retry — every time, across timeouts and redeliveries.
What each guide covers
Integrate lending
The flagship path. Create an application for a UK limited company or LLP, hand the applicant to the hosted journey (or drive a white-label flow yourself), then react to the real-time, AI-led decision. On approval you draw funds down over the Payments API using Open Banking PISP, and reconcile drawdowns and repayments from webhooks rather than polling. Includes the Idempotency-Key and signature-verification patterns you'll reuse everywhere.
Distribute Credicorp
For brokers, accountants, marketplaces and referral partners who want to introduce borrowers rather than host the whole journey. Create a tracked introduction with your partner attribution, send the business owner to a co-branded apply link, and receive introduction.* and decision.completed events as it progresses. Covers attribution, consent capture and how commission on funded loans is reported back to you. See the partner programme for tiers and rates.
Extend the marketplace
For ISVs building on top of Credicorp — accounting sync, cash-flow forecasting, collections tooling. Register an app, request the minimum OAuth 2.0 scopes, and let merchants connect their Credicorp accounts to yours. You then read account state and subscribe to the events you're authorised for. Read-only MCP access is available for AI-native tools. Publishing details live in the marketplace overview.
Idempotency
Cross-cutting and short, but load-bearing. Every state-changing request accepts an Idempotency-Key; replaying the same key returns the original result instead of creating a duplicate application, drawdown or payout. The guide shows how to choose stable keys, how long the server remembers them, and how this composes with at-least-once webhook delivery so a network blip never books a loan twice. If you read one cross-cutting guide first, read this one.
How the guides are structured
Every guide follows the same shape, so once you've read one you know your way around the rest:
- Prerequisites first. Each opens with the scopes, credentials and prior steps it assumes — so you never get halfway through and hit a missing permission.
- Sandbox before live. All flows are demonstrated against the sandbox base URL
https://api.credicorp.co.uk/partner/v1withsk_test_…keys, returning simulated decisions and payments. Going to production is a credential swap, not a code rewrite. - Money in pence, GBP only. Amounts are integer pence (
2500000= £25,000). Credicorp lends to UK incorporated bodies corporate — limited companies and LLPs — identified by Companies House number. - Webhooks over polling. Guides reconcile state from signed webhook events rather than busy-polling, and always verify the
Credicorp-Signatureheader before trusting a payload. - Copy-paste, then adapt. Samples are runnable as written against a fresh sandbox project; swap in your own ids and redirect URIs as you go.