use serde::{Deserialize, Serialize};
use serde_json::Value;
use crate::core::models::common::ProcessorCostEstimateBasis;
use crate::core::money::Money;
pub type SettlementPayoutStatus = String;
pub type ConnectorOwnership = String;
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementBucket {
#[serde(default)]
pub connector: Option<String>,
pub ownership: ConnectorOwnership,
pub currency: String,
pub gross_amount: i64,
#[serde(default)]
pub platform_fee_amount: i64,
#[serde(default)]
pub platform_fee_incomplete: bool,
pub merchant_fee_amount: i64,
pub refund_amount: i64,
pub net_to_shop: i64,
pub line_count: i64,
pub refund_count: i64,
#[serde(default)]
pub fee_percentage: Option<String>,
#[serde(default)]
pub fee_flat_amount: Option<i64>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl SettlementBucket {
#[must_use]
pub fn gross(&self) -> Money {
Money::new(self.gross_amount, &self.currency)
}
#[must_use]
pub fn merchant_fee(&self) -> Money {
Money::new(self.merchant_fee_amount, &self.currency)
}
#[must_use]
pub fn refund(&self) -> Money {
Money::new(self.refund_amount, &self.currency)
}
#[must_use]
pub fn net(&self) -> Money {
Money::new(self.net_to_shop, &self.currency)
}
#[must_use]
pub fn platform_fee(&self) -> Money {
Money::new(self.platform_fee_amount, &self.currency)
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct FeeStatementSummary {
pub id: String,
pub merchant_id: String,
pub profile_id: String,
pub period_start: String,
pub period_end: String,
pub test_mode: bool,
pub gross_usd: i64,
#[serde(default)]
pub platform_fee_usd: i64,
pub merchant_fee_usd: i64,
pub refund_usd: i64,
#[serde(default)]
pub reversal_usd: i64,
#[serde(default)]
pub dispute_debit_usd: i64,
#[serde(default)]
pub dispute_recovery_usd: i64,
#[serde(default)]
pub reversal_count: i64,
#[serde(default)]
pub processor_cost_passthrough_usd: i64,
#[serde(default)]
pub processor_cost_passthrough_incomplete: bool,
pub net_to_shop_usd: i64,
pub line_count: i64,
pub refund_count: i64,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(default)]
pub platform_fee_incomplete: bool,
#[serde(default)]
pub includes_backfill: bool,
pub payout_status: SettlementPayoutStatus,
#[serde(default)]
pub paid_amount_usd: i64,
#[serde(default)]
pub paid_at: Option<String>,
#[serde(default)]
pub payout_note: Option<String>,
pub generated_at: String,
#[serde(default)]
pub adjustments_usd: i64,
#[serde(default)]
pub net_after_adjustments_usd: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl FeeStatementSummary {
#[must_use]
pub fn payable(&self) -> Money {
Money::new(self.net_after_adjustments_usd, "USD")
}
#[must_use]
pub fn gross(&self) -> Money {
Money::new(self.gross_usd, "USD")
}
#[must_use]
pub fn merchant_fee(&self) -> Money {
Money::new(self.merchant_fee_usd, "USD")
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct FeeStatementDetail {
#[serde(flatten)]
pub summary: FeeStatementSummary,
#[serde(default)]
pub breakdown: Vec<SettlementBucket>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementStatementListResponse {
#[serde(default)]
pub statements: Vec<FeeStatementSummary>,
#[serde(default)]
pub total_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ShopSettlementOverview {
pub profile_id: String,
#[serde(default)]
pub profile_name: Option<String>,
#[serde(default)]
pub unpaid_net_usd: i64,
#[serde(default)]
pub unpaid_statement_count: i64,
#[serde(default)]
pub current_period_net_usd: i64,
#[serde(default)]
pub current_period_advances_usd: i64,
#[serde(default)]
pub current_period_still_accruing_usd: i64,
#[serde(default)]
pub current_period_merchant_fee_usd: i64,
#[serde(default)]
pub current_period_gross_usd: i64,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(default)]
pub has_fee_config: bool,
#[serde(default)]
pub visible_to_shop: bool,
#[serde(default)]
pub processor_cost_passthrough: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementOverviewResponse {
#[serde(default)]
pub shops: Vec<ShopSettlementOverview>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementCurrentResponse {
pub period_start: String,
pub period_end: String,
pub test_mode: bool,
#[serde(default)]
pub gross_usd: i64,
#[serde(default)]
pub platform_fee_usd: i64,
#[serde(default)]
pub merchant_fee_usd: i64,
#[serde(default)]
pub refund_usd: i64,
#[serde(default)]
pub reversal_usd: i64,
#[serde(default)]
pub dispute_debit_usd: i64,
#[serde(default)]
pub dispute_recovery_usd: i64,
#[serde(default)]
pub reversal_count: i64,
#[serde(default)]
pub processor_cost_passthrough_usd: i64,
#[serde(default)]
pub processor_cost_passthrough_incomplete: bool,
#[serde(default)]
pub net_to_shop_usd: i64,
#[serde(default)]
pub line_count: i64,
#[serde(default)]
pub refund_count: i64,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(default)]
pub platform_fee_incomplete: bool,
#[serde(default)]
pub advances_usd: i64,
#[serde(default)]
pub still_accruing_usd: i64,
#[serde(default)]
pub advance_excess_usd: i64,
#[serde(default)]
pub breakdown: Vec<SettlementBucket>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct StatementAdjustment {
pub id: String,
pub label: String,
pub amount_usd: i64,
pub created_at: String,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl StatementAdjustment {
#[must_use]
pub fn amount(&self) -> Money {
Money::new(self.amount_usd, "USD")
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct StatementAdjustmentListResponse {
#[serde(default)]
pub adjustments: Vec<StatementAdjustment>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementLine {
pub payment_id: String,
pub attempt_id: String,
#[serde(default)]
pub connector: Option<String>,
pub connector_ownership: ConnectorOwnership,
#[serde(default)]
pub payment_method: Option<String>,
#[serde(default)]
pub payment_method_type: Option<String>,
pub currency: String,
pub gross_amount: i64,
#[serde(default)]
pub platform_fee_amount: Option<i64>,
pub merchant_fee_amount: i64,
pub net_to_shop: i64,
pub merchant_fee_source: String,
#[serde(default)]
pub platform_fee_source: Option<String>,
pub merchant_ledger_outcome: String,
pub test_mode: bool,
#[serde(default)]
pub backfilled: bool,
pub transaction_at: String,
#[serde(default)]
pub processor_cost_basis: Option<ProcessorCostEstimateBasis>,
#[serde(default)]
pub processor_cost_passthrough_basis: Option<ProcessorCostEstimateBasis>,
#[serde(default)]
pub connector_method_code: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl SettlementLine {
#[must_use]
pub fn gross(&self) -> Money {
Money::new(self.gross_amount, &self.currency)
}
#[must_use]
pub fn merchant_fee(&self) -> Money {
Money::new(self.merchant_fee_amount, &self.currency)
}
#[must_use]
pub fn net(&self) -> Money {
Money::new(self.net_to_shop, &self.currency)
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementLineListResponse {
#[serde(default)]
pub lines: Vec<SettlementLine>,
#[serde(default)]
pub total_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ShopFeeConfigEntry {
pub schedule_id: String,
#[serde(default)]
pub connector: Option<String>,
#[serde(default)]
pub profile_specific: bool,
pub fee_type: String,
#[serde(default)]
pub percentage_fee: Option<f64>,
#[serde(default)]
pub flat_fee_amount: Option<i64>,
#[serde(default)]
pub flat_fee_currency: Option<String>,
#[serde(default)]
pub min_fee_amount: Option<i64>,
#[serde(default)]
pub max_fee_amount: Option<i64>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl ShopFeeConfigEntry {
#[must_use]
pub fn flat_fee(&self) -> Option<Money> {
match (self.flat_fee_amount, self.flat_fee_currency.as_deref()) {
(Some(amount), Some(currency)) => Some(Money::new(amount, currency)),
_ => None,
}
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ShopFeeConfigResponse {
pub profile_id: String,
#[serde(default)]
pub schedules: Vec<ShopFeeConfigEntry>,
#[serde(default)]
pub processor_cost_passthrough: bool,
#[serde(default)]
pub consent_required: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementBackfillResponse {
pub enqueued: bool,
pub job_id: String,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ShopVisibilityResponse {
pub profile_id: String,
pub visible_to_shop: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[cfg(test)]
mod tests {
use super::*;
const BUCKET_JSON: &str = r#"{
"connector": "stripe",
"ownership": "host",
"currency": "JPY",
"gross_amount": 1999,
"platform_fee_amount": 20,
"platform_fee_incomplete": true,
"merchant_fee_amount": 200,
"refund_amount": 0,
"net_to_shop": 1799,
"line_count": 3,
"refund_count": 0,
"fee_percentage": "10",
"fee_flat_amount": 0,
"surprise_field": 1
}"#;
#[test]
fn bucket_amounts_carry_their_own_currency() {
let bucket: SettlementBucket = serde_json::from_str(BUCKET_JSON).unwrap();
assert_eq!(bucket.gross().to_major_string().as_deref(), Some("1999"));
assert_eq!(bucket.net().to_major_string().as_deref(), Some("1799"));
assert_eq!(bucket.merchant_fee().amount, 200);
assert!(bucket.platform_fee_incomplete);
assert_eq!(bucket.extra["surprise_field"], 1);
}
#[test]
fn statement_detail_flattens_the_summary_beside_the_breakdown() {
let json = format!(
r#"{{
"id": "stmt_1",
"merchant_id": "mer_1",
"profile_id": "pro_1",
"period_start": "2026-07-01T00:00:00Z",
"period_end": "2026-08-01T00:00:00Z",
"test_mode": false,
"gross_usd": 100000,
"platform_fee_usd": 1000,
"merchant_fee_usd": 15000,
"refund_usd": 0,
"net_to_shop_usd": 85000,
"line_count": 12,
"refund_count": 0,
"payout_status": "unpaid",
"generated_at": "2026-08-01T00:20:00Z",
"adjustments_usd": 5000,
"net_after_adjustments_usd": 80000,
"breakdown": [{BUCKET_JSON}]
}}"#
);
let detail: FeeStatementDetail = serde_json::from_str(&json).unwrap();
assert_eq!(detail.summary.id, "stmt_1");
assert_eq!(detail.breakdown.len(), 1);
assert_eq!(
detail.summary.payable().to_major_string().as_deref(),
Some("800.00")
);
assert_eq!(detail.summary.net_to_shop_usd, 85000);
assert!(!detail.summary.extra.contains_key("breakdown"));
}
#[test]
fn statement_defaults_absent_flags_to_false() {
let json = r#"{
"id": "stmt_1",
"merchant_id": "mer_1",
"profile_id": "pro_1",
"period_start": "2026-07-01T00:00:00Z",
"period_end": "2026-08-01T00:00:00Z",
"test_mode": true,
"gross_usd": 0,
"platform_fee_usd": 0,
"merchant_fee_usd": 0,
"refund_usd": 0,
"net_to_shop_usd": 0,
"line_count": 0,
"refund_count": 0,
"payout_status": "unpaid",
"generated_at": "2026-08-01T00:20:00Z"
}"#;
let summary: FeeStatementSummary = serde_json::from_str(json).unwrap();
assert!(!summary.platform_fee_incomplete);
assert!(!summary.fx_incomplete);
assert_eq!(summary.adjustments_usd, 0);
}
#[test]
fn a_redacted_bucket_and_summary_still_decode() {
let bucket: SettlementBucket = serde_json::from_str(
r#"{"ownership":"shop","currency":"EUR","gross_amount":1999,
"merchant_fee_amount":200,"refund_amount":0,"net_to_shop":1799,
"line_count":1,"refund_count":0}"#,
)
.unwrap();
assert_eq!(bucket.platform_fee_amount, 0);
let summary: FeeStatementSummary = serde_json::from_str(
r#"{"id":"stmt_1","merchant_id":"mer_1","profile_id":"pro_1",
"period_start":"2026-07-01T00:00:00Z","period_end":"2026-08-01T00:00:00Z",
"test_mode":false,"gross_usd":100000,"merchant_fee_usd":15000,
"refund_usd":0,"net_to_shop_usd":85000,"line_count":12,"refund_count":0,
"payout_status":"unpaid","generated_at":"2026-08-01T00:20:00Z"}"#,
)
.unwrap();
assert_eq!(summary.platform_fee_usd, 0);
assert_eq!(summary.net_to_shop_usd, 85000);
assert_eq!(summary.merchant_fee_usd, 15000);
}
#[test]
fn adjustment_amount_keeps_its_sign() {
let json = r#"{
"id": "adj_1",
"label": "Goodwill credit",
"amount_usd": -2500,
"created_at": "2026-08-02T10:00:00Z"
}"#;
let adjustment: StatementAdjustment = serde_json::from_str(json).unwrap();
assert_eq!(
adjustment.amount().to_major_string().as_deref(),
Some("-25.00")
);
}
#[test]
fn line_redaction_is_visible_as_an_absent_source() {
let json = r#"{
"payment_id": "pay_1",
"attempt_id": "pay_1_1",
"connector_ownership": "shop",
"currency": "EUR",
"gross_amount": 1999,
"merchant_fee_amount": 200,
"net_to_shop": 1799,
"merchant_fee_source": "schedule",
"merchant_ledger_outcome": "deducted",
"test_mode": false,
"transaction_at": "2026-07-15T12:00:00Z"
}"#;
let line: SettlementLine = serde_json::from_str(json).unwrap();
assert_eq!(line.platform_fee_source, None);
assert_eq!(line.platform_fee_amount, None);
assert_eq!(line.gross().to_major_string().as_deref(), Some("19.99"));
assert!(line.processor_cost_basis.is_none());
}
#[test]
fn line_decodes_a_null_platform_fee() {
let line: SettlementLine = serde_json::from_str(
r#"{"payment_id":"pay_1","attempt_id":"pay_1_1","connector_ownership":"shop",
"currency":"EUR","gross_amount":1999,"platform_fee_amount":null,
"merchant_fee_amount":200,"net_to_shop":1799,"merchant_fee_source":"schedule",
"merchant_ledger_outcome":"deducted","test_mode":false,
"transaction_at":"2026-07-15T12:00:00Z"}"#,
)
.unwrap();
assert_eq!(line.platform_fee_amount, None);
let host: SettlementLine = serde_json::from_str(
r#"{"payment_id":"pay_1","attempt_id":"pay_1_1","connector_ownership":"host",
"currency":"EUR","gross_amount":1999,"platform_fee_amount":40,
"merchant_fee_amount":200,"net_to_shop":1799,"merchant_fee_source":"schedule",
"platform_fee_source":"schedule","merchant_ledger_outcome":"deducted",
"test_mode":false,"transaction_at":"2026-07-15T12:00:00Z"}"#,
)
.unwrap();
assert_eq!(host.platform_fee_amount, Some(40));
}
#[test]
fn line_decodes_the_processor_cost_bases() {
let line: SettlementLine = serde_json::from_str(
r#"{"payment_id":"pay_1","attempt_id":"pay_1_1","connector_ownership":"shop",
"currency":"EUR","gross_amount":1999,"merchant_fee_amount":200,
"net_to_shop":1799,"merchant_fee_source":"schedule",
"merchant_ledger_outcome":"deducted","test_mode":false,
"transaction_at":"2026-07-15T12:00:00Z","connector_method_code":"ideal",
"processor_cost_basis":{"schedule_id":"pcs_1","merchant_scoped":true,
"percentage":0.29,"flat_amount":25,"flat_currency":"EUR",
"effective_from":"2026-01-01T00:00:00Z","payment_method_type":"ideal"},
"processor_cost_passthrough_basis":{"schedule_id":"pcs_2",
"merchant_scoped":false,"effective_from":"2026-01-01T00:00:00Z"}}"#,
)
.unwrap();
let basis = line.processor_cost_basis.as_ref().unwrap();
assert!(basis.merchant_scoped);
assert_eq!(basis.flat_amount, Some(25));
assert_eq!(
line.processor_cost_passthrough_basis
.as_ref()
.unwrap()
.schedule_id,
"pcs_2"
);
assert_eq!(line.connector_method_code.as_deref(), Some("ideal"));
}
#[test]
fn flat_fee_needs_both_halves() {
let with_currency: ShopFeeConfigEntry = serde_json::from_str(
r#"{"schedule_id":"fee_1","fee_type":"merchant","flat_fee_amount":30,
"flat_fee_currency":"USD"}"#,
)
.unwrap();
assert_eq!(
with_currency
.flat_fee()
.unwrap()
.to_major_string()
.as_deref(),
Some("0.30")
);
let without_currency: ShopFeeConfigEntry = serde_json::from_str(
r#"{"schedule_id":"fee_1","fee_type":"merchant","flat_fee_amount":30}"#,
)
.unwrap();
assert_eq!(without_currency.flat_fee(), None);
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct StatementPayout {
pub id: String,
#[serde(default)]
pub amount_usd: i64,
#[serde(default)]
pub original_amount: Option<i64>,
#[serde(default)]
pub original_currency: Option<String>,
#[serde(default)]
pub value_date: Option<String>,
#[serde(default)]
pub method: Option<String>,
#[serde(default)]
pub reference: Option<String>,
#[serde(default)]
pub note: Option<String>,
#[serde(default)]
pub source: Option<String>,
#[serde(default)]
pub created_at: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct StatementPayoutListResponse {
#[serde(default = "Vec::new")]
pub payouts: Vec<StatementPayout>,
#[serde(default)]
pub total_usd: i64,
#[serde(default)]
pub overpaid_usd: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct StatementAdvance {
pub id: String,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub period_start: Option<String>,
#[serde(default)]
pub period_end: Option<String>,
#[serde(default)]
pub test_mode: Option<bool>,
#[serde(default)]
pub amount_usd: i64,
#[serde(default)]
pub original_amount: Option<i64>,
#[serde(default)]
pub original_currency: Option<String>,
#[serde(default)]
pub value_date: Option<String>,
#[serde(default)]
pub method: Option<String>,
#[serde(default)]
pub reference: Option<String>,
#[serde(default)]
pub note: Option<String>,
#[serde(default)]
pub source: Option<String>,
#[serde(default)]
pub statement_id: Option<String>,
#[serde(default)]
pub attached_at: Option<String>,
#[serde(default)]
pub created_at: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementAdvanceListResponse {
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub period_start: Option<String>,
#[serde(default)]
pub period_end: Option<String>,
#[serde(default)]
pub test_mode: Option<bool>,
#[serde(default = "Vec::new")]
pub advances: Vec<StatementAdvance>,
#[serde(default)]
pub total_usd: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostEventSource {
#[serde(default)]
pub source_kind: Option<String>,
#[serde(default)]
pub source_id: Option<String>,
#[serde(default)]
pub payment_id: Option<String>,
#[serde(default)]
pub attempt_id: Option<String>,
#[serde(default)]
pub connector: Option<String>,
#[serde(default)]
pub merchant_connector_id: Option<String>,
#[serde(default)]
pub payment_method: Option<String>,
#[serde(default)]
pub payment_method_type: Option<String>,
#[serde(default)]
pub source_status: Option<String>,
#[serde(default)]
pub source_created_at: Option<String>,
#[serde(default)]
pub test_mode: Option<bool>,
#[serde(default)]
pub cost_source: Option<String>,
#[serde(default)]
pub unavailable_reason: Option<String>,
#[serde(default)]
pub complete: Option<bool>,
#[serde(default)]
pub refreshable: Option<bool>,
#[serde(default)]
pub checked_at: Option<String>,
#[serde(default = "Vec::new")]
pub events: Vec<ProcessorFeeMovement>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorFeeMovement {
#[serde(default)]
pub provider_event_id: Option<String>,
#[serde(default)]
pub amount: i64,
#[serde(default)]
pub currency: Option<String>,
#[serde(default)]
pub exponent: Option<i64>,
#[serde(default)]
pub event_at: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostEventsResponse {
#[serde(default = "Vec::new")]
pub data: Vec<ProcessorCostEventSource>,
#[serde(default)]
pub total_count: i64,
#[serde(default)]
pub has_more: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
pub type NativeMinor = String;
pub type NativeSettlementQuality = String;
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct NativeSettlementTerms {
pub profile_id: String,
pub currency: String,
pub from: String,
pub to: String,
pub test_mode: bool,
pub hosting_rate_pct: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub reserve_rate_pct: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub include_open_disputes: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub fee_basis: Option<String>,
}
impl NativeSettlementTerms {
pub fn new(
profile_id: impl Into<String>,
currency: impl Into<String>,
from: impl Into<String>,
to: impl Into<String>,
test_mode: bool,
hosting_rate_pct: impl Into<String>,
) -> Self {
Self {
profile_id: profile_id.into(),
currency: currency.into(),
from: from.into(),
to: to.into(),
test_mode,
hosting_rate_pct: hosting_rate_pct.into(),
reserve_rate_pct: None,
include_open_disputes: None,
fee_basis: None,
}
}
#[must_use]
pub fn reserve_rate_pct(mut self, reserve_rate_pct: impl Into<String>) -> Self {
self.reserve_rate_pct = Some(reserve_rate_pct.into());
self
}
#[must_use]
pub fn include_open_disputes(mut self, include: bool) -> Self {
self.include_open_disputes = Some(include);
self
}
#[must_use]
pub fn fee_basis(mut self, fee_basis: impl Into<String>) -> Self {
self.fee_basis = Some(fee_basis.into());
self
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementFeeTerm {
#[serde(default)]
pub known_amount_minor: Option<NativeMinor>,
#[serde(default)]
pub estimated_amount_minor: Option<NativeMinor>,
#[serde(default)]
pub applied_amount_minor: Option<NativeMinor>,
#[serde(default)]
pub observed_source_count: i64,
#[serde(default)]
pub estimated_source_count: i64,
#[serde(default)]
pub incomplete_source_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementTotals {
#[serde(default)]
pub gross_minor: Option<NativeMinor>,
#[serde(default)]
pub hosting_fee_minor: Option<NativeMinor>,
#[serde(default)]
pub payment_fees: Option<NativeSettlementFeeTerm>,
#[serde(default)]
pub refund_minor: Option<NativeMinor>,
#[serde(default)]
pub refund_fees: Option<NativeSettlementFeeTerm>,
#[serde(default)]
pub reversal_minor: Option<NativeMinor>,
#[serde(default)]
pub settled_dispute_minor: Option<NativeMinor>,
#[serde(default)]
pub open_dispute_minor: Option<NativeMinor>,
#[serde(default)]
pub applied_dispute_minor: Option<NativeMinor>,
#[serde(default)]
pub dispute_fees: Option<NativeSettlementFeeTerm>,
#[serde(default)]
pub owed_minor: Option<NativeMinor>,
#[serde(default)]
pub reserve_minor: Option<NativeMinor>,
#[serde(default)]
pub payable_minor: Option<NativeMinor>,
#[serde(default)]
pub paid_minor: Option<NativeMinor>,
#[serde(default)]
pub outstanding_minor: Option<NativeMinor>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementFeeComponent {
#[serde(default)]
pub kind: Option<String>,
#[serde(default)]
pub description: Option<String>,
#[serde(default)]
pub amount_minor: Option<NativeMinor>,
#[serde(default)]
pub currency: Option<String>,
#[serde(default)]
pub exponent: Option<i64>,
#[serde(default)]
pub included_in_total: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementFeeEvidence {
#[serde(default)]
pub provider_event_id: Option<String>,
#[serde(default)]
pub basis: Option<String>,
#[serde(default)]
pub amount_minor: Option<NativeMinor>,
#[serde(default)]
pub currency: Option<String>,
#[serde(default)]
pub exponent: Option<i64>,
#[serde(default)]
pub category: Option<String>,
#[serde(default)]
pub native_amount_minor: Option<NativeMinor>,
#[serde(default)]
pub provider_fx_rate: Option<String>,
#[serde(default)]
pub fx_provenance: Option<String>,
#[serde(default)]
pub processor_amount_minor: Option<NativeMinor>,
#[serde(default)]
pub application_amount_minor: Option<NativeMinor>,
#[serde(default)]
pub classification_complete: bool,
#[serde(default)]
pub overlap_uncertain: bool,
#[serde(default = "Vec::new")]
pub components: Vec<NativeSettlementFeeComponent>,
#[serde(default)]
pub event_at: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementSource {
#[serde(default)]
pub source_kind: Option<String>,
#[serde(default)]
pub source_id: Option<String>,
#[serde(default)]
pub payment_id: Option<String>,
#[serde(default)]
pub attempt_id: Option<String>,
#[serde(default)]
pub connector: Option<String>,
#[serde(default)]
pub connector_label: Option<String>,
#[serde(default)]
pub merchant_connector_id: Option<String>,
#[serde(default)]
pub provider_source_id: Option<String>,
#[serde(default)]
pub payment_method: Option<String>,
#[serde(default)]
pub status: Option<String>,
#[serde(default)]
pub capture_final: bool,
#[serde(default)]
pub amount_minor: Option<NativeMinor>,
#[serde(default)]
pub applied_principal_minor: Option<NativeMinor>,
#[serde(default)]
pub known_fee_minor: Option<NativeMinor>,
#[serde(default)]
pub estimated_fee_minor: Option<NativeMinor>,
#[serde(default)]
pub applied_fee_minor: Option<NativeMinor>,
#[serde(default)]
pub cost_source: Option<String>,
#[serde(default)]
pub fee_complete: bool,
#[serde(default)]
pub unavailable_reason: Option<String>,
#[serde(default)]
pub created_at: Option<String>,
#[serde(default)]
pub modified_at: Option<String>,
#[serde(default)]
pub fee_checked_at: Option<String>,
#[serde(default = "Vec::new")]
pub fee_evidence: Vec<NativeSettlementFeeEvidence>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementAccountFees {
#[serde(default)]
pub account_namespace: Option<String>,
#[serde(default)]
pub account_reference: Option<String>,
#[serde(default)]
pub connector: Option<String>,
#[serde(default)]
pub merchant_connector_id: Option<String>,
#[serde(default)]
pub complete: bool,
#[serde(default)]
pub reported_zero: bool,
#[serde(default)]
pub unavailable_reason: Option<String>,
#[serde(default)]
pub checked_at: Option<String>,
#[serde(default = "Vec::new")]
pub evidence: Vec<NativeSettlementFeeEvidence>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementPreview {
#[serde(default)]
pub calculation_version: Option<i64>,
#[serde(default)]
pub render_version: Option<i64>,
#[serde(default)]
pub calculated_at: Option<String>,
#[serde(default)]
pub terms: Option<NativeSettlementTerms>,
#[serde(default)]
pub profile_name: Option<String>,
#[serde(default)]
pub currency_exponent: Option<i64>,
#[serde(default)]
pub quality: Option<NativeSettlementQuality>,
#[serde(default)]
pub totals: Option<NativeSettlementTotals>,
#[serde(default = "Vec::new")]
pub sources: Vec<NativeSettlementSource>,
#[serde(default = "Vec::new")]
pub payouts_in_window: Vec<NativeSettlementPayout>,
#[serde(default = "Vec::new")]
pub payouts_outside_window: Vec<NativeSettlementPayout>,
#[serde(default = "Vec::new")]
pub account_fees: Vec<NativeSettlementAccountFees>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementReport {
pub id: String,
#[serde(default)]
pub created_at: Option<String>,
#[serde(default)]
pub snapshot: Option<NativeSettlementPreview>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementReportSummary {
pub id: String,
#[serde(default)]
pub created_at: Option<String>,
#[serde(default)]
pub terms: Option<NativeSettlementTerms>,
#[serde(default)]
pub profile_name: Option<String>,
#[serde(default)]
pub currency_exponent: Option<i64>,
#[serde(default)]
pub calculation_version: Option<i64>,
#[serde(default)]
pub render_version: Option<i64>,
#[serde(default)]
pub quality: Option<NativeSettlementQuality>,
#[serde(default)]
pub totals: Option<NativeSettlementTotals>,
#[serde(default)]
pub source_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementReportListResponse {
#[serde(default = "Vec::new")]
pub data: Vec<NativeSettlementReportSummary>,
#[serde(default)]
pub has_more: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementPayout {
pub id: String,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub currency: Option<String>,
#[serde(default)]
pub test_mode: Option<bool>,
#[serde(default)]
pub amount_minor: Option<NativeMinor>,
#[serde(default)]
pub value_date: Option<String>,
#[serde(default)]
pub method: Option<String>,
#[serde(default)]
pub reference: Option<String>,
#[serde(default)]
pub note: Option<String>,
#[serde(default)]
pub reversal_of: Option<String>,
#[serde(default)]
pub created_at: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementPayoutListResponse {
#[serde(default = "Vec::new")]
pub data: Vec<NativeSettlementPayout>,
#[serde(default)]
pub has_more: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeSettlementFeeRefreshResponse {
#[serde(default)]
pub source_count: i64,
#[serde(default)]
pub complete_count: i64,
#[serde(default)]
pub has_more: bool,
#[serde(default)]
pub next_offset: Option<i64>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
pub type MarginQuality = String;
pub type ProcessorCostBasis = String;
pub type RevenueBasis = String;
pub type TermBearer = String;
pub type ExpenseAllocation = String;
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostNativeBucket {
#[serde(default)]
pub passed_through: Option<bool>,
#[serde(default)]
pub connector: Option<String>,
pub ownership: ConnectorOwnership,
#[serde(default)]
pub cost_currency: Option<String>,
#[serde(default)]
pub cost_exponent: Option<i32>,
#[serde(default)]
pub cost_amount: Option<i64>,
#[serde(default)]
pub line_count: i64,
#[serde(default)]
pub reported_count: i64,
#[serde(default)]
pub estimated_count: i64,
#[serde(default)]
pub unavailable_count: i64,
#[serde(default)]
pub unrecorded_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostBucket {
#[serde(default)]
pub passed_through: Option<bool>,
#[serde(default)]
pub connector: Option<String>,
pub ownership: ConnectorOwnership,
#[serde(default)]
pub cost_currency: Option<String>,
#[serde(default)]
pub cost_exponent: Option<i32>,
#[serde(default)]
pub cost_amount: Option<i64>,
#[serde(default)]
pub cost_usd: Option<i64>,
#[serde(default)]
pub line_count: i64,
#[serde(default)]
pub reported_count: i64,
#[serde(default)]
pub estimated_count: i64,
#[serde(default)]
pub unavailable_count: i64,
#[serde(default)]
pub unrecorded_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostMethodBucket {
#[serde(default)]
pub connector: Option<String>,
pub ownership: ConnectorOwnership,
#[serde(default)]
pub payment_method: Option<String>,
#[serde(default)]
pub payment_method_type: Option<String>,
#[serde(default)]
pub connector_method_code: Option<String>,
pub currency: String,
#[serde(default)]
pub gross_amount: i64,
#[serde(default)]
pub cost_buckets: Vec<ProcessorCostNativeBucket>,
#[serde(default)]
pub line_count: i64,
#[serde(default)]
pub reported_count: i64,
#[serde(default)]
pub estimated_count: i64,
#[serde(default)]
pub unavailable_count: i64,
#[serde(default)]
pub unrecorded_count: i64,
#[serde(default)]
pub unclassified_count: i64,
#[serde(default)]
pub effective_rate_pct: Option<f64>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostEventBucket {
pub connector: String,
pub ownership: ConnectorOwnership,
#[serde(default)]
pub payment_method: Option<String>,
#[serde(default)]
pub payment_method_type: Option<String>,
pub currency: String,
#[serde(default)]
pub exponent: i32,
#[serde(default)]
pub amount: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostEventTerm {
#[serde(default)]
pub amount_usd: Option<i64>,
#[serde(default)]
pub host_amount_usd: Option<i64>,
#[serde(default)]
pub source_count: i64,
#[serde(default)]
pub reported_count: i64,
#[serde(default)]
pub unavailable_count: i64,
#[serde(default)]
pub unrecorded_count: i64,
#[serde(default)]
pub incomplete: bool,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(default)]
pub host_incomplete: bool,
#[serde(default)]
pub host_fx_incomplete: bool,
#[serde(default)]
pub breakdown: Vec<ProcessorCostEventBucket>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct HostingFeeTerm {
pub bearer: TermBearer,
#[serde(default)]
pub amount_usd: i64,
#[serde(default)]
pub line_count: i64,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(default)]
pub uncovered_captured_attempt_count: i64,
#[serde(default)]
pub uncovered_unresolved_attempt_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProfitCostTerm {
pub bearer: TermBearer,
#[serde(default)]
pub amount_usd: i64,
#[serde(default)]
pub row_count: i64,
#[serde(default)]
pub unavailable_count: i64,
#[serde(default)]
pub excluded_count: i64,
#[serde(default)]
pub unclassified_count: i64,
#[serde(default)]
pub incomplete: bool,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(default)]
pub uncovered_captured_attempt_count: i64,
#[serde(default)]
pub uncovered_unresolved_attempt_count: i64,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct PeriodExpenseTerm {
pub bearer: TermBearer,
#[serde(default)]
pub amount_usd: i64,
#[serde(default)]
pub row_count: i64,
#[serde(default)]
pub excluded_count: i64,
#[serde(default)]
pub incomplete: bool,
#[serde(default)]
pub fx_incomplete: bool,
pub allocation: ExpenseAllocation,
#[serde(default)]
pub allocated_through: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SalesRevenueTerm {
#[serde(default)]
pub amount_usd: i64,
#[serde(default)]
pub captured_usd: i64,
#[serde(default)]
pub refunded_usd: i64,
#[serde(default)]
pub attempt_count: i64,
#[serde(default)]
pub refund_count: i64,
#[serde(default)]
pub reversed_attempt_count: i64,
#[serde(default)]
pub unpriced_captured_attempt_count: i64,
#[serde(default)]
pub unresolved_attempt_count: i64,
#[serde(default)]
pub excluded_refund_count: i64,
#[serde(default)]
pub incomplete: bool,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SettlementCostResponse {
pub period_start: String,
pub period_end: String,
pub test_mode: bool,
#[serde(default)]
pub gross_usd: i64,
#[serde(default)]
pub platform_fee_usd: i64,
#[serde(default)]
pub merchant_fee_usd: i64,
#[serde(default)]
pub processor_cost_usd: i64,
#[serde(default)]
pub host_processor_cost_usd: i64,
#[serde(default)]
pub passed_through_cost_usd: i64,
#[serde(default)]
pub revenue_usd: i64,
pub revenue_basis: RevenueBasis,
#[serde(default)]
pub sales_revenue: Option<SalesRevenueTerm>,
#[serde(default)]
pub payment_cost_usd: i64,
pub hosting_fee: HostingFeeTerm,
pub cost_of_goods: ProfitCostTerm,
pub partner_shares: ProfitCostTerm,
pub period_expenses: PeriodExpenseTerm,
#[serde(default)]
pub operating_cost_usd: i64,
#[serde(default)]
pub total_cost_usd: i64,
#[serde(default)]
pub margin_usd: Option<i64>,
pub margin_quality: MarginQuality,
#[serde(default)]
pub unlined_captured_attempt_count: i64,
#[serde(default)]
pub unlined_unresolved_attempt_count: i64,
#[serde(default)]
pub coverage_complete: bool,
pub cost_basis: ProcessorCostBasis,
#[serde(default)]
pub line_count: i64,
#[serde(default)]
pub priced_line_count: i64,
#[serde(default)]
pub reported_line_count: i64,
#[serde(default)]
pub estimated_line_count: i64,
#[serde(default)]
pub unavailable_line_count: i64,
#[serde(default)]
pub unrecorded_line_count: i64,
#[serde(default)]
pub processor_cost_incomplete: bool,
#[serde(default)]
pub processor_cost_fx_incomplete: bool,
#[serde(default)]
pub fx_incomplete: bool,
#[serde(default)]
pub platform_fee_incomplete: bool,
#[serde(default)]
pub breakdown: Vec<ProcessorCostBucket>,
#[serde(default)]
pub method_breakdown: Option<Vec<ProcessorCostMethodBucket>>,
#[serde(default)]
pub refund_processor_cost: Option<ProcessorCostEventTerm>,
#[serde(default)]
pub dispute_processor_cost: Option<ProcessorCostEventTerm>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostPeriodBucket {
pub profile_id: String,
#[serde(default)]
pub connector: Option<String>,
#[serde(default)]
pub merchant_connector_id: Option<String>,
#[serde(default)]
pub payment_method: Option<String>,
#[serde(default)]
pub payment_method_type: Option<String>,
#[serde(default)]
pub connector_method_code: Option<String>,
#[serde(default)]
pub cost_currency: Option<String>,
#[serde(default)]
pub cost_exponent: Option<i32>,
#[serde(default)]
pub cost_amount: Option<i64>,
#[serde(default)]
pub gross_currency: Option<String>,
#[serde(default)]
pub gross_exponent: Option<i32>,
#[serde(default)]
pub gross_amount: Option<i64>,
#[serde(default)]
pub attempt_count: i64,
#[serde(default)]
pub reported_count: i64,
#[serde(default)]
pub estimated_count: i64,
#[serde(default)]
pub unavailable_count: i64,
#[serde(default)]
pub unwritten_count: i64,
#[serde(default)]
pub unreadable_count: i64,
#[serde(default)]
pub effective_rate_pct: Option<f64>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ProcessorCostPeriodResponse {
pub period_start: String,
pub period_end: String,
pub test_mode: bool,
#[serde(default)]
pub profile_id: Option<String>,
pub generated_at: String,
#[serde(default)]
pub attempt_count: i64,
#[serde(default)]
pub reported_count: i64,
#[serde(default)]
pub estimated_count: i64,
#[serde(default)]
pub unavailable_count: i64,
#[serde(default)]
pub unwritten_count: i64,
#[serde(default)]
pub unreadable_count: i64,
#[serde(default)]
pub buckets: Vec<ProcessorCostPeriodBucket>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}