Statements

Use the statements endpoints to retrieve statement information or statement files for a credit account. An account statement contains a summary of account activity that occurred during a billing cycle. For more on statements, see About Credit Account Statements. To receive a webhook notification when a statement is created, see Credit account statement event in Event Types.

List account statement summaries

Action: GET
Endpoint: /credit/accounts/{account_token}/statements 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`, `TRANSACTING` When 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"
    }
  ]
}

Retrieve account statement summary

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token} Retrieve a statement summary for a credit account.

URL path parameters

Fields	Description
account_token string Required	The unique identifier of the credit account for which you want to retrieve a statement summary. 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 to retrieve. 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 Returned	Unique identifier of the statement summary. Allowable Values: 36 char max
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
opening_balance decimal Returned	Balance of the credit account when the statement period began. Allowable Values: Format: 0.00
closing_balance decimal Returned	Balance of the credit account when the statement period ended. Allowable Values: Format: 0.00
credit_limit decimal Conditionally returned	Maximum balance the credit account can carry, as of the statement closing date. Allowable Values: Format: 0.00
available_credit decimal Returned	Amount available to spend on the credit account, as of the statement closing date. Allowable Values: Format: 0.00
past_due_amount decimal Returned	Total payment amount, required to make the account current. Allowable Values: Format: 0.00
purchases decimal Returned	Total amount of purchases made during the statement period. Allowable Values: Format: 0.00
interest decimal Returned	Total amount of interest charged during the statement period. Allowable Values: Format: 0.00
fees decimal Returned	Total amount of fees charged during the statement period. Does not include periodic fees. Allowable Values: Format: 0.00
credits decimal Returned	Total amount of credits received during the statement period. Allowable Values: Format: 0.00
payments decimal Returned	Total amount of payments made during the statement period. Allowable Values: Format: 0.00
days_in_billing_cycle integer Returned	Number of days in the billing cycle, also known as the statement period. Allowable Values: Any integer
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`, `TRANSACTING` When creating or updating an account, only `TRANSACTING` is allowed.
opening_date datetime Returned	Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
closing_date datetime Returned	Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
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

{
  "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"
}

Retrieve account statement payment information

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/paymentinfo 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"
}

List account statement journal entries

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/journalentries Retrieve an array of journal entries on a credit account’s statement summary. This endpoint supports sorting.

URL path parameters

Fields	Description
account_token string Required	The unique identifier of the credit account for which to retrieve the statement journal entries. 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 journal entries. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. Allowable Values: Existing statement summary token

URL query parameters

