Merchant Profiles

A merchant_profile links a merchant to it's risk_profile and fee_profile. Each merchant has a merchant_profile.

When a merchant gets created, a merchant_profile also gets created. This new merchant_profile automatically receives a new risk_profile and fee_profile that are copies of the risk and fee profiles on the application_profile.

Related Guides: Collecting Fees

List Merchant Profiles

Retireve a list of all merchant_profiles.

Request
query Parameters
after_cursor
string

Return every resource created after the cursor value.

before_cursor
string

Return every resource created before the cursor value.

id
string

Filter by id.

limit
integer

The numbers of items to return.

Example: limit=10
Responses
200

Single merchant profile object

Response Schema: application/hal+json
object

List of merchant_profile objects.

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.

object

Details the page that's returned.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/merchant_profiles
Request samples
curl https://finix.sandbox-payments-api.com/merchant_profiles \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Fetch a Merchant Profile

Retrieve the details of a previosuly created merchant_profile.

Request
path Parameters
merchant_profile_id
required
string

ID of merchant_profile.

Responses
200

Single merchant profile object

Response Schema: application/hal+json
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.

application
string

The ID of the Application associated with the Merchant Profile.

created_at
string <date-time>

Timestamp of when the object was created.

fee_profile
string

The ID of the Fee Profile associated with the Merchant Profile resource.

id
string

The ID of the Merchant Profile resource.

risk_profile
string

The ID of the Risk Profile associated with the Merchant Profile resource.

object

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

updated_at
string <date-time>

Timestamp of when the object was last updated.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/merchant_profiles/{merchant_profile_id}
Request samples
curl https://finix.sandbox-payments-api.com/merchant_profiles/MPsdo8WPP5erWzfPwMjYjVy3 \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Update a Merchant Profile

Update a merchant_profile.

Request
path Parameters
merchant_profile_id
required
string

ID of merchant_profile.

Request Body schema: application/hal+json
fee_profile
string

ID of the fee_profile.

risk_profile
string

ID of the risk_profile.

object

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

Responses
200

Single merchant profile object

Response Schema: application/hal+json
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.

application
string

The ID of the Application associated with the Merchant Profile.

created_at
string <date-time>

Timestamp of when the object was created.

fee_profile
string

The ID of the Fee Profile associated with the Merchant Profile resource.

id
string

The ID of the Merchant Profile resource.

risk_profile
string

The ID of the Risk Profile associated with the Merchant Profile resource.

object

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

updated_at
string <date-time>

Timestamp of when the object was last updated.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

put/merchant_profiles/{merchant_profile_id}
Request samples
Response samples
application/hal+json
{}