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

tags
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.)

user
required
string

ID of the User resource.

Responses
201

Single application object

400

Error

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

post/applications
Request samples
curl https://finix.sandbox-payments-api.com/applications \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X POST \
  -d '
  {
    "entity": {
      "business_address": {
        "city": "San Mateo",
        "country": "USA",
        "line1": "741 Douglass St",
        "line2": "Apartment 8",
        "postal_code": "94114",
        "region": "CA"
      },
      "business_name": "Finix Flowers",
      "business_phone": "+1 (408) 756-4497",
      "business_tax_id": "123456789",
      "business_type": "LIMITED_LIABILITY_COMPANY",
      "dob": {
        "day": 27,
        "month": 5,
        "year": 1978
      },
      "doing_business_as": "Finix Flowers",
      "email": "user@example.org",
      "first_name": "John",
      "last_name": "Smith",
      "max_transaction_amount": 1200000,
      "personal_address": {
        "city": "San Mateo",
        "country": "USA",
        "line1": "741 Douglass St",
        "line2": "Apartment 7",
        "postal_code": "94114",
        "region": "CA"
      },
      "phone": "1234567890",
      "tax_id": "123456789"
    },
    "tags": {
      "application_name": "Finix Flowers"
    },
    "user": "USpbnPYf1MMaYYtBqNsNzD6T"
  }'
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.

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.api+json" \
  -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

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.api+json" \
  -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

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/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X PUT \
  -d '
  {
    "tags": {
      "application_name": "Finix Flowers"
    }
  }'
Response samples
application/hal+json
{}