Check financing capacity

Credit accounts describe how much financing is available to a client for a particular currency and payment rail. Check them immediately before submitting a payment for funding; a previously observed balance may have changed.

1. Confirm the client is active

Retrieve GET /clients/{clientId}. Do not request financing unless the current client resource has status ACTIVE.

2. List credit accounts

Call GET /clients/{clientId}/credit-accounts and select the account that matches the payment's currency and payment rail.

Use GET /settings/payment-rails when your integration needs the currently configured rail codes.

3. Evaluate capacity

Before continuing, verify:

• the credit account is ACTIVE;
• currency matches the payment currency;
• paymentRails matches the intended settlement channel; and
• availableBalance is sufficient for the amount you intend to fund.

creditLimit is the maximum facility. availableBalance is the amount currently available to finance a payment. Do not treat them as interchangeable.

4. Continue close to the check

Proceed to Fund a payment without unnecessary delay. The funding request remains authoritative: a credit check does not reserve capacity.

Handle an insufficient or unavailable credit response as a business outcome. Do not repeatedly retry the same request without a relevant balance or status change.