Skip to main content

Cancel Recurring Payment API

This guide explains how to cancel a recurring payment through an API call.

REQUEST​

testing server:​

GET https://staging.xpay.app/api/payments/cancel_recurring/{transaction_uuid}/

production(Live) server:​

GET https://community.xpay.app/api/payments/cancel_recurring/{transaction_uuid}/

Parameters​

URL Path Parameters​

Required Properties​

Property nameValueDescriptionNotes
transaction_uuidstringUUID that is unique to your recurring transactionThis identifies the recurring payment to cancel

Authorization​

This method requires authorization, supply the header with a key value pair with that structure

"x-api-key" : string

Required Properties​

Property nameValueDescriptionNotes
x-api-keystringAPI key linked to your communitygenerate API key

​

Request body​

This endpoint does not require a request body.

Response​

If successful, this method returns a response body with the following structure:

{
    "status": {
        "code": 200,
        "message": "success",
        "errors": []
    },
    "data": {
        "details": "successfully canceled your recurring payment"
    },
    "count": null,
    "next": null,
    "previous": null
}

Example​

GET https://staging.xpay.app/api/payments/cancel_recurring/a3d8fd1c-a919-4f4c-b1c1-2e3f6ad486d6/

Headers:
x-api-key: your-api-key-here