Payload Mapper
Turn representative sender and receiver objects into a portable Party Data Map. Review how your field paths connect to Axiym’s party fields, correct the suggestions, and export the definition for your integration.
Expected fields
- These are the baseline fields for this party object. Corridor rules may add or change conditional requirements.
- Only field paths are mapped. Sample values are never included in the exported map.
- You can review and correct every suggested mapping.
- Values are normalized to Axiym’s allowed values when a payout is requested.
| Expected payout field | Requiredness | Your field | Value | Status |
|---|---|---|---|---|
sender.name Registered business name | Required | — | — | Not mapped |
sender.countryOfIncorporation Country of incorporation | Required | — | — | Not mapped |
sender.address.addressLine Registered address line | Required | — | — | Not mapped |
sender.address.city Registered address city | Required | — | — | Not mapped |
sender.address.postalCode Registered address postal code | Recommended | — | — | Not mapped |
sender.address.region Registered address region | Recommended | — | — | Not mapped |
sender.address.country Registered address country | Required | — | — | Not mapped |
sender.contact.email Business email | Required | — | — | Not mapped |
sender.contact.phoneNumber Business phone number | Required | — | — | Not mapped |
sender.id.type Business identification type | Required | — | — | Not mapped |
sender.id.number Business identification number | Required | — | — | Not mapped |
sender.id.country Business ID issuer country | Recommended | — | — | Not mapped |
sender.id.issueDate Business ID issue date | Recommended | — | — | Not mapped |
sender.id.expiryDate Business ID expiry date | Recommended | — | — | Not mapped |
sender.ubos[].firstName UBO first name | Required | — | — | Not mapped |
sender.ubos[].lastName UBO last name | Required | — | — | Not mapped |
sender.ubos[].designation UBO designation | Required | — | — | Not mapped |
sender.ubos[].nationalities[] UBO nationalities | Required | — | — | Not mapped |
sender.ubos[].address.addressLine UBO address line | Required | — | — | Not mapped |
sender.ubos[].address.city UBO address city | Required | — | — | Not mapped |
sender.ubos[].address.postalCode UBO address postal code | Recommended | — | — | Not mapped |
sender.ubos[].address.region UBO address region | Recommended | — | — | Not mapped |
sender.ubos[].address.country UBO address country | Required | — | — | Not mapped |
sender.ubos[].id.type UBO identification type | Required | — | — | Not mapped |
sender.ubos[].id.number UBO identification number | Required | — | — | Not mapped |
sender.ubos[].id.country UBO ID issuer country | Recommended | — | — | Not mapped |
sender.ubos[].id.issueDate UBO ID issue date | Recommended | — | — | Not mapped |
sender.ubos[].id.expiryDate UBO ID expiry date | Recommended | — | — | Not mapped |
Expected fields
- These are the baseline fields for this party object. Corridor rules may add or change conditional requirements.
- Only field paths are mapped. Sample values are never included in the exported map.
- You can review and correct every suggested mapping.
- Values are normalized to Axiym’s allowed values when a payout is requested.
| Expected payout field | Requiredness | Your field | Value | Status |
|---|---|---|---|---|
receiver.name Registered business name | Required | — | — | Not mapped |
receiver.countryOfIncorporation Country of incorporation | Required | — | — | Not mapped |
receiver.relationship Relationship to sender | Required | — | — | Not mapped |
receiver.address.addressLine Business address line | Required | — | — | Not mapped |
receiver.address.city Business address city | Required | — | — | Not mapped |
receiver.address.postalCode Business address postal code | Recommended | — | — | Not mapped |
receiver.address.region Business address region | Recommended | — | — | Not mapped |
receiver.address.country Business address country | Required | — | — | Not mapped |
receiver.contact.email Business email | Required | — | — | Not mapped |
receiver.contact.phoneNumber Business phone number | Required | — | — | Not mapped |
receiver.id.type Business identification type | Conditional | — | — | Not mapped |
receiver.id.number Business identification number | Conditional | — | — | Not mapped |
receiver.id.country Business ID issuer country | Conditional | — | — | Not mapped |
receiver.id.issueDate Business ID issue date | Conditional | — | — | Not mapped |
receiver.id.expiryDate Business ID expiry date | Conditional | — | — | Not mapped |
receiver.bank.accountHolderName Account holder name | Required | — | — | Not mapped |
receiver.bank.accountType Account type | Required | — | — | Not mapped |
receiver.bank.accountNumber Account number | Required | — | — | Not mapped |
receiver.bank.name Bank name | Required | — | — | Not mapped |
receiver.bank.country Bank country | Required | — | — | Not mapped |
receiver.bank.bic SWIFT BIC | Conditional | — | — | Not mapped |
receiver.bank.clearingSystem Clearing system | Derived | Derived by Axiym | — | Not mapped |
receiver.bank.clearingCode Clearing or routing code | Conditional | — | — | Not mapped |
Export the Party Data Map
The exported definition contains field paths only. It does not contain sample values, partner identity, credentials, enum translations, or transaction data.
Sender structure
Not mapped yet
Receiver structure
Not mapped yet
Map both party objects to create a definition
Complete the sender and receiver tabs. Their reviewed field paths are combined into one portable Party Data Map.
What happens next
This browser tool stops at export. Your authenticated integration stores and tests the reviewed definition.
Store the definition
Submit a name and this definition toPOST /party-data-maps. The response returns the immutable partyDataMapId.
Test a complete payout
Send representative sender, receiver, and transaction data toPOST /payouts/tests with the saved ID. Axiym applies the map, normalizes controlled values, and validates destination requirements.