Update merchant account | SchoolSet

curl -X PATCH https://app.schoolset.io/app/api/v1/school/settings/merchant/account/update/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type_id": 3,
  "connection_data": "[{\"host\":\"db.schoolset.io\",\"port\":5432,\"database\":\"merchant_db\",\"user\":\"admin\",\"password\":\"securePass123\"}]",
  "rules_to_delete": [
    17,
    23
  ]
}'

{
  "status": "success",
  "message": "Merchant account updated successfully.",
  "data": {
    "id": 3,
    "is_default": false,
    "merchant_account_type_id": 3,
    "name": "Primary Merchant Account",
    "charge_processing_fees": true,
    "fee_display_option": "inclusive",
    "optional_fee_coverage": "partial",
    "fee_rules": [
      {}
    ],
    "type": {},
    "connection_data": {},
    "test_mode": "enabled",
    "hash": "a1b2c3d4e5f67890",
    "webhook_url": "https://webhooks.schoolset.io/merchant/updates",
    "account_id": "ACC-987654321",
    "last_webhook_call": "2024-06-10T15:45:00Z",
    "credit_card_required_rules": {},
    "created_at": "2023-11-01T09:00:00Z",
    "updated_at": "2024-06-10T15:50:00Z"
  }
}

Updates merchant account configuration, connection data, and associated fee rule mappings.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

type_idinteger or nullRequired

merchant account type ID.

connection_datastring or nullRequired

Connection data.

rules_to_deletelist of integersRequired

rules to delete list.

namestring or nullOptional

name display value.

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