Skip to content

Mercury: Credit schemas

7 Mercury schemas with complete fields and constraints.

← Credit operations · All schemas

Get credit account statements — response body

FieldTypePresenceDescription and constraints
$objectRoot
pageobjectRequired within parent
page.nextPagestringOptionalID for the account statement
Format: uuid
page.previousPagestringOptionalID for the account statement
Format: uuid
statementsarrayRequired within parent
statements[]ModelEach itemExpand Get credit account statements — response body — statements item

Referenced models: Get credit account statements — response body — statements item

Get credit account statements — response body — statements / item / details / accountType: depository, credit

FieldTypePresenceDescription and constraints
$objectRootAccount statement payload with type discriminator
accountDetailsJSONRequired within parentAccount-specific details based on accountType
accountDetails (anyOf 1)ModelAlternativeExpand Get credit account statements — response body — statements / item / details / accountType: depository, credit account Details account Number, routing Number
accountDetails (anyOf 2)ModelAlternativeExpand Get credit account statements — response body — statements / item / details / accountType: depository, credit account Details credit Limit, credit Period Id, due Date, starting Balance, total Autopay Payments, total Cashback Earned, total One Time Payments, total Transactions
accountTypestringRequired within parentKnown values: depository, credit

Referenced models: Get credit account statements — response body — statements / item / details / accountType: depository, credit account Details credit Limit, credit Period Id, due Date, starting Balance, total Autopay Payments, total Cashback Earned, total One Time Payments, total Transactions, Get credit account statements — response body — statements / item / details / accountType: depository, credit account Details account Number, routing Number

Get credit account statements — response body — statements / item / details / accountType: depository, credit account Details account Number, routing Number

FieldTypePresenceDescription and constraints
$objectRoot
accountNumberstringRequired within parent
routingNumberstringRequired within parent

Get credit account statements — response body — statements / item / details / accountType: depository, credit account Details credit Limit, credit Period Id, due Date, starting Balance, total Autopay Payments, total Cashback Earned, total One Time Payments, total Transactions

FieldTypePresenceDescription and constraints
$objectRoot
creditLimitJSONRequired within parent
creditLimit (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
creditPeriodIdJSONRequired within parent
creditPeriodId (allOf 1)stringAll variants applyID for the credit statement period
Format: uuid
dueDatestringRequired within parent
startingBalanceJSONRequired within parent
startingBalance (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
totalAutopayPaymentsJSONRequired within parent
totalAutopayPayments (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
totalCashbackEarnedJSONRequired within parent
totalCashbackEarned (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
totalOneTimePaymentsJSONRequired within parent
totalOneTimePayments (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
totalTransactionsJSONRequired within parent
totalTransactions (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value

Referenced models: Create a product — response body — unit Price value

Get credit account statements — response body — statements item

FieldTypePresenceDescription and constraints
$objectRoot
companyLegalAddressJSONRequired within parent
companyLegalAddress (allOf 1)ModelAll variants applyExpand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region
companyLegalNamestringRequired within parent
detailsJSONRequired within parent
details (allOf 1)ModelAll variants applyExpand Get credit account statements — response body — statements / item / details / accountType: depository, credit
downloadUrlstringRequired within parent
einJSONOptional
ein (anyOf 1)stringAlternative
ein (anyOf 2)nullAlternative
endDateJSONRequired within parent
endDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
endingBalanceJSONRequired within parent
endingBalance (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the account statement
Format: uuid
startDateJSONRequired within parent
startDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
transactionsarrayRequired within parent
transactions[]ModelEach itemExpand Get account statements — response body — statements item transactions item

Referenced models: Create a product — response body — unit Price value, Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region, Get account statements — response body — statements item transactions item, Get credit account statements — response body — statements / item / details / accountType: depository, credit

List all credit accounts — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountsarrayRequired within parent
accounts[]ModelEach itemExpand List all credit accounts — response body — accounts item

Referenced models: List all credit accounts — response body — accounts item

List all credit accounts — response body — accounts item

FieldTypePresenceDescription and constraints
$objectRoot
availableBalanceJSONRequired within parent
availableBalance (anyOf 1)numberAlternativeMultiple of: 0.01
availableBalance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
currentBalanceJSONRequired within parent
currentBalance (anyOf 1)numberAlternativeMultiple of: 0.01
currentBalance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
statusJSONRequired within parent
status (allOf 1)stringAll variants applyKnown values: active, deleted, pending, archived

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.