Cancel repeat payment

  • Updated on Sep 26, 2024
  • Published on Aug 27, 2024
  • 1 minute(s) read
Delete
/api/pay/v1/repeat-payments/cancel/{payment_id}

This endpoint refunds a single previous payment in a schedule.

Parameters

schedule_id (integer): id of the schedule of the repeat payment.

Request Body

  • payment_type (string, required): Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat schedule. This value cannot be updated.
    • fixed_schedule
    • variable_schedule
  • recurring_id (integer, required): id of the transaction you wish to refund.

Response Body

  • success (boolean)
  • message (string)
Security
HTTP
Type bearer
Header parameters
Authorization
string
ExampleBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c
Path parameters
payment_id
stringRequired
Responses
200

Successful response