OPopenpayd

Validate Beneficiary

Validate a beneficiary without creating one first to ensure that beneficiary details are valid for a given payment type and currency.

post/beneficiaries/validate

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/beneficiaries/validate
  • Auth
    API key in header Authorization

Request body

bankAccountCurrencystring required

Three-letter ISO 4217 currency code in which the beneficiary account is held. e.g. EUR

bankAccountCountrystring required

Two-letter ISO 3166-1 alpha-2 country code where the beneficiary account is held. e.g. GB

beneficiaryTypestring required

CORPORATE, RETAIL

paymentTypesstring[]

Payment Types against which to validate the beneficiary. If left empty, the beneficiary will be validated for all available Payment Types.

bankAccountTypestring

Type of the account. e.g. Current, Savings

bankNamestring

Name of the bank where the account is held. e.g. HSBC UK

bankAddressstring

Address of the bank where the account is held.

bankAccountHolderNamestring

Name appearing the beneficiary account.

accountNumberstring

Account number of the account.

ibanstring

IBAN of the account.

bicstring

SWIFT BIC of the account.

companyNamestring

Required if beneficiaryType is CORPORATE.

titlestring

Required if beneficiaryType is RETAIL.

beneficiaryFirstNamestring

Required if beneficiaryType is RETAIL.

beneficiaryLastNamestring

Required if beneficiaryType is RETAIL.

beneficiaryBirthDatestring

YYYY-MM-DD e.g. 1986-04-29 for 29th April 1986

beneficiaryAddressLinestring
beneficiaryCitystring
beneficiaryCountrystring

Two-letter ISO 3166-1 alpha-2 country code e.g. GB

beneficiaryPostalCodestring
friendlyNamestring

User friendly name associated with the bank beneficiary. e.g. My HSBC Account

taxIdstring

Tax Id of the beneficiary.

Response

200

Example response

{
  "beneficiaryValidationResultSet": [
    {
      "paymentType": "CHAPS",
      "valid": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.