GET//////
Retrieve the payment information on a credit account’s statement summary.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | The unique identifier of the credit account for which you want to retrieve the statement payment information. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
| statement_summary_token string Required | The unique identifier of the statement summary from which to retrieve the payment information. Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.Allowable Values: Existing statement summary token |
Response body
| Fields | Description |
|---|---|
| token uuid Conditionally returned | Unique identifier of the statement payment. Allowable Values: 36 char max |
| statement_summary_token uuid Conditionally returned | Unique identifier of the statement summary. Allowable Values: Existing statement summary token |
| new_statement_balance decimal Conditionally returned | Balance on the credit account when the statement period ended. Allowable Values: Format: 0.00 |
| minimum_payment_due decimal Conditionally returned | Minimum payment amount for the current statement period, based on the associated credit product settings. Allowable Values: Format: 0.00 |
| payment_due_date datetime Conditionally returned | Payment due date, based on the credit account settings. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| payment_cutoff_date datetime Conditionally returned | Last day a payment can be made before interest and fees are charged to the account. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| three_year_savings decimal Conditionally returned | Savings amount if the balance is paid off in three years versus only making minimum payments. Allowable Values: Format: 0.00 |
| warnings array of objects Conditionally returned | One or more payoff warnings. Allowable Values: One or more warnings objects |
| warnings[].type string Conditionally returned | Type of statement warning. - MIN_PAYMENT - Displays the total estimated payment amount and how long it would take to pay off the statement balance if only making minimum payments.- 3_YEAR - Displays the monthly payment amount and total estimated payment amount if paying off the statement balance in three years.Allowable Values: MIN_PAYMENT, 3_YEAR |
| warnings[].total_paid decimal Conditionally returned | For the minimum payment warning type, this value represents the total amount of principal and interest to pay off the statement balance if only making the minimum payment each month. For the 3 Year warning type, this value represents the total amount of principal and interest if paying off the statement balance in three years. Allowable Values: Format: 0.00 |
| warnings[].interest_paid decimal Conditionally returned | For the minimum payment warning type, this value represents the total amount of interest to pay off the statement balance if only making the minimum payment each month. For the 3 Year warning type, this value represents the total amount of interest if paying off the statement balance in three years. Allowable Values: Format: 0.00 |
| warnings[].monthly_payment decimal Conditionally returned | For the minimum payment warning type, this value is 0. For the 3 Year warning type, this value represents the fixed monthly payment amount required to pay off the statement balance in three years. Allowable Values: Format: 0.00 |
| warnings[].pay_off_period integer Conditionally returned | For the minimum payment warning type, this value represents the number of periods required to pay off the statement balance. For the 3 Year warning type, this value is 36 (months). Allowable Values: 1 min |
| warnings[].period_type string Conditionally returned | Time unit of the pay off period. Allowable Values: MONTH, YEAR |
| warnings[].disclosure string Conditionally returned | Statement disclosure in the case of negative or no amortization, or no lifetime repayment for the minimum payment warning type. - NEGATIVE_OR_NO_AMORTIZATION - Occurs when the interest amount is higher than the minimum payment; results in the outstanding balance remaining in perpetuity.- NO_LIFETIME_REPAYMENT - Occurs when the interest amount is just below the minimum payment; results in the outstanding balance taking longer than a lifetime to pay off.Allowable Values: NEGATIVE_OR_NO_AMORTIZATION, NO_LIFETIME_REPAYMENT |
| created_time datetime Conditionally returned | Date and time when the statement payment information was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "5e3182dc-fc8f-4a83-8038-8808297ca0ca",
"statement_summary_token": "acc0544e-4075-fe67-93dd-6b5cd443adb1",
"new_statement_balance": 2000,
"minimum_payment_due": 25,
"payment_due_date": "2021-07-01T00:27:09Z",
"payment_cutoff_date": "2021-07-01T00:27:09Z",
"three_year_savings": 0,
"warnings": [
{
"type": "MIN_PAYMENT",
"total_paid": 0,
"interest_paid": 0,
"monthly_payment": 0,
"pay_off_period": 1,
"period_type": "MONTH",
"disclosure": "NEGATIVE_OR_NO_AMORTIZATION"
}
],
"created_time": "2021-07-01T00:27:09Z"
}