1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
//! Disbursement entry types for the Payrix API.
//!
//! Disbursement entries are individual line items within a disbursement,
//! representing specific fund movements.
//!
//! **OpenAPI schema:** `disbursementEntriesResponse`
use serde::{Deserialize, Serialize};
use super::PayrixId;
// =============================================================================
// DISBURSEMENT ENTRY STRUCT
// =============================================================================
/// A Payrix disbursement entry.
///
/// Disbursement entries track individual fund movements within a disbursement.
///
/// **OpenAPI schema:** `disbursementEntriesResponse`
///
/// See API_INCONSISTENCIES.md for known deviations from this spec.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "sqlx", derive(sqlx::FromRow))]
#[serde(rename_all = "camelCase")]
pub struct DisbursementEntry {
/// The ID of this resource.
///
/// **OpenAPI type:** string
pub id: PayrixId,
/// The date and time at which this resource was created.
///
/// Format: `YYYY-MM-DD HH:MM:SS.SSSS`
///
/// **OpenAPI type:** string (pattern: `^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$`)
#[serde(default)]
pub created: Option<String>,
/// The date and time at which this resource was modified.
///
/// Format: `YYYY-MM-DD HH:MM:SS.SSSS`
///
/// **OpenAPI type:** string (pattern: `^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$`)
#[serde(default)]
pub modified: Option<String>,
/// The identifier of the Login that created this resource.
///
/// **OpenAPI type:** string (ref: creator)
#[serde(default)]
pub creator: Option<PayrixId>,
/// The identifier of the Login that last modified this resource.
///
/// **OpenAPI type:** string
#[serde(default)]
pub modifier: Option<PayrixId>,
/// The identifier of the Disbursement that this DisbursementEntry resource refers to.
///
/// **OpenAPI type:** string (ref: disbursementEntriesModelDisbursement)
#[serde(default)]
pub disbursement: Option<PayrixId>,
/// The identifier of the Entry that this DisbursementEntry resource refers to.
///
/// **OpenAPI type:** string (ref: disbursementEntriesModelEntry)
#[serde(default)]
pub entry: Option<PayrixId>,
/// The identifier of the PendingEntry that this DisbursementEntry resource refers to.
///
/// **OpenAPI type:** string (ref: disbursementEntriesModelPendingEntry)
#[serde(default)]
pub pending_entry: Option<PayrixId>,
/// The identifier of the ReserveEntry that this DisbursementEntry resource refers to.
///
/// **OpenAPI type:** string (ref: disbursementEntriesModelReserveEntry)
#[serde(default)]
pub reserve_entry: Option<PayrixId>,
/// The event that triggered the funding activity.
///
/// This is a large integer enum with values 1-600+ representing various event types
/// like DAYS, WEEKS, CAPTURE, REFUND, CHARGEBACK, etc.
///
/// **OpenAPI type:** integer (ref: disbursementEntryEvent)
#[serde(default)]
pub event: Option<i32>,
/// The identifier of the record that is associated with this DisbursementEntry resource.
///
/// **OpenAPI type:** string (ref: disbursementEntriesModelEventId)
#[serde(default)]
pub event_id: Option<PayrixId>,
/// The total amount of this DisbursementEntry.
///
/// This field is specified in cents (up to three decimal points).
///
/// **OpenAPI type:** number
#[serde(default)]
pub amount: Option<f64>,
/// The total amount used of this DisbursementEntry.
///
/// This field is specified in cents (up to three decimal points).
///
/// **OpenAPI type:** number
#[serde(default)]
pub amount_used: Option<f64>,
/// A description of this DisbursementEntry.
///
/// **OpenAPI type:** string
#[serde(default)]
pub description: Option<String>,
}
// =============================================================================
// TESTS
// =============================================================================
#[cfg(test)]
mod tests {
use super::*;
// ==================== DisbursementEntry Struct Tests ====================
#[test]
fn disbursement_entry_deserialize_full() {
let json = r#"{
"id": "t1_dbe_12345678901234567890123",
"created": "2024-01-01 00:00:00.0000",
"modified": "2024-01-02 23:59:59.9999",
"creator": "t1_lgn_12345678901234567890123",
"modifier": "t1_lgn_12345678901234567890124",
"disbursement": "t1_dbm_12345678901234567890123",
"entry": "t1_etr_12345678901234567890123",
"pendingEntry": "t1_per_12345678901234567890123",
"reserveEntry": "t1_rer_12345678901234567890123",
"event": 7,
"eventId": "t1_txn_12345678901234567890123",
"amount": 10000.50,
"amountUsed": 0,
"description": "CAPTURE fee schedule"
}"#;
let entry: DisbursementEntry = serde_json::from_str(json).unwrap();
assert_eq!(entry.id.as_str(), "t1_dbe_12345678901234567890123");
assert_eq!(entry.created, Some("2024-01-01 00:00:00.0000".to_string()));
assert_eq!(entry.modified, Some("2024-01-02 23:59:59.9999".to_string()));
assert_eq!(
entry.creator.as_ref().map(|c| c.as_str()),
Some("t1_lgn_12345678901234567890123")
);
assert_eq!(
entry.modifier.as_ref().map(|m| m.as_str()),
Some("t1_lgn_12345678901234567890124")
);
assert_eq!(
entry.disbursement.as_ref().map(|d| d.as_str()),
Some("t1_dbm_12345678901234567890123")
);
assert_eq!(
entry.entry.as_ref().map(|e| e.as_str()),
Some("t1_etr_12345678901234567890123")
);
assert_eq!(
entry.pending_entry.as_ref().map(|p| p.as_str()),
Some("t1_per_12345678901234567890123")
);
assert_eq!(
entry.reserve_entry.as_ref().map(|r| r.as_str()),
Some("t1_rer_12345678901234567890123")
);
assert_eq!(entry.event, Some(7)); // CAPTURE
assert_eq!(
entry.event_id.as_ref().map(|e| e.as_str()),
Some("t1_txn_12345678901234567890123")
);
assert_eq!(entry.amount, Some(10000.50));
assert_eq!(entry.amount_used, Some(0.0));
assert_eq!(entry.description, Some("CAPTURE fee schedule".to_string()));
}
#[test]
fn disbursement_entry_deserialize_minimal() {
let json = r#"{"id": "t1_dbe_12345678901234567890123"}"#;
let entry: DisbursementEntry = serde_json::from_str(json).unwrap();
assert_eq!(entry.id.as_str(), "t1_dbe_12345678901234567890123");
assert!(entry.created.is_none());
assert!(entry.modified.is_none());
assert!(entry.creator.is_none());
assert!(entry.modifier.is_none());
assert!(entry.disbursement.is_none());
assert!(entry.entry.is_none());
assert!(entry.pending_entry.is_none());
assert!(entry.reserve_entry.is_none());
assert!(entry.event.is_none());
assert!(entry.event_id.is_none());
assert!(entry.amount.is_none());
assert!(entry.amount_used.is_none());
assert!(entry.description.is_none());
}
#[test]
fn disbursement_entry_various_event_values() {
// Test various event values from the OpenAPI spec
let test_cases = vec![
(1, "DAYS"),
(7, "CAPTURE"),
(8, "REFUND"),
(11, "CHARGEBACK"),
(40, "REMAINDER"),
];
for (event_val, _name) in test_cases {
let json = format!(
r#"{{"id": "t1_dbe_12345678901234567890123", "event": {}}}"#,
event_val
);
let entry: DisbursementEntry = serde_json::from_str(&json).unwrap();
assert_eq!(entry.event, Some(event_val));
}
}
#[test]
fn disbursement_entry_amount_as_float() {
// Test that amount handles decimal values (up to 3 decimal points per spec)
let json = r#"{"id": "t1_dbe_12345678901234567890123", "amount": 1234.567}"#;
let entry: DisbursementEntry = serde_json::from_str(json).unwrap();
assert_eq!(entry.amount, Some(1234.567));
let json = r#"{"id": "t1_dbe_12345678901234567890123", "amount": 5000}"#;
let entry: DisbursementEntry = serde_json::from_str(json).unwrap();
assert_eq!(entry.amount, Some(5000.0));
}
#[test]
fn disbursement_entry_serialize_roundtrip() {
let json = r#"{
"id": "t1_dbe_12345678901234567890123",
"disbursement": "t1_dbm_12345678901234567890123",
"amount": 5000.0,
"event": 7
}"#;
let entry: DisbursementEntry = serde_json::from_str(json).unwrap();
let serialized = serde_json::to_string(&entry).unwrap();
let deserialized: DisbursementEntry = serde_json::from_str(&serialized).unwrap();
assert_eq!(entry.id, deserialized.id);
assert_eq!(entry.disbursement, deserialized.disbursement);
assert_eq!(entry.amount, deserialized.amount);
assert_eq!(entry.event, deserialized.event);
}
}