API Documentation

Environment Variables

  • SANDBOX `base_url`: https://www.iyap360.com/m/point/sandbox
  • Production `base_url`: https://www.iyap360.com/m/point/production

API Keys

Register

curl -X POST -d '{
    "firstname": "John",
    "lastname": "Doe",
    "username": "johndoe",
    "email": "[email protected]",
    "phone": "+15123456789",
    "password": "",
    "repeatPassword": ""
}' "{{base_url}}/register"
POST {{base_url}}/register HTTP/1.1
Host: 
{
    "firstname": "John",
    "lastname": "Doe",
    "username": "johndoe",
    "email": "[email protected]",
    "phone": "+15123456789",
    "password": "",
    "repeatPassword": ""
}
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Successfully registered and check your email to confirm your account. If you do not receive the confirmation message within a few minutes of signing up, please check your Spam folder just in case the confirmation email got delivered there instead of your inbox.",
        "data": [],
        "action": ""
    }
}
Status 200 OK
Content-Type application/json
{
    "status": false,
    "response": {
        "message": "User already exists",
        "data": [],
        "action": ""
    }
}

Create

curl -X POST "{{base_url}}/key/create"
POST {{base_url}}/key/create HTTP/1.1
Host: 
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Success!",
        "data": [
            {
                "id": "1",
                "member_id": "61295",
                "expiry": "2023-03-10 06:52:54",
                "modified": null,
                "api_key": "c0d003-2cb2c8-821556-2f3e19-a418d5",
                "created": "2022-03-10 06:52:54",
                "status": "Active"
            }
        ],
        "action": ""
    }
}

List

curl -X POST "{{base_url}}/key/list"
POST {{base_url}}/key/list HTTP/1.1
Host: 
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Success!",
        "data": [
            {
                "id": "1",
                "member_id": "61295",
                "expiry": "2023-03-10 06:52:54",
                "modified": null,
                "api_key": "c0d003-2cb2c8-821556-2f3e19-a418d5",
                "created": "2022-03-10 06:52:54",
                "status": "Active"
            }
        ],
        "action": ""
    }
}

Account

Balance

curl -X POST -d '{
    "api_key": "api-key-from-create-api"
}' "{{base_url}}/balance"
POST {{base_url}}/balance HTTP/1.1
        Host: 
{
    "api_key": "api-key-from-create-api"
}
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Success!",
        "data": 500,
        "action": ""
    }
}

Trans List

curl -X POST -d '{
    "api_key": "api-key-from-create-api"
}' "{{base_url}}/transaction/list?page=2&limit=20"
POST {{base_url}}/transaction/list?page=2&limit=20 HTTP/1.1
Host: 
{
    "api_key": "api-key-from-create-api"
}
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Success!",
        "data": [
            {
                "points_earned": "0.00",
                "points_redeemed": "0.00",
                "action_id": "9",
                "action_type": "add",
                "group": "_modzzz_point_header_profile",
                "unit": "profile",
                "desc": "_modzzz_point_join_desc"
            }
        ],
        "action": ""
    }
}

Payments

Pay

curl -X POST -d '{
    "receiver_email": "[email protected]",
    "receiver_phone": "+15123456789",
    "amount": 1,
    "item_description": "Payment of Bike Ride",
    "notes": "Payment notes",
    "api_key": "api-key-from-create-api"
}' "{{base_url}}/pay"
POST {{base_url}}/pay HTTP/1.1
Host: 

{
    "receiver_email": "[email protected]",
    "receiver_phone": "+15123456789",
    "amount": 1,
    "item_description": "Payment of Bike Ride",
    "notes": "Payment notes",
    "api_key": "api-key-from-create-api"
}
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Success!",
        "data": [],
        "action": ""
    }
}

Public

Payees(Drivers)

curl -X GET "{{base_url}}/payee/list?page=1&limit=20"
GET {{base_url}}/payee/list?page=1&limit=20 HTTP/1.1
Host: 
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Success!",
        "data": {
            "total": 1,
            "per_page": "20",
            "current_page": "1",
            "total_pages": 1,
            "items": [
                {
                    "Email": "[email protected]",
                    "FullName": "iYap Production",
                    "phone": "18332580554",
                    "company_type": "",
                    "company_name": "",
                    "business_street": "",
                    "business_zip": "",
                    "business_city": "",
                    "business_name": "",
                    "business_phone": ""
                }
            ]
        },
        "action": ""
    }
}

Card

Reward card request

Resource Information

| Response formats | JSON |
| Requires authentication? | Yes (user context only) |

Post Parameters

Name Required Description
reward_card_type required Two types of reward_card_type . “Reward”,“Black”
first_name required First name of user
last_name required Last name of user
birth_date required yyyy-mm-dd
gender required
residence_country required
residence_state_province required
city required
address required
place_id required
post_code required
email required
mobile_phone required
api_key required
curl -X POST -d '{
    "reward_card_type":"Reward",
    "first_name":"John",
    "last_name":"Doe",
    "birth_date":"1986-01-20",
    "gender":"Male",
    "residence_country":"US",
    "residence_state_province":"state-us",
    "city":"lorem-city",
    "address":"lorem-address",
    "post_code":"11231",
    "email":"[email protected]",
    "mobile_phone":"+15123456789",
    "api_key": "api-key-from-create-api"
}' "{{base_url}}/reward-card-add"
POST {{base_url}}/reward-card-add HTTP/1.1
Host: 

{
    "reward_card_type":"Reward",
    "first_name":"John",
    "last_name":"Doe",
    "birth_date":"1986-01-20",
    "gender":"Male",
    "residence_country":"US",
    "residence_state_province":"state-us",
    "city":"lorem-city",
    "address":"lorem-address",
    "post_code":"11231",
    "email":"[email protected]",
    "mobile_phone":"+15123456789",
    "api_key": "api-key-from-create-api"
}
Status 200 OK
Content-Type application/json
{
    "status": true,
    "response": {
        "message": "Successfully submitted!",
        "data": {
            "status": true,
            "msg": null
        },
        "action": ""
    }
}