---
title: "Fetch Beneficiaries List"
method: GET
path: "/api/merchants/{key}/payout/createBeneficiary"
tags: ["Payout APIs"]
---

# Fetch Beneficiaries List

`GET /api/merchants/{key}/payout/createBeneficiary`

## Request

- Base URL: `https://api.portone.cloud`
- URL: `https://api.portone.cloud/api/merchants/{key}/payout/createBeneficiary`
- Auth: none declared

## Path parameters

- `key` string, required

## Query parameters

- `environment` 'live' | 'sandbox'
- `page` integer
- `pageSize` integer

## Headers

- `X-Portone-Client-Key` string
- `Authorization` string

## Response `200`

Successful response

- object
  - `content` VirtualAccountContent: The object containing the virtual account details.
    - `account_no` string: The account_number to virtual account.
    - `account_name` string: The name of the virtual account.
    - `bank_code` string: The bank_code of the virtual account.
    - `bank_name` string: The bank name of the virtual account.
    - `start_date` string: The creation date of the virtual account.
    - `channel_key` string: The PSP Channel Key linked to the virtual account. Refer PortOne docs for additional details.
    - `end_date` string: The expiry_date of the virtual account.
    - `balance` number, double: The amount present in the virtual account.
    - `currency` string: The currency supported by the virtual account for the transaction.
    - `condition` string: Refer PortOne docs for additional details.
    - `conditional_amount` number, double: The amount limit conditional to the PSP
  - `message` string: The description of the API request execution result
  - `status_code` string: The status_code for API request execution result
  - `status_reason` string: The status_reason for API request execution result

## Other responses

- `400`: Failure response
- `401`: Failure response

---

[API](https://skmtc.dev/portone/apis/payout-apis.md) - [All operations](https://skmtc.dev/portone/apis/payout-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/portone/apis/payout-apis/revisions/b2e255108469?raw)