Documentation
Beneficiaries
Ireland Beneficiary

Ireland Beneficiary

Before making a payment to a Ireland bank account, you must add the account as a beneficiary. Ireland supports two transfer types: BANK (EUR via SEPA) and SWIFT (USD).

BANK Transfer (EUR)

Below is a sample request for creating a Ireland BANK beneficiary:

cURL
curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
  "reference": "<sample-reference>",
  "country": "IE",
  "currency": "EUR",
  "destination": {
    "type": "BANK",
    "accountName": "Patrick Murphy",
    "accountNumber": "IE29AIBK93115212345678",
    "remittancePurpose": "FAMILY_SUPPORT",
    "beneficiary": {
      "type": "INDIVIDUAL",
      "country": "IE",
      "city": "Dublin",
      "postCode": "D01",
      "address": "O'\''Connell Street 25"
    },
    "sender": {
      "type": "INDIVIDUAL",
      "accountName": "John Smith",
      "country": "US",
      "city": "New York",
      "address": "123 Main St",
      "postCode": "10001",
      "dateOfBirth": "1985-03-15",
      "countryOfBirth": "US"
    }
  }
}'

The parameters for adding Ireland BANK beneficiaries are:

ParameterDescriptionRequired
countryCountry of beneficiary payload. Must be IE.
currencyCurrency of transfer. Must be EUR.
destination.typeDestination type. Must be BANK.
accountNameBeneficiary account name.
accountNumberBeneficiary IBAN (22 chars, no spaces).
remittancePurposeRemittance purpose. Must be one of the supported enumerations below.
💡

The remittance purpose for BANK transfers can be any one of the following values: COMPUTER_SERVICES, FAMILY_SUPPORT, EDUCATION, GIFT_AND_DONATION, MAINTENANCE_EXPENSES, TRAVEL, CONSTRUCTION_EXPENSES, ADVISORY_FEES, BUSINESS_INSURANCE, INSURANCE_CLAIMS, EXPORTED_GOODS, SERVICE_CHARGES, LOAN_PAYMENT, PROPERTY_PURCHASE, PROPERTY_RENTAL, TAX_PAYMENT, UTILITY_BILLS, PERSONAL_TRANSFER, SALARY_PAYMENT.

Sender Parameters (Business)

ParameterDescriptionRequired
sender[type]Must be BUSINESS.
sender[accountName]Sender account name.
sender[country]Sender country.
sender[city]Sender city.
sender[address]Sender address.
sender[postCode]Sender postal code.
sender[businessRegistrationNumber]Business registration number.

Sender Parameters (Individual)

ParameterDescriptionRequired
sender[type]Must be INDIVIDUAL.
sender[accountName]Sender account name.
sender[country]Sender country.
sender[city]Sender city.
sender[address]Sender address.
sender[postCode]Sender postal code.
sender[dateOfBirth]Sender date of birth (YYYY-MM-DD).
sender[countryOfBirth]Sender country of birth.

Beneficiary Parameters

ParameterDescriptionRequired
beneficiary[type]Must be INDIVIDUAL or BUSINESS.
beneficiary[country]Beneficiary country.
beneficiary[city]Beneficiary city.
beneficiary[postCode]Beneficiary postal code.
beneficiary[address]Beneficiary address.

SWIFT Transfer (USD)

Below is a sample request for creating a Ireland SWIFT beneficiary:

cURL
curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
  "reference": "<sample-reference>",
  "country": "IE",
  "currency": "USD",
  "destination": {
    "type": "SWIFT",
    "accountName": "Patrick Murphy",
    "accountNumber": "IE29AIBK93115212345678",
    "swiftCode": "AIBKIE2D",
    "bankName": "AIB Group",
    "bankAddress": "O'\''Connell Street 25",
    "bankCity": "Dublin",
    "bankPostCode": "D01",
    "bankCountry": "IE",
    "remittancePurpose": "FAMILY_SUPPORT",
    "beneficiary": {
      "type": "BUSINESS",
      "country": "IE",
      "city": "Dublin",
      "postCode": "D01",
      "address": "O'\''Connell Street 25"
    },
    "sender": {
      "type": "INDIVIDUAL",
      "accountName": "John Smith",
      "country": "US",
      "city": "New York",
      "address": "123 Main St",
      "postCode": "10001",
      "dateOfBirth": "1985-03-15",
      "countryOfBirth": "US"
    }
  }
}'

The parameters for adding Ireland SWIFT beneficiaries are:

ParameterDescriptionRequired
countryCountry of beneficiary payload. Must be IE.
currencyCurrency of transfer. Must be USD.
destination.typeDestination type. Must be SWIFT.
accountNameBeneficiary account name.
accountNumberBeneficiary IBAN (22 chars, no spaces).
swiftCodeSWIFT/BIC code (8 or 11 chars, uppercase letters/numbers).
bankNameReceiving bank name.
bankAddressReceiving bank address.
bankCityReceiving bank city.
bankPostCodeReceiving bank postal code.
bankCountryReceiving bank country.
remittancePurposeRemittance purpose. Must be one of the supported enumerations below.
💡

The remittance purpose for SWIFT transfers can be any one of the following values: FAMILY_SUPPORT, EDUCATION, GIFT_AND_DONATION, MEDICAL_TREATMENT, MAINTENANCE_EXPENSES, TRAVEL, SMALL_VALUE_REMITTANCE, LIBERALIZED_REMITTANCE, OTHER, CONSTRUCTION_EXPENSES, HOTEL_ACCOMMODATION, ADVERTISING_EXPENSES, ADVISORY_FEES, BUSINESS_INSURANCE, INSURANCE_CLAIMS, DELIVERY_FEES, EXPORTED_GOODS, SERVICE_CHARGES, LOAN_PAYMENT, OFFICE_EXPENSES, PROPERTY_PURCHASE, PROPERTY_RENTAL, ROYALTY_FEES, SHARES_INVESTMENT, FUND_INVESTMENT, TAX_PAYMENT, TRANSPORTATION_FEES, UTILITY_BILLS, PERSONAL_TRANSFER, SALARY_PAYMENT, OTHER_FEES, COMPUTER_SERVICES, REWARD_PAYMENT, INFLUENCER_PAYMENT.

Sender Parameters (Business)

ParameterDescriptionRequired
sender[type]Must be BUSINESS.
sender[accountName]Sender account name.
sender[country]Sender country.
sender[city]Sender city.
sender[address]Sender address.
sender[postCode]Sender postal code.
sender[businessRegistrationNumber]Business registration number.

Sender Parameters (Individual)

ParameterDescriptionRequired
sender[type]Must be INDIVIDUAL.
sender[accountName]Sender account name.
sender[country]Sender country.
sender[city]Sender city.
sender[address]Sender address.
sender[postCode]Sender postal code.
sender[dateOfBirth]Sender date of birth (YYYY-MM-DD).
sender[countryOfBirth]Sender country of birth.

Beneficiary Parameters

ParameterDescriptionRequired
beneficiary[type]Must be BUSINESS in this schema.
beneficiary[country]Beneficiary country.
beneficiary[city]Beneficiary city.
beneficiary[postCode]Beneficiary postal code.
beneficiary[address]Beneficiary address.