Documentation
Beneficiaries
Portugal Beneficiary

Portugal Beneficiary

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

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

cURL
curl --location '{{baseURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
  "reference": "<sample-reference>",
  "country": "PT",
  "currency": "EUR",
  "destination": {
    "type": "BANK",
    "accountName": "João Silva",
    "accountNumber": "PT50000201231234567890154",
    "remittancePurpose": "FAMILY_SUPPORT",
    "beneficiary": {
      "type": "INDIVIDUAL",
      "country": "PT",
      "city": "Lisbon",
      "postCode": "1269-037",
      "address": "Avenida da Liberdade 10"
    },
    "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 Portugal BANK beneficiaries are:

ParameterDescriptionRequired
countryCountry of beneficiary payload. Must be PT.✅
currencyCurrency of transfer. Must be EUR.✅
destination.typeDestination type. Must be BANK.✅
accountNameBeneficiary account name.✅
accountNumberBeneficiary IBAN (25 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.✅