Axiym

Repay a client from your balance

Applies funds from your own settlement balance to the client's outstanding receivables. Use it when incoming funds could not be attributed to a client automatically and were credited to your settlement account as unallocated. The funds must already be on your settlement account for currency and paymentRails (see GET /accounts in the Account API); an amount above that balance is rejected. Allocation is FIFO across the client's active receivables; the request does not select a particular receivable. Any amount beyond the client's totalRepaymentAmount remains on the client's settlement balance. The response acknowledges the request; read the receivable and credit account after settlement.

AuthorizationBearer <token>

In: header

Path Parameters

clientId*string

Client identifier (UUID).

Formatuuid

Header Parameters

X-Request-Id?string

Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the X-Request-Id response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.

Formatuuid
Idempotency-Key?string

Unique client-generated key to safely retry a funds-moving request (e.g. a UUID, but any unique string works). Repeating a request with the same key returns the original result instead of creating a duplicate.

Lengthlength <= 255

Request Body

application/json

amount*string

Amount to apply from your settlement balance in currency. Allocated FIFO across the client's active receivables.

currency*Currency

Currency code — ISO 4217 fiat (e.g. USD, EUR) or a supported stablecoin (USDT, USDC).

paymentRails?string

Payment rail code of the settlement balance to debit.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json