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

Return a collection of Applications. If there are no Applications, an empty collection gets returned.

Request
query Parameters
id
string

Filter by id.

before_cursor
string

Return every resource created before the cursor value.

after_cursor
string

Return every resource created after the cursor value.

limit
integer

The numbers of items to return.

Example: limit=10
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.

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.

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
{}