- [JSON representation](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#SCHEMA_REPRESENTATION)
- [SettlementEntryType](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#SettlementEntryType)
  - [JSON representation](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#SettlementEntryType.SCHEMA_REPRESENTATION)
- [RefundEvent](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#RefundEvent)
  - [JSON representation](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#RefundEvent.SCHEMA_REPRESENTATION)
- [ReverseRefundEvent](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseRefundEvent)
  - [JSON representation](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseRefundEvent.SCHEMA_REPRESENTATION)
- [ReverseChargebackEvent](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseChargebackEvent)
  - [JSON representation](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseChargebackEvent.SCHEMA_REPRESENTATION)
- [MiscellaneousAdjustment](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#MiscellaneousAdjustment)
  - [JSON representation](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#MiscellaneousAdjustment.SCHEMA_REPRESENTATION)

Represents an individual settlement line item in a settlement file provided by the payment integrator to settle transactions for GSP cards.

| JSON representation |
|---|
| ``` { "entryId": string, "settlementEntryType": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#SettlementEntryType`) } } ``` |

| Fields ||
|---|---|
| `entryId` | `string (https://developers.google.com/discovery/v1/type-format format)` **REQUIRED**: A non-zero and non-negative number within the settlement file that uniquely identifies a settlement line. |
| `settlementEntryType` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#SettlementEntryType`)`` **REQUIRED**: The type of the settlement entry. |

## SettlementEntryType

The type of settlement entry.

| JSON representation |
|---|
| ``` { // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "captureEvent": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/CaptureEvent`) }, "refundEvent": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#RefundEvent`) }, "reverseRefundEvent": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseRefundEvent`) }, "chargebackEvent": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ChargebackEvent`) }, "reverseChargebackEvent": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseChargebackEvent`) }, "fundsReservationEvent": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/FundsReservationEvent`) }, "aggregateAdjustment": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/AggregateAdjustment`) }, "miscellaneousAdjustment": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#MiscellaneousAdjustment`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| **REQUIRED**: Represents a single event in this settlement file. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `captureEvent` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/CaptureEvent`)`` Details surrounding a capture event that is being settled. |
| `refundEvent` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#RefundEvent`)`` Details surrounding a refund event that is being settled. |
| `reverseRefundEvent` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseRefundEvent`)`` Details surrounding a reverse refund event that is being settled. |
| `chargebackEvent` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ChargebackEvent`)`` Details surrounding a chargeback event that is being settled. |
| `reverseChargebackEvent` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#ReverseChargebackEvent`)`` Details surrounding a reverse chargeback event that is bing settled. |
| `fundsReservationEvent` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/FundsReservationEvent`)`` Details surrounding a funds reservation event that is being settled. |
| `aggregateAdjustment` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/AggregateAdjustment`)`` Details surrounding a aggregate adjustment event that is being settled. |
| `miscellaneousAdjustment` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspCardSettlementEntry#MiscellaneousAdjustment`)`` Details surrounding a miscellaneous adjustment that is being settled any usages of this type should be communicated with Google prior to usage. |
| End of mutually exclusive fields. ||

## RefundEvent

This represents a refund where money is being returned to a customer. It will be associated with a `refund` event.

| JSON representation |
|---|
| ``` { "asynchronousRefundRequestId": string, "paymentIntegratorRefundId": string, "eventCharge": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "eventPresentmentDetails": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/EventPresentmentDetails`) }, "eventFee": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "eventFeeBreakdown": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/EventFeeBreakdown`) }, "eventVat": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "argentinaTaxes": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ArgentinaTaxes`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `asynchronousRefundRequestId` | `string` **REQUIRED** : `requestId` that was sent by Google for the `asynchronousRefund` request that this `settlementEvent` pertains to. |
| `paymentIntegratorRefundId` | `string` **REQUIRED**: An ID that is generated by the payment integrator that can be used to refer to this refund event. |
| `eventCharge` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventPresentmentDetails` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventFee` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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`. For example, if an agreement says that Google will pay 1% of the `eventCharge` to the payment integrator, and will reverse that 1% upon refund of that transaction, then the capture fee will be negative and upon refund the refund fee will be positive. |
| `eventFeeBreakdown` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventVat` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| **OPTIONAL**: Regional withholding taxes applied to this event. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `argentinaTaxes` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ArgentinaTaxes`)`` Argentina specific withholding taxes. |
| End of mutually exclusive fields. ||

## ReverseRefundEvent

This represents a reverse refund. It is associated with a `reverseRefundNotification` and typically is used when a refund was performed but the issuing bank was unable to return funds to the customer, so they are being returned to Google.

| JSON representation |
|---|
| ``` { "asynchronousRefundRequestId": string, "paymentIntegratorReverseRefundNotificationRequestId": string, "eventCharge": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "eventPresentmentDetails": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/EventPresentmentDetails`) }, "eventFee": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "eventFeeBreakdown": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/EventFeeBreakdown`) }, "eventVat": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "argentinaTaxes": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ArgentinaTaxes`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `asynchronousRefundRequestId` | `string` **REQUIRED** : `requestId` that was sent by Google for the `refund` request that this `reverseRefundEvent` is reversing. |
| `paymentIntegratorReverseRefundNotificationRequestId` | `string` **REQUIRED** : This is the `requestId` generated by the payment integrator in the `reversereRefundNotification` request. |
| `eventCharge` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventPresentmentDetails` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventFee` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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`. For example, if an agreement says that Google will pay 1% of the `eventCharge` to the payment integrator, and will reverse that 1% upon refund of that transaction, then the capture fee will be negative and upon refund the refund fee will be positive. |
| `eventFeeBreakdown` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventVat` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| **OPTIONAL**: Regional withholding taxes applied to this event. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `argentinaTaxes` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ArgentinaTaxes`)`` Argentina specific withholding taxes. |
| End of mutually exclusive fields. ||

