Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Schedule, Statement and Timeline

Three reads answer the questions of reconciliation: what you will receive and when (the schedule), how your money moved (the statement), and what happened to one payment (the timeline). All three are reads, open to any access, and take ?subAccountId= to read for a sub-account. A query parameter not listed for a route is refused with 400.

Schedule: what you will receive, and when​

GEThttps://api.sandbox.avenia.io:10952/v2/account/acquiring/schedule?dateFrom=2026-11-01&dateTo=2026-11-30&limit=100&cursor=

The schedule lists the account's own sales. The main account's markup on its sub-accounts' sales is not on it: the markup has no date of its own, it follows each sub-account's installment, and the main reads it on its statement (MARKUP_DEFERRED until the installment is paid, MARKUP_PAYABLE after). A main account with no sales of its own reads an empty schedule.

ParameterRules
dateFrom, dateToRequired. Days, YYYY-MM-DD, both included, in the Brazilian calendar. A read covers at most 366 days.
limitOptional. Default 100, at most 500.
cursorOptional. The cursor of the previous page.

Request example​

cURL
curl -X GET "https://api.sandbox.avenia.io:10952/v2/account/acquiring/schedule?dateFrom=2026-11-01&dateTo=2026-11-30" \
-H "Authorization: Bearer <token>"

Response​

Entries come in date order. Each is an installment the acquirer pays (type INSTALLMENT) or a tranche of your rolling reserve that may be released (type RESERVE_TRANCHE); the fields of the other kind are empty or "0":

JSON
{
"entries": [
{
"type": "INSTALLMENT",
"id": "3b6e1c84-92d0-4f7a-a5e1-8c0d2b9f4e63",
"date": "2026-11-09",
"status": "EXPECTED",
"paymentId": "e4b8d1a2-6c3f-4a9e-b7d5-1f2e3a4b5c6d",
"externalId": "order-10045",
"installmentNumber": 1,
"dateApproximate": false,
"acquirerAmount": "150",
"settledAmount": "0",
"settledAt": "",
"deferredAmount": "55.05",
"earlySettledAmount": "0",
"releasedAmount": "0",
"releasedAt": "",
"releaseSettlementId": "",
"trancheAmount": "0",
"trancheOutstandingAmount": "0",
"trancheSettlementId": "",
"trancheDisputeId": ""
}
],
"cursor": ""
}
FieldMeaning
dateThe day the acquirer is expected to pay the installment, or the day the reserve tranche may be released (YYYY-MM-DD).
statusFor an installment: EXPECTED, SETTLED, SHORT (paid less than scheduled), MISSING (the day passed and nothing came) or CANCELED. For a tranche: HELD, PARTIALLY_CONSUMED, CONSUMED or RELEASED.
dateApproximatetrue when date is an estimate.
acquirerAmountWhat the acquirer is to pay for the installment, less what refunds and chargebacks took off it.
settledAmount, settledAtWhat the acquirer paid and when ("0" and "" until it does).
deferredAmountYour part of the installment that waits for the acquirer: its slice of the payment's deferred amount, less what early settlements took and what refunds and chargebacks cancelled.
earlySettledAmountWhat early settlements paid you early of this installment.
releasedAmount, releasedAt, releaseSettlementIdWhat the release paid you of this installment, when, and the settlement that paid it.
trancheAmount, trancheOutstandingAmountA reserve tranche's amount and what is still held.
trancheSettlementId, trancheDisputeIdThe SALES settlement the tranche was held from, and the dispute that consumed it, if any.

cursor is "" on the last page; otherwise send it back as cursor, with the same dateFrom, dateTo and limit.

Statement: how your money moved​

GEThttps://api.sandbox.avenia.io:10952/v2/account/acquiring/statement?createdAfter=1793502000000&createdBefore=1796094000000&limit=100&cursor=
ParameterRules
createdAfter, createdBeforeRequired. Unix time in milliseconds (1793502000000 is 2026-11-01 00:00 in Brazil); 0 or a negative value counts as missing. The range is createdAfter included, createdBefore excluded, and covers at most 366 days.
limitOptional. Default 100, at most 500.
cursorOptional. The cursor of the previous page.

Lines come oldest first. Each is one movement of one of your accounts in the ledger:

JSON
{
"lines": [
{
"id": "8e41b7d3-0a52-4c96-b1f8-2d6c9e3a7054",
"createdAt": "2026-11-09T18:30:41.207Z",
"account": "PAYABLE",
"direction": "CREDIT",
"amount": "54.15",
"signedAmount": "54.15",
"refType": "settlement",
"refId": "c2d8a0f4-7b13-4e69-95a2-1f6e8d0b3c47",
"paymentId": "",
"settlementId": "c2d8a0f4-7b13-4e69-95a2-1f6e8d0b3c47",
"settlementType": "SALES",
"settlementStatus": "PAID",
"userId": "",
"settlementFailureCode": ""
}
],
"cursor": ""
}
FieldMeaning
accountThe balance that moved, named as the balance names it: PAYABLE (what you are owed now), DEFERRED_PAYABLE (owed once the acquirer pays), RESERVE and RECEIVABLE (your debt). On the main account the statement also has the main's own lines: BUFFER, MAIN_RECEIVABLE, MARKUP_DEFERRED, MARKUP_PAYABLE and FX_MARKUP_PAYABLE.
direction, amountDEBIT or CREDIT, and the amount, always positive.
signedAmountThe amount signed by what it does to the account's balance: positive grows it, negative shrinks it.
refType, refIdWhat moved the money and its id (for example payment, refund, dispute, settlement, receivable).
paymentIdThe payment behind the line, "" when there is none.
settlementId, settlementType, settlementStatus, settlementFailureCodeThe settlement behind the line, where there is one ("" otherwise). A held settlement reads HELD; why it is held is not shown. settlementFailureCode is the settlement's failure code, "" unless it is FAILED.
userIdOnly on a markup line of the main account: the sub-account whose sale earned the markup. "" on every other line, which is the reading account's own.

cursor works as on the schedule.

Timeline: one payment, step by step​

GEThttps://api.sandbox.avenia.io:10952/v2/account/acquiring/payments/{payment-id}/timeline

Oldest first: capture, settlement, each installment the acquirer paid and its release, refunds, disputes and what covered a debt it left. A payment of another account or sub-account, or one that does not exist, answers 404.

JSON
{
"paymentId": "e4b8d1a2-6c3f-4a9e-b7d5-1f2e3a4b5c6d",
"steps": [
{ "type": "CREATED", "at": "2026-10-08T15:02:11.482Z", "amount": "150", "refId": "", "detail": "CAPTURED" },
{ "type": "AUTHORIZED", "at": "2026-10-08T15:02:12.031Z", "amount": "150", "refId": "", "detail": "" },
{ "type": "CAPTURED", "at": "2026-10-08T15:02:12.644Z", "amount": "150", "refId": "", "detail": "" }
]
}
typeamount, refId, detail
CREATEDThe sale's amount; detail is the payment's current status.
AUTHORIZED, CAPTUREDThe authorized or captured amount.
CANCELED, EXPIRED"0".
REFUNDThe refund's amount and id; detail is its status (PENDING_APPROVAL, PENDING, SUCCEEDED or FAILED).
DISPUTE_OPENED, DISPUTE_RESOLVEDThe dispute's amount and id; detail is the dispute's type on DISPUTE_OPENED (CHARGEBACK, PRE_DISPUTE or OTHER), or its final status on DISPUTE_RESOLVED.
SETTLEDWhat the settlement paid for this payment (its net) and the settlement's id; detail is the settlement's status (HELD when it was kept back; the reason is never shown).
EARLY_SETTLEDThe installment's principal settled early, and the early settlement's id; detail names the installment.
INSTALLMENT_PAID_BY_ACQUIRERWhat the acquirer paid for the installment; detail names it.
INSTALLMENT_RELEASEDWhat the release paid you of that installment, and the settlement that paid it.
SALE_UNDONEThe amount of a sale taken back (a refund or a lost dispute) and its id; detail is its kind and status.
DEBT_COVEREDWhat covered a debt the payment left, and where it came from (the buffer, the reserve, what you were owed, or your account's token balance).

Errors​

HTTPerrorWhat to do
400dateFrom must be a date, YYYY-MM-DD or dateTo must be a date, YYYY-MM-DD (schedule); InvalidFieldError: createdAfter is invalid or createdBefore is invalid, a value that is not an integer (statement)Fix the range. Both ends are required on both reads.
400both ends of the range are required, the range ends before it starts, a read covers at most 366 days, limit is at most 500, or InvalidFieldError: limit is invalidFix the range or the page.
400cursor is not one this route gaveSend back the cursor of the same read.