Fields	Description
count integer Optional	Specifies the number of journal entries to return. Allowable Values: 1–100
start_index integer Optional	Specifies the sort order index from which to begin returning journal entries. Allowable Values: 0 min
expand string Optional	Embeds the specified object into the response. Allowable Values: `detailObject`
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 `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. Allowable Values: `lastModifiedTime`, `-lastModifiedTime`

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	Contains one or more journal entries on a credit account. Allowable Values: One or more journal entry objects
data[].token string Returned	Unique identifier of the journal entry. Allowable Values: 36 char max
data[].related_token string Conditionally returned	Unique identifier of the original journal entry. If the current journal entry is the original, this field is returned empty. Allowable Values: Existing journal entry token
data[].root_token string Conditionally returned	Unique identifier of the root journal entry. If the current journal entry is the root, this field is returned empty. Allowable Values: Existing journal entry token
data[].account_token string Returned	Unique identifier of the credit account associated with the credit card used to make the journal entry. Allowable Values: Existing account token
data[].card_token string Returned	Unique identifier of the credit card used to make the journal entry. Allowable Values: 8–36 chars Existing credit card token
data[].user_token string Returned	Unique identifier of the credit user. Allowable Values: Existing user token
data[].status string Returned	Status of the journal entry when it was initially recorded and had an impact on the balance, either `PENDING` or `POSTED`. This field is immutable and may not represent the current status. To view the current status of purchases, refunds, OCTs, and payments, see the `detail_object.state` field. These journal entries start in `PENDING` and can transition to `CLEARED`, `DECLINED`, or `ERROR`. This transition of status is only sent through webhook event notifications. Journal entries that are final transactions, such as clearings, start and remain in a `POSTED` state. NOTE: `CLEARED`, `DECLINED`, and `ERROR` are special statuses that do not have an impact on the account balance, and are not recorded in the journal. For these special statuses, `impact_time`, `request_time`, `created_time`, `token`, and `id` are returned blank. Allowable Values: `PENDING`, `POSTED`, `DECLINED`, `ERROR`, `CLEARED`
data[].group string Returned	Group to which the journal entry belongs. Allowable Values: `PURCHASE`, `REFUND`, `DISPUTE`, `ORIGINAL_CREDIT`, `FEE`, `REWARD`, `INTEREST`, `PAYMENT`, `ADJUSTMENT`, `BALANCE_TRANSFER`, `CASH_ADVANCE`, `BALANCE_REFUND`
data[].type string Returned	The journal entry event type. Allowable Values: Example: `authorization.clearing` A valid journal entry event type
data[].id string Returned	Eight-digit numeric identifier of the journal entry, an alternate identifier to the UUID that is useful for remembering and referencing. Allowable Values: 8 chars
data[].amount decimal Returned	Amount of the journal entry. Allowable Values: Format: 0.00
data[].currency_code string Returned	A valid three-digit ISO 4217 currency code Allowable Values: `USD`
data[].memo string Returned	Merchant name or description for the journal entry. Allowable Values: Example: Whole Foods Market
data[].request_time datetime Returned	For purchases, the date and time of the authorization, which is when the user initiates the journal entry. For other journal entry groups, equivalent to `impact_time`. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].impact_time datetime Returned	Date and time when the journal entry impacts the account balance. For purchases, this is the time of the authorization. For purchase authorization clearings, this is the time when the transaction is settled. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].created_time datetime Returned	Date and time when the journal entry was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].dispute_token string Conditionally returned	Unique identifier of the dispute, if the journal entry is disputed. Allowable Values: Existing dispute token
data[].detail_token string Returned	Unique identifier of the journal entry’s full details. Allowable Values: 36 char max
data[].detail_object object Conditionally returned	Contains the journal entry’s full details. The fields returned in this object vary based on the journal entry group. The following lists each journal entry group and the specific fields returned for each group. - Purchases and refunds: see the transactions response fields. - Disputes: see the account disputes response fields. - Original credit transaction (OCT): see the Push-to-Card disbursement fields. - Rewards: see the account reward response fields. - Payments: see the account payment response fields. - Balance refunds: see the balance refund response fields. - Adjustments: see the account adjustment response fields. - Interest and fees: see fields below. Allowable Values: Existing detail object
data[].detail_object.token string Conditionally returned	Unique identifier of the interest charge or fee. If in the `detail_object`, unique identifier of the detail object. Returned for interest or fees. Allowable Values: 36 char max
data[].detail_object.account_token string Conditionally returned	Unique identifier of the credit account on which the interest or fee was charged. Returned for interest or fees. Allowable Values: 36 char max Existing account token
data[].detail_object.type string Conditionally returned	Type of fee. Returned for fees. Allowable Values: `FOREIGN_TRANSACTION_FEE`, `OVER_LIMIT_FEE`, `LATE_PAYMENT_FEE`, `RETURNED_PAYMENT_FEE`, `CARD_REPLACEMENT_FEE`, `MINIMUM_INTEREST_FEE`, `MINIMUM_INTEREST_FEE_REVERSAL`, `ANNUAL_FEE`, `MONTHLY_FEE`
data[].detail_object.method string Conditionally returned	Method used to calculate the fee value. Returned for fees. Allowable Values: `PERCENTAGE`, `FLAT`
data[].detail_object.value decimal Conditionally returned	Value of the fee configured on the account. Equivalent to `config.fees.schedule.value` on the credit account. Send a `GET` request to `/credit/accounts/{account_token}` to retrieve an existing credit account. Returned for fees. Allowable Values: Format: 0.00
data[].detail_object.currency_code string Conditionally returned	A valid three-digit ISO 4217 currency code Allowable Values: `USD`
data[].detail_object.amount decimal Conditionally returned	Amount of the fee. Returned for fees. Allowable Values: Format: 0.00
data[].detail_object.applied_to_amount decimal Conditionally returned	The total amount to which a percentage fee method is applied (for example, if a 3% fee is applied to 100, then `100` is the `applied_to_amount` value). This field is not applicable for a flat fee method. Returned for fees. NOTE: This field is currently not supported and returns `null`. Allowable Values: Format: 0.00
data[].detail_object.description string Conditionally returned	Description of the fee. Returned for fees. Allowable Values: 255 char max
data[].detail_object.created datetime Conditionally returned	Date and time when the fee was created. Returned for fees. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].detail_object.statement_token string Conditionally returned	Unique identifier of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Existing statement summary token
data[].detail_object.statement_opening_date datetime Conditionally returned	Opening date of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].detail_object.statement_closing_date datetime Conditionally returned	Closing date of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].detail_object.statement_balance decimal Conditionally returned	Balance on the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: 0.00
data[].detail_object.average_daily_balance decimal Conditionally returned	Average daily balance used to calculate interest. Returned for interest. Allowable Values: Format: 0.00
data[].detail_object.goto_apr decimal Conditionally returned	Annual percentage rate. Returned for interest. Allowable Values: 0–100
data[].detail_object.daily_periodic_rate decimal Conditionally returned	Daily rate used to calculate interest. Returned for interest. Allowable Values: 0–100
data[].detail_object.days_in_billing_cycle integer Conditionally returned	Number of days in the billing cycle. Returned for interest. Allowable Values: 1–31
data[].detail_object.interest_amount decimal Conditionally returned	Amount of interest calculated for the billing period. Returned for interest. Allowable Values: Format: 0.00
data[].detail_object.created_date datetime Conditionally returned	Date and time when the interest was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].detail_object.updated_date datetime Conditionally returned	Date and time when the interest was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON

{
  "count": 3,
  "start_index": 0,
  "end_index": 4,
  "is_more": true,
  "data": [
    {
      "token": "interest_journal_entry_token1111",
      "account_token": "my_account_token_12",
      "user_token": "user_token1111",
      "card_token": "my_credit_card_token7794",
      "status": "POSTED",
      "group": "INTEREST",
      "type": "account.interest",
      "id": "11112222",
      "amount": 2.31,
      "currency_code": "USD",
      "memo": "Interest charge on purchases",
      "request_time": "2021-08-01T03:59:59Z",
      "impact_time": "2021-08-01T03:59:59Z",
      "created_time": "2021-08-01T07:00:19Z",
      "detail_token": "detail_token_96749",
      "detail_object": {
        "token": "detail_token_96749",
        "account_token": "my_account_token_12",
        "statement_token": "statement_token_75b",
        "statement_opening_date": "2021-07-01T04:00:00Z",
        "statement_closing_date": "2021-08-01T03:59:59Z",
        "statement_balance": 208.93,
        "average_daily_balance": 181.67,
        "goto_apr": 14.99,
        "daily_periodic_rate": 0.00041068,
        "days_in_billing_cycle": 31,
        "interest_amount": 2.31,
        "currency_code": "USD",
        "created_date": "2021-08-01T07:00:19Z",
        "updated_date": "2021-08-01T07:00:19Z"
      }
    },
    {
      "token": "fee_journal_entry_token2121",
      "account_token": "my_account_token_12",
      "user_token": "user_token2121",
      "card_token": "my_credit_card_token7794",
      "status": "POSTED",
      "group": "FEE",
      "type": "account.fee.payment.late",
      "id": "44445678",
      "amount": 15,
      "currency_code": "USD",
      "memo": "Late payment fee",
      "request_time": "2021-07-01T03:59:59Z",
      "impact_time": "2021-07-01T03:59:59Z",
      "created_time": "2021-07-01T07:00:24Z",
      "detail_token": "detail_token_11221",
      "detail_object": {
        "token": "detail_token_11221",
        "account_token": "my_account_token_12",
        "type": "LATE_PAYMENT_FEE",
        "method": "FLAT",
        "value": 25,
        "currency_code": "USD",
        "amount": 15,
        "description": "Late Payment Fee",
        "created": "2021-07-01T07:00:24Z"
      }
    },
    {
      "token": "purchase_journal_entry_token6789",
      "related_token": "journal_entry_token2460",
      "root_token": "journal_entry_token2460",
      "account_token": "my_account_token_12",
      "user_token": "user_token12",
      "card_token": "my_credit_card_token7794",
      "status": "POSTED",
      "group": "PURCHASE",
      "type": "authorization.clearing",
      "id": "12345678",
      "amount": 9.11,
      "currency_code": "USD",
      "memo": "SWEET TREATS 0484",
      "request_time": "2021-09-25T20:59:43Z",
      "impact_time": "2021-09-26T11:53:48Z",
      "created_time": "2021-09-26T11:53:48Z",
      "detail_token": "detail_token_645736",
      "detail_object": {
        "type": "authorization.clearing",
        "state": "COMPLETION",
        "identifier": 6457,
        "token": "detail_token_645736",
        "user_token": "user_token4632",
        "acting_user_token": "user_token4632",
        "card_token": "my_credit_card_token7794",
        "preceding_related_transaction_token": "journal_entry_token2460",
        "gpa": {
          "currency_code": "USD",
          "ledger_balance": 61.7,
          "available_balance": 0,
          "credit_balance": 0,
          "pending_credits": 0,
          "impacted_amount": -9.11,
          "balances": {
            "USD": {
              "currency_code": "USD",
              "ledger_balance": 61.7,
              "available_balance": 0,
              "credit_balance": 0,
              "pending_credits": 0,
              "impacted_amount": -9.11
            }
          }
        },
        "gpa_order": {
          "token": "gpa_order_token2c2c5",
          "amount": 9.11,
          "created_time": "2021-09-25T20:59:43Z",
          "last_modified_time": "2021-09-26T11:53:47Z",
          "transaction_token": "transaction_token42352a",
          "state": "COMPLETION",
          "response": {
            "code": 0,
            "memo": "Approved or completed successfully"
          },
          "funding": {
            "amount": 9.11,
            "source": {
              "type": "programgateway",
              "token": "funding_source_token6789",
              "active": true,
              "name": "My Funding Source",
              "is_default_account": false,
              "created_time": "2021-06-22T18:41:14Z",
              "last_modified_time": "2021-06-22T18:41:14Z"
            }
          },
          "funding_source_token": "funding_source_token6789",
          "jit_funding": {
            "token": "jit_funding_token43a3",
            "method": "pgfs.authorization.capture",
            "user_token": "user_token4632",
            "acting_user_token": "user_token4632",
            "amount": 9.11,
            "original_jit_funding_token": "jit_funding_token4be7"
          },
          "user_token": "user_token4632",
          "currency_code": "USD"
        },
        "duration": 378,
        "created_time": "2021-09-26T11:53:46Z",
        "user_transaction_time": "2021-09-25T20:59:43Z",
        "settlement_date": "2021-09-26T00:00:00Z",
        "request_amount": 9.11,
        "amount": 9.11,
        "currency_conversion": {
          "network": {
            "original_amount": 9.11,
            "conversion_rate": 1,
            "original_currency_code": 840
          }
        },
        "issuer_interchange_amount": 0.19131,
        "currency_code": "USD",
        "approval_code": 946791,
        "response": {
          "code": 0,
          "memo": "Approved or completed successfully"
        },
        "network": "VISA",
        "subnetwork": "VISANET",
        "acquirer_fee_amount": 0,
        "acquirer": {
          "system_trace_audit_number": 0
        },
        "fees": {
          "type": "INTERCHANGE_FEE",
          "amount": 0.19131,
          "credit_debit": "C"
        },
        "user": {
          "metadata": {
            "notification_email": "hello@myemail.com"
          }
        },
        "card": {
          "last_four": 4489,
          "metadata": {}
        },
        "issuer_received_time": "2021-09-26T11:53:46Z",
        "issuer_payment_node": "042f97a3458b59e3cce0269f66e864d8",
        "network_reference_id": "000218552461989029",
        "clearing_record_sequence_number": 0,
        "batch_number": 2021048291031352,
        "acquirer_reference_data": 4.355106395860054e+22,
        "card_acceptor": {
          "mid": "000555600244811",
          "mcc": 5814,
          "name": "SWEET TREATS 0484",
          "city": "OAKLAND",
          "state": "CA",
          "postal_code": 94612,
          "country_code": "US"
        },
        "pos": {
          "terminal_id": 65,
          "pin_present": false,
          "partial_approval_capable": false,
          "purchase_amount_only": false,
          "is_recurring": false,
          "is_installment": false
        },
        "transaction_metadata": {
          "payment_channel": "OTHER"
        },
        "network_metadata": {
          "product_id": "VISA_TRADITIONAL",
          "program_id": ""
        }
      }
    }
  ]
}

List account statement ledger entries

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/ledgerentries

Important
This feature is being deprecated and replaced by statement journal entries. To list statement journal entries, see List account statement journal entries.

Retrieve an array of ledger entries on a credit account’s statement summary. This endpoint supports sorting.

URL path parameters

Fields	Description
account_token string Required	The unique identifier of the credit account for which to retrieve the statement ledger entries. 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 ledger entries. Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens. Allowable Values: Existing statement summary token

URL query parameters

Fields	Description
expand string Optional	Embeds the specified object into the response. Allowable Values: `detailObject`
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 `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. Allowable Values: `lastModifiedTime`, `-lastModifiedTime`

