Method: settlementNotification

{
  "start": {
    object (Timestamp)
  },
  "end": {
    object (Timestamp)
  }
}

object (Timestamp)

REQUIRED: The start of this interval, which is inclusive.

object (Timestamp)

REQUIRED: The end of this interval, which is exclusive.

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

string

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

string

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

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.

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.

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.

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.

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.

{
  "presentmentAmount": {
    object (Amount)
  },
  "nanoExchangeRate": string
}

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.

The presentment amount of the purchase in the currency that was used for the purchase. This should only be specified if the purchase currency is different than the settlement currency.

string (Int64Value format)

REQUIRED: The exchange rate used in converting the presentment amount to the settlement (invoice) amount.

This value is in nano basis points (1 basis point = .0001 = .01%). That is, to get the exchange rate, divide this field by 10^13.

Example:

• $1 USD is €0.85 EUR.
• USD/EUR exchange rate is: 0.85
• USD/EUR exchange rate with 0.0001 basis point is: 0.85*10^(4)
• USD/EUR exchange rate with nano 0.0001 basis point is: 0.85*10^(13)
• USD/EUR exchange rate with nano 0.0001 basis point is: 8 500 000 000 000

{
  "feeDetails": [
    {
      object (FeeDetail)
    }
  ]
}

object (FeeDetail)

{
  "unitFee": {
    object (Amount)
  },
  "feeAssessmentSource": {
    object (FeeAssessmentSource)
  },
  "feeType": {
    object (FeeType)
  },
  "feeCategory": string,
  "feeSubCategory": string,
  "feeDescription": string
}

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.

The amount of the fee being described. This can be smaller than the minimum billible unit. The sum of all the unitFee should be close to the eventFee but might not be exact due to rounding or small values less than the minimum billible unit. Because of that, this value might not match the exact amount settled for the transaction. The eventFee should be used for the amount settled.

object (FeeAssessmentSource)

REQUIRED: The source that is assessing the fee.

object (FeeType)

REQUIRED: This is the type of the fee event. It might match the event type, but it doesn't have to. For example, an authorization fee might be assessed with a captureEvent.

string

REQUIRED: The category of the fee. e.g. Discount, Fee, etc.

string

REQUIRED: The category of the fee. e.g. Authorization, assessment, deposit, etc.

string

REQUIRED: A description of the fee. This field is not parsed by the system and is only for human consumption to better understand the fee.

{

  // Union field fee_assessment_source can be only one of the following:
  "scheme": {
    object (Empty)
  },
  "interchange": {
    object (InterchangeFee)
  },
  "contract": {
    object (Empty)
  }
  // End of list of possible types for union field fee_assessment_source.
}

object (Empty)

The fee is assessed by the scheme or network.

object (InterchangeFee)

The fee is assessed as part of the interchange fee.

object (Empty)

The fee is specified in the contract between Google and the payment integrator.

{
  "interchangeCode": string,
  "interchangeQualification": string
}

string

REQUIRED: The interchange fee code.

string

REQUIRED: The qualification of the interchange fee.

{

  // Union field fee_type can be only one of the following:
  "authorization": {
    object (Empty)
  },
  "capture": {
    object (Empty)
  },
  "refund": {
    object (Empty)
  },
  "chargeback": {
    object (Empty)
  },
  "reverseChargeback": {
    object (Empty)
  },
  "reverseRefund": {
    object (Empty)
  },
  "fxMarkup": {
    object (Empty)
  },
  "authReversal": {
    object (Empty)
  },
  "partialRefund": {
    object (Empty)
  }
  // End of list of possible types for union field fee_type.
}

object (Empty)

The fee is assessed as part of an authorization.

object (Empty)

The fee is assessed as part of a capture.

object (Empty)

The fee is assessed as part of a refund.

object (Empty)

The fee is assessed as part of a chargeback.

object (Empty)

The fee is assessed as part of a reverse chargeback.

object (Empty)

The fee is assessed as part of a reverse refund.

object (Empty)

The fee is assessed as part of an exchange rate markup.

object (Empty)

Fee associated with a reversal of an authorization event.

object (Empty)

Fee associated with a partial refund event.

