MerchantPaymentMethod

  • The MerchantPaymentMethod object represents a payment method provided by a merchant or action, including details like ID, display information, and status.

  • Each payment method has a unique ID (paymentMethodId) and can belong to a group (paymentMethodGroup).

  • PaymentMethodDisplayInfo provides display details for the payment method.

  • PaymentMethodStatus indicates the current status of the payment method, including a user-facing message if needed.

Payment method provided by Merchant / Action.

JSON representation 
{
  "paymentMethodGroup": string,
  "paymentMethodId": string,
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodStatus": {
    object (PaymentMethodStatus)
  }
}
Fields
paymentMethodGroup

string

Optional. The group / profile name that the payment method belongs to.

paymentMethodId

string

Required. Id of the payment method passed from merchant / action. Note this id is should be unique if multiple payment methods are sent from Merchant/Action.

paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

Required. Display info of this payment method.

paymentMethodStatus

object (PaymentMethodStatus)

Optional. Status of the payment method. If not present, the payment method is assumed to be in OK status.

PaymentMethodStatus

Status of a payment method

JSON representation 
{
  "status": enum (Status),
  "statusMessage": string
}
Fields
status

enum (Status)
statusMessage

string

User facing message regarding the payment method status, i.e. "Expired". Only required when payment method requires fix or is inapplicable.