Fund a payment
Funding a payment creates a receivable. The receivable records the financing provided by Axiym and the client's resulting repayment obligation; it is not a replacement for the payment record in your own system.
Before you submit
Confirm that:
- the client is active;
- a matching credit account is active and has sufficient available balance;
- the amount and currency describe the payment to be funded, and the payment rail is supplied when required for the intended settlement channel; and
- the payment has a stable unique identifier in your system.
1. Choose an idempotency key
Generate one idempotency key for this funding intent. Store it before sending the request and reuse it only when retrying the same client, endpoint, and body.
2. Create the receivable
Call POST /clients/{clientId}/receivables with:
- the payment amount and currency;
- the configured payment rail; and
paymentTransaction, including your payment ID, timestamp, and payment data.
Follow the Fund a Payment API Reference for the exact request contract.
Serialize the amount as a decimal string. Preserve the value exactly as sent; do not use a binary floating-point number in the JSON payload.
3. Store the response before continuing
Persist at least:
| Value | Use |
|---|---|
clientId | Identifies the legal entity that owes the receivable. |
| Your payment ID | Joins the receivable to the original client payment. |
receivableId | Retrieves and reconciles the Axiym financing record. |
| Idempotency key | Makes an ambiguous request safe to retry. |
| Initial status | Records the state returned with the created receivable. |
The 201 response creates and returns the receivable. It does not by itself
prove that an external disbursement has completed.
4. Track the outcome
Continue with Track a receivable. Do not create a second receivable while the outcome of the first request is unclear; retry it with the original idempotency key or retrieve the recorded resource.