Method: updateMandateStatus

Inform Google of a change in status of a mandate due to user activities outside of Google.

The mandate should be referred using the requestId of the createMandate call.

If the endpoint encounters an error while processing the request, the endpoint will return HTTP 4xx or 5xx and the HTTP body will either be of type ErrorResponse or contain a generic error (e.g. a message similar to "There was an error. Please try again later.").

The generic error is used in situations where an ErrorResponse with a clear description could be used to help an attacker understand the payment integrator account identifier of other integrators. In these situations, where either the signing key doesn't match, the payment integrator identifier was not found, or the encryption key was unknown, this method will return a generic error. If the request signature could be verified, additional information regarding the error will be returned in an ErrorResponse.

An example request looks like:


{
  "requestHeader": {
    "protocolVersion": {
      "major": 2
    },
    "requestId": "bWVyY2hhbnQgdHJhbnNhY3Rpb24gaWQ",
    "requestTimestamp": {
      "epochMillis": "1502220196077"
    },
    "paymentIntegratorAccountId": "InvisiCashIN_INR"
  },
  "mandateId": "zXCbyY2hhbnQgdHJhbnNhY3Rpb49qaAH",
  "updateSequenceTimestamp": {
      "epochMillis": "1502220196077"
  },
  "mandateStatus" : {
    "mandateActive" : {}
  }
}

An example response looks like:


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

HTTP request

POST https://vgw.googleapis.com/gsp/e-wallets-v2/updateMandateStatus/:PIAID

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "mandateId": string,
  "updateSequenceTimestamp": {
    object (Timestamp)
  },
  "mandateStatus": {
    object (MandateStatus)
  }
}
Fields
requestHeader

object (RequestHeader)

REQUIRED: Common header for all requests.
mandateId

string

REQUIRED: The unique identifier for the mandate that is being updated. This is the requestId generated by Google during the asynchronousCreateMandate call which this mandate is associated with.

This is a string with a max length of 100 characters and contains only the characters "a-z", "A-Z", "0-9", ":", "-", and "_".
updateSequenceTimestamp

object (Timestamp)

REQUIRED: A timestamp (in UTC) describing when this request was sent. Google will use this timestamp to order multiple updateMandateStatus calls and other mutations on this mandate, that arrive around the same time, to determine which request is the most recent.
mandateStatus

object (MandateStatus)

REQUIRED: The latest status of this 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

object (UpdateMandateStatusResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

MandateStatus

The status of a mandate.

JSON representation 
{

  // Union field status can be only one of the following:
  "mandateActive": {
    object (Empty)
  },
  "mandateCancelled": {
    object (MandateCancelled)
  },
  "mandatePaused": {
    object (MandatePaused)
  }
  // End of list of possible types for union field status.
}
Fields
Union field status. REQUIRED: The status must contain exactly one of these messages. status can be only one of the following:
mandateActive

object (Empty)

The mandate is active and can be used for transactions.
mandateCancelled

object (MandateCancelled)

The mandate is cancelled and cannot be used for future transactions.
mandatePaused

object (MandatePaused)

The mandate is paused and cannot be used for transactions until re-activated.

MandateCancelled

This mandate is cancelled in the network.

JSON representation 
{
  "rawResult": {
    object (RawResult)
  }
}
Fields
rawResult

object (RawResult)

OPTIONAL: Raw result of this event. Used to help inform Google's risk engine and analytics. In decline code–mapping situations, data is sometimes lost. The integrator can choose to give Google a raw code. For example, a credit card gateway (the integrator) may use this field to communicate to Google the exact decline code that was received from the VISA network. In that case, the scope would be "visa" and the rawCode would be whatever the VISA network returned.

UpdateMandateStatusResponse

Response object for the updateMandateStatus method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (UpdateMandateStatusResult)

REQUIRED: Result of this call.

UpdateMandateStatusResult

Result codes for the updateMandateStatus method.

JSON representation 
{

  // Union field result can be only one of the following:
  "success": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}
Fields
Union field result. REQUIRED: The result must contain exactly one of these messages. result can be only one of the following:
success

object (Empty)

Update mandate status was successfully processed.