> 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/update-payee.md). # Update Payee ## Update a Payee `PATCH` `https:///api/payouts/:merchant_id/payee/:payeetoken` **Path Parameters** | Name | Type | Description | | ---------------------------------------------- | ------ | ---------------------------------- | | merchant\_id\* | string | Merchant ID | | payeetoken | string | Unique ID to identify payee record | #### Request Body

Name	Type	Description
status*	string	payee record status ACTIVE/INACTIVE
client_payee_id	string	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 + , - . / _ ~ \|
category*	string	payee category e.g. distributor, supplier etc
first_name*	string	The payee's first name. (If Business account, the first name of the representative)
middle_name	string	The payee's middle name. (If Business account, the middle name of the representative)
last_name*	string	The payee's last name. (If Business account, the last name of the representative)
address1*	string	The payee's street address
address2	string	The payee's street address, line 2
city*	string	The payee's city
state_province	string	The payee's state/province
postal_code*	string	The payee's postal code
country*	string	The payee's country code. ISO_3166 code
mobile_number	string	Mobile number of payee. Allows for SMS notifications upon availability of funds
date_of_birth	date	Date of birth. . Minimum 18 years old YYYY-MM_DD
business_name	string	Company legal name (Only if Business account)
funding_method*	string	method of payment to the payee. following are possible values 1 - Next Day Bank Deposit 2 - Same Day Bank Deposit 3 - Real Time Payment
account_name*	string	payee bank account name
account_type*	string	Personal/Business
account_subtype	string	payee bank account type C => Checking S => Saving This will exist only if funding method = 1,2,3
routing_number	string	payee bank routing number This will exist only if funding method = 1,2,3 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
account_currency*	string	Account Currency (Using ISO 4217 format)
account_number	string	payee bank account number This will exist only if funding method = 1,2,3
card_number	string	This will exist only if funding method = instant pay.
card_expiry	string	This will exist only if funding method = instant pay (YYYYMM)

**Response Body** {% tabs %} {% tab title="200 " %} {% tabs %} {% tab title="Field Definitions" %}

Name	Type	Description
merchant_id*	string	Merchant ID
payee_token*	string	Unique Payee ID
status*	string	payee record status ACTIVE/INACTIVE
updated_on*	string	Payee Update Date Time
client_payee_id	string	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 + , - . / _ ~ \|
category*	string	payee category e.g. distributor, supplier etc
first_name*	string	The payee's first name. (If Business account, the first name of the representative)
middle_name	string	The payee's middle name. (If Business account, the middle name of the representative)
last_name*	string	The payee's last name. (If Business account, the last name of the representative)
address1*	string	The payee's street address
address2	string	The payee's street address, line 2
city*	string	The payee's city
state_province	string	The payee's state/province
postal_code*	string	The payee's postal code
country*	string	The payee'scountry code. ISO_3166 code
mobile_number	string	Mobile number of payee
date_of_birth	date	Date of birth E.g. YYYY-MM_DD
business_name	string	Company legal name (Only if Business account)
funding_method*	string	Method of payment to the payee. following are possible values 1 - Next Day Bank Deposit 2 - Same Day Bank Deposit 3 - Real Time Payment
account_name*	string	payee bank account name
account_type*	string	Personal/Business
account_subtype	string	payee bank account type C => Checking S => Saving This will exist only if funding method = 1,2,3
routing_number	string	payee bank routing number This will exist only if funding method = 1,2,3 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
account_currency*	string	Account Currency (Using ISO 4217 format)
account_number	string	payee bank account number (masked) This will exist only if funding method = 1,2,3
card_number	string	This will exist only if funding method = instant pay. This should be masked value
card_expiry	string	This will exist only if funding method = instant pay (YYYYMM)

{% endtab %} {% endtabs %} {% endtab %} {% endtabs %} {% tabs %} {% tab title="Sample Request Body" %}

{
    "merchant_id": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
    "payee_token": "123e4567-e89b-12d3-a456-426614174000",
    "data": {  
            "status":"ACTIVE",
            "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",
            "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":"13719713158835300"
          }
}

{% endtab %} {% tab title="Sample Response Body" %} ```json { "merchant_id":"1cc7b594-b80f-4227-a0fa-299c4c6ce8ab", "payee_token":"123e4567-e89b-12d3-a456-426614174000", "status":"ACTIVE", "updated_on":"2019-07-07T23:03:05", "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 %}