Скасування підписки на регулярні платежі

В будь-який момент ви можете достроково завершити (скасувати) підписку клієнта на регулярні платежі за власною ініціативою або за ініціативою клієнта.

Для цього повинен бути відправлений PUT запит до ендпоїнту /api/v1/recurring/:recurringId/cancel, де значенням параметру recurringId повинен бути унікальний ідентифікатор відповідної підписки на регулярні платежі.

Приклад запиту на скасування підписки:

  curl --location \
  --request PUT 'https://api.tranzzo.com/api/v1/recurring/UGqZLkh3VoxdG2llFGz84/cancel' \
  --header 'X-API-Auth: CPAY-HMAC f3572ccc-7794-480a-b72e-83bee915a1b0:3872075252afc108bc5c7668349193c74718332a' \
  --header 'X-API-Key: AIzaSyBi23UpVOCqAjMRSwnWgi1HNXDtco478m8'

Відповідь на запит на скасування підписки:

{
  "recurring_payment": {
    "pos_id": "2a810802-d3ac-4aad-b4c7-74c54cba628e",
    "company_id": "f636d31e-2711-41f7-8d4f-535e897e43f1",
    "order_id": "P4rTCGHOBySWc9J",
    "amount": 7,
    "currency": "UAH",
    "cc_token": "ZTM4ZGRhZDc2NWVhNGNiYmFmYjQxOWRmMjU2YzM1YjU6RjdHZHZ2RFhqUkZ0ZFZjT0hY",
    "description": "Test recurring",
    "payway": "cc",
    "server_url": "https://webhook.site/36eb903e-e8fc-4163-8efc-f245cc7a7f7f"
  },
  "recurring_config": {
    "interval_unit": "day",
    "interval_count": 1,
    "retry_attempts": 5,
    "retry_interval_hours": 1,
    "start_date": "2023-09-13",
    "expiry_date": "2023-09-15",
    "time": "10:10:00"
  },
  "recurring_status": "canceled",
  "metadata": {
    "id": "SOS6EUthvMXo137Wf7h5F",
    "created_at": "2023-09-13T20:53:17.736",
    "updated_at": "2023-09-14T10:31:14.012"
  }
}

Після успішної обробки запиту, підписку на регулярні платежі буде припинено, і подальших списань з клієнта за відповідним замовленням проводитися не буде.

Тестування процесу створення підписки:

Створіть підписку на регулярні платежі.
Відправте запит на скасування підписки.
Опрацьовуйте отримані помилки.

Вихід в онлайн

Коли наша команда Комплаєнсу активує робочий проєкт, замініть автентифікаційні дані тестового проєкту на дані робочого.

Дивіться також:​

Дивіться також: