Email Login
API usage for Username and password method
Overview
This API endpoint allows you to log in to your Xellar Embedded wallet account using the User’s username and password.
- HTTP Method: POST
- Endpoint:
/api/<VERSION>/auth/login
Request Body Parameters
username
(required): User’s chosen username.password
(required): User’s password.
Example Request Body
{
"username": "user_username",
"password": "user_password"
}
Request
Request Headers
x-client-secret
(required): Client secret which was generated when register in Xellar Embedded Wallets API Service Dashboard.
Example Request Syntax
Response
The response will include a JSON object with the following properties:
status
(number): The HTTP status code of the response (e.g., 200 for success).message
(string): A message providing additional information about the operation.data
(object): An object containing the accessToken, walletToken, and isWalletCreated.data.isWalletCreated
(bool): A boolean value to determine whether the wallet is already created or not.data.refreshToken
(string): A string containing the refresh token which will be used for generating the new walletToken after every wallet operation executed.data.walletToken
(string): The wallet token access used to access the wallet operations.data.rampableAccessToken
: JWT token used to access the Rampable Operation endpoint. This token will only be available if the account already create a rampable account and the organization has enabled the rampable feature.
Example Response
below is an example response if the users have not created any wallet yet
{
"status": 200,
"message": "ok",
"data": {
"rampableAccessToken": "your_rampable_access_token_here",
"accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6.....",
"isWalletCreated": false
}
}
below is an example response if the users have already created their wallets
📝
This response only works on v2
{
"status": 200,
"message": "ok",
"data": {
"rampableAccessToken": "your_rampable_access_token_here",
"refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6.....",
"walletToken": "eyJhbfsf838JsjFyhsmmfjsHWEyuI1NasdaJ9.eyJpZCI6.....",
"isWalletCreated": true
}
}