How it works
Map your sender and receiver field paths once, then reuse the stored definition in Payment API requests.
Partners often already have complete business and beneficiary data, but use different property names and object structures. The Payload Mapper lets you keep those party structures instead of rebuilding them around Axiym's field names.
Field mapping and value normalization are separate
Value normalization also applies when you submit Axiym's documented sender and receiver structure without a map. An exact accepted value passes through unchanged.
From your own data objects to a reusable map
- 1
Paste your own party data structures
In the Mapping tool, paste one representative sender JSON object and one representative receiver JSON object using the exact property names and nesting your integration will submit.
- 2
Review the suggested field paths
The tool connects your source paths to Axiym party fields. Correct any suggestion and resolve every required field.
- 3
Export the Party Data Map
The exported JSON contains the reviewed field paths for both party objects. It does not contain the sample values.
- 4
Store the definition
Submit the exported JSON through the authenticated Payment API. Axiym returns an immutable partyDataMapId for the stored definition.
- 5
Test complete payout data
Run a Payout Test with the saved ID, representative party data, and transaction data. Testing does not require a quote and does not move funds.
- 6
Use the map in payout requests
Include partyDataMapId with your custom sender and receiver objects. Axiym applies the stored paths before preparing the payout for review.
What the map contains
- sender source paths mapped to Axiym sender fields;
- receiver source paths mapped to Axiym receiver fields;
- the definition and target-model versions.
- sample values, partner identity, or credentials;
- transaction data or supporting documents;
- value translations or destination requirements.
Transaction data remains specific to each payout. The Payout Test and payout preparation flow normalize controlled values and validate the complete payload against destination requirements.