Get User SDK Token — API
Retrieves the SDK token and associated user, business unit, terminal, and device information for a specified user using their UUID. Returns the token details and active status, with a documented 400 Bad Request response for unsuccessful requests.
1. Overview
Retrieves the SDK token and associated user, business unit, and terminal information for a specified user.
The response includes the user's ID, SDK token, business unit ID, user type, terminal ID, terminal serial number (trsm), device ID, and active status.
2. Endpoint Details
| Property | Value |
|---|---|
| HTTP Method | GET |
| Endpoint | /api/v1/sdk-token/USERID |
| Production Base URL | https://app-api.edfapay.com |
| Access Level | Not specified in the provided API reference |
| Request Body | None |
3. Authentication
Include the API key in the request headers, as required by the API configuration.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
4. Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
userId | String (UUID) | Yes | Unique identifier of the user whose SDK token is being retrieved. |
Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6
5. Request Example
cURL
curl --request GET \
--url 'https://app-api.edfapay.com/api/v1/sdk-token/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Accept: */*'Replace the sample UUID with the actual userId.
6. Responses
6.1 HTTP 200 — OK
Description: The request was processed successfully.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"token": "string",
"userBusinessUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userType": "SUPER_ADMIN",
"terminalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"trsm": "string",
"deviceId": "string",
"active": true
}
}Response Fields
| Field | Type | Description |
|---|---|---|
code | Number | API response code. |
message | String | Response message. |
errorCode | String | Error identifier, where applicable. |
data.userId | UUID | User identifier. |
data.token | String | SDK token associated with the user. |
data.userBusinessUnitId | UUID | Business unit identifier associated with the user. |
data.userType | String | User role or type, such as SUPER_ADMIN in the example. |
data.terminalId | UUID | Associated terminal identifier. |
data.trsm | String | Terminal serial number or identifier used by the system. |
data.deviceId | String | Associated device identifier. |
data.active | Boolean | Indicates whether the returned record is active. |
6.2 HTTP 400 — Bad Request
Description: The request could not be processed because of invalid input or another request-related issue.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}The response values are placeholders from the API documentation and may differ at runtime.
7. Implementation Notes
- Provide a valid UUID in the
userIdpath parameter. - Include the required API key header.
- Handle unsuccessful responses according to the returned HTTP status and response details.
- Treat the SDK token as sensitive information. Avoid exposing it in client logs or sharing it with unauthorized parties.
- The supplied API reference does not specify token expiration, refresh behavior, or the complete list of supported user types.
8. Summary
This endpoint retrieves a user's SDK token and associated business unit, terminal, device, and activation information using the user's UUID.
Updated 25 days ago