Skip to content

Ramp: Statement schemas

4 Ramp schemas with complete fields and constraints.

← Statement operations · All schemas

Fetch a statement — response body

FieldTypePresenceDescription and constraints
$objectRoot
balance_sectionsarrayRequired within parentBreakdown of statement balances by entity and currency.
balance_sections[]ModelEach itemExpand Fetch a statement — response body — balance sections item
chargesModelRequired within parentExpand Hold Bill — response body — amount
Total charges incurred during the statement period
creditsModelRequired within parentExpand Hold Bill — response body — amount
Total credits accumulated during the statement period
end_datestringRequired within parentEnd date of the statement period.
Format: date-time
ending_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the end of the statement period
idstringRequired within parentUnique identifier for the statement.
Format: uuid
opening_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the beginning of the statement period
paymentsModelRequired within parentExpand Hold Bill — response body — amount
Total payments made during the statement period
preceding_statement_idstringOptionalIdentifier of the previous statement in sequence.
Format: uuid
start_datestringRequired within parentStart date of the statement period.
Format: date-time
statement_linesarrayRequired within parentFinancial activities including card transactions, transfers, and cashbacks during the statement period.
statement_lines[]ModelEach itemExpand Fetch a statement — response body — statement lines item
statement_urlstringOptionalPre-signed URL to download statement PDF, valid for 1 hour after generation.
Format: url

Referenced models: Fetch a statement — response body — statement lines item, Hold Bill — response body — amount, Fetch a statement — response body — balance sections item

Fetch a statement — response body — balance sections item

FieldTypePresenceDescription and constraints
$objectRoot
chargesModelRequired within parentExpand Hold Bill — response body — amount
Total charges incurred during the statement period.
creditsModelRequired within parentExpand Hold Bill — response body — amount
Total credits accumulated during the statement period.
ending_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the end of the statement period.
entity_idstringRequired within parentBusiness entity this balance section belongs to.
Format: uuid
idstringRequired within parentUnique identifier for the balance section.
Format: uuid
opening_balanceModelRequired within parentExpand Hold Bill — response body — amount
Balance at the beginning of the statement period.
paymentsModelRequired within parentExpand Hold Bill — response body — amount
Total payments made during the statement period.

Referenced models: Hold Bill — response body — amount

Fetch a statement — response body — statement lines item

FieldTypePresenceDescription and constraints
$objectRoot
cleared_atJSONOptional
cleared_at (anyOf 1)stringAlternativeTime when transaction was cleared. Only present for transactions and may be null if not cleared.
Format: date-time
cleared_at (anyOf 2)nullAlternative
created_atstringRequired within parentFor transactions: time when card was swiped. For transfers/cashbacks: creation time.
Format: date-time
idstringOptionalUnique identifier for the statement line item.
Format: uuid
typestringOptionalType of statement line item (CARD_TRANSACTION, TRANSFER_PAYMENT, or CASHBACK).
Known values: CARD_TRANSACTION, CASHBACK, TRANSFER_PAYMENT

List statements — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a statement — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Fetch a statement — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.