Payment-party data
Your integration makes payments using one set of partner credentials. Each payout carries the businesses involved, so you can make payments for your own clients without creating Axiym client records for them.
1. Supply the parties in each payout
When paying on behalf of a client, submit the complete sender, receiver, and transaction payload with the payout request. If your party objects use your own structure, reference a Party Data Map stored for your integration.
These payloads describe the parties to a payment. They do not require an Axiym client record for the business you represent.
2. Reuse a Party Data Map where it fits
A Party Data Map stores the field-path mapping for your sender and receiver objects. It does not store party values or transaction data. You can reuse it when the submitted party structures match, while supplying the current payment data in every request.
3. Keep identifiers within your integration
The account, corridor, quote, payout, Party Data Map, and webhook subscription must all be accessible with the same partner credentials. Never combine an identifier obtained with another partner's credentials.
4. Retry the same request
For an idempotent retry, keep the endpoint, request body, and
Idempotency-Key unchanged.
5. Reconcile with returned identifiers
Persist the returned account, quote, payout, and external reference identifiers in your own ledger. Use the payout's embedded sender and receiver data to correlate it with the client on whose behalf you submitted it.