---
title: "Beneficiary Required Details"
method: GET
path: "/beneficiary-required-details"
---

# Beneficiary Required Details

`GET /beneficiary-required-details`

## Request

- Base URL: `https://sandbox.openpayd.com/api`
- URL: `https://sandbox.openpayd.com/api/beneficiary-required-details`
- Auth: API key in header `Authorization`

Get the details required to create a beneficiary depending on the beneficiary type, currency and country.

## Query parameters

- `bankAccountCountry` string, required
- `bankAccountCurrency` string, required
- `beneficiaryType` string, required

## Response `200`

200

- object[]
  - `paymentType` string
  - `requiredFieldsList` object[]
    - `fieldName` string
    - `display` boolean
    - `required` boolean
    - `expression` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/openpayd/apis/openpayd-reference-data.md) - [All operations](https://skmtc.dev/openpayd/apis/openpayd-reference-data/llms.txt) - [OpenAPI document](https://skmtc.dev/openpayd/apis/openpayd-reference-data/revisions/32370d47c0ea?raw)