> For the complete documentation index, see [llms.txt](https://docs.payengine.co/payengine-api-v2.5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/payengine-api-v2.5/payouts/get-payee.md).

# Get Payee

## Get Payee

<mark style="color:blue;">`GET`</mark> `https://<Platform-host>/api/payouts/:merchant_id/payee/:payeetoken`

**Path Parameters**

| Name                                           | Type   | Description                        |
| ---------------------------------------------- | ------ | ---------------------------------- |
| merchant\_id<mark style="color:red;">\*</mark> | string | Merchant ID                        |
| payeetoken                                     | string | Unique ID to identify payee record |

**Response Body**

{% tabs %}
{% tab title="200 " %}
{% tabs %}
{% tab title="Field Definitions" %}

<table><thead><tr><th width="197">Name</th><th width="120">Type</th><th>Description</th></tr></thead><tbody><tr><td>merchant_id<mark style="color:red;">*</mark></td><td>string</td><td>Merchant ID</td></tr><tr><td>payee_token<mark style="color:red;">*</mark></td><td>string</td><td>Unique Payee ID</td></tr><tr><td>status<mark style="color:red;">*</mark></td><td>string</td><td><p>payee record status</p><p>ACTIVE/INACTIVE</p></td></tr><tr><td>created_on<mark style="color:red;">*</mark></td><td>string</td><td>Payee Created Date Time</td></tr><tr><td>updated_on</td><td>string</td><td>Payee Update Date Time</td></tr><tr><td>client_payee_id</td><td>string</td><td>A client-defined identifier for the payee. This is the unique ID assigned to the payee on your system. Max 75 characters. Allows letters, numbers, and + , - . / _ ~ |</td></tr><tr><td>category<mark style="color:red;">*</mark></td><td>string</td><td>payee category e.g. distributor, supplier etc</td></tr><tr><td>first_name<mark style="color:red;">*</mark></td><td>string</td><td>The payee's first name. (If Business account, the first name of the representative)</td></tr><tr><td>middle_name</td><td>string</td><td>The payee's middle name. (If Business account, the middle name of the representative)</td></tr><tr><td>last_name<mark style="color:red;">*</mark></td><td>string</td><td>The payee's last name. (If Business account, the last name of the representative)</td></tr><tr><td>address1<mark style="color:red;">*</mark></td><td>string</td><td>The payee's street address</td></tr><tr><td>address2</td><td>string</td><td>The payee's street address, line 2</td></tr><tr><td>city<mark style="color:red;">*</mark></td><td>string</td><td>The payee's city</td></tr><tr><td>state_province</td><td>string</td><td>The payee's state/province</td></tr><tr><td>postal_code<mark style="color:red;">*</mark></td><td>string</td><td>The payee's postal code</td></tr><tr><td>country<mark style="color:red;">*</mark></td><td>string</td><td>The payee's country code. <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">ISO_3166</a> code</td></tr><tr><td>mobile_number</td><td>string</td><td>Mobile number of payee</td></tr><tr><td>date_of_birth</td><td>date</td><td>Date of birth e.g. YYYY-MM_DD</td></tr><tr><td>business_name</td><td>string</td><td>Company legal name (Only if Business account)</td></tr><tr><td>funding_method<mark style="color:red;">*</mark></td><td>string</td><td><p>Method of payment to the payee. following are possible values</p><p>1 - Next Day Bank Deposit</p><p>2 - Same Day Bank Deposit</p><p>3 - Real Time Payment</p></td></tr><tr><td>account _name<mark style="color:red;">*</mark></td><td>string</td><td>payee bank account name</td></tr><tr><td>account_type<mark style="color:red;">*</mark></td><td>string</td><td>Personal/Business</td></tr><tr><td>account_subtype</td><td>string</td><td><p>payee bank account type</p><p>C => Checking<br>S => Saving</p><p>This will exist only if funding method = 1,2,3</p></td></tr><tr><td>routing_number</td><td>string</td><td><p>payee bank routing number</p><p>This will exist only if funding method = 1,2,3</p><p>The 9-digit bank routing number (American Bankers Association Routing Transit Number), used in conjunction with the bank account number, is used to route transactions to the payee's bank account</p></td></tr><tr><td>account_currency<mark style="color:red;">*</mark></td><td>string</td><td>Account Currency (Using <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a> format)</td></tr><tr><td>account_number</td><td>string</td><td><p>payee bank account number (masked)</p><p>This will exist only if funding method = 1,2,3</p></td></tr><tr><td>card_number</td><td>string</td><td>This will exist only if funding method = instant pay. This should be masked</td></tr><tr><td>card_expiry</td><td>string</td><td>This will exist only if funding method = instant pay (YYYYMM)</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Sample Request Body" %}
{% code fullWidth="true" %}

```bash
curl --location --request GET '<API_HOST>/api/payouts/1cc7b594-b80f-4227-a0fa-299c4c6ce8ab/payee/123e4567-e89b-12d3-a456-426614174000' \

--header 'Authorization: Basic <API_KEY>'
```

{% endcode %}
{% endtab %}

{% tab title="Sample Response Body " %}

```json
{
  "merchant_id":"1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
  "payee_token":"123e4567-e89b-12d3-a456-426614174000",
  "status":"ACTIVE",
  "created_on":"2019-07-07T23:03:05",
  "updated_on":"2019-07-17T11:02:15",
  "client_payee_id":"4324-rOzk",
  "category":"distributor",
  "first_name":"John",
  "middle_name":"",
  "last_name":"Doe",
  "address1":"2000 main st",
  "address2":"apt D",
  "city":"Santa Monica",
  "state_province":"CA",
  "postal_code":"90405",
  "country":"USA",
  "email":"jdoe@gmail.com",
  "mobile_number":"16502000226",
  "date_of_birth":"1975-03-24",
  "business_name":"ABC Company",
  "funding_method":"1"
  "account_name":"John Doe",
  "account_type":"Business",
  "account_subtype":"S",
  "routing_number":"125000118",
  "account_currency":"USD",
  "account_number":"*************5300",
  }
```

{% endtab %}
{% endtabs %}