merchant_configurations

Patch a configuration document

JSON merge patch on features, settings and providers (null removes a key); enabled and provider are set directly ("provider": null clears it). expected_version must be the version read; a document that moved on answers 409 and nothing is written.

patch/v1/merchant_configurations/{id}

Request

  • Base URL
    https://ewallets-api.paymongo.com
  • URL
    https://ewallets-api.paymongo.com/v1/merchant_configurations/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Document id

Headers

PayMongo-Actorstring required

account:<id> | system:<job> | migration:<source>

PayMongo-Livemode'true' | 'false' required

true or false

Request body

enabledboolean
expected_versioninteger required
featuresobject
providerstring
providersobject
reasonstring
settingsobject

Example request

{
  "expected_version": 4,
  "provider": "paymaya"
}

Response

OK

has_moreboolean

Example response

{
  "data": {
    "id": "mcfg_5e2a8c1d7f4b9e6a3c0d1b58",
    "method": "paymaya",
    "organization_id": "org_abc123",
    "provider": "paymaya",
    "version": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.