CaptureEvent

  • This JSON object represents a payment where a customer is charged, linked to a capture, asynchronous capture, or redirect event.

  • It includes key details like capture request ID, payment integrator capture ID, event charge, and optional presentment details.

  • The object also outlines event fees, potentially broken down for reporting, and any applicable VAT, all impacting the final settlement value.

  • Amounts can be positive or negative, indicating the direction of monetary flow between Google and the payment integrator.

This represents a payment where a customer is charged. It is associated with a capture, asynchronousCaptureFundsReservation or beginRedirect event.

JSON representation 
{
  "captureRequestId": string,
  "paymentIntegratorCaptureId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}
Fields
captureRequestId

string

REQUIRED: requestId that was sent by Google for the capture event represented by this settlementEvent.
paymentIntegratorCaptureId

string

REQUIRED: An ID that is generated by the payment integrator that can be used to refer to this capture event.
eventCharge

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.
eventPresentmentDetails

object (EventPresentmentDetails)

OPTIONAL: If the settlement currency is different than the purchase currency then this field should be used to specify details about the event in the original purchase currency and the conversion to the settlement amount.
eventFee

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google. If the fee is broken down into several parts, this value is the sum of them and the amount settled. A breakdown of the fee can be specified in the eventFeeBreakdown.
eventFeeBreakdown

object (EventFeeBreakdown)

OPTIONAL: This is a breakdown of the eventFee. It is used for reporting purposes and is not factored into the settlementAmount. It is used to understand what parts of the eventFee are attributable to what sources.
eventVat

object (Amount)

REQUIRED: If this amount is negative then it represents monetary value moving from Google to the payment integrator. If this is positive it is money from the payment integrator due to Google.

This is the value-added-tax (VAT) for the eventFee. This amount is in addition to the fee. e.g. If the eventCharge is $2.00, the eventFee is -$0.20 and the eventVat is -$0.05 the total settlement value for this event would be $1.75.