Profile - os-salahuddin/php8-cluster GitHub Wiki

User basic information

Basic Information

This API provides user information like profile photo, qr code text, available balance and user details(name, email, mobile number, kyc status)

URL

[GET] http://127.0.0.1:8282/api/v1/private/user/basic-information

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "user": {
            "name": "John smith",
            "nid_name": "John smith",
            "mobile_number": "+8801784563942",
            "email": "[email protected]",
            "user_has_pin": true,
            "is_pin_expired": true,
            "kyc_status": 1,
            "is_linked_account": true,
            "available_balance": [
                {
                    "account_type": "Savings Account",
                    "account_no": "PAA001649",
                    "currency": "BDT",
                    "balance": "৳138,603.14"
                }
            ],
            "profile_thumbnail": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/36WgiXqYdVNZSP8TJpwgaGeTF1735198756.png",
            "qr_code_text": "Tk1kRTBrVlY4M2FzYjhPdXx8cjNnUlJYY0Fwa1ZORENpQVIxSnpMeXg4bzdwMWpmVGxPWDVSK2Q1d3BsQStwRG1OZExHU3Avck9lVmdMNzU1OEJsdG9kUndNL1U1MHZ6Sm9YeFh4SGd3Q283c3VpdkZyQXJxK3J6T2FwWlFpRFJJRFF0VXZDYithZS8vVnlQRTFvaG1uRngrVGFIWTQ0SXd3dGNEWmRFUWdKbG9sT1d2OGZIdXZYUk1IU2dJPQ=="
        }
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.user Object User details Yes
data.user.name String Full name of the user Yes
data.user.nid_name String NID registered name of the user Yes
data.user.mobile_number String User's mobile number Yes
data.user.email String User's email address Yes
data.user.user_has_pin Boolean Indicates if the user has a PIN set Yes
data.user.is_pin_expired Boolean Indicates if the user's PIN is expired Yes
data.user.kyc_status Int KYC verification status (1 = Verified) Yes
data.user.is_linked_account Boolean Indicates if the user has a linked account Yes
data.user.available_balance Array List of user's available balances Yes
data.user.available_balance[].account_type String Type of bank account (e.g., Savings Account) Yes
data.user.available_balance[].account_no String User's account number Yes
data.user.available_balance[].currency String Currency (e.g., BDT) Yes
data.user.available_balance[].balance String Account balance with currency symbol Yes
data.user.profile_thumbnail String URL of the user's profile thumbnail Yes
data.user.qr_code_text String QR code text for the user Yes

User Email Update information

Basic Information

This API provides user information like profile photo, qr code text, available balance and user details(name, email, mobile number, kyc status)

URL

[GET] http://127.0.0.1:8282/api/v1/private/user/basic-information

Sample Request Format

The table below provides form data (application/x-www-form-urlencoded) request body.

Parameter Type Description Always Present
name string Mobile number Yes
photo File Profile Photo Yes
email string Email Yes

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "photo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/36WgiXqYdVNZSP8TJpwgaGeTF1735198756.png",
        "name": "John Smith",
        "nid_name": "John Smith",
        "mobile_number": "+8801784563942",
        "email": "[email protected]",
        "user_has_pin": true,
        "is_pin_expired": true,
        "kyc_status": 1,
        "is_linked_account": true,
        "available_balance": [
            {
                "account_type": "Savings Account",
                "account_no": "PAA001649",
                "currency": "BDT",
                "balance": "৳122,115.14"
            }
        ],
        "profile_thumbnail": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/users/photos/thumbnails/36WgiXqYdVNZSP8TJpwgaGeTF1735198756.png",
        "qr_code_text": "UFI0Yk5GTldHR3RBakI4V3x8ZG5DMTJidWdhNjdDeVIzdzlsaitpcmVQZ1VnZE9lcENvbFJkT054TWRCSWNKdlk0bTIyOU94bUx1NUpUSzhSdEJiSzJYSnJXQjkrQ3Y1OE9qejdDcmIwTThkZ05FUTFySmJKVjQyUmdhYWEvUWVsT1JtYlZrQWU5Ry9hK01pc003Unl2blVBZkRINGxvaFhRNUFjUFdOaTIvVmN1VjFlTlhXZlF2d3J5ekE0PQ=="
    }
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages Yes
data.user Object User details Yes
data.user.name String Full name of the user Yes
data.user.nid_name String NID registered name of the user Yes
data.user.mobile_number String User's mobile number Yes
data.user.email String User's email address Yes
data.user.user_has_pin Boolean Indicates if the user has a PIN set Yes
data.user.is_pin_expired Boolean Indicates if the user's PIN is expired Yes
data.user.kyc_status Int KYC verification status (1 = Verified) Yes
data.user.is_linked_account Boolean Indicates if the user has a linked account Yes
data.user.available_balance Array List of user's available balances Yes
data.user.available_balance[].account_type String Type of bank account (e.g., Savings Account) Yes
data.user.available_balance[].account_no String User's account number Yes
data.user.available_balance[].currency String Currency type (e.g., BDT) Yes
data.user.available_balance[].balance String Account balance with currency symbol Yes
data.user.profile_thumbnail String URL of the user's profile thumbnail Yes
data.user.qr_code_text String Encoded QR code text for the user Yes

Logout

User Logout

This API provides is used to log out user with a post request

URL

[POST] http://127.0.0.1:8282/api/v1/auth/logout

Sample Response

{
    "code": 200,
    "messages": [],
    "data": null
}

Sample Response Format

Parameter Type Description Always Present
code Int HTTP code (e.g., 200) Yes
messages Array Result messages or empty Yes
data Mixed Object or null Yes