Limits

Setting limits via the API. Limits can also be configured through the merchant's personal account. There are 3 types of limits for payouts:

• order — limit per transaction
• day — daily limit per shop
• month — monthly limit per shop

The limit type is unique for each shop.

Request headers

Name	Type	Required	Description
X-Api-Key	string	Yes	Unique shop identifier
X-Signature	string	Yes	Request signature

List of limits

URL

Method: GET

• Production: https://api.baas.kvell.group/v1/points/limits
• Stage: https://api.baas.stage.kvell.group/v1/points/limits

Building the signature

The X-Signature signature is formed by concatenating X-Api-Key and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{secret_key})

where secret_key is the secret key found in the merchant's shop settings.

Response

200: OK422: Validation error

[
  {
    "id": 2,
    "amount": 1000,
    "type": "month"
  }
]

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Create a limit

URL

Method: POST

• Production: https://api.baas.kvell.group/v1/points/limits
• Stage: https://api.baas.stage.kvell.group/v1/points/limits

Request parameters

Name	Type	Required	Description
amount	integer	Yes	Limit amount in kopecks
type	string enum	Yes	Limit type: order, day, month

Request example:

{
  "amount": 1000,
  "type": "order"
}

Building the signature

The X-Signature signature is formed by concatenating X-Api-Key, amount, type, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{amount}{type}{secret_key})

where secret_key is the secret key found in the merchant's shop settings.

Response

200: OK422: Validation error

{
  "id":40,
  "amount": 1000,
  "type": "order"
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Get a limit

URL

Method: GET

• Production: https://api.baas.kvell.group/v1/points/limits/{limit_id}
• Stage: https://api.baas.stage.kvell.group/v1/points/limits/{limit_id}

Request parameters

Name	Type	Description
limit_id	string	Identifier id obtained when the limit was created

Building the signature

The X-Signature signature is formed by concatenating X-Api-Key, limit_id, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{limit_id}{secret_key})

where secret_key is the secret key found in the merchant's shop settings.

Response

200: OK422: Validation error

{
  "id":40,
  "amount": 1000,
  "type": "order"
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Edit a limit

URL

Method: PATCH

• Production: https://api.baas.kvell.group/v1/points/limits/{limit_id}
• Stage: https://api.baas.stage.kvell.group/v1/points/limits/{limit_id}

Request parameters

Name	Type	Description
limit_id	string	Identifier id obtained when the limit was created

Request body parameters

Name	Type	Required	Description
amount	integer	Yes	Limit amount in kopecks
type	string enum	Yes	Limit type: order, day, month

Building the signature

The X-Signature signature is formed by concatenating X-Api-Key, limit_id, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{limit_id}{secret_key})

where secret_key is the secret key found in the merchant's shop settings.

Response

200: OK422: Validation error

{
  "id":40,
  "amount": 1000,
  "type": "order"
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Delete a limit

URL

Method: DELETE

• Production: https://api.baas.kvell.group/v1/points/limits/{limit_id}
• Stage: https://api.baas.stage.kvell.group/v1/points/limits/{limit_id}

Request parameters

Name	Type	Description
limit_id	string	Identifier id obtained when the limit was created

Building the signature

The X-Signature signature is formed by concatenating X-Api-Key, limit_id, and secret_key. sha256 is computed from the resulting string:

sha256({x-api-key}{limit_id}{secret_key})

where secret_key is the secret key found in the merchant's shop settings.

Response

204: No content422: Validation error

Success, no content.

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}