Controlled values
Direct payouts require the exact Axiym codes below. To use your own labels, review and store value mappings in a Payment Data Map, then use the mapped payout endpoint.
Saved translations apply by exact match. Canonical codes pass unchanged; unknown labels are rejected.
Controlled input fields
| Input field | Canonical vocabulary |
|---|---|
sender.identification.typesender.relationships[].identification.typerecipient.identification.typerecipient.relationships[].identification.type | PartyIdentificationType |
sender.relationships[].rolerecipient.relationships[].role | RelationshipRole |
supportingDocuments[].documentTypesender.documents[].documentTyperecipient.documents[].documentTypesender.identification.documents[].documentTyperecipient.identification.documents[].documentTypesender.relationships[].identification.documents[].documentTyperecipient.relationships[].identification.documents[].documentType | SupportingDocumentType |
sourceOfFunds | SourceOfFunds |
purpose | TransactionPurpose |
recipient.businessRelationship | BusinessRelationship |
PartyIdentificationType
Identification document or identifier type. The corridor determines which types are accepted.
Canonical values
REGISTRATION_NUMBERTAX_IDVAT_NUMBERNATIONAL_IDPASSPORTDRIVER_LICENSERESIDENCE_PERMITLEIOTHER
RelationshipRole
Canonical role of an individual in relation to the party.
Canonical values
UBODIRECTOROFFICERSHAREHOLDERAUTHORIZED_SIGNATORYEMPLOYEE_OFOTHER_RELATIONSHIP
SupportingDocumentType
Axiym classification of evidence supplied with a payout.
Canonical values
PASSPORTNATIONAL_IDDRIVER_LICENSERESIDENCE_PERMITPROOF_OF_ADDRESSUTILITY_BILLBANK_STATEMENTTAX_CERTIFICATECERTIFICATE_OF_INCORPORATIONREGISTRY_EXTRACTARTICLES_OF_ASSOCIATIONSHAREHOLDER_REGISTERDIRECTOR_REGISTERUBO_DECLARATIONPOWER_OF_ATTORNEYBOARD_RESOLUTIONREGULATORY_LICENSEBUSINESS_LICENSEFINANCIAL_STATEMENTAUDIT_REPORTSOURCE_OF_FUNDSINVOICECONTRACTPURCHASE_ORDERPAYROLL_FILELOAN_AGREEMENTSHIPPING_DOCUMENTCUSTOMS_DECLARATIONOTHER
SourceOfFunds
Origin of the sender's funds used for this payment. Use BUSINESS_INCOME for general business income not covered by a more specific category. INVESTMENT_INCOME covers investment returns such as interest and dividends; proceeds from selling investments use SALE_OF_OTHER_ASSETS. CAPITAL_CONTRIBUTION covers equity funding; shareholder and intercompany loans use LOAN_PROCEEDS.
Canonical values
BUSINESS_INCOMESALE_OF_GOODSSALE_OF_SERVICESCOMMISSIONRENTAL_INCOMEINVESTMENT_INCOMELOAN_PROCEEDSCAPITAL_CONTRIBUTIONSALE_OF_REAL_ESTATESALE_OF_OTHER_ASSETSGRANTDONATIONINSURANCE_PAYOUT
TransactionPurpose
Reason for the payment. Each code corresponds to one ISO 20022 purpose code (ExternalPurpose1Code). SERVICES_PAYMENT covers every kind of service, including contractor, IT, legal and financial services. OWN_ACCOUNT_TRANSFER is between accounts of the same legal entity; INTERCOMPANY_TRANSFER is between separate companies in a group; TREASURY_MANAGEMENT is a group treasury operation. LOAN_REPAYMENT covers principal; INTEREST_PAYMENT covers interest. INVESTMENT is a financial investment; a property purchase uses REAL_ESTATE_PURCHASE. OTHER covers purposes outside the listed codes. Accepted purposes depend on the selected corridor.
Canonical values
GOODS_PURCHASESERVICES_PAYMENTSUPPLIER_PAYMENTSALARY_PAYROLLRENT_LEASELOAN_DISBURSEMENTLOAN_REPAYMENTINTEREST_PAYMENTINTERCOMPANY_TRANSFEROWN_ACCOUNT_TRANSFERTREASURY_MANAGEMENTTAX_PAYMENTINVESTMENTREAL_ESTATE_PURCHASEINSURANCE_PAYMENTBUSINESS_EXPENSESEDUCATION_TRAINING_FEESSUBSCRIPTION_MEMBERSHIP_FEESROYALTY_LICENSE_FEESCHARITABLE_DONATIONREFUNDOTHER
BusinessRelationship
Relationship of the recipient to the sender.
Canonical values
SUPPLIERCUSTOMERCONTRACTORSERVICE_PROVIDERGROUP_COMPANYSUBSIDIARYPARENTINVESTMENT_TARGETDEBTORCREDITOROTHER