MerchantPaymentMethod

  • The content describes the MerchantPaymentMethod object used for payment methods provided by a Merchant or Action.

  • The MerchantPaymentMethod object includes fields for paymentMethodGroup , paymentMethodId , paymentMethodDisplayInfo , and paymentMethodStatus .

  • The paymentMethodId is a required and unique identifier passed from the merchant or action.

  • PaymentMethodStatus indicates the status of a payment method, including a status enum and an optional user-facing message.

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.

Design a Mobile Site
View Site in Mobile | Classic
Share by: