List Merchant Profiles
Overview
Retrieve a list of Merchant Profiles. The Merchant Profile resource links a Merchant to its Risk Profile, Fee Profile, and Payout Profile. Every Merchant is automatically assigned one upon creation.
Resource Access
- User Permissions: All users can access this endpoint
- Endpoint:
GET /merchant_profiles
Arguments
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | No | The maximum number of results to return (default: 10) |
| id | string | No | Filter by Merchant Profile ID |
| after_cursor | string | No | Return every resource created after the cursor value for pagination |
Example Request
curl -X GET \
'https://api.ahrvo.network/payments/na/merchant_profiles?limit=20' \
-u username:password \
-H 'Content-Type: application/json'
Example Response
{
"_embedded": {
"merchant_profiles": [
{
"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"
}
}
}
]
},
"page": {
"offset": 0,
"limit": 20,
"count": 1
}
}
Additional Information
- Linked Profiles: Each Merchant Profile can link to a Fee Profile (for standard transactions), Card Present Fee Profile (for in-person transactions), Payout Profile (for settlement settings), and Risk Profile (for velocity and fraud limits)
- Automatic Creation: Merchant Profiles are automatically created when a Merchant is created
- Pagination: Use the
after_cursorparameter to paginate through large result sets - Filtering: Filter results by specific Merchant Profile IDs to retrieve targeted data