Skip to main content

Fetch a Merchant Profile

Overview

Retrieve the details of a previously created Merchant Profile. The Merchant Profile resource links a Merchant to its Risk Profile, Fee Profile, and Payout Profile.

Resource Access

  • User Permissions: All users can access this endpoint
  • Endpoint: GET /merchant_profiles/\{merchant_profile_id}

Arguments

ParameterTypeRequiredDescription
merchant_profile_idstringYesThe unique ID of the Merchant Profile to retrieve

Example Request

curl -X GET \
'https://api.ahrvo.network/payments/na/merchant_profiles/MPpqhH8XuQk2TSXf66dE9Nvx' \
-u username:password \
-H 'Content-Type: application/json'

Example Response

{
"id": "MPpqhH8XuQk2TSXf66dE9Nvx",
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-01-15T10:30:00Z",
"application": "APvHR8dn8F4FZxRCHLKzgqxv",
"fee_profile": "FPbLuQG7SzjYYJeKQqRCXJPe",
"card_present_fee_profile": "FPcp5KNj8RtQxYJeKQqRCXJPe",
"payout_profile": "PPsK4VB9WcxFYJeKQqRCXJPe",
"risk_profile": "RPjN8MZd3vYFYJeKQqRCXJPe",
"tags": {
"merchant_type": "retail",
"region": "west"
},
"_links": {
"self": {
"href": "https://api.ahrvo.network/payments/na/merchant_profiles/MPpqhH8XuQk2TSXf66dE9Nvx"
},
"application": {
"href": "https://api.ahrvo.network/payments/na/applications/APvHR8dn8F4FZxRCHLKzgqxv"
},
"fee_profile": {
"href": "https://api.ahrvo.network/payments/na/fee_profiles/FPbLuQG7SzjYYJeKQqRCXJPe"
},
"payout_profile": {
"href": "https://api.ahrvo.network/payments/na/payout_profiles/PPsK4VB9WcxFYJeKQqRCXJPe"
},
"risk_profile": {
"href": "https://api.ahrvo.network/payments/na/risk_profiles/RPjN8MZd3vYFYJeKQqRCXJPe"
}
}
}

Additional Information

  • Profile Linking: The Merchant Profile connects a Merchant to multiple configuration profiles:
    • Fee Profile: Defines pricing for standard transactions
    • Card Present Fee Profile: Defines pricing for in-person card transactions
    • Payout Profile: Determines settlement timing and routing
    • Risk Profile: Sets velocity limits and fraud thresholds
  • Automatic Assignment: Every Merchant receives a Merchant Profile automatically upon creation
  • Tags: Custom metadata can be attached for organization and filtering
  • Related Resources: Use the _links object to navigate to related profiles