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

Retrieve a list of Merchant Profiles.

For details on how to query endpoints using the available parameters, see Query Parameters.

Request
query Parameters
id
string

Filter by id.

before_cursor
string

Return every resource created before the cursor value.

Example: before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
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
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 "Finix-Version: 2022-02-01" \
  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
Response samples
application/json
{}

Fetch a Merchant Profile

Retrieve the details of a previously 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/MPfRU8XJ8sDZryZhoYCyjtyB" \
  -H "Finix-Version: 2022-02-01" \
  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda
Response samples
application/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/json
card_present_fee_profile
string or null

ID of the fee_profile to be used for card present transfers.

fee_profile
string

ID of the fee_profile.

payout_profile
string

ID of the payout_profile.

risk_profile
string

ID of the risk_profile.

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 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/MPfRU8XJ8sDZryZhoYCyjtyB" \
  -H "Content-Type: application/json" \
  -H "Finix-Version: 2022-02-01" \
  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \
  -X PUT \
  -d '
  {
    "fee_profile": "FP9F2KEnY4wt1XjFvhLBJVjb"
  }'
Response samples
application/json
{}