Create New Receiver

Create a new receiver under a SubAccount for receiving the payout.

Create a New Receiver

POST /api/receiver

Headers

Name	Value
x-api-key	<token>
signature	<token>

Body

Name	Type	Description
subaccount_id*	string	Subaccount ID of the receiver user.
first_name*	string	First Name of the receiver user.
last_name*	string	Last Name of the receiver the user.
middle_name	string	Middle Name of the receiver the user.
email*	string	Email of the receiver the user.
dob*	string	Date of Birth of the receiver the user. In the format of YYYY-MM-DD
dialcode*	string	Country Dial Code of the receiver the user. (for example, 61, 353 , and so on)
phone*	string	Phone of the receiver the user.
address*	string	Address of the receiver the user.
address2	string	Additional information related to the street.
gender	string	Gender of the receiver the user.
city*	string	City, town, or another settlement.
state*	string	State, region, district, county or another territorial entity inside a country.
postcode*	string	Address postal code.
country*	string	Alpha-3 country code (for example, DEU, GBR, ARG, and so on).
reference	string	Your reference for the receiver. This is usually a unique ID in your system.

* is mandatory parameter

Example body request

{
    "subaccount_id": "3dc81811-8cdb-49c6-8f9e-9b25ea4544b7"
    "first_name": "David",
    "last_name": "Lahm",
    "middle_name": "Robert",
    "email":"[email protected]",
    "dob": "1990-03-21",
    "dialcode": "61",
    "phone": "213094857",
    "address": "122 Grenfell St",
    "gender": "M",
    "city": "Adelaide",
    "state": "SA",
    "postcode": "5000",
    "country": "AUS",
    "reference": "david8740"
}

Response

200

{
    "message": "Receiver created successfully",
    "payload": {
        "receiver_id": "d81b714c-a082-431a-8935-d0c67ad22c2d",
        "first_name": "David",
        "last_name": "Lahm",
        "email": "[email protected]"
    }
}

400

{
    "message": "There was an error while creating a receiver",
    "error": [
        {
            "code": "REVR201",
            "message": "Email already exist"
        }
    ]
}