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

Create an Application

If created successfully, a 201 response gets returned and adds a location header to the response which refers to the new created Application.

Request
Request Body schema: application/hal+json
object

Information needed to verify the identity of the entity.

max_transaction_amount
integer or null

Maximum amount that can be processed for a single transaction in cents (max 12 characters).

name
string or null

Merchant's full legal business name (If INDIVIDUAL_SOLE_PROPRIETORSHIP, enter first name, Full legal last name and middle initial; max 120 characters).

object

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

user
required
string

ID of the User resource.

Responses
201

Single application object

Response Schema: application/hal+json
id
string

ID of the Application resource.

created_at
string <date-time>

Point in time when this object was created.

updated_at
string <date-time>

Point in time when this object was most recently updated.

card_cvv_required
boolean

Details if the Application requires CVV code.

card_expiration_date_required
boolean

Details if the Application requires the card's expiration date.

creating_transfer_from_report_enabled
boolean

Details if the Application is automatically set to create Transfers once settlement reports get generated.

enabled
boolean

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

fee_ready_to_settle_upon
string or null

Details when the fees of Authroizations submitted under the Application will be ready to settle.

Enum: "RECONCILIATION" "SUCCESSFUL_CAPTURE"
name
string

The name of the Application.

owner
string

ID of the Identity resource that created the Application.

processing_enabled
boolean

Details if transaction processing is enabled for the Application.

ready_to_settle_upon
string or null

Details when Authroizations submitted under the Application will be ready to settle.

Enum: "RECONCILIATION" "SUCCESSFUL_CAPTURE"
settlement_enabled
boolean

Details if settlement processing is enabled for the Application.

settlement_funding_identifier
string or null
Value: "UNSET"
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

406

Not Acceptable

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

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
Responses
200

List of Applications.

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of Application resources.

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/applications
Request samples
curl https://finix.sandbox-payments-api.com/applications \
  -H "Content-Type: application/vnd.json+api" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{}

Fetch an Application

Retrieve the details of an Application.

Request
path Parameters
application_id
required
string

ID of Application to use.

Responses
200

Single application object

Response Schema: application/hal+json
id
string

ID of the Application resource.

created_at
string <date-time>

Point in time when this object was created.

updated_at
string <date-time>

Point in time when this object was most recently updated.

card_cvv_required
boolean

Details if the Application requires CVV code.

card_expiration_date_required
boolean

Details if the Application requires the card's expiration date.

creating_transfer_from_report_enabled
boolean

Details if the Application is automatically set to create Transfers once settlement reports get generated.

enabled
boolean

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

fee_ready_to_settle_upon
string or null

Details when the fees of Authroizations submitted under the Application will be ready to settle.

Enum: "RECONCILIATION" "SUCCESSFUL_CAPTURE"
name
string

The name of the Application.

owner
string

ID of the Identity resource that created the Application.

processing_enabled
boolean

Details if transaction processing is enabled for the Application.

ready_to_settle_upon
string or null

Details when Authroizations submitted under the Application will be ready to settle.

Enum: "RECONCILIATION" "SUCCESSFUL_CAPTURE"
settlement_enabled
boolean

Details if settlement processing is enabled for the Application.

settlement_funding_identifier
string or null
Value: "UNSET"
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/applications/{application_id}
Request samples
curl https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Update an Application

Update an existing Application.

Request
path Parameters
application_id
required
string

ID of Application to use.

Responses
200

Single application object

Response Schema: application/hal+json
id
string

ID of the Application resource.

created_at
string <date-time>

Point in time when this object was created.

updated_at
string <date-time>

Point in time when this object was most recently updated.

card_cvv_required
boolean

Details if the Application requires CVV code.

card_expiration_date_required
boolean

Details if the Application requires the card's expiration date.

creating_transfer_from_report_enabled
boolean

Details if the Application is automatically set to create Transfers once settlement reports get generated.

enabled
boolean

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

fee_ready_to_settle_upon
string or null

Details when the fees of Authroizations submitted under the Application will be ready to settle.

Enum: "RECONCILIATION" "SUCCESSFUL_CAPTURE"
name
string

The name of the Application.

owner
string

ID of the Identity resource that created the Application.

processing_enabled
boolean

Details if transaction processing is enabled for the Application.

ready_to_settle_upon
string or null

Details when Authroizations submitted under the Application will be ready to settle.

Enum: "RECONCILIATION" "SUCCESSFUL_CAPTURE"
settlement_enabled
boolean

Details if settlement processing is enabled for the Application.

settlement_funding_identifier
string or null
Value: "UNSET"
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

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