---
page_source: https://docs.juspay.io/payout-brazil/docs/integration/list-of-beneficiary
page_title: List of Beneficiary
---

## API Version: default


# List of Beneficiary



Merchant can list all the beneficiary details.## Endpoints:
- Sandbox: https://api.sandbox.juspay.io/payout/merchant/v1/benedetails/{customerId}

- Production: https://api.juspay.io/payout/merchant/v1/benedetails/{customerId}

## Request Type: 
GET

## Authorization:

#### Basic Auth:
Consists of two parts.

* Username: API Key obtained from Juspay dashboard
* Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
- Tags: String, Mandatory
## Headers:

#### x-merchantid:
pass merchant id that is provided by Juspay
- Tags: string

#### Content-Type:
application/json
- Tags: String
## Sample Code Snippets:
### Sample Request:

#### Request Code Snippet:

```request
curl --location --request GET 'https://api.juspay.io/payout/merchant/v1/benedetails/:customerId' \
--header 'Content-Type: application/json' \
--header 'x-merchantid: <merchant id>' \
--header 'Authorization: Basic (b64 encoded API key)' \

```

### Sample Response:

#### Response:
```json
{
    "summary": {
        "totalPages": 1,
        "currentPage": 1,
        "count": 4
    },
    "list": [
        {
            "uniqueId": "paypalbeneid1",
            "status": "CREATED",
            "remark": "",
            "beneDetails": {
                "details": {
                    "walletIdentifierType": "EMAIL",
                    "walletIdentifier": "sb-zXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.com",
                    "payeeAdditionalDetails": {
                        "state": "Rio de Janeiro",
                        "payerId": "GJGL66GWCHMZ2",
                        "name": "JoXXXXoe",
                        "email": "sb-zXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.com",
                        "country": "Brazil",
                        "accountVerificationStatus": "true"
                    },
                    "brand": "PAYPAL"
                },
                "type": "WALLET"
            }
        },
        {
            "uniqueId": "606",
            "status": "DISABLED",
            "remark": "",
            "beneDetails": {
                "details": {
                    "walletIdentifierType": "PAYPAL_ID",
                    "walletIdentifier": "FSMRXXXXX8PSG",
                    "payeeAdditionalDetails": {
                        "state": "XYZ",
                        "payerId": "FSMRBANCV8PSG",
                        "name": "samXXXXXser",
                        "email": "sb-mXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.com",
                        "country": "Brazil",
                        "accountVerificationStatus": "true"
                    },
                    "brand": "PAYPAL"
                },
                "type": "WALLET"
            }
        },
        {
            "uniqueId": "986",
            "status": "DELETED",
            "remark": "",
            "beneDetails": {
                "details": {
                    "walletIdentifierType": "PAYPAL_ID",
                    "walletIdentifier": "XXXXXXXXXXXXX",
                    "payeeAdditionalDetails": {
                        "state": "XXX",
                        "payerId": "XXXXXXXXXXXXX",
                        "name": "XXXXXXXXXXX",
                        "email": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                        "country": "XXXXXX"
                    },
                    "brand": "PAYPAL"
                },
                "type": "WALLET"
            }
        },
        {
            "uniqueId": "138",
            "status": "DISABLED",
            "remark": "",
            "beneDetails": {
                "details": {
                    "vpa": "sucXXXXXupi",
                    "name": "ShubXXXXXumar"
                },
                "type": "WALLET"
            }
        }
    ]
}
```

## API Responses:
### 200:

#### json:
- Tags: Object
### 400:

#### object:
- Description: {}
- Tags: Object