Response body

Fields	Description
token string Returned	Unique identifier of the ledger entry. Allowable Values: 36 char max
related_token string Conditionally returned	Unique identifier of the original ledger entry. If the current ledger entry is the original, this field is returned empty. Allowable Values: Existing ledger entry token
root_token string Conditionally returned	Unique identifier of the root ledger entry. If the current ledger entry is the root, this field is returned empty. Allowable Values: Existing ledger entry token
account_token string Returned	Unique identifier of the credit account associated with the credit card used to make the ledger entry. Allowable Values: Existing account token
card_token string Returned	Unique identifier of the credit card used to make the ledger entry. Allowable Values: 8–36 chars Existing credit card token
status string Returned	Status of the ledger entry when it was initially recorded and had an impact on the balance, either `PENDING` or `POSTED`. This field is immutable and may not represent the current status. To view the current status of purchases, refunds, OCTs, and payments, see the `detail_object.state` field. These ledger entries start in `PENDING` and can transition to `CLEARED`, `DECLINED`, or `ERROR`. This transition of status is only sent through webhook event notifications. Ledger entries that are final transactions, such as clearings, start and remain in a `POSTED` state. NOTE: `CLEARED`, `DECLINED`, and `ERROR` are special statuses that do not have an impact on the account balance, and are not recorded in the ledger. For these special statuses, `impact_time`, `request_time`, `created_time`, `token`, and `id` are returned blank. Allowable Values: `PENDING`, `POSTED`, `DECLINED`, `ERROR`, `CLEARED`
group string Returned	Group to which the ledger entry belongs. Allowable Values: `PURCHASE`, `INTERNAL`, `FEE`, `REWARD`, `INTEREST`, `PAYMENT`, `ADJUSTMENT`, `BALANCE_TRANSFER`, `CASH_ADVANCE`, `BALANCE_REFUND`, `ORIGINAL_CREDIT`
type string Returned	The ledger entry event type. Allowable Values: Example: `authorization.clearing` A valid ledger entry event type
id string Returned	Eight-digit numeric identifier of the ledger entry, an alternate identifier to the UUID that is useful for remembering and referencing. Allowable Values: 8 chars
amount decimal Returned	Amount of the ledger entry. Allowable Values: Format: 0.00
currency_code string Returned	A valid three-digit ISO 4217 currency code Allowable Values: `USD`
memo string Returned	Merchant name or description for the ledger entry. Allowable Values: Example: Whole Foods Market
request_time datetime Returned	For purchases, the date and time of the authorization, which is when the user initiates the ledger entry. For other ledger entry groups, equivalent to `impact_time`. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
impact_time datetime Returned	Date and time when the ledger entry impacts the account balance. For purchases, this is the time of the authorization. For purchase authorization clearings, this is the time when the transaction is settled. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
created_time datetime Returned	Date and time when the ledger entry was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
dispute_token string Conditionally returned	Unique identifier of the dispute, if the ledger entry is disputed. Allowable Values: Existing dispute token
detail_token string Returned	Unique identifier of the ledger entry’s full details. Allowable Values: 36 char max
detail_object object Conditionally returned	Contains the ledger entry’s full details. The fields returned in this object vary based on the ledger entry group. The following lists each ledger entry group and the specific fields returned for each group. - Purchases and refunds: see the transactions response fields. - Disputes: see the account disputes response fields. - Original credit transaction (OCT): see the Push-to-Card disbursement fields. - Rewards: see the account reward response fields. - Payments: see the account payment response fields. - Balance refunds: see the balance refund response fields. - Adjustments: see the account adjustment response fields. - Interest and fees: see fields below. Allowable Values: Existing detail object
detail_object.token string Conditionally returned	Unique identifier of the interest charge or fee. If in the `detail_object`, unique identifier of the detail object. Returned for interest or fees. Allowable Values: 36 char max
detail_object.account_token string Conditionally returned	Unique identifier of the credit account on which the interest or fee was charged. Returned for interest or fees. Allowable Values: 36 char max Existing account token
detail_object.type string Conditionally returned	Type of fee. Returned for fees. Allowable Values: `FOREIGN_TRANSACTION_FEE`, `OVER_LIMIT_FEE`, `LATE_PAYMENT_FEE`, `RETURNED_PAYMENT_FEE`, `CARD_REPLACEMENT_FEE`, `MINIMUM_INTEREST_FEE`, `MINIMUM_INTEREST_FEE_REVERSAL`, `ANNUAL_FEE`, `MONTHLY_FEE`
detail_object.method string Conditionally returned	Method used to calculate the fee value. Returned for fees. Allowable Values: `PERCENTAGE`, `FLAT`
detail_object.value decimal Conditionally returned	Value of the fee configured on the account. Equivalent to `config.fees.schedule.value` on the credit account. Send a `GET` request to `/credit/accounts/{account_token}` to retrieve an existing credit account. Returned for fees. Allowable Values: Format: 0.00
detail_object.currency_code string Conditionally returned	A valid three-digit ISO 4217 currency code Allowable Values: `USD`
detail_object.amount decimal Conditionally returned	Amount of the fee. Returned for fees. Allowable Values: Format: 0.00
detail_object.applied_to_amount decimal Conditionally returned	The total amount to which a percentage fee method is applied (for example, if a 3% fee is applied to 100, then `100` is the `applied_to_amount` value). This field is not applicable for a flat fee method. Returned for fees. NOTE: This field is currently not supported and returns `null`. Allowable Values: Format: 0.00
detail_object.description string Conditionally returned	Description of the fee. Returned for fees. Allowable Values: 255 char max
detail_object.created datetime Conditionally returned	Date and time when the fee was created. Returned for fees. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
detail_object.statement_token string Conditionally returned	Unique identifier of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Existing statement summary token
detail_object.statement_opening_date datetime Conditionally returned	Opening date of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
detail_object.statement_closing_date datetime Conditionally returned	Closing date of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
detail_object.statement_balance decimal Conditionally returned	Balance on the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: 0.00
detail_object.average_daily_balance decimal Conditionally returned	Average daily balance used to calculate interest. Returned for interest. Allowable Values: Format: 0.00
detail_object.goto_apr decimal Conditionally returned	Annual percentage rate. Returned for interest. Allowable Values: 0–100
detail_object.daily_periodic_rate decimal Conditionally returned	Daily rate used to calculate interest. Returned for interest. Allowable Values: 0–100
detail_object.days_in_billing_cycle integer Conditionally returned	Number of days in the billing cycle. Returned for interest. Allowable Values: 1–31
detail_object.interest_amount decimal Conditionally returned	Amount of interest calculated for the billing period. Returned for interest. Allowable Values: Format: 0.00
detail_object.created_date datetime Conditionally returned	Date and time when the interest was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
detail_object.updated_date datetime Conditionally returned	Date and time when the interest was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON

