---
title: "Get Beneficiary by External ID"
method: GET
path: "/bank-beneficiaries/external/{external_id}"
---

# Get Beneficiary by 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`

Get a beneficiary by its external id.

## Path parameters

- `externalId` string, required

## Response `200`

200

- object
  - `id` string
  - `accountHolderId` string
  - `beneficiaryId` string
  - `externalId` string
  - `status` string
  - `beneficiaryFirstName` string
  - `beneficiaryLastName` string
  - `beneficiaryType` string
  - `beneficiaryCountry` string
  - `beneficiaryPostalCode` string
  - `beneficiaryCity` string
  - `accountNumber` string
  - `iban` string
  - `bic` string
  - `currency` string
  - `bankName` string
  - `bankAddress` string
  - `bankAccountCountry` string
  - `bankAccountHolderName` string
  - `companyName` string
  - `paymentType` string
  - `bankRoutingCodes` object[]
    - `routingCodeKey` string
    - `routingCodeValue` string
  - `class` string
  - `bankAccountType` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/openpayd/apis/openpayd-api.md) - [All operations](https://skmtc.dev/openpayd/apis/openpayd-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openpayd/apis/openpayd-api/revisions/0f820ef79fab?raw)
