Method: cancelMandate
Stay organized with collections
Save and categorize content based on your preferences.
Initiates a mandate cancellation on the user's account with the integrator.
This cancels the existing mandate on the user's account. The mandateId
identifies which mandate is being cancelled. This is the requestId
of the createMandate
or asynchronousCreateMandate
call.
If the mandate has expired or is already cancelled, consider it a successful cancel 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,
"minor": 0,
"revision": 0
},
"requestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
"requestTimestamp": "1502220196078"
},
"paymentIntegratorAccountId": "InvisiCashIN_INR",
"mandateId": "Gbsdfju4bnQgdHJXPFWSDhgdka4"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1502220196079"
},
"result": "SUCCESS"
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/e-wallets-v1/cancelMandate
Request body
The request body contains data with the following structure:
JSON representation |
{
"requestHeader": {
object (RequestHeader )
},
"paymentIntegratorAccountId": string,
"mandateId": string
} |
Fields |
requestHeader |
object (RequestHeader )
REQUIRED: Common header for all requests.
|
paymentIntegratorAccountId |
string
REQUIRED: This is the payment integrator account identifier that identifies contractual constraints around this transaction.
|
mandateId |
string
REQUIRED: The Google generated ID of the mandate to cancel.
|
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 |
object (CancelMandateResponse )
|
HTTP 4XX / 5XX Status |
object (ErrorResponse )
|
CancelMandateResponse
Response object for the cancelMandate
method call.
CancelMandateResultCode
Result codes for e-wallets-v1.cancelMandate
method call.
Enums |
CANCEL_MANDATE_RESULT_CODE_UNSPECIFIED |
Do not ever set this default value! |
SUCCESS |
The mandate was cancelled successfully. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eCancels a user's existing mandate using the \u003ccode\u003emandateId\u003c/code\u003e from the \u003ccode\u003ecreateMandate\u003c/code\u003e or \u003ccode\u003easynchronousCreateMandate\u003c/code\u003e call.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003esuccess\u003c/code\u003e response even if the mandate is already expired or cancelled.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003erequestId\u003c/code\u003e in the header as an idempotency key for unique transaction identification.\u003c/p\u003e\n"],["\u003cp\u003eProvides request and response examples for a clearer understanding of the API's functionality.\u003c/p\u003e\n"],["\u003cp\u003eDefines specific result codes for indicating the outcome of the mandate cancellation request.\u003c/p\u003e\n"]]],["This describes the `cancelMandate` function, which cancels an existing mandate on a user's account. The process requires a `POST` request to a specified endpoint, including a `requestHeader`, `paymentIntegratorAccountId`, and `mandateId` in the request body. The `requestId` in the header serves as an idempotency key. A successful cancellation, even if the mandate is expired or already canceled, returns a `SUCCESS` response, and errors return an `ErrorResponse`. The response includes a `responseHeader` and a `result` code.\n"],null,["# Method: cancelMandate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [CancelMandateResponse](#CancelMandateResponse)\n - [JSON representation](#CancelMandateResponse.SCHEMA_REPRESENTATION)\n- [CancelMandateResultCode](#CancelMandateResultCode)\n\nInitiates a mandate cancellation on the user's account with the integrator.\n\nThis cancels the existing mandate on the user's account. The `mandateId` identifies which mandate is being cancelled. This is the `requestId` of the `createMandate` or `asynchronousCreateMandate` call.\n\nIf the mandate has expired or is already cancelled, consider it a successful cancel rather than an error. Therefore, return a `success` response code.\n\nThe `requestId` within the header is the idempotency key and uniquely identifies this transaction.\n\nIf the endpoint encounters an error while processing the request, the response body from this endpoint should be of type [`ErrorResponse`](/pay/e-wallets-v1/payment-integrator-e-wallets-api/ErrorResponse).\n\nAn example request looks like: \n\n\n {\n \"requestHeader\": {\n \"protocolVersion\": {\n \"major\": 1,\n \"minor\": 0,\n \"revision\": 0\n },\n \"requestId\": \"bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ\",\n \"requestTimestamp\": \"1502220196078\"\n },\n \"paymentIntegratorAccountId\": \"InvisiCashIN_INR\",\n \"mandateId\": \"Gbsdfju4bnQgdHJXPFWSDhgdka4\"\n }\n\nAn example response looks like: \n\n\n {\n \"responseHeader\": {\n \"responseTimestamp\": \"1502220196079\"\n },\n \"result\": \"SUCCESS\"\n }\n\n### HTTP request\n\n`POST https://www.integratorhost.example.com/integrator-base-path/e-wallets-v1/cancelMandate`\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestHeader\": { object (/pay/e-wallets-v1/payment-integrator-e-wallets-api/RequestHeader) }, \"paymentIntegratorAccountId\": string, \"mandateId\": string } ``` |\n\n| Fields ||\n|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestHeader` | `object (`[RequestHeader](/pay/e-wallets-v1/payment-integrator-e-wallets-api/RequestHeader)`)` **REQUIRED**: Common header for all requests. |\n| `paymentIntegratorAccountId` | `string` **REQUIRED**: This is the payment integrator account identifier that identifies contractual constraints around this transaction. |\n| `mandateId` | `string` **REQUIRED**: The Google generated ID of the mandate to cancel. |\n\n### Response body\n\nThis 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](/pay/e-wallets-v1/guides/connectivity/protocol-standards#http_status_codes).\n\n| Possible response messages ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------|\n| HTTP 200 Status | `object (`[CancelMandateResponse](/pay/e-wallets-v1/payment-integrator-e-wallets-api/cancelMandate#CancelMandateResponse)`)` |\n| HTTP 4XX / 5XX Status | `object (`[ErrorResponse](/pay/e-wallets-v1/payment-integrator-e-wallets-api/ErrorResponse)`)` |\n\nCancelMandateResponse\n---------------------\n\nResponse object for the `cancelMandate` method call.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responseHeader\": { object (/pay/e-wallets-v1/payment-integrator-e-wallets-api/ResponseHeader) }, \"result\": enum (/pay/e-wallets-v1/payment-integrator-e-wallets-api/cancelMandate#CancelMandateResultCode) } ``` |\n\n| Fields ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responseHeader` | `object (`[ResponseHeader](/pay/e-wallets-v1/payment-integrator-e-wallets-api/ResponseHeader)`)` **REQUIRED**: Common header for all responses. |\n| `result` | `enum (`[CancelMandateResultCode](/pay/e-wallets-v1/payment-integrator-e-wallets-api/cancelMandate#CancelMandateResultCode)`)` **REQUIRED**: The result of the cancel mandate call. |\n\nCancelMandateResultCode\n-----------------------\n\nResult codes for `e-wallets-v1.cancelMandate` method call.\n\n| Enums ||\n|------------------------------------------|-----------------------------------------|\n| `CANCEL_MANDATE_RESULT_CODE_UNSPECIFIED` | Do not ever set this default value! |\n| `SUCCESS` | The mandate was cancelled successfully. |"]]