Endpoints

Update EFT gateway settings

Updates EFT gateway settings. Supply a settings map of key/value pairs, or copy_settings_from to copy every writable setting from another merchant in your own scope. When copy_settings_from is supplied it overrides settings entirely: copy wins, the two are not merged.

Keys outside the partner allowlist are rejected, not silently ignored. Writes are compare-before-write: a value supplied unchanged counts as 0 updates and produces no write. Checkbox values coerce to 1/0; numeric values must be numeric.

PUT
/v1/merchants/{merchantId}/settings

Authorization

bearerAuth
AuthorizationBearer <token>

A partner API token issued to a Master Account. Send Authorization: Bearer <token> on every request. Tokens are issued and revoked by a SuperAdmin in the backoffice, not through this API.

In: header

Path Parameters

merchantId*integer

The merchant id. Must belong to the calling master, or the request is 404.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

{
  "merchantid": 10544,
  "updated": 2,
  "applied": [
    "CUSTOM_GATEWAY_NAME",
    "MINIMUM_EFT_AMOUNT"
  ],
  "copied": false
}
{
  "error": {
    "code": "validation_failed",
    "message": "MINIMUM_EFT_AMOUNT must be numeric.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "A valid bearer token is required.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Merchant not found.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the period indicated.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}

On this page