Initiates cancelling the mandate that was created for recurring payment.
This cancels the existing mandate on the user's account. The mandateId
identifies which mandate is being cancelled. It was generated by the vendor while creating the mandate.
If the mandate has expired or is already cancelled, consider it a successful cancellation rather than an error. Therefore, return a success
response code.
The requestId
within the header is the idempotency key and uniquely identifies this transaction.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "cmVxdWVzdDE",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
},
"mandateId": "MA061B00045154",
"customerReferenceId": "customer57",
"recurringPaymentReferenceId": "subscription201"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1481899949611"
}
},
"result": {
"success": {}
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/v1/payment-integrator-authenticated-card-fop-api/cancelMandate
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestHeader": {
object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
mandate |
REQUIRED: The payment integrator generated ID that represents the mandate for this recurring payment. This is returned in the |
customer |
REQUIRED: The Google generated customer reference ID that is associated with the mandate for this recurring payment. It is the same ID that is provided when the mandate creation is requested and is unique to that mandate. |
recurring |
REQUIRED: The Google generated recurring payment ID. It is the same ID that is provided when the mandate creation is requested and is unique to that mandate. |
Response body
This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse
, consult the ErrorResponse
object and HTTP status codes documentation.
Possible response messages | |
---|---|
HTTP 200 Status |
|
HTTP 4XX / 5XX Status |
|
CancelMandateResponse
Response object for the cancel mandate method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this mandate cancellation. |
CancelMandateResult
Result codes for cancel mandate.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field result . REQUIRED: The result of the cancel mandate. This message should only be used to report a terminal state for mandate cancellation. result can be only one of the following: |
|
success |
The mandate was successfully cancelled. |