[
  {
    "token": "ledger_entry_token6789",
    "related_token": "ledger_entry_token2460",
    "root_token": "ledger_entry_token2460",
    "account_token": "my_account_token_12",
    "card_token": "my_credit_card_token7794",
    "status": "POSTED",
    "group": "PURCHASE",
    "type": "authorization.clearing",
    "id": "12345678",
    "amount": 9.11,
    "currency_code": "USD",
    "memo": "SWEET TREATS 0484",
    "request_time": "2021-09-25T20:59:43Z",
    "impact_time": "2021-09-26T11:53:48Z",
    "created_time": "2021-09-26T11:53:48Z",
    "detail_token": "detail_token_645736",
    "detail_object": {
      "type": "authorization.clearing",
      "state": "COMPLETION",
      "identifier": 6457,
      "token": "detail_token_645736",
      "user_token": "user_token4632",
      "acting_user_token": "user_token4632",
      "card_token": "my_credit_card_token7794",
      "preceding_related_transaction_token": "ledger_entry_token2460",
      "gpa": {
        "currency_code": "USD",
        "ledger_balance": 61.7,
        "available_balance": 0,
        "credit_balance": 0,
        "pending_credits": 0,
        "impacted_amount": -9.11,
        "balances": {
          "USD": {
            "currency_code": "USD",
            "ledger_balance": 61.7,
            "available_balance": 0,
            "credit_balance": 0,
            "pending_credits": 0,
            "impacted_amount": -9.11
          }
        }
      },
      "gpa_order": {
        "token": "gpa_order_token2c2c5",
        "amount": 9.11,
        "created_time": "2021-09-25T20:59:43Z",
        "last_modified_time": "2021-09-26T11:53:47Z",
        "transaction_token": "transaction_token42352a",
        "state": "COMPLETION",
        "response": {
          "code": 0,
          "memo": "Approved or completed successfully"
        },
        "funding": {
          "amount": 9.11,
          "source": {
            "type": "programgateway",
            "token": "funding_source_token6789",
            "active": true,
            "name": "My Funding Source",
            "is_default_account": false,
            "created_time": "2021-06-22T18:41:14Z",
            "last_modified_time": "2021-06-22T18:41:14Z"
          }
        },
        "funding_source_token": "funding_source_token6789",
        "jit_funding": {
          "token": "jit_funding_token43a3",
          "method": "pgfs.authorization.capture",
          "user_token": "user_token4632",
          "acting_user_token": "user_token4632",
          "amount": 9.11,
          "original_jit_funding_token": "jit_funding_token4be7"
        },
        "user_token": "user_token4632",
        "currency_code": "USD"
      },
      "duration": 378,
      "created_time": "2021-09-26T11:53:46Z",
      "user_transaction_time": "2021-09-25T20:59:43Z",
      "settlement_date": "2021-09-26T00:00:00Z",
      "request_amount": 9.11,
      "amount": 9.11,
      "currency_conversion": {
        "network": {
          "original_amount": 9.11,
          "conversion_rate": 1,
          "original_currency_code": 840
        }
      },
      "issuer_interchange_amount": 0.19131,
      "currency_code": "USD",
      "approval_code": 946791,
      "response": {
        "code": 0,
        "memo": "Approved or completed successfully"
      },
      "network": "VISA",
      "subnetwork": "VISANET",
      "acquirer_fee_amount": 0,
      "acquirer": {
        "system_trace_audit_number": 0
      },
      "fees": {
        "type": "INTERCHANGE_FEE",
        "amount": 0.19131,
        "credit_debit": "C"
      },
      "user": {
        "metadata": {
          "notification_email": "hello@myemail.com"
        }
      },
      "card": {
        "last_four": 4489,
        "metadata": {}
      },
      "issuer_received_time": "2021-09-26T11:53:46Z",
      "issuer_payment_node": "042f97a3458b59e3cce0269f66e864d8",
      "network_reference_id": "000218552461989029",
      "clearing_record_sequence_number": 0,
      "batch_number": 2021048291031352,
      "acquirer_reference_data": 4.355106395860054e+22,
      "card_acceptor": {
        "mid": "000555600244811",
        "mcc": 5814,
        "name": "SWEET TREATS 0484",
        "city": "OAKLAND",
        "state": "CA",
        "postal_code": 94612,
        "country_code": "US"
      },
      "pos": {
        "terminal_id": 65,
        "pin_present": false,
        "partial_approval_capable": false,
        "purchase_amount_only": false,
        "is_recurring": false,
        "is_installment": false
      },
      "transaction_metadata": {
        "payment_channel": "OTHER"
      },
      "network_metadata": {
        "product_id": "VISA_TRADITIONAL",
        "program_id": ""
      }
    }
  }
]

