Merchant
Settings for the key's mode
GET /v1/merchant/settings
Retrieve the merchant settings for this mode.
Authentication: Secret key
Responses
| Status | Description | Body |
|---|---|---|
| 200 | MerchantSettings application/json | |
| 401 | ErrorResponse application/json |
POST /v1/merchant/settings
Update the merchant settings for this mode. Omitted fields are unchanged.
webhook_url must be a public https:// endpoint. Registered destinations cannot be changed here.
Authentication: Secret key
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
Idempotency-Keyrequired | header | string | Unique per logical operation |
Request body
application/json
| Field | Type | Description |
|---|---|---|
display_name | string or null | |
webhook_url | string or null |
|
default_assets | array of string or null | |
underpay_tolerance_bps | integer (int32) or null |
|
Responses
| Status | Description | Body |
|---|---|---|
| 200 | MerchantSettings application/json | |
| 400 | Invalid value, including a refused webhook URL | ErrorResponse application/json |
| 403 | Tried to change registered destinations, or a live-mode webhook URL (use the dashboard) | ErrorResponse application/json |
POST /v1/merchant/webhook_secret/roll
Replace the webhook signing secret. The response is the only time the new secret is readable; deliveries are signed with it from now on.
Authentication: Secret key
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
Idempotency-Keyrequired | header | string | Unique per logical operation |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | WebhookSecret application/json | |
| 401 | ErrorResponse application/json | |
| 403 | Live mode: use the dashboard's protected-change flow | ErrorResponse application/json |