PaginatedResponseAgentResidualStatementResponse
items object[]required
Array [
agentIdstringrequired
buyRateCardVersionIdstringrequired
createdAtstring<date-time>required
lines object[]required
Array [
buyAmountinteger<int64>required
chargeKindAgentResidualChargeKindrequired
Possible values: [BASE_MONTHLY, ENABLEMENT, MONTHLY, PER_TRANSACTION, ACH_RETURN_CORRECTION, ACH_RECOLLECTION_REVERSAL, LATE_PAYMENT_CORRECTION]
correctionEventIdstringnullable
featureGroupBillingFeatureGroupnullable
Possible values: [FRAUD, TOKENIZATION, NETWORK_TOKENIZATION, ACCOUNT_UPDATER, SMART_ROUTING, CARD_NOT_PRESENT, THREE_DS, APPLE_PAY, GOOGLE_PAY, ACH_TENDER, EBT_TENDER, AGENTIC_CHECKOUT, SMART_POS, TTP_IOS_NATIVE, TTP_IOS_NEARPAY, TTP_ANDROID_NEARPAY, TTP_ANDROID_NATIVE]
organizationIdstringrequired
quantityinteger<int64>required
residualinteger<int64>required
sellAmountinteger<int64>required
sourceChargeIdstringnullable
sourceInvoiceIdstringnullable
sourcePeriodstringnullable
volumeinteger<int64>required
]
paidOutAtstring<date-time>nullable
paidOutBystringnullable
payoutReferencestringnullable
periodstringrequired
statusAgentResidualStatementStatusrequired
Possible values: [OPEN, FINALIZED, PAID_OUT]
totalBuyinteger<int64>required
totalResidualinteger<int64>required
totalSellinteger<int64>required
updatedAtstring<date-time>required
]
limitinteger<int32>required
offsetinteger<int32>required
totalinteger<int64>required
PaginatedResponseAgentResidualStatementResponse
{
"items": [
{
"agentId": "string",
"buyRateCardVersionId": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"lines": [
{
"buyAmount": 0,
"chargeKind": "BASE_MONTHLY",
"correctionEventId": "string",
"featureGroup": "FRAUD",
"organizationId": "string",
"quantity": 0,
"residual": 0,
"sellAmount": 0,
"sourceChargeId": "string",
"sourceInvoiceId": "string",
"sourcePeriod": "string",
"volume": 0
}
],
"paidOutAt": "2024-07-29T15:51:28.071Z",
"paidOutBy": "string",
"payoutReference": "string",
"period": "string",
"status": "OPEN",
"totalBuy": 0,
"totalResidual": 0,
"totalSell": 0,
"updatedAt": "2024-07-29T15:51:28.071Z"
}
],
"limit": 0,
"offset": 0,
"total": 0
}