Implementation guides
Check financing capacity
Check the client's credit account right before you fund a payment.
1. Confirm the client is active
GET /clients/{clientId} must return status ACTIVE.
2. Find the credit account
Call GET /clients/{clientId}/credit-accounts
and pick the account whose currency and paymentRails match the payment.
Rail codes are listed by GET /settings/payment-rails.
3. Check the balance
The account must be ACTIVE and its availableBalance must cover the amount
you want to fund.
creditLimitis the maximum for this account.availableBalanceis what is left to fund now.balanceis money received from the client and not yet used for repayment.
4. Fund the payment
The check does not reserve capacity, so fund the payment right after it.