Replace out-of-scope rules

put

https://api.justt.ai/v1/integrations/{integrationId}/scope-settings

Replaces the out-of-scope rules on an integration. Every dimension in the body is written and an omitted dimension is cleared, so a body with only cardSchemes removes the rules on the other five dimensions. The merchant's chargebacks from this integration's PSP are then re-evaluated against the new rules in the background: removing a rule brings chargebacks back into scope, and adding one takes chargebacks out of scope. Only the named integration changes; rules set on a parent integration are not copied to children that already exist. Merchant identifiers and the go-live date cannot be changed here. A rejected request stores nothing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integrationId

string

required

Integration ID

Body Params

paymentMethods

array of strings

Payment methods whose chargebacks are out of scope. Values are case-sensitive. GET /scope-settings/options lists the accepted values.

paymentMethods

cardSchemes

array of strings

Card schemes whose chargebacks are out of scope. Values are case-sensitive. GET /scope-settings/options lists the accepted values.

cardSchemes

lifecycleStages

array of strings

Dispute lifecycle stages that are out of scope. Values are case-sensitive. GET /scope-settings/options lists the accepted values.

lifecycleStages

reasonGroups

array of strings

Reason groups whose chargebacks are out of scope. Values are case-sensitive. GET /scope-settings/options lists the accepted values.

reasonGroups

reasonCodes

array of strings

Reason codes whose chargebacks are out of scope. Values are case-sensitive. GET /scope-settings/options lists the accepted values.

reasonCodes

chargebackAmount

object

Chargebacks below the minimum or above the maximum amount are out of scope

Headers

reference-account-id

string

Use this header to select a merchant within the API key's scope, which can be Entire account (All Merchants), Merchant group, or Specific merchant. It is required for the Merchant group scope, or for the Entire account scope when the account has more than one merchant. It is not needed for the Specific merchant scope, which is issued for a single merchant. (https://developers.justt.ai/docs/reference-accounts)

Responses

200The out-of-scope rules now stored on the integration

400A value is not one of the accepted options, the body carries a field that is not a rule dimension, an amount is negative, the minimum amount is not below the maximum, or a field has the wrong JSON type

404The integration does not exist, or it belongs to a merchant other than the one the API key resolves to

500In the message you can find explanation of what went wrong, please provide the error ID for our support for future investigation if needed

503The request could not be completed. It can be retried. After a PUT, read the rules back first: the change may have been stored before the answer was lost