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 seller 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.

header Parameters
Accept
string
Default: application/hal+json
Request Body schema: application/json
enabled
boolean

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

object or null

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

Responses
201

Single User object.

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
curl "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM/users" \
  -H "Content-Type: application/json" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X POST \
  -d '{}'
Response samples
application/json
{}

List all Users

Retrieve a list of all Users.

Request
header Parameters
Accept
string
Default: application/hal+json
Responses
200

List of User objects.

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 "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/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.

header Parameters
Accept
string
Default: application/hal+json
Responses
200

Single User object.

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 "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/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.

header Parameters
Accept
string
Default: application/hal+json
Request Body schema: application/json
enabled
boolean

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

object or null

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

Responses
200

Single User object.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

put/users/{user_id}
Request samples
curl "https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL" \
  -H "Content-Type: application/json" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X PUT \
  -d '
  {
    "tags": {
      "card_name": "New Employee"
    }
  }'
Response samples
application/json
{}