Accounts API

Once an application is approved and funds are disbursed, a funded account is created. It carries the principal, the running balance, the agreed repayment schedule and the servicing status. This API is read-mostly: you query accounts and balances, and (in beta) administer the partner-side constructs that sit alongside them — sub-accounts, tracked introductions and payouts.

Base URL

https://hub.credicorp.co.uk/partner/v1

Auth

Bearer token — scope accounts.read to read, accounts.manage for sub-accounts and payouts.

Identifiers

Account ids are prefixed acc_; sub-accounts sub_; introductions intro_; payouts po_.

Money

All amounts are integer pence, currency GBP.

Endpoints

Retrieve an account

curl -s https://hub.credicorp.co.uk/partner/v1/accounts/acc_2WdR7yK \
  -H "Authorization: Bearer $TOKEN"

import Credicorp from '@credicorp/sdk';
const cc = new Credicorp({ token: process.env.CC_TOKEN });

const account = await cc.accounts.retrieve('acc_2WdR7yK');
console.log(account.balance.payoff_pence);

from credicorp import Credicorp
cc = Credicorp(token=os.environ["CC_TOKEN"])

account = cc.accounts.retrieve("acc_2WdR7yK")
print(account.balance.payoff_pence)

Response 200 OK

{
  "id": "acc_2WdR7yK",
  "object": "account",
  "status": "performing",
  "product": "business_term_loan",
  "borrower": {
    "company_number": "09876543",
    "company_name": "Acme Trading Ltd"
  },
  "principal_pence": 500000,
  "term_months": 12,
  "rate_apr": 14.9,
  "disbursed_at": "2026-06-15T09:20:00Z",
  "balance": {
    "principal_outstanding_pence": 458333,
    "interest_accrued_pence": 5120,
    "arrears_pence": 0,
    "payoff_pence": 463453
  },
  "sub_account_id": "sub_acme_intro"
}

Account fields

Account statuses

Balance & transactions

GET /accounts/{id}/balance returns just the balance object for cheap polling, and /transactions returns the immutable ledger — every drawdown, collection, refund and adjustment, newest first. The ledger is cursor-paginated; see Pagination.

{
  "object": "list",
  "data": [
    { "id": "txn_91", "type": "collection", "amount_pence": 41667,
      "payment_id": "pay_9Lm4Qx", "posted_at": "2026-06-15T11:09:40Z" },
    { "id": "txn_01", "type": "drawdown", "amount_pence": -500000,
      "posted_at": "2026-06-15T09:20:00Z" }
  ],
  "has_more": false
}

Partner sub-accounts Beta

Distribution partners can open sub-accounts to segment funded loans by brand, region or campaign. Every application you originate is attributed to a sub-account, which is the unit revenue-share is calculated and paid against. Creating a sub-account requires the accounts.manage scope.

curl -s https://hub.credicorp.co.uk/partner/v1/sub-accounts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: sub_001" \
  -d '{ "name": "Acme — North West", "revenue_share_bps": 150 }'

Tracked introductions Beta

An introduction is created when you originate an application through your partner credentials. It links the borrower journey to your sub-account and exposes where it sits in the funnel — so you can attribute conversions and forecast revenue-share before payout.

{
  "object": "list",
  "data": [
    {
      "id": "intro_7Hb2",
      "sub_account_id": "sub_acme_intro",
      "application_id": "app_44Qx",
      "stage": "funded",
      "account_id": "acc_2WdR7yK",
      "introduced_at": "2026-06-14T16:02:00Z"
    }
  ],
  "has_more": false
}

Introduction stages

Revenue-share payouts Beta

Payouts settle the revenue-share owed on funded introductions for a period. Each payout aggregates the per-account amounts across a sub-account, and is paid to your nominated bank account. A payout.paid webhook fires on settlement — reconcile it the same way you reconcile collections.

{
  "id": "po_2026_06",
  "object": "payout",
  "sub_account_id": "sub_acme_intro",
  "period": "2026-06",
  "status": "paid",
  "gross_pence": 128400,
  "introductions": 17,
  "paid_at": "2026-07-05T08:00:00Z"
}

Errors

All errors from this endpoint use the standard hub error envelope. Branch on code for precise handling; quote correlation_id when contacting support.

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "correlation_id": "cor_01J2K3M4N5P6Q7R8S9T0A1V2W3",
    "retryable": false
  }
}

The full error code list and all envelope fields are on the Errors page.

Related: Apply roadmap and Decisioning roadmap for how an account comes into being, Payments roadmap for collecting against it, and Webhooks roadmap for account.* and payout.* events.