Mercury: Credit schemas
7 Mercury schemas with complete fields and constraints.
← Credit operations · All schemas
Get credit account statements — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
page | object | Required within parent | |
page.nextPage | string | Optional | ID for the account statement Format: uuid |
page.previousPage | string | Optional | ID for the account statement Format: uuid |
statements | array | Required within parent | |
statements[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Account statement payload with type discriminator |
accountDetails | JSON | Required within parent | Account-specific details based on accountType |
accountDetails (anyOf 1) | Model | Alternative | Expand Get credit account statements — response body — statements / item / details / accountType: depository, credit account Details account Number, routing Number |
accountDetails (anyOf 2) | Model | Alternative | Expand 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 |
accountType | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountNumber | string | Required within parent | |
routingNumber | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
creditLimit | JSON | Required within parent | |
creditLimit (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
creditPeriodId | JSON | Required within parent | |
creditPeriodId (allOf 1) | string | All variants apply | ID for the credit statement period Format: uuid |
dueDate | string | Required within parent | |
startingBalance | JSON | Required within parent | |
startingBalance (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
totalAutopayPayments | JSON | Required within parent | |
totalAutopayPayments (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
totalCashbackEarned | JSON | Required within parent | |
totalCashbackEarned (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
totalOneTimePayments | JSON | Required within parent | |
totalOneTimePayments (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
totalTransactions | JSON | Required within parent | |
totalTransactions (allOf 1) | Model | All variants apply | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
companyLegalAddress | JSON | Required within parent | |
companyLegalAddress (allOf 1) | Model | All variants apply | Expand Add a new recipient — response body — address address1, address2, city, country, name, postal Code, region address1, address2, city, country, name, postal Code, region |
companyLegalName | string | Required within parent | |
details | JSON | Required within parent | |
details (allOf 1) | Model | All variants apply | Expand Get credit account statements — response body — statements / item / details / accountType: depository, credit |
downloadUrl | string | Required within parent | |
ein | JSON | Optional | |
ein (anyOf 1) | string | Alternative | |
ein (anyOf 2) | null | Alternative | |
endDate | JSON | Required within parent | |
endDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
endingBalance | JSON | Required within parent | |
endingBalance (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the account statement Format: uuid |
startDate | JSON | Required within parent | |
startDate (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
transactions | array | Required within parent | |
transactions[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounts | array | Required within parent | |
accounts[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
availableBalance | JSON | Required within parent | |
availableBalance (anyOf 1) | number | Alternative | Multiple of: 0.01 |
availableBalance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
currentBalance | JSON | Required within parent | |
currentBalance (anyOf 1) | number | Alternative | Multiple of: 0.01 |
currentBalance (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | Known values: active, deleted, pending, archived |