Retrieve account statement interest charges

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/interestcharges 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
    }
  ]
}

Retrieve account statement rewards

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/rewards Retrieve the rewards on a credit account’s statement summary.

URL path parameters

Fields	Description
account_token string Required	The unique identifier of the credit account from which to retrieve statement rewards. 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 rewards. 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 string Conditionally returned	Unique identifier of the rewards for a specific statement. Allowable Values: 36 char max
previous_billing_cycle_reward decimal Conditionally returned	Amount of rewards received in the previous billing cycle. Allowable Values: Format: 0.00
current_billing_cycle_reward decimal Conditionally returned	Amount of rewards received in the current billing cycle. Allowable Values: Format: 0.00
created_time datetime Conditionally returned	Date and time when the statement reward was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON

{
  "token": "account_statement_reward1234",
  "previous_billing_cycle_reward": 0,
  "current_billing_cycle_reward": 0,
  "created_time": "2022-09-01T00:27:09Z"
}

Retrieve account statement year-to-date totals

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/yeartodate Retrieve the year-to-date fee and interest totals on a credit account’s statement summary.

URL path parameters

Fields	Description
account_token string Required	The unique identifier of the credit account from which to retrieve statement year-to-date totals. 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 year-to-date totals. 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 year-to-date total. Allowable Values: 36 char max
account_token string Returned	Unique identifier of the associated credit account. Allowable Values: 36 char max Existing account token
statement_token uuid Returned	Unique identifier of the statement summary from which to retrieve year-to-date totals. Allowable Values: Existing statement summary token
total_fees decimal Returned	Total fees charged year-to-date. Allowable Values: Format: 0.00
total_interest decimal Returned	Total interest charged year-to-date. Allowable Values: Format: 0.00
created_time datetime Conditionally returned	Date and time when the year-to-date total was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON

