Create Payee
This API is used to create a new payee for a merchant
Create a Payee
POST https://<Platform-host>/api/payouts/:merchant_id/payee
Path Parameters
merchant_id*
string
Merchant ID (Payer)
Request Body
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
email*
string
The payee's e-mail address. Must be unique. Cannot have two payees with the same e-mail address.
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 the possible values
1 - Next Day Bank Deposit
2 - Same Day Bank Deposit
3 - Real Time Payment
4 - Instant Pay
account_name*
string
payee bank account name
account_type*
string
Personal/Business
account_subtype
string
payee bank account type and accepted values are
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_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
merchant_id*
string
Merchant ID
payee_token*
string
Unique Payee ID (Payout Platform Payee ID)
status*
string
payee record status
ACTIVE/INACTIVE
created_on*
String
Payee Creation 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. Required in order to process a payout.
address2
string
The payee's street address, line 2
city*
string
The payee's city. Required in order to process a payout
state_province
string
The payee's state/province
postal_code*
string
The payee's postal code
email*
string
The payee's e-mail address.
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_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)
{
"merchant_id": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
"data": {
"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":"[email protected]",
"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",
"account_currency":"USD",
"routing_number":"125000118",
"account_number":"13719713158835300",
}
}Last updated