OPopenpayd

Get Beneficiary by External ID

Get a beneficiary by its external id.

get/bank-beneficiaries/external/{external_id}

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/bank-beneficiaries/external/{external_id}
  • Auth
    API key in header Authorization

Path parameters

externalIdstring required

externalId (UUID) from the create bank beneficiary request.

Response

200

idstring
accountHolderIdstring
beneficiaryIdstring
externalIdstring
statusstring
beneficiaryFirstNamestring
beneficiaryLastNamestring
beneficiaryTypestring
beneficiaryCountrystring
beneficiaryPostalCodestring
beneficiaryCitystring
accountNumberstring
ibanstring
bicstring
currencystring
bankNamestring
bankAddressstring
bankAccountCountrystring
bankAccountHolderNamestring
companyNamestring
paymentTypestring
classstring
bankAccountTypestring

Example response

{
  "id": "cc409c57-115d-41ed-bc72-f24f1a4374c8",
  "accountHolderId": "71a32bf6-f190-4c19-8afa-6a1679829cb7",
  "beneficiaryId": "c04a2985-2e65-4c5b-ba20-2f29a6f6c235",
  "externalId": "51d1346e-a745-4cd0-9db9-b5bf93367ccd",
  "status": "VALID",
  "beneficiaryFirstName": "Oliver",
  "beneficiaryLastName": "Johnson",
  "beneficiaryType": "CORPORATE",
  "beneficiaryCountry": "GB",
  "beneficiaryPostalCode": "SW1 9EF",
  "beneficiaryCity": "London",
  "accountNumber": "DE75512108001245126199",
  "iban": "DE75512108001245126199",
  "bic": "ABCADEFFXXX",
  "currency": "EUR",
  "bankName": "Natwest Bank",
  "bankAddress": "London",
  "bankAccountCountry": "GB",
  "bankAccountHolderName": "Oliver Johnson",
  "companyName": "Any Company",
  "paymentType": "SEPA",
  "bankRoutingCodes": [
    {
      "routingCodeKey": "BRANCH_CODE",
      "routingCodeValue": "20"
    }
  ],
  "class": "BANK",
  "bankAccountType": "CURRENT"
}

Changes

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