{
  "token": "c40b683b-ad88-51b6-a1fa-bc9961bc011e",
  "account_token": "my_account_token_12",
  "statement_token": "c07918af-2ffa-4da9-972c-6b3d24b2a772",
  "total_fees": 0,
  "total_interest": 0,
  "created_time": "2021-07-01T00:27:09Z"
}

List files for a statement summary

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/files Retrieve an array of statement files for a specific statement summary.

URL path parameters

Fields	Description
account_token string Required	The unique identifier of the credit account for which to retrieve statement files for a statement summary. 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 whose statement files you want to retrieve. Send a `GET` request to `/credit/accounts/{token}/statements` to retrieve existing statement summary tokens. Allowable Values: Existing statement summary token

URL query parameters

Fields	Description
count integer Optional	The number of statement files to return. Allowable Values: 1–100
start_index integer Optional	Sort order index from which to begin returning files. Allowable Values: 0 min

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	List of statement files. Allowable Values: One or more statement files
data[].token string Conditionally returned	Unique identifier of the statement file. Allowable Values: 36 char max
data[].account_token string Conditionally returned	Unique identifier of the credit account on which the statement PDF file is generated. Allowable Values: 36 char max Existing account token
data[].statement_summary_token uuid Conditionally returned	Unique identifier of the statement summary. Allowable Values: Existing statement summary token
data[].opening_date datetime Conditionally returned	Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].closing_date datetime Conditionally returned	Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].signed_url string Conditionally returned	The signed URL to retrieve the statement PDF file. Allowable Values: A valid signed URL
data[].type string Conditionally returned	Type of file. Allowable Values: `STATEMENT_PDF`

Sample response body

JSON

{
  "count": 1,
  "start_index": 0,
  "end_index": 0,
  "is_more": false,
  "data": [
    {
      "token": "file_token",
      "account_token": "credit_account_token1234",
      "statement_summary_token": "37f07818-2a2c-4c82-a721-a479936d5b2e",
      "opening_date": "2021-07-01T00:27:09Z",
      "closing_date": "2021-07-31T00:27:09Z",
      "signed_url": "<signed_https_url_pointing_to_a_resource_on_S3>",
      "type": "STATEMENT_PDF"
    }
  ]
}

List files for an account

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/files Retrieve an array of statement files for a specific credit account.

URL path parameters

Fields	Description
account_token string Required	The unique identifier of the credit account for which to retrieve statement files. 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	The start date of the statement files to return. Allowable Values: Example: 2020-01-01T00:00:00Z
end_date datetime Optional	The end date of the statement files to return. Allowable Values: Example: 2020-03-01T03:59:59Z
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	List of statement files. Allowable Values: One or more statement files
data[].token string Conditionally returned	Unique identifier of the statement file. Allowable Values: 36 char max
data[].account_token string Conditionally returned	Unique identifier of the credit account on which the statement PDF file is generated. Allowable Values: 36 char max Existing account token
data[].statement_summary_token uuid Conditionally returned	Unique identifier of the statement summary. Allowable Values: Existing statement summary token
data[].opening_date datetime Conditionally returned	Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].closing_date datetime Conditionally returned	Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].signed_url string Conditionally returned	The signed URL to retrieve the statement PDF file. Allowable Values: A valid signed URL
data[].type string Conditionally returned	Type of file. Allowable Values: `STATEMENT_PDF`

Sample response body

JSON

{
  "count": 1,
  "start_index": 0,
  "end_index": 0,
  "is_more": false,
  "data": [
    {
      "token": "file_token",
      "account_token": "credit_account_token1234",
      "statement_summary_token": "37f07818-2a2c-4c82-a721-a479936d5b2e",
      "opening_date": "2021-07-01T00:27:09Z",
      "closing_date": "2021-07-31T00:27:09Z",
      "signed_url": "<signed_https_url_pointing_to_a_resource_on_S3>",
      "type": "STATEMENT_PDF"
    },
    {
      "token": "file_token",
      "account_token": "credit_account_token4567",
      "statement_summary_token": "79938791-5e15-456a-bf13-c39142c9a763",
      "opening_date": "2021-06-01T00:27:09Z",
      "closing_date": "2021-06-30T00:27:09Z",
      "signed_url": "<signed_https_url_pointing_to_a_resource_on_S3>",
      "type": "STATEMENT_PDF"
    }
  ]
}

Resend credit event notification

Action: POST
Endpoint: /credit/webhooks/{event_type}/{resource_token} Resends a credit event notification to your webhook endpoint. Although you send this request as a POST, all parameters are passed in the URL and the body is empty. The event notification is resent to your webhook endpoint and also returned in the response to this request. For details on how to configure your webhook endpoint, see the About Webhooks tutorial. For the complete /webhooks endpoint reference, see Webhooks.

URL path parameters

Fields	Description
event_type string Required	Specifies the type of event you want to resend. Allowable Values: `ledgerentry`, `journalentry`, `accounttransition`, `accountstatement`, `paymenttransition`, `delinquencytransition`
resource_token string Required	The unique identifier of the resource for which you want to resend a notification. Send a `GET` request to `/credit/accounts/{account_token}/journalentries` to retrieve existing journal entry tokens. Send a `GET` request to `/credit/accounts/{account_token}/ledgerentries` to retrieve existing ledger entry tokens. Send a `GET` request to `/accounts/{account_token}/accounttransitions` to retrieve existing account transition tokens. Send a `GET` request to `/credit/accounts/{account_token}/payments/{payment_token}` to retrieve existing payment transition tokens. Send a `GET` request to `/accounts/{account_token}/statements` to retrieve existing statement summary tokens. Send a `GET` request to `/accounts/{account_token}/delinquencystate/transitions` to retrieve existing delinquency transition tokens. Allowable Values: Existing journal entry token, ledger entry token, account transition token, payment transition token, statement summary token, or delinquency transition token

Response body

Fields	Description
unused string Conditionally returned	The event notification that was resent to your webhook endpoint. Allowable Values: Valid event notification

Sample response body

The following code block shows a sample of a resent creditaccounttransitions event.

JSON

{
  "token": "my_credit_account_transition_token1234",
  "account_token": "my_credit_account_token1234",
  "original_status": "UNACTIVATED",
  "status": "ACTIVE",
  "created_time": "2021-08-18T20:25:10.408Z"
}

