Show merchant account info

GET

https://app.schoolset.io/app/api/v1/school/settings/merchant/account/:id

GET

/app/api/v1/school/settings/merchant/account/:id

1 curl https://app.schoolset.io/app/api/v1/school/settings/merchant/account/id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Merchant account details retrieved successfully.",
4   "data": {
5     "id": 42,
6     "is_default": true,
7     "merchant_account_type_id": 3,
8     "name": "Main School Payment Gateway",
9     "charge_processing_fees": true,
10     "fee_display_option": "inclusive",
11     "optional_fee_coverage": 2.5,
12     "fee_rules": [
13       {
14         "rule_id": 101,
15         "description": "Standard transaction fee",
16         "fee_percentage": 2.9,
17         "fixed_fee": 0.3,
18         "applicable_countries": [
19           "US",
20           "CA"
21         ]
22       }
23     ],
24     "type": {
25       "id": 3,
26       "name": "Stripe",
27       "description": "Stripe payment processor"
28     },
29     "connection_data": {
30       "api_key": "sk_live_4eC39HqLyjWDarjtT1zdp7dc",
31       "environment": "production"
32     },
33     "test_mode": "disabled",
34     "hash": "a1b2c3d4e5f67890",
35     "webhook_url": "https://schoolset.io/webhooks/stripe",
36     "account_id": "acct_1Gqj58Lz0qyl6XeW",
37     "last_webhook_call": "2024-06-10T15:45:00Z",
38     "credit_card_required_rules": {
39       "min_amount": 10,
40       "max_amount": 1000,
41       "required": true
42     },
43     "created_at": "2023-11-01T09:00:00Z",
44     "updated_at": "2024-06-01T12:00:00Z",
45     "payment_settings": {
46       "charge_processing_fees": true,
47       "fee_display_option": "inclusive",
48       "optional_fee_coverage": 2.5
49     }
50   }
51 }

Returns full merchant account details, fee rules, and resolved payment settings.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

dataobject