Orderpayments: notifyrefund

Requires authorization

Notify about refund on user's selected payments method. Try it now.

Request

HTTP request

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

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 which charge is happening.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

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

{
  "invoiceIds": [
    string
  ],
  "refundState": string
}
Property name Value Description Notes
refundState string Whether refund was successful.

Acceptable values are:
  • "failed"
  • "refunded"
invoiceIds[] list Invoice IDs from the orderinvoices service that correspond to the refund.

Response

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

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

Acceptable values are:
  • "ok"

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Content API for Shopping