Show merchant accounts

GET

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

GET

/app/api/v1/school/settings/merchant/accounts

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Merchant accounts retrieved successfully.",
4   "data": [
5     {
6       "id": 1024,
7       "is_default": true,
8       "merchant_account_type_id": 3,
9       "name": "Stripe Primary Account",
10       "charge_processing_fees": false,
11       "fee_display_option": "inclusive",
12       "optional_fee_coverage": 2.5,
13       "fee_rules": [
14         {
15           "rule_id": 501,
16           "description": "Standard processing fee",
17           "percentage": 2.9,
18           "fixed_fee": 0.3
19         }
20       ],
21       "type": {
22         "code": "stripe",
23         "description": "Stripe payment gateway"
24       },
25       "connection_data": {
26         "api_key": "sk_live_4eC39HqLyjWDarjtT1zdp7dc",
27         "environment": "production"
28       },
29       "test_mode": "off",
30       "hash": "a1b2c3d4e5f67890",
31       "webhook_url": "https://schoolset.io/webhooks/stripe",
32       "account_id": "acct_1Gqj58Lz0qyl6XeW",
33       "last_webhook_call": "2024-06-10T15:45:00Z",
34       "credit_card_required_rules": {
35         "min_amount": 10,
36         "required": true
37       },
38       "created_at": "2023-11-01T09:00:00Z",
39       "updated_at": "2024-05-20T12:30:00Z"
40     }
41   ]
42 }

Returns all merchant accounts with fee-rule associations.

Authentication

AuthorizationBearer

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

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects