# SIXR API ## /auth `POST` `https://partnerapi.six.th/v1/auth` This endpoint allows you to let user do authentications #### Headers | Name | Type | Description | | --------- | ------ | ----------- | | x-api-id | string | An API id | | x-api-key | string | An API key | #### Request Body | Name | Type | Description | | ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | authrequest | object |

{
"phone\_number": "+66875556666"
}

phone\_number : Country code is needed to put at the beginning without ‘0’ leading.

| {% tabs %} {% tab title="200 Successful request, user will receive SMS with OTP" %} ```javascript { "success": true, "data": { "ref_no": "GDDNE", "transaction_id": "07816604-9caf-45b6-ace2-e4e3565193dc" } } ``` {% endtab %} {% tab title="500 Fatal error, unexpected error." %} ```javascript { "success": false, "message": "System error" } ``` {% endtab %} {% endtabs %} ## /auth `PUT` `https://partnerapi.six.th/v1/auth` This endpoint allows you to let user do authentications #### Headers | Name | Type | Description | | --------- | ------ | ----------- | | x-api-id | string | An API id | | x-api-key | string | An API Key | #### Request Body | Name | Type | Description | | ----------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | authrequest | object |

{
"ref\_no": "GDDNE",
"transaction\_id": "07816604-9caf-45b6-ace2-e4e3565193dc",
"confirm\_code": "554133"
}

ref\_no : Random 5 alphabet character referenced to OTP code which will also be part of the SMS message.

transaction\_id : Reference transaction id refer to generated OTP code. This code will not seen by the user.

confirm\_code : 6--digits of number received via user’s SMS message.

| {% tabs %} {% tab title="200 Successful request, user will receive SMS with OTP" %} ```javascript { "success": true, "data": { "ref_no": "GDDNE", "transaction_id": "07816604-9caf-45b6-ace2-e4e3565193dc", "user_id": "80a0e232-58b8-45f9-b1a7-c91bd97c7b2d", "username": "sixruser", "wallet_user": true } } ``` {% endtab %} {% tab title="400 Bad request with error code" %} ```javascript { "success": true, "error_code": 50, "error_message": "No operation." } /* About error_code 50 : No operation for the request 206 : Confirm code not matched */ ``` {% endtab %} {% endtabs %} ## /users `POST` `https://partnerapi.six.th/v1/users` #### Headers | Name | Type | Description | | --------- | ------ | ----------- | | x-api-id | string | An API id | | x-api-key | string | An API KEY | #### Request Body | Name | Type | Description | | ----------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | createUserRequest | object |

{
"ref\_no": "GDDNE",
"transaction\_id": "07816604-9caf-45b6-ace2-e4e3565193dc",
"username": "foo"
}


ref\_no : Ref No. of the OTP which has been already verified.

transaction\_id : The transaction ID of the OTP which has been already verified.

username : Decided username.

| {% tabs %} {% tab title="200 Successful request, user will receive SMS with OTP" %} ```javascript { "user_id": "07816604-9caf-45b6-ace2-e4e3565193dc" } ``` {% endtab %} {% tab title="400 Bad request with error code" %} ```javascript { "success": true, "error_code": 50, "error_message": "No operation." } /* About error_code 50 : No operation for the request 120 : Verified OTP has expired 220 : Decided username already exists */ ``` {% endtab %} {% tab title="500 Fatal error, unexpected error." %} ```javascript { "success": false, "message": "System error" } ``` {% endtab %} {% endtabs %} ## /transactions/reward-six `POST` `https://partnerapi.six.th/v1/transactions/reward-six` #### Headers | Name | Type | Description | | --------- | ------ | ----------- | | x-api-id | string | An API id | | x-api-key | string | An API Key | #### Request Body | Name | Type | Description | | --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | rewardTxRequest | object |

{
"user\_id": "07816604-9caf-45b6-ace2-e4e3565193dc",
"sixr\_amount": 10
}

user\_id : Generated user identifier

sixr\_amount : Amount of SIXr to reward to user

| {% tabs %} {% tab title="200 " %} ```javascript { "success": true, "data": { "tx_id": "a90b3dc20f28a861e687488eec68ca5a3af4165ca6930fb79e38011792b5da14" } } ``` {% endtab %} {% tab title="400 Bad request with error code" %} ```javascript { "success": true, "error_code": 50, "error_message": "No operation." } /* About error_code 50 : No operation for the request 210 : User not found */ ``` {% endtab %} {% tab title="500 Fatal error, unexpected error." %} ```javascript { "success": false, "message": "System error" } ``` {% endtab %} {% endtabs %} ## /sixr/redeems/claims `POST` `https://partnerapi.six.th/sixr/redeems/claims` For claim SIXR #### Request Body | Name | Type | Description | | ------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-six-authorization | string | SIX Authorization | | claimRequest | object |

{
"reward\_id": "828",
"qty": 5
}


reward\_id : Known as product ID to be claimed
qty : Claimed quantity

| {% tabs %} {% tab title="200 Successful request, client will receive status and transaction id" %} ``` { "status": 0, "message": "string", "body": { "id": "string", "event_type": "string", "model_type": "string", "timestamp": 0, "asset_type": "string", "asset_issuer": "string", "amount": 0, "amount_usd": 0, "amount_thb": 0, "memo": "string", "ref_code": "string", "tx_id": "string", "direction_type": "string", "from": { "wallet": { "model_type": "string", "id": "string", "type": "string", "asset_type": "string", "memo": "string", "address": "string", "balance": 0 }, "previous_balance": 0, "current_balance": 0 }, "to": { "wallet": { "model_type": "string", "id": "string", "type": "string", "asset_type": "string", "memo": "string", "address": "string", "balance": 0 }, "previous_balance": 0, "current_balance": 0 } } } ``` {% endtab %} {% tab title="500 Fatal error, unexpected error." %} ``` { "success": false, "message": "System error" } ``` {% endtab %} {% endtabs %} ## /sixr/tx `POST` `https://partnerapi.six.th/sixr/tx` #### Request Body | Name | Type | Description | | ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-six-authorization | string | SIX Authorization | | txRequest | object |

{
"type": "Payment",
"asset\_name": "SIXR",
"to\_username": "v"
}


type : Tx type, for now it’s only Payment
asset\_name : Asset name, now there’s only SIXR
to\_username : Username of the destination user

| {% tabs %} {% tab title="200 Successful request, client will receive status and transaction id" %} ``` { "status": "Success", "tx_id": "e-fbeab1f3-5671-49ef-854c-1b8d993cb92c" } /* tx_id : The returned transaction id. */ ``` {% endtab %} {% tab title="500 Fatal error, unexpected error." %} ``` { "success": false, "message": "System error" } ``` {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://sixnetwork.gitbook.io/docs/six-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.