> For the complete documentation index, see [llms.txt](https://pivot-payment.gitbook.io/pivot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/payout-international/beneficiary/create-beneficiary.md).

# Create Beneficiary

## Method and URL

<mark style="color:green;">`POST`</mark> \[<mark style="color:orange;">BASE\_URL</mark>]/xb/beneficiary

## **Request Params**

#### **Request Body**

```json
{
    "name": "Merci Beacou Supa",
    "countryCode": "US",
    "state": "New York",
    "city": "New York City",
    "address": "Jl Amerika",
    "postcode": "12345",
    "accountType": "Individual",
    "accountNumber": "35628342",
    "identificationType": "Passport",
    "identificationNumber": "X123456",
    "bankName": "Bank of America"
    // "bankCode": "123", → only for beneficiary country Korea
    // "contactCountryCode": "+81", → only for beneficiary country Korea
    // "contactNumber": "123134123", → only for beneficiary country Korea
    // "email": "halo@email.com", → only for beneficiary country Korea
    // “payoutMethod”: “WALLET” → only for sending to Alipay (BANK/WALLET/CASH)
}
```

## Response

**Response Body**

```json
{
    "code": "00",
    "message": "Success",
    "data": {
        "uuid": "62b39dd6-85dc-4c33-b9d9-edc992251bf3",
        "name": "Merci Beacou Supa",
        "accountType": "Individual",
        "address": "Jl Amerika",
        "city": "New York City",
        "postcode": "12345",
        "state": "New York",
        "countryCode": "US",
        "identificationType": "Passport",
        "identificationNumber": "X123456",
        "accountNumber": "35628342",
        "bankName": "Bank of America",
        "bankCode": "",
        "contactCountryCode": "",
        "contactNumber": "",
        "email": "",
        "createdAt": "2024-11-07T02:43:52Z"
    }
}
```
