GET////
Retrieve an array of statement summaries tied to a cardholder’s account.
The statement summary, which is a summary of account activity on a statement, provides account holders with a synopsis of activity that occurred on the account during a specified billing cycle.
This endpoint supports sorting and pagination. You can use optional query parameters to return a statement based on its exact opening or closing date, or a statement whose closing date falls within a range of dates.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | The unique identifier of the credit account for which you want to retrieve statement summaries. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
URL query parameters
| Fields | Description |
|---|---|
| start_date datetime Optional | Returns statements with a matching opening date. If both start_date and end_date are specified, statements whose closing date falls between the start and end dates are returned.Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| end_date datetime Optional | Returns statements with a matching closing date. If both start_date and end_date are specified, statements whose closing date falls between the start and end dates are returned.Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| count integer Optional | The number of resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as createdTime, and not by the field names appearing in response bodies such as created_time.Allowable Values: createdTime, -createdTime |
Response body
| Fields | Description |
|---|---|
| count integer Returned | Number of resources returned. Allowable Values: 1-10 |
| start_index integer Returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Returned | One or more statement summaries. Allowable Values: One or more statement summary objects |
| data[].token uuid Returned | Unique identifier of the statement summary. Allowable Values: 36 char max |
| data[].account_token string Returned | Unique identifier of the credit account on which the statement summary is generated. Allowable Values: 36 char max Existing account token |
| data[].opening_balance decimal Returned | Balance of the credit account when the statement period began. Allowable Values: Format: 0.00 |
| data[].closing_balance decimal Returned | Balance of the credit account when the statement period ended. Allowable Values: Format: 0.00 |
| data[].credit_limit decimal Conditionally returned | Maximum balance the credit account can carry, as of the statement closing date. Allowable Values: Format: 0.00 |
| data[].available_credit decimal Returned | Amount available to spend on the credit account, as of the statement closing date. Allowable Values: Format: 0.00 |
| data[].past_due_amount decimal Returned | Total payment amount, required to make the account current. Allowable Values: Format: 0.00 |
| data[].purchases decimal Returned | Total amount of purchases made during the statement period. Allowable Values: Format: 0.00 |
| data[].interest decimal Returned | Total amount of interest charged during the statement period. Allowable Values: Format: 0.00 |
| data[].fees decimal Returned | Total amount of fees charged during the statement period. Does not include periodic fees. Allowable Values: Format: 0.00 |
| data[].credits decimal Returned | Total amount of credits received during the statement period. Allowable Values: Format: 0.00 |
| data[].payments decimal Returned | Total amount of payments made during the statement period. Allowable Values: Format: 0.00 |
| data[].days_in_billing_cycle integer Returned | Number of days in the billing cycle, also known as the statement period. Allowable Values: Any integer |
| data[].cycle_type string Returned | Type of cycle. - BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.- REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.- END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.- TRANSACTING - Account is not revolving and the balance is paid off each month.Allowable Values: BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTINGWhen creating or updating an account, only TRANSACTING is allowed. |
| data[].opening_date datetime Returned | Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].closing_date datetime Returned | Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].created_time datetime Returned | Date and time when the statement summary was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": true,
"data": [
{
"token": "acc0544e-4075-fe67-93dd-6b5cd443adb1",
"account_token": "my_account_token_12",
"opening_balance": 1000,
"closing_balance": 2000,
"credit_limit": 10000,
"available_credit": 800,
"past_due_amount": 0,
"purchases": 200,
"interest": 0,
"fees": 0,
"credits": 0,
"payments": 0,
"days_in_billing_cycle": 31,
"cycle_type": "BEGINNING_REVOLVING",
"opening_date": "2021-07-01T00:27:09Z",
"closing_date": "2021-07-01T00:27:09Z",
"created_time": "2021-07-01T00:27:09Z"
}
]
}