Receiver and bank account

The receiver object identifies the business being paid, its relationship to the sender, and the local bank account that receives the payout.

Receiver fields

Field	Type or format	Requiredness	Description
`receiver.name`	String	Required	Registered legal business name.
`receiver.countryOfIncorporation`	ISO 3166-1 alpha-2	Required	Country where the business is incorporated.
`receiver.relationship`	String	Required	Business relationship to the sender. Supply an accepted Axiym value or descriptive text.
`receiver.address.addressLine`	String	Required	Business street address.
`receiver.address.city`	String	Required	Business city or town.
`receiver.address.postalCode`	String	Recommended	Business postal or ZIP code.
`receiver.address.region`	String	Recommended	State, province, or region.
`receiver.address.country`	ISO 3166-1 alpha-2	Required	Country of the business address.
`receiver.contact.email`	Email	Required	Business contact email.
`receiver.contact.phoneNumber`	International phone number	Required	Business contact phone number.

Identification fields

Receiver identification is conditional because the applicable destination rules determine when it must be supplied. For example, receiver identification is required for China bank payouts.

Field	Type or format	Requiredness
`receiver.id.type`	String, normalized	Conditional
`receiver.id.number`	String	Conditional
`receiver.id.country`	ISO 3166-1 alpha-2	Conditional
`receiver.id.issueDate`	ISO 8601 date	Conditional
`receiver.id.expiryDate`	ISO 8601 date	Conditional

Bank account fields

Field	Type or format	Requiredness	Description
`receiver.bank.accountHolderName`	String	Required	Name registered on the account. If omitted from a mapped payload, Axiym derives it from `receiver.name`.
`receiver.bank.accountType`	String	Required	Bank-account type. Supply an accepted Axiym value or descriptive text. If omitted from a mapped payload, defaults to `CURRENT`.
`receiver.bank.accountNumber`	String	Required	Destination bank account number or local account identifier.
`receiver.bank.name`	String	Required	Destination bank name.
`receiver.bank.country`	ISO 3166-1 alpha-2	Required	Country of the destination bank.
`receiver.bank.bic`	ISO 9362 BIC	Conditional	SWIFT BIC when required for the route.
`receiver.bank.clearingSystem`	String	Derived	Local clearing scheme resolved from the corridor and routing data.
`receiver.bank.clearingCode`	Corridor-specific	Conditional	Local clearing or routing code. Use the Country Playbook for format and validation.

Account currency is not supplied. It is derived from the quote's buy currency.

Axiym normalizes relationship, identification type, and accountType to their final controlled values before validation. Exact accepted values pass through unchanged. This happens for both Axiym-shaped and mapped party data.

Example

{
  "name": "Example Supplier Corporation",
  "countryOfIncorporation": "PH",
  "relationship": "supplier of imported goods",
  "address": {
    "addressLine": "6789 Ayala Avenue",
    "city": "Makati",
    "postalCode": "1226",
    "region": "Metro Manila",
    "country": "PH"
  },
  "contact": {
    "email": "accounts@example-supplier.test",
    "phoneNumber": "+63281234567"
  },
  "bank": {
    "accountHolderName": "Example Supplier Corporation",
    "accountType": "business current account",
    "accountNumber": "1234567890",
    "name": "Example Bank",
    "country": "PH",
    "clearingCode": "010000018"
  }
}

Receiver fields

Identification fields

Bank account fields

Example

On this page