Method: paymentMethodsUpdatedNotification

  • Integrators should use the paymentMethodsUpdatedNotification method to inform Google of changes to a user's payment methods within a linked partner account, such as updates to card details or the addition of new payment methods.

  • This method should only be called when changes to payment methods will be reflected in the ListPaymentMethodsResponse; it should not be used for changes like balance adjustments or updates to a user's email address.

  • A successful paymentMethodsUpdatedNotification request will return an HTTP 200 status and an EchoResponse, while errors during processing will result in HTTP 4xx or 5xx status codes.

  • The request body must include a requestHeader object and a linkUserAccountRequestId string, and the response can be a PaymentMethodsUpdatedNotificationResponse or an ErrorResponse for error cases.

  • The PaymentMethodsUpdatedNotificationResult includes a union field result, which must be set to success to indicate that the update notification was processed.

Notify Google that the payment methods contained within a linked Partner (Payment Integrator) User account have changed. Google will use listPaymentMethods to call back into the partner to get the user's current payment methods.

Integrators should only call this method when changes in the payment methods will appear in listPaymentMethodsResponse. Examples include changes in the card-holder's name, billing address, card expiration date or number, or the addition of a new card or e-wallet.

Integrators should NOT call this method if the changes won't appear in listPaymentMethodsResponse. Examples include balance changes, changes in a card's limit, or changes to a user's email address.

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": 1
    },
    "requestId": "randomRequestId12345",
    "requestTimestamp": {
      "epochMillis": "1481899999606"
    },
    "paymentIntegratorAccountId": "GoldenPartner123"
  },
  "linkUserAccountRequestId": "qierozie12345"
}

An example response looks like:


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

HTTP request

POST https://vgw.googleapis.com/gsp/partner-user-account-linking-v1/paymentMethodsUpdatedNotification/:PIAID

Request body

The request body contains data with the following structure:

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

object (RequestHeader)

REQUIRED: Common header for all requests.

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 (PaymentMethodsUpdatedNotificationResponse)
HTTP 4XX / 5XX Status

object (ErrorResponse)

PaymentMethodsUpdatedNotificationResponse

Response object for the paymentMethodsUpdatedNotification method.

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

object (ResponseHeader)

REQUIRED: Common header for all responses.
result

object (PaymentMethodsUpdatedNotificationResult)

REQUIRED: Result of this call.

PaymentMethodsUpdatedNotificationResult

Result codes for this call.

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: Contains the possible result types. Exactly one must be set. result can be only one of the following:
success

object (Empty)

The notification about updating the user's payment methods was successfully processed.