Get Payee

This API is used to get payee details

Get Payee

GET https://<PayEngine-host>/api/payouts/:merchant_id/payee/:payeetoken

Path Parameters

Name	Type	Description
merchant_id*	string	Merchant ID
payeetoken	string	Unique ID to identify payee record

Response Body

200

Field Definitions

Name	Type	Description
merchant_id*	string	Merchant ID
payee_token*	string	Unique Payee ID
status*	string	payee record status ACTIVE/INACTIVE
created_on*	string	Payee Created Date Time
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's country 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
card_expiry	string	This will exist only if funding method = instant pay (YYYYMM)

Sample Request Body

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

--header 'Authorization: Basic <API_KEY>'

Sample Response Body