Method: integrator-base-path.carriers-v1.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 combination of requestId within the header and paymentIntegratorAccountId 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
    },
    "requestId": "G1NMPDFX4AW395L",
    "requestTimestamp": {
      "epochMillis": "1502220196077"
    },
    "paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
  },
  "reserveFundsRequestId": "G1MQ0YERJ0Q7LPM"
}

An example response looks like:


{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis": "1481907920760"
    }
  },
  "result": {
    "success": {}
  }
}

HTTP request

POST https://www.integratorhost.example.com/integrator-base-path/carriers-v1/cancelFundsReservation

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestHeader": {
    object (RequestHeader)
  },
  "reserveFundsRequestId": string
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.

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.

JSON representation
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (CancelReservedFundsResult)
  }
}
Fields
responseHeader

object (ResponseHeader)

REQUIRED: Common header for all responses.

result

object (CancelReservedFundsResult)

REQUIRED: Result of this cancel.

CancelReservedFundsResult

JSON representation
{
  "success": {
    object (Empty)
  }
}
Fields
success

object (Empty)

Successful cancellation.