Get Receiver

Get Receiver By ID

GET /api/receiver/<id>

Get a receiver data under subaccount by ID.

Headers

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

Example request

/api/receiver/8ae6b25e-d08f-4391-84ae-fa7bd061b9ee

Response

200

{
    "message": "Receiver found",
    "payload": {
        "id": "8ae6b25e-d08f-4391-84ae-fa7bd061b9ee",
        "first_name": "Xcel",
        "last_name": "Tesla",
        "middle_name": "",
        "email": "[email protected]",
        "gender": "M",
        "dob": "1973-12-12",
        "dialcode": "61",
        "phone": "483908899",
        "applicant_id": "65f272e2341af77124132294",
        "kyc_status": "pending",
        "status": "pending",
        "created_at": "1710387933592",
        "address_data": {
            "address": "992A Stanley St E",
            "address2": "",
            "city": "East Brisbane",
            "state": "QLD",
            "country": "AUS",
            "postcode": "6008"
        },
        "reference": "ref-xcel"
    }
}

400

Get Receiver list

GET /api/receiver

Get receiver list under subaccount.

Headers

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

Request query parameter

Name	Type	Description
subaccount_id*	string	Subaccount ID
limit	string	Limit of request data.
status	string	Filter by receiver status. 0 = CREATING 1 = PENDING 2 = ACTIVE 3 = INACTIVE 4 = FAILED
kyc_status	string	Filter by receiver KYC status. 0 = PENDING 1 = COMPLETED 2 = FAILED

* is mandatory parameter

Example query parameter request

/api/receiver?subaccount_id=3dc81811-8cdb-49c6-8f9e-9125ea4540b0&status=2&kyc_status=1&limit=2

Response

200

{
    "message": "Receiver found",
    "payload": [
        {
          {
            "id": "7e4b88bf-9b99-4d3e-8a93-dc5e91b6ce2c",
            "first_name": "Marina",
            "last_name": "Quartz",
            "middle_name": "",
            "email": "[email protected]",
            "gender": "F",
            "dob": "1986-07-24",
            "dialcode": "44",
            "phone": "7712345678",
            "applicant_id": "a9fd80e1cd2a4b688a994d5487e8d6f1",
            "kyc_status": "pending",
            "status": "pending",
            "created_at": "1710023456789",
            "address_data": {
                "address": "111/22222",
                "address2": "Paklok Rd",
                "state": "PK",
                "city": "Phuket",
                "country": "THA",
                "postcode": "83110"
            }
        },
        {
            "id": "9b3773e1-cb8e-4b9a-bc68-4e5011b8d30f",
            "first_name": "Leonardo",
            "last_name": "Fibonacci",
            "middle_name": "",
            "email": "[email protected]",
            "gender": "M",
            "dob": "1990-03-14",
            "dialcode": "39",
            "phone": "4881234567",
            "applicant_id": "bd7a8a4d980a432a8a5beb4a2a98f7c2",
            "kyc_status": "pending",
            "status": "pending",
            "created_at": "1710112233445",
            "address_data": {
                "address": "55/66666",
                "address2": "Renaissance Road",
                "state": "RR",
                "city": "Florence",
                "country": "ITA",
                "postcode": "50125"
            }
        }
    ],
    "lastkey": "eyJlbnRpdHkiOiJSRVZSIyIsIlBLIjoiUkVWUiMyZTg1MGY1ZS1iMzQ2LTRlOWEtYjhkNi1hYWVjMzE5YTkwOWQiLCJTSyI6IlNVQkEjM2RjODE4MTEtOGNkYi00OWM2LThmOWUtOTEyNWVhNDU0MGIwIiwiY3JlYXRlZF9hdCI6IjE3MTk5ODAzOTM4MTYifQ=="
}