Update a merchant account

PATCH

https://ssuccessv2.com/app/api/v1/school/settings/merchant/account/update/:id

Updates credentials, payment options, and fee rules for one merchant account.

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

idintegerRequired

Merchant account identifier to update.

This endpoint expects an object.

type_iddouble or nullOptional

namestring or nullOptional

connection_datastring or nullOptional

JSON encoded connection settings.

charge_processing_feesboolean or nullOptional

fee_display_optionstring or nullOptional

optional_fee_coveragestring or nullOptional

credit_card_enabledboolean or nullOptional

ach_enabledboolean or nullOptional

deposit_account_idinteger or nullOptional

ruleslist of objectsOptional

rules_to_deletelist of integersOptional

is_*_requiredany or nullOptional

Provider-specific optional requirement flag.

The merchant account was updated and returned.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X PATCH https://ssuccessv2.com/app/api/v1/school/settings/merchant/account/update/12 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"status": "success",
3	"message": "Saved successfully.",
4	"data": {
5	"id": 12,
6	"name": "Primary tuition account",
7	"merchant_account_type_id": 1,
8	"connection_data": {
9	"account_id": "masked1234"
10	},
11	"fee_rules": [
12	{}
13	],
14	"payment_settings": {
15	"charge_processing_fees": true,
16	"fee_display_option": "separate",
17	"optional_fee_coverage": "customer_choice"
18	}
19	}
20	}