Applications

The Application resource represents your app. This could be an iOS app, a website, an online marketplace, a SaaS platform, etc. Any web service that connects buyers (i.e. customers) and sellers (i.e. merchants).

In other words, an Application is a resource that represents the program you're integrating with Finix and using to connect with customers (i.e. buyers).

Related Guides: Your Account, Key Resources and Account Structure

List Applications

Retrieve a list of Applications. If there are no Applications, an empty collection is returned.

For details on how to query endpoints using the available parameters, see Query Parameters.

Request
query Parameters
before_cursor
string

Return every resource created before the cursor value.

Example: before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
after_cursor
string

Return every resource created after the cursor value.

Example: after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
limit
integer

The numbers of items to return.

Example: limit=10
created_at.gte
string <date-time>

Filter where created_at is after the given date.

Example: created_at.gte=2022-09-27T11:21:23
created_at.lte
string <date-time>

Filter where created_at is before the given date.

Example: created_at.lte=2022-09-27T11:21:23
updated_at.gte
string <date-time>

Filter where updated_at is after the given date.

Example: updated_at.gte=2022-09-27T11:21:23
updated_at.lte
string <date-time>

Filter where updated_at is before the given date.

Example: updated_at.lte=2023-01-21T10:17:22
id
string

Filter by the Application's ID.

Example: id=APgPDQrLD52TYvqazjHJJchM
name.like
string

Filter by the Application's name.

Example: name.like=Finix%20Flowers
owner_identity_business_name.like
string

Filter by the Application Owner Identity's business name.

Example: owner_identity_business_name.like=Finix%20Flowers
owner_identity_doing_business_as.like
string

Filter by the Application Owner Identity's Doing Business As (DBA).

Example: owner_identity_doing_business_as.like=Finix%20Flowers%20Inc
owner_identity_email.like
string

Filter by the Application Owner Identity's email.

Example: owner_identity_email.like=john.doe@finix.com
owner_identity_first_name.like
string

Filter by the Application Owner Identity's first name.

Example: owner_identity_first_name.like=john
owner_identity_id
string

Filter by the Application Owner Identity's ID.

Example: owner_identity_id=IDfuTjQubvNjKBwzp2k5WNmW
owner_identity_last_name.like
string

Filter by the Application Owner Identity's last name.

Example: owner_identity_last_name.like=doe
processing_enabled
boolean

Filter by whether the Application's processing is enabled.

Example: processing_enabled=true
settlement_enabled
boolean

Filter by whether the Application's settlements are enabled.

Example: settlement_enabled=true
header Parameters
Accept
string
Default: application/hal+json
Responses
200

List of Applications.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/applications
Request samples 
curl "https://finix.sandbox-payments-api.com/applications" \
  -H "Finix-Version: 2022-02-01" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/json
{}

Fetch an Application

Retrieve the details of an Application.

Request
path Parameters
application_id
required
string

ID of Application to use.

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

Single application object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/applications/{application_id}
Request samples 
curl "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/json
{}

Update an Application

Update an existing Application.

Request
path Parameters
application_id
required
string

ID of Application to use.

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

Single application object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

put/applications/{application_id}
Request samples 
curl "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM" \
  -H "Content-Type: application/json" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X PUT \
  -d '
  {
    "tags": {
      "application_name": "Finix Flowers"
    }
  }'
Response samples
application/json
{}