Axiym

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.

Sender object
Paste one representative JSON object using your own field names and structure.
28 expected fields

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.
28 fields
Expected payout fieldRequirednessYour fieldValueStatus

sender.name

Registered business name

RequiredNot mapped

sender.countryOfIncorporation

Country of incorporation

RequiredNot mapped

sender.address.addressLine

Registered address line

RequiredNot mapped

sender.address.city

Registered address city

RequiredNot mapped

sender.address.postalCode

Registered address postal code

RecommendedNot mapped

sender.address.region

Registered address region

RecommendedNot mapped

sender.address.country

Registered address country

RequiredNot mapped

sender.contact.email

Business email

RequiredNot mapped

sender.contact.phoneNumber

Business phone number

RequiredNot mapped

sender.id.type

Business identification type

RequiredNot mapped

sender.id.number

Business identification number

RequiredNot mapped

sender.id.country

Business ID issuer country

RecommendedNot mapped

sender.id.issueDate

Business ID issue date

RecommendedNot mapped

sender.id.expiryDate

Business ID expiry date

RecommendedNot mapped

sender.ubos[].firstName

UBO first name

RequiredNot mapped

sender.ubos[].lastName

UBO last name

RequiredNot mapped

sender.ubos[].designation

UBO designation

RequiredNot mapped

sender.ubos[].nationalities[]

UBO nationalities

RequiredNot mapped

sender.ubos[].address.addressLine

UBO address line

RequiredNot mapped

sender.ubos[].address.city

UBO address city

RequiredNot mapped

sender.ubos[].address.postalCode

UBO address postal code

RecommendedNot mapped

sender.ubos[].address.region

UBO address region

RecommendedNot mapped

sender.ubos[].address.country

UBO address country

RequiredNot mapped

sender.ubos[].id.type

UBO identification type

RequiredNot mapped

sender.ubos[].id.number

UBO identification number

RequiredNot mapped

sender.ubos[].id.country

UBO ID issuer country

RecommendedNot mapped

sender.ubos[].id.issueDate

UBO ID issue date

RecommendedNot mapped

sender.ubos[].id.expiryDate

UBO ID expiry date

RecommendedNot mapped
Receiver object
Paste one representative JSON object using your own field names and structure.
23 expected fields

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.
23 fields
Expected payout fieldRequirednessYour fieldValueStatus

receiver.name

Registered business name

RequiredNot mapped

receiver.countryOfIncorporation

Country of incorporation

RequiredNot mapped

receiver.relationship

Relationship to sender

RequiredNot mapped

receiver.address.addressLine

Business address line

RequiredNot mapped

receiver.address.city

Business address city

RequiredNot mapped

receiver.address.postalCode

Business address postal code

RecommendedNot mapped

receiver.address.region

Business address region

RecommendedNot mapped

receiver.address.country

Business address country

RequiredNot mapped

receiver.contact.email

Business email

RequiredNot mapped

receiver.contact.phoneNumber

Business phone number

RequiredNot mapped

receiver.id.type

Business identification type

ConditionalNot mapped

receiver.id.number

Business identification number

ConditionalNot mapped

receiver.id.country

Business ID issuer country

ConditionalNot mapped

receiver.id.issueDate

Business ID issue date

ConditionalNot mapped

receiver.id.expiryDate

Business ID expiry date

ConditionalNot mapped

receiver.bank.accountHolderName

Account holder name

RequiredNot mapped

receiver.bank.accountType

Account type

RequiredNot mapped

receiver.bank.accountNumber

Account number

RequiredNot mapped

receiver.bank.name

Bank name

RequiredNot mapped

receiver.bank.country

Bank country

RequiredNot mapped

receiver.bank.bic

SWIFT BIC

ConditionalNot mapped

receiver.bank.clearingSystem

Clearing system

DerivedDerived by AxiymNot mapped

receiver.bank.clearingCode

Clearing or routing code

ConditionalNot 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

Pending

Receiver structure

Not mapped yet

Pending

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.

1

Store the definition

Submit a name and this definition toPOST /party-data-maps. The response returns the immutable partyDataMapId.

Store a party data map
2

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.

Test a payout