# Create Beneficiary

### **Request** URL <a href="#payin-by-creditcard" id="payin-by-creditcard"></a>

`POST` `/remittance/payment/create-beneficiary`

### **Request Body**

&#x20;**Refer to :** [**common**](https://docs.pagsmile.com/remittance-api/common)

&#x20;**Biz\_data**&#x20;

<table><thead><tr><th width="302.53515625">Name</th><th width="135.44140625">Type</th><th>Description</th></tr></thead><tbody><tr><td>merchant_id<mark style="color:red;">*</mark></td><td>long</td><td>Merchant ID</td></tr><tr><td>bank_country<mark style="color:red;">*</mark></td><td>string</td><td>Receive Country</td></tr><tr><td>receive_currency<mark style="color:red;">*</mark></td><td>string</td><td>Receive Currency</td></tr><tr><td>payment_type<mark style="color:red;">*</mark></td><td>integer</td><td><p>Payment Type</p><p>Refer to <a href="../../data/dictionary-item/payment-type">Pay Type</a></p></td></tr><tr><td>account_type<mark style="color:red;">*</mark></td><td>integer</td><td><p>Account Type</p><p>Refer to<a href="../../data/dictionary-item/account-type"> Account Type</a></p></td></tr><tr><td>is_withdrawal_beneficiary<mark style="color:red;">*</mark></td><td>boolean</td><td>Default : false</td></tr><tr><td>account_name</td><td>string</td><td>Account Name, if is_withdrawal_beneficiary is false, it is required</td></tr><tr><td>payee_type<mark style="color:red;">*</mark></td><td>integer</td><td>Refer to:<a href="../../data/dictionary-item/payee-type"> Payee Type</a></td></tr><tr><td>payee_values<mark style="color:red;">*</mark></td><td>object</td><td><p>Payee Values</p><p>For example:</p><pre class="language-json"><code class="lang-json">{
  "bicSwift": "EBAPFRPPXXX",
  "accountNumber": "12333",
  "beneficiaryCompanyName": "11111sss",
  "beneficiaryAddress": "ssssss",
  "beneficiaryCity": "Feng Tai Qu",
  "beneficiaryStateOrProvince": "Bei Jing Shi",
  "beneficiaryPostalCode": "1000070",
  "beneficiaryCountry": "CN"
}
</code></pre></td></tr><tr><td>remark</td><td>string</td><td>Remark</td></tr></tbody></table>

### Response <a href="#example" id="example"></a>

{% tabs %}
{% tab title="200:submit successfully" %}

```
{
    "code": "10000",
    "msg": "Success",
    "data":{
    },
    "random_key":"abssdddd2wdw==",
    "sign_type": "RSA",
    "app_id": "2017051914172236111"
}
```

{% endtab %}

{% tab title="400: invalid-signature" %}

```
{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "invalid-signature",
    "sub_msg": "invalid signature"
}
```

{% endtab %}
{% endtabs %}

| Name            | Type | Description    |
| --------------- | ---- | -------------- |
| beneficiary\_id | long | Beneficiary ID |

### Example <a href="#example" id="example"></a>

```
curl --location --request POST 'https://rem-api-sandbox.pagsmile.com/remittance/payment/add-payee' \
--header 'Content-Type: application/json' \
--data-raw '
{
    "partner_id": "000000000000001",
    "app_id": "162051914172236138",
    "timestamp": "2011-09-23 04:24:03",
    "format": "JSON",
    "version": "2.0",
    "random_key": "jJT3+PR9CSowcR2QOK5OzMjVmTSjGoectzYbO8lENHnboElE",
    "request_id": "F6bEd39c-EecF-C1a2-AFcb-bA9BAeC8",
    "sign_type": "RSA",
    "biz_data": "jJT3+PR9CSowcR2QOK5OzMjVmTSjGoectzYbO8lENHnboElEjJT3+PR9CSowcR2QOK5OzMjVmTSjGoectzYbO8lENHnboElE"
}'
```

```
```

Note: **162\*\*\*\*\*\*\*\*\*\*\*\*38** is pagsmile's test app id for sandbox

Please use your own **app\_id** when testing.