Update Payment Method

Update a payment method configuration.

PUT /cabinet/admin/payment-methods/{method_id}

Update Payment Method

cURL

curl --request PUT \
  --url https://api.example.com/cabinet/admin/payment-methods/{method_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_enabled": true,
  "display_name": "<string>",
  "sub_options": {},
  "min_amount_kopeks": 1,
  "max_amount_kopeks": 1,
  "user_type_filter": "<string>",
  "first_topup_filter": "<string>",
  "promo_group_filter_mode": "<string>",
  "allowed_promo_group_ids": [
    123
  ],
  "reset_display_name": false,
  "reset_min_amount": false,
  "reset_max_amount": false
}
'

200

{
  "method_id": "<string>",
  "sort_order": 123,
  "is_enabled": true,
  "default_display_name": "<string>",
  "default_min_amount_kopeks": 123,
  "default_max_amount_kopeks": 123,
  "user_type_filter": "<string>",
  "first_topup_filter": "<string>",
  "promo_group_filter_mode": "<string>",
  "is_provider_configured": true,
  "display_name": "<string>",
  "sub_options": {},
  "available_sub_options": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "min_amount_kopeks": 123,
  "max_amount_kopeks": 123,
  "allowed_promo_group_ids": [
    123
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

method_id · string · required

Body

application/json

is_enabled · boolean | null

display_name · string | null

Null to reset to default

sub_options · Sub Options · object

Show child attributes

min_amount_kopeks · integer | null

Required range: x >= 0

max_amount_kopeks · integer | null

Required range: x >= 0

user_type_filter · string | null

Pattern: ^(all|telegram|email)$

first_topup_filter · string | null

Pattern: ^(any|yes|no)$

promo_group_filter_mode · string | null

Pattern: ^(all|selected)$

allowed_promo_group_ids · integer[] | null

reset_display_name · boolean · default: false

reset_min_amount · boolean · default: false

reset_max_amount · boolean · default: false

Response

200

application/json

Successful Response

method_id · string · required

sort_order · integer · required

is_enabled · boolean · required

default_display_name · string · required

default_min_amount_kopeks · integer · required

default_max_amount_kopeks · integer · required

user_type_filter · string · required

first_topup_filter · string · required

promo_group_filter_mode · string · required

is_provider_configured · boolean · required

display_name · string | null

sub_options · Sub Options · object

available_sub_options · SubOptionInfo · object[] | null

Show child attributes

min_amount_kopeks · integer | null

max_amount_kopeks · integer | null

allowed_promo_group_ids · integer[]

created_at · string<date-time> | null

updated_at · string<date-time> | null