Users

A User resource represents a pair of API keys which are used to perform authenticated requests against the Finix API. When making authenticated requests via HTTP basic access authentication the ID of a User resource maps to the username, while the password corresponds to the password (i.e. secret key).

The password field for a User resource is only returned during the initial creation. Any following GET requests to the resource returns the password field as null for security purposes.

Related Guides: Account Structure

Create an Application User

Creating an application user is the equivalent of provisioning API keys (i.e. credentials) for an Application.

Each Application can have multiple Users which allows each merchant to have multiple API keys that can be independently enabled and disabled. Merchants only have read access to the API.

Request
path Parameters
application_id
required
string

ID of Application to use.

Request Body schema: application/hal+json
enabled
boolean

Details if the user is enabled and active. Set to false to disable the user.

object

Key value pair for annotating custom meta data (e.g. order numbers).

Responses
201

Single User object.

Response Schema: application/hal+json
id
string

The ID of the User object.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

enabled
boolean

Details if the User is enabled and active. Set to false to disable the User.

identity
string or null

ID of the Identity that the User object was created under.

password
string or null

The password you'll use to authetnicate requests.

role
string

Details the level of access the User has available.

Enum: "ROLE_ADMIN" "ROLE_PLATFORM" "ROLE_PARTNER" "ROLE_MERCHANT"
object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

400

Error

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

post/applications/{application_id}/users
Request samples
Response samples
application/hal+json
{}

List all Users

Retrieve a list of all Users.

Responses
200

List of User objects.

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of User objects.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/users
Request samples
curl https://finix.sandbox-payments-api.com/users \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Fetch a User by ID

Retrieve a specific user with the ID of the User.

Request
path Parameters
user_id
required
string

ID of User object.

Responses
200

Single User object.

Response Schema: application/hal+json
id
string

The ID of the User object.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

enabled
boolean

Details if the User is enabled and active. Set to false to disable the User.

identity
string or null

ID of the Identity that the User object was created under.

password
string or null

The password you'll use to authetnicate requests.

role
string

Details the level of access the User has available.

Enum: "ROLE_ADMIN" "ROLE_PLATFORM" "ROLE_PARTNER" "ROLE_MERCHANT"
object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/users/{user_id}
Request samples
curl https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Update a User

Update a User with new tags or disable the User and their credentials.

Request
path Parameters
user_id
required
string

ID of User object.

Request Body schema: application/hal+json
enabled
boolean

Details if the user is enabled and active. Set to false to disable the user.

object

Key value pair for annotating custom meta data (e.g. order numbers).

Responses
200

Single User object.

Response Schema: application/hal+json
id
string

The ID of the User object.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

enabled
boolean

Details if the User is enabled and active. Set to false to disable the User.

identity
string or null

ID of the Identity that the User object was created under.

password
string or null

The password you'll use to authetnicate requests.

role
string

Details the level of access the User has available.

Enum: "ROLE_ADMIN" "ROLE_PLATFORM" "ROLE_PARTNER" "ROLE_MERCHANT"
object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

put/users/{user_id}
Request samples
Response samples
application/hal+json
{}