The following code block shows a sample of a resent creditaccountstatements event.

JSON

{
  "token": "my_credit_account_statement_token",
  "account_token": "my_credit_account_token",
  "opening_balance": 496.45,
  "closing_balance": 506.41,
  "credit_limit": 500,
  "available_credit": 0,
  "past_due_amount": 10,
  "purchases": 0,
  "interest": 4.96,
  "fees": 15,
  "credits": 0,
  "payments": 10,
  "days_in_billing_cycle": 31,
  "cycle_type": "REVOLVING",
  "opening_date": "2023-03-01T05:00:00.000Z",
  "closing_date": "2023-04-01T03:59:59.999Z",
  "created_time": "2021-08-18T22:04:31.261Z"
}

The following code block shows a sample of a resent creditjournalentries event.

JSON

{
  "token": "my_journal_entry_token1234",
  "related_token": null,
  "root_token": null,
  "account_token": "my_credit_account_token1234",
  "card_token": "my_credit_card_token1234",
  "status": "PENDING",
  "group": "PURCHASE",
  "type": "authorization",
  "id": "12345678",
  "amount": 10,
  "currency_code": "USD",
  "memo": "Jane's Bakery",
  "request_time": "2021-08-18T22:06:52.000Z",
  "impact_time": "2021-08-18T22:07:21.422Z",
  "created_time": "2021-08-18T22:07:21.422Z",
  "dispute_token": null,
  "detail_token": "my_detail_token1234",
  "detail_object": {
    "type": "authorization",
    "state": "PENDING",
    "identifier": "234",
    "token": "my_detail_token1234",
    "user_token": "my_user_token",
    "acting_user_token": "my_user_token",
    "card_token": "my_credit_card_token1234",
    "gpa": {
      "currency_code": "USD",
      "ledger_balance": 510.87,
      "available_balance": 0,
      "credit_balance": 0,
      "pending_credits": 0,
      "impacted_amount": -10,
      "balances": {
        "USD": {
          "currency_code": "USD",
          "ledger_balance": 510.87,
          "available_balance": 0,
          "credit_balance": 0,
          "pending_credits": 0,
          "impacted_amount": -10
        }
      }
    },
    "gpa_order": {
      "token": "my_gpa_order_token1234",
      "amount": 10,
      "created_time": "2021-08-18T22:06:53Z",
      "last_modified_time": "2021-08-18T22:06:53Z",
      "transaction_token": "my_transaction_token1234",
      "state": "PENDING",
      "response": {
        "code": "0000",
        "memo": "Approved or completed successfully"
      },
      "funding": {
        "amount": 10,
        "source": {
          "type": "programgateway",
          "token": "**********1ab2",
          "active": true,
          "name": "credit_backed_funding_source",
          "is_default_account": false,
          "created_time": "2021-10-14T17:26:35Z",
          "last_modified_time": "2021-10-14T17:26:35Z"
        },
        "gateway_log": {
          "order_number": "my_gateway_token12345",
          "transaction_id": "my_transaction_id1234",
          "message": "Approved or completed successfully",
          "duration": 485,
          "timed_out": false,
          "response": {
            "code": "200",
            "data": {
              "jit_funding": {
                "token": "my_jit_funding_token1234",
                "method": "pgfs.authorization",
                "user_token": "my_user_token",
                "acting_user_token": "my_user_token",
                "amount": 10
              }
            }
          }
        }
      },
      "funding_source_token": "**********1ab2",
      "jit_funding": {
        "token": "my_transaction_id1234",
        "method": "pgfs.authorization",
        "user_token": "my_user_token",
        "acting_user_token": "my_user_token",
        "amount": 10
      },
      "user_token": "my_user_token",
      "currency_code": "USD"
    },
    "duration": 837,
    "created_time": "2021-08-18T22:06:52Z",
    "user_transaction_time": "2021-08-18T22:06:52Z",
    "settlement_date": "2021-08-18T00:00:00Z",
    "request_amount": 10,
    "amount": 10,
    "currency_code": "USD",
    "approval_code": "974406",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "network": "DISCOVER",
    "acquirer_fee_amount": 0,
    "acquirer": {
      "system_trace_audit_number": "376582"
    },
    "user": {
      "metadata": {
        "key1": "value1",
        "key2": "value2",
        "notification_email": "user@domain.com",
        "notification_language": "spa"
      }
    },
    "card": {
      "last_four": "9949",
      "metadata": {}
    },
    "issuer_received_time": "2021-08-18T22:06:52.771Z",
    "issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
    "network_reference_id": "484311571095",
    "card_acceptor": {
      "mid": "1234",
      "mcc": "6411",
      "name": "Jane's Bakery",
      "street_address": "1989 Fillmore St",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94115",
      "country_code": "USA"
    },
    "pos": {
      "pin_present": false,
      "partial_approval_capable": true,
      "purchase_amount_only": false,
      "is_recurring": false,
      "is_installment": false
    }
  }
}

The following code block shows a sample of a resent creditledgerentries event.

JSON

