Create merchant account | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/school/settings/merchant/account/create \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type_id": 3,
  "name": "Campus Payment Gateway",
  "connection_data": "{\"api_key\":\"abc123xyz789\",\"endpoint\":\"https://payments.schoolset.io/api/v1/transactions\"}"
}'

{
  "status": "success",
  "message": "Merchant account created successfully.",
  "data": {
    "id": 1024,
    "is_default": true,
    "merchant_account_type_id": 3,
    "name": "Campus Payment Gateway",
    "charge_processing_fees": true,
    "fee_display_option": "inclusive",
    "optional_fee_coverage": "partial",
    "fee_rules": [
      {}
    ],
    "type": {},
    "connection_data": {},
    "test_mode": "enabled",
    "hash": "9f86d081884c7d659a2feaa0c55ad015",
    "webhook_url": "https://schoolset.io/webhooks/payment",
    "account_id": "acc_789654123",
    "last_webhook_call": "2024-06-10T15:45:00Z",
    "credit_card_required_rules": {},
    "created_at": "2024-06-10T14:00:00Z",
    "updated_at": "2024-06-10T15:00:00Z"
  }
}

Creates a merchant account with connection details, optional fee settings, and processing rules.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

type_idintegerRequired

Merchant account type ID.

namestringRequired

name display value.

connection_datastringRequired

Connection data.

charge_processing_feesboolean or nullOptional

charge processing fees flag.

fee_display_optionstring or nullOptional

fee display option value.

optional_fee_coveragestring or nullOptional

optional fee coverage flag.

ruleslist of objectsOptional

rules list.

Response

Success

statusenum

Allowed values:

messagestring

dataobject