Users - old

The Users API allows you to create, fetch, update, disconnect, and disassociate users from your partner application. These users are the foundation for routing, identity, and transactions on Reveel PayID.

All endpoints require partner authentication.

---

Authentication

Authorization: Bearer your-api-key
Content-Type: application/json
Accept: application/json

---

1. Create user

POST /user/create

Authentication: Required

Description: Creates a new user and associates them with your partner account.

Request Body:

{
  "email": "[e-mail]",
  "twitterUsername": "username",
  "walletAddress": "0x123abc456def789ghi"
}

Success Response – 201 Created:

{
  "message": "User created successfully",
  "user": {
    "id": "user-id",
    "email": "[e-mail]",
    "twitterUsername": "username",
    "walletAddress": "0x123abc456def789ghi",
    "createdAt": "2023-03-01T00:00:00.000Z"
  }
}

Error Responses:

• 400 Bad Request

{
  "error": "Validation error",
  "message": "Email is required"
}

• 401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Partner authentication required"
}

• 409 Conflict

{
  "error": "User already exists",
  "message": "This user is already associated with your partner account",
  "userId": "existing-user-id"
}

• 500 Internal Server Error

{
  "error": "Internal server error",
  "message": "Error message details"
}

---

2. Get All users

GET /user/list

Authentication: Required

Description: Lists users associated with your partner.

Query Parameters:

• page: Page number (default: 1)

• limit: Users per page (default: 20)

Success Response – 200 OK:

{
  "message": "Users retrieved successfully",
  "count": 2,
  "users": [
    {
      "id": "user-id-1",
      "email": "[e-mail]",
      "twitterUsername": "username1",
      "walletAddress": "0x123...",
      "createdAt": "2023-03-01T00:00:00.000Z",
      "payId": {
        "id": "payid-id-1",
        "name": "username1"
      }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "totalCount": 2,
    "perPage": 20
  }
}

Error Responses:

• 401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Partner authentication required"
}

• 500 Internal Server Error

{
  "error": "Internal server error",
  "message": "Error message details"
}

---

3. Get a particular user by ID

GET /user/:id

Authentication: Required

Description: Fetches a user by ID if associated with your account.

Success Response – 200 OK:

{
  "message": "User retrieved successfully",
  "user": {
    "id": "user-id-1",
    "email": "[e-mail]",
    "twitterUsername": "username1",
    "walletAddress": "0x123...",
    "createdAt": "2023-03-01T00:00:00.000Z",
    "payId": {
      "id": "payid-id-1",
      "name": "username1"
    }
  }
}

Error Responses:

• 401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Partner authentication required"
}

• 404 Not Found

{
  "error": "User not found",
  "message": "This user does not exist or is not associated with your partner account"
}

• 500 Internal Server Error

{
  "error": "Internal server error",
  "message": "Error message details"
}

---

4. Update user

PUT /user/:id

Authentication: Required

Description: Updates an existing user.

Request Body:

{
  "email": "[e-mail]",
  "twitterUsername": "newusername",
  "walletAddress": "0x987zyx654wvu321tsr"
}

Success Response – 200 OK:

{
  "message": "User updated successfully",
  "user": {
    "id": "user-id-1",
    "email": "[e-mail]",
    "twitterUsername": "newusername",
    "walletAddress": "0x987zyx654wvu321tsr",
    "updatedAt": "2023-03-10T00:00:00.000Z"
  }
}

Error Responses:

• 400 Bad Request

{
  "error": "Validation error",
  "message": "Field validation failed"
}

• 401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Partner authentication required"
}

• 404 Not Found

{
  "error": "User not found",
  "message": "This user does not exist or is not associated with your partner account"
}

• 409 Conflict

{
  "error": "Update failed",
  "message": "The provided email is already associated with another user"
}

• 500 Internal Server Error

{
  "error": "Internal server error",
  "message": "Error message details"
}

---

5. Disconnect Wallet

POST /user/:id/disconnect-wallet

Authentication: Required

Description: Disconnects the wallet address of a user.

Success Response – 200 OK:

{
  "message": "Wallet disconnected successfully",
  "user": {
    "id": "user-id-1",
    "walletAddress": null,
    "updatedAt": "2023-03-15T00:00:00.000Z"
  }
}

Error Responses:

• 400 Bad Request

{
  "error": "Wallet disconnection failed",
  "message": "User does not have a connected wallet"
}

• 401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Partner authentication required"
}

• 404 Not Found

{
  "error": "User not found",
  "message": "This user does not exist or is not associated with your partner account"
}

• 500 Internal Server Error

{
  "error": "Internal server error",
  "message": "Error message details"
}

---

6. Delete user

DELETE /user/:id

Description: Disassociates a user from your partner account (does not delete the user globally).

Success Response – 200 OK:

{
  "message": "User disassociated from partner successfully"
}

Error Responses:

• 401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Partner authentication required"
}

• 404 Not Found

{
  "error": "Association not found",
  "message": "No association between this user and partner found"
}

• 500 Internal Server Error

{
  "error": "Internal server error",
  "message": "Error message details"
}