{
  "token": "my_ledger_entry_token1234",
  "related_token": null,
  "root_token": null,
  "account_token": "my_credit_account_token1234",
  "card_token": "my_credit_card_token1234",
  "status": "PENDING",
  "group": "PURCHASE",
  "type": "authorization",
  "id": "12345678",
  "amount": 10,
  "currency_code": "USD",
  "memo": "Jane's Bakery",
  "request_time": "2021-08-18T22:06:52.000Z",
  "impact_time": "2021-08-18T22:07:21.422Z",
  "created_time": "2021-08-18T22:07:21.422Z",
  "dispute_token": null,
  "detail_token": "my_detail_token1234",
  "detail_object": {
    "type": "authorization",
    "state": "PENDING",
    "identifier": "234",
    "token": "my_detail_token1234",
    "user_token": "my_user_token",
    "acting_user_token": "my_user_token",
    "card_token": "my_credit_card_token1234",
    "gpa": {
      "currency_code": "USD",
      "ledger_balance": 510.87,
      "available_balance": 0,
      "credit_balance": 0,
      "pending_credits": 0,
      "impacted_amount": -10,
      "balances": {
        "USD": {
          "currency_code": "USD",
          "ledger_balance": 510.87,
          "available_balance": 0,
          "credit_balance": 0,
          "pending_credits": 0,
          "impacted_amount": -10
        }
      }
    },
    "gpa_order": {
      "token": "my_gpa_order_token1234",
      "amount": 10,
      "created_time": "2021-08-18T22:06:53Z",
      "last_modified_time": "2021-08-18T22:06:53Z",
      "transaction_token": "my_transaction_token1234",
      "state": "PENDING",
      "response": {
        "code": "0000",
        "memo": "Approved or completed successfully"
      },
      "funding": {
        "amount": 10,
        "source": {
          "type": "programgateway",
          "token": "**********1ab2",
          "active": true,
          "name": "credit_backed_funding_source",
          "is_default_account": false,
          "created_time": "2021-10-14T17:26:35Z",
          "last_modified_time": "2021-10-14T17:26:35Z"
        },
        "gateway_log": {
          "order_number": "my_gateway_token12345",
          "transaction_id": "my_transaction_id1234",
          "message": "Approved or completed successfully",
          "duration": 485,
          "timed_out": false,
          "response": {
            "code": "200",
            "data": {
              "jit_funding": {
                "token": "my_jit_funding_token1234",
                "method": "pgfs.authorization",
                "user_token": "my_user_token",
                "acting_user_token": "my_user_token",
                "amount": 10
              }
            }
          }
        }
      },
      "funding_source_token": "**********1ab2",
      "jit_funding": {
        "token": "my_transaction_id1234",
        "method": "pgfs.authorization",
        "user_token": "my_user_token",
        "acting_user_token": "my_user_token",
        "amount": 10
      },
      "user_token": "my_user_token",
      "currency_code": "USD"
    },
    "duration": 837,
    "created_time": "2021-08-18T22:06:52Z",
    "user_transaction_time": "2021-08-18T22:06:52Z",
    "settlement_date": "2021-08-18T00:00:00Z",
    "request_amount": 10,
    "amount": 10,
    "currency_code": "USD",
    "approval_code": "974406",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "network": "DISCOVER",
    "acquirer_fee_amount": 0,
    "acquirer": {
      "system_trace_audit_number": "376582"
    },
    "user": {
      "metadata": {
        "key1": "value1",
        "key2": "value2",
        "notification_email": "user@domain.com",
        "notification_language": "spa"
      }
    },
    "card": {
      "last_four": "9949",
      "metadata": {}
    },
    "issuer_received_time": "2021-08-18T22:06:52.771Z",
    "issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
    "network_reference_id": "484311571095",
    "card_acceptor": {
      "mid": "1234",
      "mcc": "6411",
      "name": "Jane's Bakery",
      "street_address": "1989 Fillmore St",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94115",
      "country_code": "USA"
    },
    "pos": {
      "pin_present": false,
      "partial_approval_capable": true,
      "purchase_amount_only": false,
      "is_recurring": false,
      "is_installment": false
    }
  }
}

The following code block shows a sample of a resent creditpaymenttransitions event.

JSON

{
  "token": "my_payment_transition_token1234",
  "account_token": "my_credit_account_token1234",
  "payment_token": "my_credit_account_payment_token1234",
  "status": "COMPLETED",
  "refund_details": null,
  "created_time": "2021-08-17T18:26:47.591Z"
}

The following code block shows a sample of a resent creditdelinquencytransitions event.

JSON

{
  "token": "my_delinquency_transition_token1234",
  "account_token": "my_credit_account_token1234",
  "transition_trigger_reason": "STATEMENT_GENERATION",
  "transition_trigger_time": "2023-03-01 04:59:59.999",
  "original_status": "CURRENT",
  "status": "DELINQUENT",
  "impact_time": "2023-03-01 04:59:59.999",
  "total_past_due": 100,
  "current_due": 40,
  "total_due": 140,
  "oldest_payment_due_date": "2023-02-01 04:59:59.999",
  "bucket_count": 2,
  "is_invalidated": false,
  "created_time": "2023-03-01 04:59:59.999",
  "updated_time": "2023-03-01 04:59:59.999"
}

Core API Basics

SDKs

Credentials

Account Holders

Funding

Just-in-Time Funding

Cards

Digital Wallets

Spend Control

Accounts

Transactions

3D Secure

Real-Time Decisioning

Disputes

Digital Banking

Credit Programs

Credit Account Management

Credit Account Servicing

Credit Reward Accounts

Testing

Webhooks

​List account statement summaries

​URL path parameters

​URL query parameters

​Response body

​Sample response body

​Retrieve account statement summary

​URL path parameters

​Response body

​Sample response body

​Retrieve account statement payment information

​URL path parameters

​Response body

​Sample response body

​List account statement journal entries

​URL path parameters

​URL query parameters

​Response body

​Sample response body

​List account statement ledger entries

​URL path parameters

​URL query parameters

​Response body

​Sample response body

​Retrieve account statement interest charges

​URL path parameters

​Response body

​Sample response body

​Retrieve account statement rewards

​URL path parameters

​Response body

​Sample response body

​Retrieve account statement year-to-date totals

​URL path parameters

​Response body

​Sample response body

​List files for a statement summary

​URL path parameters

​URL query parameters

​Response body

​Sample response body

​List files for an account

​URL path parameters

​URL query parameters

​Response body

​Sample response body

​Resend credit event notification

​URL path parameters

​Response body

​Sample response body

List account statement summaries

URL path parameters

URL query parameters

Response body

Sample response body

Retrieve account statement summary

URL path parameters

Response body

Sample response body

Retrieve account statement payment information

URL path parameters

Response body

Sample response body

List account statement journal entries

URL path parameters

URL query parameters

Response body

Sample response body

List account statement ledger entries

URL path parameters

URL query parameters

Response body

Sample response body

Retrieve account statement interest charges

URL path parameters

Response body

Sample response body

Retrieve account statement rewards

URL path parameters

Response body

Sample response body

Retrieve account statement year-to-date totals

URL path parameters

Response body

Sample response body

List files for a statement summary

URL path parameters

URL query parameters

Response body

Sample response body

List files for an account

URL path parameters

URL query parameters

Response body

Sample response body

Resend credit event notification

URL path parameters

Response body

Sample response body