Application Profiles

The application_profile resource is used to configure the Application's Fee Profile. The Application's Fee Profile configures what Fee gets applied to transactions processed by the application_profile.

Related Guides: Onboarding Process, Collecting Fees

List Application Profiles

Retrieve a list of all application_profiles.

For details on how to query endpoints using the available parameters.

Request
query Parameters
limit
integer

The numbers of items to return.

Example: limit=10
after_cursor
string

Return every resource created after the cursor value.

Example: after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
before_cursor
string

Return every resource created before the cursor value.

Example: before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
header Parameters
Accept
string
Default: application/hal+json
Responses
200

List of application_profile objects

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

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

Fetch Application Profile

Retrieve the details of an existing application_profile.

Request
path Parameters
application_profile_id
required
string

ID of Application profile to use.

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

Single application_profile object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

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

Update Application Profile

Update an existing application_profile.

Request
path Parameters
application_profile_id
required
string

ID of Application profile to use.

Example: PPqjTEKAmRNGLquQUeLKmXhi
header Parameters
Accept
string
Default: application/hal+json
Request Body schema: application/json
card_present_fee_profile
string or null

The ID of the Fee Profile to be used for all card present transfers associated with the Merchant Profile resource. If not set the value in fee_profile will be used for card present transfers.

fee_profile
string

The ID of the Fee Profile associated with the Application.

risk_profile
string

The ID of the Risk Profile associated with the Application.

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. (For example, order_number: 25, item_type: produce, department: sales)
Responses
200

Single application_profile object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

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