# Controlled values

Allowed Axiym payment codes and fields supported by saved value mappings.

Product: Payment API
Guides follow API reference 0.1.0 and event reference 0.1.0.
Canonical page: https://docs.axiym.io/payment-api/integration-guide/prepare-payout-data/controlled-values

Direct payouts require the exact Axiym codes below. To use your own labels, review
and store [value mappings](/payment-api/integration-guide/prepare-payout-data/payment-data-maps#value-mapping)
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.type`<br />`sender.relationships[].identification.type`<br />`recipient.identification.type`<br />`recipient.relationships[].identification.type`                                                                                                                                                                                                            | [`PartyIdentificationType`](#partyidentificationtype) |
| `sender.relationships[].role`<br />`recipient.relationships[].role`                                                                                                                                                                                                                                                                                                                 | [`RelationshipRole`](#relationshiprole)               |
| `supportingDocuments[].documentType`<br />`sender.documents[].documentType`<br />`recipient.documents[].documentType`<br />`sender.identification.documents[].documentType`<br />`recipient.identification.documents[].documentType`<br />`sender.relationships[].identification.documents[].documentType`<br />`recipient.relationships[].identification.documents[].documentType` | [`SupportingDocumentType`](#supportingdocumenttype)   |
| `sourceOfFunds`                                                                                                                                                                                                                                                                                                                                                                     | [`SourceOfFunds`](#sourceoffunds)                     |
| `purpose`                                                                                                                                                                                                                                                                                                                                                                           | [`TransactionPurpose`](#transactionpurpose)           |
| `recipient.businessRelationship`                                                                                                                                                                                                                                                                                                                                                    | [`BusinessRelationship`](#businessrelationship)       |

## `PartyIdentificationType`

Identification document or identifier type. The corridor determines which types are accepted.

### Canonical values

* `REGISTRATION_NUMBER`
* `TAX_ID`
* `VAT_NUMBER`
* `NATIONAL_ID`
* `PASSPORT`
* `DRIVER_LICENSE`
* `RESIDENCE_PERMIT`
* `LEI`
* `OTHER`

## `RelationshipRole`

Canonical role of an individual in relation to the party.

### Canonical values

* `UBO`
* `DIRECTOR`
* `OFFICER`
* `SHAREHOLDER`
* `AUTHORIZED_SIGNATORY`
* `EMPLOYEE_OF`
* `OTHER_RELATIONSHIP`

## `SupportingDocumentType`

Axiym classification of evidence supplied with a payout.

### Canonical values

* `PASSPORT`
* `NATIONAL_ID`
* `DRIVER_LICENSE`
* `RESIDENCE_PERMIT`
* `PROOF_OF_ADDRESS`
* `UTILITY_BILL`
* `BANK_STATEMENT`
* `TAX_CERTIFICATE`
* `CERTIFICATE_OF_INCORPORATION`
* `REGISTRY_EXTRACT`
* `ARTICLES_OF_ASSOCIATION`
* `SHAREHOLDER_REGISTER`
* `DIRECTOR_REGISTER`
* `UBO_DECLARATION`
* `POWER_OF_ATTORNEY`
* `BOARD_RESOLUTION`
* `REGULATORY_LICENSE`
* `BUSINESS_LICENSE`
* `FINANCIAL_STATEMENT`
* `AUDIT_REPORT`
* `SOURCE_OF_FUNDS`
* `INVOICE`
* `CONTRACT`
* `PURCHASE_ORDER`
* `PAYROLL_FILE`
* `LOAN_AGREEMENT`
* `SHIPPING_DOCUMENT`
* `CUSTOMS_DECLARATION`
* `OTHER`

## `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_INCOME`
* `SALE_OF_GOODS`
* `SALE_OF_SERVICES`
* `COMMISSION`
* `RENTAL_INCOME`
* `INVESTMENT_INCOME`
* `LOAN_PROCEEDS`
* `CAPITAL_CONTRIBUTION`
* `SALE_OF_REAL_ESTATE`
* `SALE_OF_OTHER_ASSETS`
* `GRANT`
* `DONATION`
* `INSURANCE_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_PURCHASE`
* `SERVICES_PAYMENT`
* `SUPPLIER_PAYMENT`
* `SALARY_PAYROLL`
* `RENT_LEASE`
* `LOAN_DISBURSEMENT`
* `LOAN_REPAYMENT`
* `INTEREST_PAYMENT`
* `INTERCOMPANY_TRANSFER`
* `OWN_ACCOUNT_TRANSFER`
* `TREASURY_MANAGEMENT`
* `TAX_PAYMENT`
* `INVESTMENT`
* `REAL_ESTATE_PURCHASE`
* `INSURANCE_PAYMENT`
* `BUSINESS_EXPENSES`
* `EDUCATION_TRAINING_FEES`
* `SUBSCRIPTION_MEMBERSHIP_FEES`
* `ROYALTY_LICENSE_FEES`
* `CHARITABLE_DONATION`
* `REFUND`
* `OTHER`

## `BusinessRelationship`

Relationship of the recipient to the sender.

### Canonical values

* `SUPPLIER`
* `CUSTOMER`
* `CONTRACTOR`
* `SERVICE_PROVIDER`
* `GROUP_COMPANY`
* `SUBSIDIARY`
* `PARENT`
* `INVESTMENT_TARGET`
* `DEBTOR`
* `CREDITOR`
* `OTHER`