Content API for Shopping . orderpayments

Instance Methods

notifyauthapproved(merchantId=*, orderId=*, body=*)

Notify about successfully authorizing user's payment method for a given amount.

notifyauthdeclined(merchantId=*, orderId=*, body=*)

Notify about failure to authorize user's payment method.

notifycharge(merchantId=*, orderId=*, body=*)

Notify about charge on user's selected payments method.

notifyrefund(merchantId=*, orderId=*, body=*)

Notify about refund on user's selected payments method.

Method Details

notifyauthapproved(merchantId=*, orderId=*, body=*)
Notify about successfully authorizing user's payment method for a given amount.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  orderId: string, The ID of the order for for which payment authorization is happening. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "authAmountTax": { # Authorized amount for tax charge on user's credit card.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
    "authAmountPretax": { # Authorized amount for pre-tax charge on user's credit card.
      "currency": "A String", # The currency of the price.
      "value": "A String", # The price represented as a number.
    },
  }


Returns:
  An object of the form:

    {
    "kind": "content#orderpaymentsNotifyAuthApprovedResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthApprovedResponse".
    "executionStatus": "A String", # The status of the execution.
  }
notifyauthdeclined(merchantId=*, orderId=*, body=*)
Notify about failure to authorize user's payment method.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  orderId: string, The ID of the order for which payment authorization was declined. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "declineReason": "A String", # Reason why payment authorization was declined.
  }


Returns:
  An object of the form:

    {
    "kind": "content#orderpaymentsNotifyAuthDeclinedResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthDeclinedResponse".
    "executionStatus": "A String", # The status of the execution.
  }
notifycharge(merchantId=*, orderId=*, body=*)
Notify about charge on user's selected payments method.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  orderId: string, The ID of the order for which charge is happening. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "chargeState": "A String", # Whether charge was successful.
    "invoiceId": "A String", # Deprecated. Please use invoiceIds instead.
    "invoiceIds": [ # Invoice IDs from the orderinvoices service that correspond to the charge.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#orderpaymentsNotifyChargeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyChargeResponse".
    "executionStatus": "A String", # The status of the execution.
  }
notifyrefund(merchantId=*, orderId=*, body=*)
Notify about refund on user's selected payments method.

Args:
  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
  orderId: string, The ID of the order for which charge is happening. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "invoiceId": "A String", # Deprecated. Please use invoiceIds instead.
    "refundState": "A String", # Whether refund was successful.
    "invoiceIds": [ # Invoice IDs from the orderinvoices service that correspond to the refund.
      "A String",
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#orderpaymentsNotifyRefundResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyRefundResponse".
    "executionStatus": "A String", # The status of the execution.
  }