The Deactivate Recurring Card Token endpoint is used to cancel a recurring transaction or deactivate a card token associated with a recurring payment. This API is particularly useful for merchants who wish to stop future charges associated with a specific card token.

Request

METHOD: POST

✅
Endpoint: https://api.hydrogenpay.com/bepay/api/v1/api/v1/Merchant/deactivate-recurring-card-token

Request parameters

Mandatory	Type	Name	Comment
Yes	String	token	A unique identifier for the card token to be deactivated. This is mandatory for recurring transactions that returned a card token in the webhook or the confirm payment endpoint.
Yes	String	transactionRef	A reference ID for the transaction being canceled. This is required for regular recurring transactions, where the card token is not utilised.

Sample Request

{
    "token": "2c382ed1-b5e5-4050-81fb-1b4d61443429",
    "transactionRef": "csE8CyZTn3OD"
}

Success Response

Field	Type	Value
statusCode	Integer	90000
data	String	Token has been deactivated

Sample Response

{
	"statusCode": "90000",
	"message": null,
	"data": "Token has been deactivated"
}

Application

Regular Recurring Transactions: Only the transactionRef is required in the request body.

Recurring Transactions with Frequency 5: Include both the token and transactionRef to deactivate the card token linked to the recurring transaction.