{
  "asynchronousRefundRequestId": string,
  "paymentIntegratorRefundId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}

string

REQUIRED: requestId that was sent by Google for the asynchronousRefund request that this settlementEvent pertains to.

string

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

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.

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.

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.

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.

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.

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.

{
  "asynchronousRefundRequestId": string,
  "paymentIntegratorReverseRefundNotificationRequestId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}

string

REQUIRED: requestId that was sent by Google for the refund request that this reverseRefundEvent is reversing.

string

REQUIRED: This is the requestId generated by the payment integrator in the reversereRefundNotification request.

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.

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.

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.

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.

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.

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.

{
  "captureRequestId": string,
  "paymentIntegratorChargebackNotificationRequestId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}

string

REQUIRED: requestId that was sent by Google for the capture request that this settlementEvent pertains to.

string

REQUIRED: This is the requestId generated by the payment integrator in the chargebackNotification request.

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.

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.

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.

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.

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.

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.

{
  "captureRequestId": string,
  "paymentIntegratorReverseChargebackNotificationRequestId": string,
  "eventCharge": {
    object (Amount)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  },
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventVat": {
    object (Amount)
  }
}

string

REQUIRED: requestId that was sent by Google for the capture request that this settlementEvent pertains to.

string

REQUIRED: This is the requestId generated by the payment integrator in the reversereChargebackNotification request.

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.

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.

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.

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.

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.

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.

{
  "fundsReservationRequestId": string,
  "eventFee": {
    object (Amount)
  },
  "eventFeeBreakdown": {
    object (EventFeeBreakdown)
  },
  "eventPresentmentDetails": {
    object (EventPresentmentDetails)
  }
}

string

REQUIRED: requestId that was sent by Google for the reserveFunds request that this settlementEvent pertains to.

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.

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.

object (EventPresentmentDetails)

REQUIRED: Specify details about the funds reservation currency, amount and the conversion rate to the settlement currency.

{
  "adjustmentAmount": {
    object (Amount)
  },
  "adjustmentType": {
    object (AdjustmentType)
  }
}

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.

The amount of the adjustment that will be factored into the settlementAmount for this settlementNotificationRequest.

object (AdjustmentType)

REQUIRED: This provides more information about the adjustment.

{

  // Union field adjustment_type can be only one of the following:
  "aggregatedAuthorizationFees": {
    object (AggregatedFees)
  },
  "aggregatedChargebackFees": {
    object (AggregatedFees)
  },
  "aggregatedIntegrityFees": {
    object (AggregatedFees)
  },
  "aggregatedAuthorizationFeesVariance": {
    object (AggregatedFees)
  },
  "aggregatedChargebackFeesVariance": {
    object (AggregatedFees)
  },
  "aggregatedIntegrityFeesVariance": {
    object (AggregatedFees)
  },
  "chargebackThresholdFine": {
    object (Empty)
  },
  "miscellaneousAdjustment": {
    object (MiscellaneousAdjustment)
  },
  "eventFeesRounding": {
    object (Empty)
  },
  "aggregatedSchemeFees": {
    object (Empty)
  },
  "aggregatedGoodsServicesFees": {
    object (Empty)
  },
  "aggregatedSchemeFeesVariance": {
    object (Empty)
  }
  // End of list of possible types for union field adjustment_type.
}

object (AggregatedFees)

Credit card authorization fees aggregated over a period of time. This should only be used if those fees aren't provided at the transaction level via the eventFee field.

object (AggregatedFees)

Chargeback fees aggregated over a period of time. This should only be used if those fees can't be provided at the transaction level via the eventFee field.

object (AggregatedFees)

Aggregated integrity fees over a period of time. Integrity fees are imposed by a card network for transactions that were not 3DS-authenticated. This should only be used if those fees aren't provided at the transaction level via the eventFee field.

object (AggregatedFees)

Aggregate change in authorization fees due to updated rates or some other factor that was unknown when the authorization fees were originally set in the eventFee field with the transactions.

object (AggregatedFees)

Aggregate change in chargeback fees due to updated rates or some other factor that was unknown when the chargeback fees were originally set in the eventFee field with the transactions.

object (AggregatedFees)

Aggregate change in integrity fees due to updated rates or some other factor that was unknown when the integrity fees were originally set in the eventFee field with the transactions.

object (Empty)

Card networks (eg VISA, MC) have Dispute Monitoring Programs. A fine can be imposed by a card network for breaking a certain chargeback threshold in terms of a number of chargebacks per a period of time.

object (MiscellaneousAdjustment)

Miscellaneous type is used only when other types are not suitable. It is recommended to use miscellaneous type only occasionally and only in exceptional situations. Google will monitor for usage of this AdjustmentType and consider it a bug if a payment integrator uses this option systematically. If the existing adjustment types are not suitable, Google is willing to discuss adding a more targeted type.

object (Empty)

Used to account for adjustment in the rounding of event fees. If the event fees do not sum to a round number of billable units, then this value should be used to account for the rounding to billable units. It can be represented as sub-billable units. e.g. if the event fees sum to $10.053 USD and $10.06 would be the settlement amount than this can capture the missing $0.007 USD so it is accounted for. This amount can be larger than a single billable unit if the rounding is occurring in multiple places.

object (Empty)

Aggregate fees charged by the networks.

object (Empty)

Aggregate Goods and Service Tax.

object (Empty)

Aggregate fees variance charged by the networks due to updated rates or some other factor that was unknown when the scheme fees were originally set in the 'eventFee' field with the transactions.

{
  "numberOfEvents": string
}

string (Int64Value format)

Number of events (eg payments) that fees are aggregated across.

{
  "adjustmentDescription": string
}

string

REQUIRED: Adjustment description should clearly explain a nature and exceptional circumstances of the adjustment.

{
  "responseHeader": {
    object (ResponseHeader)
  },
  "result": {
    object (Result)
  }
}

object (ResponseHeader)

REQUIRED: Common header for all responses.

object (Result)

REQUIRED: Contains the result of the request.

{

  // Union field result can be only one of the following:
  "accepted": {
    object (Empty)
  }
  // End of list of possible types for union field result.
}

object (Empty)

The settlementNotification was valid and is now being processed by Google.