Orderpayments: notifyauthapproved

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

Request

HTTP request

POST https://www.googleapis.com/content/v2/merchantId/orderpayments/orderId/notifyAuthApproved

Parameters

Parameter name Value Description
Path parameters
merchantId unsigned long The ID of the account that manages the order. This cannot be a multi-client account.
orderId string The ID of the order for for which payment authorization is happening.

Authorization

This request requires authorization with the following scope:

Scope
https://www.googleapis.com/auth/content

For more information, see the authentication and authorization page.

Request body

In the request body, supply data with the following structure:

{
  "authAmountPretax": {
    "value": string,
    "currency": string
  },
  "authAmountTax": {
    "value": string,
    "currency": string
  }
}
Property name Value Description Notes
authAmountPretax nested object Authorized amount for pre-tax charge on user's credit card.
authAmountPretax.value string The price represented as a number. writable
authAmountPretax.currency string The currency of the price. writable
authAmountTax nested object Authorized amount for tax charge on user's credit card.
authAmountTax.value string The price represented as a number. writable
authAmountTax.currency string The currency of the price. writable

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "content#orderpaymentsNotifyAuthApprovedResponse",
  "executionStatus": string
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#orderpaymentsNotifyAuthApprovedResponse".
executionStatus string The status of the execution.

Acceptable values are:
  • "ok"