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

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.

before_cursor
string

Return every resource created before the cursor value.

Responses
200

List of application_profile objects

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of application_profile resources.

_links
string

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

406

Not Acceptable

get/application_profiles
Request samples
Response samples
application/hal+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.

Responses
200

Single application_profile object

Response Schema: application/hal+json
id
string

ID of the application_profile resource.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

application
string

The ID of the Application resource.

fee_profile
string or null

The ID of the Fee Profile associated with the Application.

risk_profile
string

The ID of the risk_profile that was created during provisioning.

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/application_profiles/{application_profile_id}
Request samples
Response samples
application/hal+json
{}

Update Application Profile

Update an existing application_profile.

Request
path Parameters
application_profile_id
required
string

ID of Application profile to use.

Request Body schema: application/hal+json
fee_profile
object

The ID of the Fee Profile associated with the Application.

risk_profile
object

The ID of the Fee Profile associated with the Application.

object

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

Responses
200

Single application_profile object

Response Schema: application/hal+json
id
string

ID of the application_profile resource.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

application
string

The ID of the Application resource.

fee_profile
string or null

The ID of the Fee Profile associated with the Application.

risk_profile
string

The ID of the risk_profile that was created during provisioning.

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/application_profiles/{application_profile_id}
Request samples
Response samples
application/hal+json
{}