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."],[[["\u003cp\u003eThe JSON representation describes a payment where a customer is charged, linked to a capture, asynchronous capture funds reservation, or begin redirect event.\u003c/p\u003e\n"],["\u003cp\u003eIt includes fields like captureRequestId, paymentIntegratorCaptureId, eventCharge, eventPresentmentDetails, eventFee, eventFeeBreakdown, and eventVat, providing comprehensive payment details.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eeventCharge\u003c/code\u003e, \u003ccode\u003eeventFee\u003c/code\u003e, and \u003ccode\u003eeventVat\u003c/code\u003e represent monetary values, indicating the flow of funds between Google and the payment integrator.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eeventFeeBreakdown\u003c/code\u003e offers a detailed breakdown of the eventFee for reporting purposes, while \u003ccode\u003eeventPresentmentDetails\u003c/code\u003e handles currency conversions if needed.\u003c/p\u003e\n"],["\u003cp\u003eThis structure ensures transparent and detailed tracking of payment events and associated charges, fees, and VAT.\u003c/p\u003e\n"]]],["This payment event data includes details of a customer charge, tied to a `capture`, `asynchronousCaptureFundsReservation`, or `beginRedirect` action. Key information involves: `captureRequestId` and `paymentIntegratorCaptureId` as identifiers; `eventCharge`, `eventFee`, and `eventVat` that represent monetary values (negative values indicate money to the payment integrator, while positive values represent the money going to Google); `eventPresentmentDetails` which shows settlement details if the currency differes; and `eventFeeBreakdown` for a detailed breakdown of `eventFee`.\n"],null,["# CaptureEvent\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nThis represents a payment where a customer is charged. It is associated with a `capture`, `asynchronousCaptureFundsReservation` or `beginRedirect` event.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"captureRequestId\": string, \"paymentIntegratorCaptureId\": string, \"eventCharge\": { object (/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#Amount) }, \"eventPresentmentDetails\": { object (/pay/korea-cards-v1/google-korea-cards-api/EventPresentmentDetails) }, \"eventFee\": { object (/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#Amount) }, \"eventFeeBreakdown\": { object (/pay/korea-cards-v1/google-korea-cards-api/EventFeeBreakdown) }, \"eventVat\": { object (/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#Amount) } } ``` |\n\n| Fields ||\n|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `captureRequestId` | `string` **REQUIRED** : `requestId` that was sent by Google for the `capture` event represented by this `settlementEvent`. |\n| `paymentIntegratorCaptureId` | `string` **REQUIRED**: An ID that is generated by the payment integrator that can be used to refer to this capture event. |\n| `eventCharge` | `object (`[Amount](/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#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. |\n| `eventPresentmentDetails` | `object (`[EventPresentmentDetails](/pay/korea-cards-v1/google-korea-cards-api/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. |\n| `eventFee` | `object (`[Amount](/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#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`. |\n| `eventFeeBreakdown` | `object (`[EventFeeBreakdown](/pay/korea-cards-v1/google-korea-cards-api/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. |\n| `eventVat` | `object (`[Amount](/pay/korea-cards-v1/google-korea-cards-api/settlementNotification#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. |"]]