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
id
string

Filter by id.

before_cursor
string

Return every resource created before the cursor value.

limit
integer

The numbers of items to return.

Example: limit=10
after_cursor
string

Return every resource created after the cursor value.

tags.key
string

Filter by the key of a Tag.

tags.value
string

Filter by the value of a Tag.

Responses
200

Single merchant profile object

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

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

payout_profile
string

ID of the payout_profile.

risk_profile
string

ID of the risk_profile.

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

Responses
200

Single merchant profile object

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

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