GET//////
Retrieve the interest charges 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 interest charges. 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 interest charges. 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 |
|---|---|
| account_token string Returned | Unique identifier of the credit account on which the statement interest charge is generated. Allowable Values: 36 char max |
| statement_summary_token string Returned | Unique identifier of the statement summary. Allowable Values: Existing statement summary token |
| data array of objects Returned | Contains one or more interest charges on a statement. Allowable Values: One or more interest charge objects |
| data[].balance_type string Conditionally returned | Type of balance. - PURCHASE - The balance on purchases.Allowable Values: PURCHASE |
| data[].apr_value decimal Conditionally returned | Annual percentage rate. Allowable Values: 0–100 |
| data[].apr_type string Conditionally returned | Type of APR. Allowable Values: GO_TO |
| data[].balance_subject_to_interest_rate decimal Conditionally returned | Average daily balance used to calculate interest. Allowable Values: Format: 0.00 |
| data[].amount decimal Conditionally returned | Amount of interest calculated for the billing period. Allowable Values: Format: 0.00 |
Sample response body
JSON
{
"account_token": "credit_account_token1234",
"user_token": "user_token1234",
"statement_summary_token": "statement_summary_token1234",
"data": [
{
"balance_type": "PURCHASE",
"apr_value": 14.99,
"apr_type": "GO_TO",
"balance_subject_to_interest_rate": 181.67,
"amount": 2.31
}
]
}