Method: cancelFundsReservation
Stay organized with collections
Save and categorize content based on your preferences.
Initiates canceling the funds that were reserved by a reserveFunds
call.
This cancels the pending transaction by freeing the reserved funds. The reserveFundsRequestId
identifies which funds reservation is being canceled. When this is used, there is no money movement from a customer's account for this transaction. The final result of the cancel is supplied by a call to cancelFundsReservationResultNotification
. The requestId
within the header is the idempotency key and uniquely identifies this transaction.
If the reservation of funds has expired or the payment integrator has automatically canceled the reservation, consider it a successful cancel rather than an error. Therefore, return an ACKNOWLEDGED response code and call cancelFundsReservationResultNotification
.
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": "G1NMPDFX4AW395L",
"requestTimestamp": "1481907920000"
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR",
"reserveFundsRequestId": "G1MQ0YERJ0Q7LPM"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": "1481907920760"
},
"result": "SUCCESS"
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/e-wallets-v1/cancelFundsReservation
Request body
The request body contains data with the following structure:
JSON representation |
{
"requestHeader": {
object (RequestHeader )
},
"paymentIntegratorAccountId": string,
"reserveFundsRequestId": 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.
|
reserveFundsRequestId |
string
REQUIRED: requestId of the reserve funds call for this transaction.
|
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 (CancelFundsReservationResponse )
|
HTTP 4XX / 5XX Status |
object (ErrorResponse )
|
CancelFundsReservationResponse
Response object for the cancel method.
CancelReservedFundsResultCode
Result codes for capture.
Enums |
CANCEL_RESERVED_FUNDS_RESULT_CODE_UNSPECIFIED |
Do not ever set this default value! |
SUCCESS |
Successfully cancelled. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-16 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-07-16 UTC."],[[["\u003cp\u003eThe \u003ccode\u003ecancelFundsReservation\u003c/code\u003e API initiates the cancellation of reserved funds, identified by \u003ccode\u003ereserveFundsRequestId\u003c/code\u003e, without actual money movement.\u003c/p\u003e\n"],["\u003cp\u003eUpon receiving the request, the endpoint should acknowledge it and subsequently notify the result via \u003ccode\u003ecancelFundsReservationResultNotification\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe combination of \u003ccode\u003erequestId\u003c/code\u003e and \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e ensures idempotency for the transaction.\u003c/p\u003e\n"],["\u003cp\u003eIf the reservation has already expired or been canceled, consider it a success and proceed with the acknowledgement and notification.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes \u003ccode\u003erequestHeader\u003c/code\u003e, \u003ccode\u003epaymentIntegratorAccountId\u003c/code\u003e, and \u003ccode\u003ereserveFundsRequestId\u003c/code\u003e, while the response conveys the result through \u003ccode\u003eresponseHeader\u003c/code\u003e and \u003ccode\u003eresult\u003c/code\u003e fields.\u003c/p\u003e\n"]]],["The core action is to cancel previously reserved funds via a `POST` request to the `/cancelFundsReservation` endpoint. This requires a `requestHeader`, `paymentIntegratorAccountId`, and `reserveFundsRequestId`. The request identifies the funds reservation to cancel, freeing the reserved amount. A successful response includes a `responseHeader` and a `result` indicating \"SUCCESS\". If the reservation has expired it should still be considered a success. Errors are handled by returning an `ErrorResponse` object. The final result is communicated via `cancelFundsReservationResultNotification`.\n"],null,["# Method: cancelFundsReservation\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- [CancelFundsReservationResponse](#CancelFundsReservationResponse)\n - [JSON representation](#CancelFundsReservationResponse.SCHEMA_REPRESENTATION)\n- [CancelReservedFundsResultCode](#CancelReservedFundsResultCode)\n\nInitiates canceling the funds that were reserved by a `reserveFunds` call.\n\nThis cancels the pending transaction by freeing the reserved funds. The `reserveFundsRequestId` identifies which funds reservation is being canceled. When this is used, there is no money movement from a customer's account for this transaction. The final result of the cancel is supplied by a call to `cancelFundsReservationResultNotification`. The `requestId` within the header is the idempotency key and uniquely identifies this transaction.\n\nIf the reservation of funds has expired or the payment integrator has automatically canceled the reservation, consider it a successful cancel rather than an error. Therefore, return an ACKNOWLEDGED response code and call `cancelFundsReservationResultNotification`.\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\": \"G1NMPDFX4AW395L\",\n \"requestTimestamp\": \"1481907920000\"\n },\n \"paymentIntegratorAccountId\": \"SpeedyPaymentsIndia_INR\",\n \"reserveFundsRequestId\": \"G1MQ0YERJ0Q7LPM\"\n }\n\nAn example response looks like: \n\n\n {\n \"responseHeader\": {\n \"responseTimestamp\": \"1481907920760\"\n },\n \"result\": \"SUCCESS\"\n }\n\n### HTTP request\n\n`POST https://www.integratorhost.example.com/integrator-base-path/e-wallets-v1/cancelFundsReservation`\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, \"reserveFundsRequestId\": 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| `reserveFundsRequestId` | `string` **REQUIRED** : `requestId` of the reserve funds call for this transaction. |\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 (`[CancelFundsReservationResponse](/pay/e-wallets-v1/payment-integrator-e-wallets-api/cancelFundsReservation#CancelFundsReservationResponse)`)` |\n| HTTP 4XX / 5XX Status | `object (`[ErrorResponse](/pay/e-wallets-v1/payment-integrator-e-wallets-api/ErrorResponse)`)` |\n\nCancelFundsReservationResponse\n------------------------------\n\nResponse object for the cancel method.\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/cancelFundsReservation#CancelReservedFundsResultCode) } ``` |\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 (`[CancelReservedFundsResultCode](/pay/e-wallets-v1/payment-integrator-e-wallets-api/cancelFundsReservation#CancelReservedFundsResultCode)`)` **REQUIRED**: Result of this cancel. |\n\nCancelReservedFundsResultCode\n-----------------------------\n\nResult codes for capture.\n\n| Enums ||\n|-------------------------------------------------|-------------------------------------|\n| `CANCEL_RESERVED_FUNDS_RESULT_CODE_UNSPECIFIED` | Do not ever set this default value! |\n| `SUCCESS` | Successfully cancelled. |"]]