Used by Google to check with reseller whether a charge for purchase order is authorized. If the purchase order is originated from a subscription, declining the charge will also cancel the originating subscription, or deactivate the originating subscription line items.
Note: The POST URL shown here is for illustrative purpose only. This should be in the partner domain with same path as here.
HTTP request
POST https://paymentsresellersubscription.googleapis.com/v1/{parent=partners/*}/purchaseorders:authorizeCharge
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}". |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestId": string,
"purchaseOrder": {
object ( |
Fields | |
---|---|
requestId |
Required. A random UUID to uniquely identify the request. The idempotency key for the request. So in case of retries, requestId will be same as previous one. |
purchaseOrder |
Required. Details of the charge. |
Response body
If successful, the response body contains data with the following structure:
The reseller's determination as to whether the charge should be approved.
JSON representation |
---|
{
"authorizationResult": enum ( |
Fields | |
---|---|
authorizationResult |
Required. The reseller's authorization result for purchase order charge request. |
purchaseOrderId |
Required. Sets the id only if the authorization is approved. The id assigned by the partner for the authorized purchase order. The purchase order notification from Cloud pubsub notification message will contain the resource name with this id. |