CaptureEvent
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["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 describes a payment charge event, linked to a capture or similar event. Key data includes `captureRequestId` (from Google) and `paymentIntegratorCaptureId` (integrator-generated). `eventCharge`, `eventFee`, and `eventVat` detail monetary transfers between Google and the payment integrator, with positive/negative values indicating direction. `eventPresentmentDetails` is provided if settlement differs from purchase currency. `eventFeeBreakdown` details the fee structure for reporting. All values are associated with the type `Amount`.\n"]]