Add a Receive User
Read on how to add a receive user
You will have to create an individual or business 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 have receive capabilities.
POST /users
POST /users
Individual Receive User
curl --location --request POST '{{url}}/users \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "Edmund",
"middle_name": "",
"last_name": "Hillary",
"email":"[email protected]",
"gender": "male",
"date_of_birth":"2000-01-01",
"mobile_phone": "9879879870",
"address_line1": "500 El Camino Real Santa Clara",
"city": "Santa Clara",
"zipcode": "95053",
"state": "CA",
"country":"US",
"business":false,
"occupation":"Engineer",
"ip_address":"10.0.0.1",
"user_relationship": "BROTHER",
"send_user_id":UUID,
"type":"RECEIVE"
}'
Business Receive User
curl --location --request POST '{{url}}/users \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "Everest pvt Ltd",
"middle_name": null,
"last_name": null,
"mobile_phone": "5433456478",
"address_line1": "Cra.23 No.20B-01, El Retiro",
"city": "Antioquia",
"zipcode": "95053",
"country": "CO",
"send_user_id": {{UUID}},
"type": "RECEIVE",
"business": true,
"virtual_documents": [
{
"document_value": "12345",
"document_type": "EIN_NUMBER"
}
]
}'
Last updated
Was this helpful?