v1

latestOpenAPI 3.0.12026-07-14134373.9 KB

Recurring Service

Cancel recurring payment

Cancels an active recurring payment and stops future billing cycles for the specified recurring ID.

post/recurring/cancel

Request body

subscriptionIdstring required

Unique subscription identifier associated with the recurring payment.

recurringIdstring required

Unique identifier of the recurring payment.

cancelReasonCodeinteger required

Cancellation reason code. Valid values: 1 = Payment Failure, 2 = Fraud-Related, 3 = Chargeback, 4 = Disabled/Blocked Case/Payer, 5 = Customer Initiated, 6 = Other.

cancelReasonTextstring

Additional free-text details for the cancellation reason.

Example request

{
  "cancelReasonCode": 5,
  "cancelReasonText": "Customer requested cancellation by phone."
}

Response

Recurring payment cancelled successfully

subscriptionIdstring

Unique subscription identifier associated with the recurring payment.

recurringIdstring

Unique identifier of the recurring payment.

httpStatusCodeinteger

HTTP status code.

messagestring

Response message.

cancelledAtstring date-time

Date and time when the recurring payment cancellation was processed.