## ReverseChargebackEvent

This represents a reverse chargeback. It is associated with a `reverseChargebackNotification` and is used when Google successfully disputes a `chargebackNotification`. The funds are being returned to Google.

| JSON representation |
|---|
| ``` { "captureRequestId": string, "paymentIntegratorReverseChargebackNotificationRequestId": string, "eventCharge": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "eventPresentmentDetails": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/EventPresentmentDetails`) }, "eventFee": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "eventFeeBreakdown": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/EventFeeBreakdown`) }, "eventVat": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "argentinaTaxes": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ArgentinaTaxes`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `captureRequestId` | `string` **REQUIRED** : `requestId` that was sent by Google for the `capture` request that this `settlementEvent` pertains to. |
| `paymentIntegratorReverseChargebackNotificationRequestId` | `string` **REQUIRED** : This is the `requestId` generated by the payment integrator in the `reversereChargebackNotification` request. |
| `eventCharge` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventPresentmentDetails` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventFee` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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`. For example, if an agreement says that Google will pay 1% of the `eventCharge` to the payment integrator, and will reverse that 1% upon refund of that transaction, then the capture fee will be negative and upon refund the refund fee will be positive. |
| `eventFeeBreakdown` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| `eventVat` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. |
| **OPTIONAL**: Regional withholding taxes applied to this event. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `argentinaTaxes` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/ArgentinaTaxes`)`` Argentina specific withholding taxes. |
| End of mutually exclusive fields. ||

## MiscellaneousAdjustment

Miscellaneous Adjustments should only be used in exceptional situations when no other entries are suitable to represent money movement. Google will monitor the usage of this type of entry and consider it a bug if it's used systematically.

| JSON representation |
|---|
| ``` { "adjustmentDescription": string, "adjustmentAmount": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) } } ``` |

| Fields ||
|---|---|
| `adjustmentDescription` | `string` **REQUIRED**: Adjustment description should clearly explain the nature and exceptional circumstances of the adjustment. |
| `adjustmentAmount` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-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. The amount of the adjustment that will be factored into the `settlementAmount` for this `settlementNotificationRequest`. |