Register a receive user
Read on how to add a receive user
For P2P transactions, you will have to create a receive user who will receive the funds. In order to enable receive capabilities to a user, you need to create a user with "type": "RECEIVE".
Receive users will be linked to a particular send user and only users in destination corridors enabled for you can be created with receive capabilities.

POST /users

Details
Request Sample
Response Sample

Receive user object details

Field
Required
Type
Description
mobile_phone
Yes
numeric
10 digits mobile number of the user
phone_number
No
numeric
10 digits phone number of the user
email
No
String
Email ID of receive user
first_name
Yes
String
First name of the user.
middle_name
No
String
Middle name of the user
last_name
Yes
String
Family name of the user
gender
No
String
Male, female, other
date_of_birth
No
String
Birth date of individual
address_line1
No
String
Street address of the user
address_line2
No
String
Street address of the user
city
No
String
City of the user
state
No
String
2-letter ISO code of the user’s state.
zipcode
No
String
Zip code of the user’s address
occupation
No
String
User’s occupation
type
Yes
String
Enumerated Value : ‘SEND’ , ‘RECEIVE’
user_relationship
No
String
Enumerated value. Details provided below.
send_user_id
Yes
UUID
The ID of the send user who is registering the receive user to make a transfer.

User Relationship Enumerated Values

1
AUNT("Aunt"),
2
BROTHER("Brother"),
3
BROTHER_IN_LAW("Brother in Law"),
4
COUSIN("Cousin"),
5
DAUGHTER("Daughter"),
6
FATHER("Father"),
7
FATHER_IN_LAW("Father in Law"),
8
FRIENDS("Friends"),
9
GRANDFATHER("Grand Father"),
10
GRANDMOTHER("Grand Mother"),
11
HUSBAND("Husband"),
12
MOTHER("Mother"),
13
MOTHER_IN_LAW("Mother in law"),
14
NEPHEW("Nephew"),
15
NIECE("Niece"),
16
SELF("Self"),
17
SISTER("Sister"),
18
SISTER_IN_LAW("Sister in Law"),
19
SON("Son"),
20
UNCLE("Uncle"),
21
WIFE("Wife"),
22
OTHERS("Others")
Copied!
1
curl --location --request POST 'https://v4test.machpay.com/v4/users \
2
--header 'X-Client-Id: {{client_id}}' \
3
--header 'X-Client-Secret: {{client_secret}}' \
4
--header 'Content-Type: application/json' \
5
--data-raw '{
6
"first_name": "Edmund",
7
"middle_name": "",
8
"last_name": "Hillary",
9
"email":"[email protected]",
10
"gender": "male",
11
"date_of_birth":"2000-01-01",
12
"mobile_phone": "9879879870",
13
"address_line1": "500 El Camino Real Santa Clara",
14
"city": "Santa Clara",
15
"zipcode": "95053",
16
"state": "CA",
17
"country":"US",
18
"business":false,
19
"occupation":"Engineer",
20
"ip_address":"10.0.0.1",
21
"user_relationship": "BROTHER",
22
"send_user_id":UUID,
23
"type":"RECEIVE"
24
}'
Copied!
1
{
2
"address_line1": "500 El Camino Real Santa Clara",
3
"business": false,
4
"city": "Santa Clara",
5
"country": "US",
6
"date_of_birth": "2000-01-01",
7
"email": "[email protected]",
8
"first_name": "edmund",
9
"gender": "male",
10
"id": "23a1f436-f75c-4c9c-9563-7812f9bcc135",
11
"ip_address": "10.0.0.1",
12
"last_name": "hillary",
13
"middle_name": "",
14
"mobile_phone": "9879879870",
15
"occupation": "Engineer",
16
"state": "CA",
17
"status": "UNVERIFIED",
18
"tier": 0,
19
"type": "RECEIVE",
20
"user_relationship": "BROTHER",
21
"zipcode": "95053"
22
}
Copied!
Copy link
Contents