Marqeta Statements API

openapi: 3.0.3
info:
  contact:
    email: support@marqeta.com
    name: Marqeta
  description: Marqeta's Core API endpoints, conveniently annotated to enable code generation (including SDKs), test cases, and documentation. Currently in beta.
  termsOfService: https://www.marqeta.com/api-terms
  title: Core accepted countries Statements API
  version: 3.0.39
servers:
- url: /v3
security:
- mqAppAndAccessToken: []
tags:
- description: '// Conditional snippet for beta or internal content

    include::../../maturity-admonition-banner.adoc[]


    Use the statements endpoints to retrieve statement information or statement files for a <</core-api/credit-accounts, credit account>>.


    An account statement contains a summary of account activity that occurred during a billing cycle.

    For more on statements, see <</developer-guides/about-credit-account-statements, About Credit Account Statements>>.


    To receive a webhook notification when a statement is created, see <</core-api/event-types#_credit_account_statement_event, Credit account statement event>> in Event Types.'
  name: Statements
paths:
  /accounts/{account_token}/statements:
    get:
      description: '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 <</core-api/sorting-and-pagination, 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.'
      operationId: getStatementSummariesByAccount
      parameters:
      - description: '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.'
        explode: false
        in: path
        name: account_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing account token
        style: simple
      - description: '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.'
        explode: true
        in: query
        name: start_date
        required: false
        schema:
          format: date-time
          type: string
          x-allowableValues: 'Format: yyyy-MM-ddThh:mm:ssZ'
        style: form
      - description: '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.'
        explode: true
        in: query
        name: end_date
        required: false
        schema:
          format: date-time
          type: string
          x-allowableValues: 'Format: yyyy-MM-ddThh:mm:ssZ'
        style: form
      - description: Number of account statement resources to retrieve.
        explode: true
        in: query
        name: count
        required: false
        schema:
          default: 5
          maximum: 100
          minimum: 1
          type: integer
        style: form
      - description: Sort order index of the first resource in the returned array.
        explode: true
        in: query
        name: start_index
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
        style: form
      - description: '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`.'
        explode: true
        in: query
        name: sort_by
        required: false
        schema:
          default: -createdTime
          enum:
          - createdTime
          - -createdTime
          type: string
        style: form
      responses:
        '200':
          content:
            application/json:
              example:
                count: 1
                data:
                - account_token: my_account_token_12
                  available_credit: 800
                  closing_balance: 2000
                  closing_date: 2023-07-01 00:27:09+00:00
                  created_time: 2023-07-01 00:27:09+00:00
                  credit_limit: 10000
                  credits: 0
                  cycle_type: BEGINNING_REVOLVING
                  days_in_billing_cycle: 31
                  fees: 0
                  interest: 0
                  opening_balance: 1000
                  opening_date: 2023-07-01 00:27:09+00:00
                  past_due_amount: 0
                  payments: 0
                  purchases: 200
                  token: acc0544e-4075-fe67-93dd-6b5cd443adb1
                end_index: 0
                is_more: true
                start_index: 0
              schema:
                $ref: '#/components/schemas/StatementSummaryPage'
          description: A JSON object containing a list of Statement Summaries
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      security:
      - zionToken: []
      summary: List account statement summaries
      tags:
      - Statements
  /accounts/{account_token}/statements/files:
    get:
      description: Retrieve an array of statement files for a specific credit account.
      operationId: getStatementFilesByAccount
      parameters:
      - description: '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.'
        explode: false
        in: path
        name: account_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing account token
        style: simple
      - description: Start date of the date range for which to return statement files.
        explode: true
        in: query
        name: start_date
        required: false
        schema:
          example: 2024-01-01 00:00:00+00:00
          format: date-time
          type: string
        style: form
      - description: End date of the date range for which to return statement files.
        explode: true
        in: query
        name: end_date
        required: false
        schema:
          example: 2024-03-01 03:59:59+00:00
          format: date-time
          type: string
        style: form
      - description: Number of statement file resources to retrieve.
        explode: true
        in: query
        name: count
        required: false
        schema:
          default: 5
          maximum: 100
          minimum: 1
          type: integer
        style: form
      - description: Sort order index of the first resource in the returned array.
        explode: true
        in: query
        name: start_index
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
        style: form
      - description: '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`.'
        explode: true
        in: query
        name: sort_by
        required: false
        schema:
          default: -createdTime
          enum:
          - createdTime
          - -createdTime
          type: string
        style: form
      responses:
        '200':
          content:
            application/json:
              example:
                count: 1
                data:
                - account_token: credit_account_token1234
                  closing_date: 2023-07-31 00:27:09
                  opening_date: 2023-07-01 00:27:09
                  signed_url: <signed_https_url_pointing_to_a_resource_on_S3>
                  statement_summary_token: 37f07818-2a2c-4c82-a721-a479936d5b2e
                  token: file_token
                  type: STATEMENT_PDF
                - account_token: credit_account_token4567
                  closing_date: 2023-06-30 00:27:09
                  opening_date: 2023-06-01 00:27:09
                  signed_url: <signed_https_url_pointing_to_a_resource_on_S3>
                  statement_summary_token: 79938791-5e15-456a-bf13-c39142c9a763
                  token: file_token
                  type: STATEMENT_PDF
                end_index: 0
                is_more: false
                start_index: 0
              schema:
                $ref: '#/components/schemas/StatementFilePage'
          description: A JSON object containing a list of statement files.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      security:
      - zionToken: []
      summary: List files for an account
      tags:
      - Statements
  /accounts/{account_token}/statements/{statement_summary_token}:
    get:
      description: Retrieve a statement summary for a credit account.
      operationId: retrieveStatementSummary
      parameters:
      - description: '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.'
        explode: false
        in: path
        name: account_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing account token
        style: simple
      - description: 'Unique identifier of the statement summary to retrieve.


          Send a `GET` request to `/credit/accounts/{token}/statements/` to retrieve existing statement summary tokens.'
        explode: false
        in: path
        name: statement_summary_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing statement summary token
        style: simple
      responses:
        '200':
          content:
            application/json:
              example:
                account_token: my_account_token_12
                available_credit: 800
                closing_balance: 2000
                closing_date: 2021-07-01 00:27:09+00:00
                created_time: 2021-07-01 00:27:09+00:00
                credit_limit: 10000
                credits: 0
                cycle_type: BEGINNING_REVOLVING
                days_in_billing_cycle: 31
                fees: 0
                interest: 0
                opening_balance: 1000
                opening_date: 2021-07-01 00:27:09+00:00
                past_due_amount: 0
                payments: 0
                purchases: 200
                token: acc0544e-4075-fe67-93dd-6b5cd443adb1
              schema:
                $ref: '#/components/schemas/StatementSummary'
          description: A JSON object containing statement_summary information
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      security:
      - zionToken: []
      summary: Retrieve account statement summary
      tags:
      - Statements
  /accounts/{account_token}/statements/{statement_summary_token}/files:
    get:
      description: Retrieve an array of statement files for a specific statement summary.
      operationId: retrieveStatementFiles
      parameters:
      - description: '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.'
        explode: false
        in: path
        name: account_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing account token
        style: simple
      - description: '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.'
        explode: false
        in: path
        name: statement_summary_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing statement summary token
        style: simple
      - description: Number of statement files to return.
        explode: true
        in: query
        name: count
        required: false
        schema:
          default: 5
          maximum: 100
          minimum: 1
          type: integer
        style: form
      - description: Sort order index from which to begin returning files.
        explode: true
        in: query
        name: start_index
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
        style: form
      responses:
        '200':
          content:
            application/json:
              example:
                count: 1
                data:
                - account_token: credit_account_token1234
                  closing_date: 2023-07-31 00:27:09
                  opening_date: 2023-07-01 00:27:09
                  signed_url: <signed_https_url_pointing_to_a_resource_on_S3>
                  statement_summary_token: 37f07818-2a2c-4c82-a721-a479936d5b2e
                  token: file_token
                  type: STATEMENT_PDF
                end_index: 0
                is_more: false
                start_index: 0
              schema:
                $ref: '#/components/schemas/StatementFilePage'
          description: Expected response to a valid request.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      security:
      - zionToken: []
      summary: List files for a statement summary
      tags:
      - Statements
  /accounts/{account_token}/statements/{statement_summary_token}/interestcharges:
    get:
      description: Retrieve the interest charges on a credit account's statement summary.
      operationId: retrieveStatementInterestCharges
      parameters:
      - description: '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.'
        explode: false
        in: path
        name: account_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing account token
        style: simple
      - description: '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.'
        explode: false
        in: path
        name: statement_summary_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing statement summary token
        style: simple
      responses:
        '200':
          content:
            application/json:
              example:
                account_token: credit_account_token1234
                data:
                - amount: 2.31
                  apr_type: GO_TO
                  apr_value: 14.99
                  balance_subject_to_interest_rate: 181.67
                  balance_type: PURCHASE
                statement_summary_token: statement_summary_token1234
                user_token: user_token1234
              schema:
                $ref: '#/components/schemas/StatementInterestChargesPage'
          description: Expected response to a valid request.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      security:
      - zionToken: []
      summary: Retrieve account statement interest charges
      tags:
      - Statements
  /accounts/{account_token}/statements/{statement_summary_token}/journalentries:
    get:
      description: 'Retrieve an array of journal entries on a credit account''s statement summary.


        This endpoint supports <</core-api/sorting-and-pagination, sorting>>.'
      operationId: listStatementJournalEntries
      parameters:
      - description: '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.'
        explode: false
        in: path
        name: account_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing account token
        style: simple
      - description: '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.'
        explode: false
        in: path
        name: statement_summary_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing statement summary token
        style: simple
      - description: Number of journal entry resources to return.
        explode: true
        in: query
        name: count
        required: false
        schema:
          default: 5
          maximum: 100
          minimum: 1
          type: integer
        style: form
      - description: Sort order index of the first resource in the returned array.
        explode: true
        in: query
        name: start_index
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
        style: form
      - description: Embeds the specified object into the response.
        explode: true
        in: query
        name: expand
        required: false
        schema:
          items:
            enum:
            - detailObject
            - originalCurrency
            type: string
          type: array
        style: form
      - description: '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`.'
        explode: true
        in: query
        name: sort_by
        required: false
        schema:
          default: lastModifiedTime
          enum:
          - lastModifiedTime
          - -lastModifiedTime
          type: string
        style: form
      responses:
        '200':
          content:
            application/json:
              example:
                count: 3
                data:
                - account_token: my_account_token_12
                  amount: 2.31
                  card_token: my_credit_card_token7794
                  created_time: 2023-08-01 07:00:19.756000+00:00
                  currency_code: USD
                  detail_object:
                    account_token: my_account_token_12
                    average_daily_balance: 181.67
                    created_date: 2023-08-01 07:00:19.755000+00:00
                    currency_code: USD
                    daily_periodic_rate: 0.00041068
                    days_in_billing_cycle: 31
                    goto_apr: 14.99
                    interest_amount: 2.31
                    statement_balance: 208.93
                    statement_closing_date: 2023-08-01 03:59:59.999000+00:00
                    statement_opening_date: 2023-07-01 04:00:00
                    statement_token: statement_token_75b
                    token: detail_token_96749
                    updated_date: 2023-08-01 07:00:19.755000+00:00
                  detail_token: detail_token_96749
                  group: INTEREST
                  id: '11112222'
                  impact_time: 2023-08-01 03:59:59.999000+00:00
                  memo: Interest charge on purchases
                  request_time: 2023-08-01 03:59:59.999000+00:00
                  status: POSTED
                  token: interest_journal_entry_token1111
                  type: account.interest
                  user_token: user_token1111
                - account_token: my_account_token_12
                  amount: 15
                  card_token: my_credit_card_token7794
                  created_time: 2023-07-01 07:00:24.240000+00:00
                  currency_code: USD
                  detail_object:
                    account_token: my_account_token_12
                    amount: 15
                    created: 2023-07-01 07:00:24.239000+00:00
                    currency_code: USD
                    description: Late Payment Fee
                    method: FLAT
                    token: detail_token_11221
                    type: LATE_PAYMENT_FEE
                    value: 25
                  detail_token: detail_token_11221
                  group: FEE
                  id: '44445678'
                  impact_time: 2023-07-01 03:59:59.999000+00:00
                  memo: Late payment fee
                  request_time: 2023-07-01 03:59:59.999000+00:00
                  status: POSTED
                  token: fee_journal_entry_token2121
                  type: account.fee.payment.late
                  user_token: user_token2121
                - account_token: my_account_token_12
                  amount: 9.11
                  card_token: my_credit_card_token7794
                  created_time: 2023-09-26 11:53:48.228000+00:00
                  currency_code: USD
                  detail_object:
                    acquirer:
                      system_trace_audit_number: 0
                    acquirer_fee_amount: 0
                    acquirer_reference_data: 4.355106395860054E22
                    acting_user_token: user_token4632
                    amount: 9.11
                    approval_code: 946791
                    batch_number: 2021048291031352
                    card:
                      last_four: 4489
                      metadata: {}
                    card_acceptor:
                      city: OAKLAND
                      country_code: US
                      mcc: 5814
                      mid: 555600244811
                      name: SWEET TREATS 0484
                      postal_code: 94612
                      state: CA
                    card_token: my_credit_card_token7794
                    clearing_record_sequence_number: 0
                    created_time: 2023-09-26 11:53:46+00:00
                    currency_code: USD
                    currency_conversion:
                      network:
                        conversion_rate: 1
                        original_amount: 9.11
                        original_currency_code: 840
                    duration: 378
                    fees:
                      amount: 0.19131
                      credit_debit: C
                      type: INTERCHANGE_FEE
                    gpa:
                      available_balance: 0
                      balances:
                        USD:
                          available_balance: 0
                          credit_balance: 0
                          currency_code: USD
                          impacted_amount: -9.11
                          ledger_balance: 61.7
                          pending_credits: 0
                      credit_balance: 0
                      currency_code: USD
                      impacted_amount: -9.11
                      ledger_balance: 61.7
                      pending_credits: 0
                    gpa_order:
                      amount: 9.11
                      created_time: 2023-09-25 20:59:43+00:00
                      currency_code: USD
                      funding:
                        amount: 9.11
                        source:
                          active: true
                          created_time: 2023-06-22 18:41:14+00:00
                          is_default_account: false
                          last_modified_time: 2023-06-22 18:41:14+00:00
                          name: My Funding Source
                          token: funding_source_token6789
                          type: programgateway
                      funding_source_token: funding_source_token6789
                      jit_funding:
                        acting_user_token: user_token4632
                        amount: 9.11
                        method: pgfs.authorization.capture
                        original_jit_funding_token: jit_funding_token4be7
                        token: jit_funding_token43a3
                        user_token: user_token4632
                      last_modified_time: 2023-09-26 11:53:47+00:00
                      response:
                        code: 0
                        memo: Approved or completed successfully
                      state: COMPLETION
                      token: gpa_order_token2c2c5
                      transaction_token: transaction_token42352a
                      user_token: user_token4632
                    identifier: 6457
                    issuer_interchange_amount: 0.19131
                    issuer_payment_node: 042f97a3458b59e3cce0269f66e864d8
                    issuer_received_time: 2023-09-26 11:53:46.886000+00:00
                    network: VISA
                    network_metadata:
                      product_id: VISA_TRADITIONAL
                      program_id: ''
                    network_reference_id: 218552461989029
                    pos:
                      is_installment: false
                      is_recurring: false
                      partial_approval_capable: false
                      pin_present: false
                      purchase_amount_only: false
                      terminal_id: 101
                    preceding_related_transaction_token: journal_entry_token2460
                    request_amount: 9.11
                    response:
                      code: 0
                      memo: Approved or completed successfully
                    settlement_date: 2023-09-26 00:00:00+00:00
                    state: COMPLETION
                    subnetwork: VISANET
                    token: detail_token_645736
                    transaction_metadata:
                      payment_channel: OTHER
                    type: authorization.clearing
                    user:
                      metadata:
                        notification_email: hello@myemail.com
                    user_token: user_token4632
                    user_transaction_time: 2023-09-25 20:59:43+00:00
                  detail_token: detail_token_645736
                  group: PURCHASE
                  id: '12345678'
                  impact_time: 2023-09-26 11:53:48.228000+00:00
                  memo: SWEET TREATS 0484
                  related_token: journal_entry_token2460
                  request_time: 2023-09-25 20:59:43
                  root_token: journal_entry_token2460
                  status: POSTED
                  token: purchase_journal_entry_token6789
                  type: authorization.clearing
                  user_token: user_token12
                end_index: 4
                is_more: true
                start_index: 0
              schema:
                $ref: '#/components/schemas/JournalEntriesPage'
          description: Expected response to a valid request.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unexpected error
      security:
      - zionToken: []
      summary: List account statement journal entries
      tags:
      - Statements
  /accounts/{account_token}/statements/{statement_summary_token}/ledgerentries:
    get:
      description: '[IMPORTANT]

        This feature is being deprecated and replaced by statement journal entries.

        To list statement journal entries, see <</core-api/credit-account-journal-entries#listStatementJournalEntries, List account statement journal entries>>.


        Retrieve an array of ledger entries on a credit account''s statement summary.


        This endpoint supports <</core-api/sorting-and-pagination, sorting>>.'
      operationId: listStatementLedgerEntries
      parameters:
      - description: '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.'
        explode: false
        in: path
        name: account_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing account token
        style: simple
      - description: '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.'
        explode: false
        in: path
        name: statement_summary_token
        required: true
        schema:
          type: string
          x-allowableValues: Existing statement summary token
        style: simple
      - description: Embeds the specified object into the response.
        explode: true
        in: query
        name: expand
        required: false
        schema:
          items:
            enum:
            - detailObject
            - originalCurrency
            type: string
          type: array
        style: form
      - description: '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`.'
        explode: true
        in: query
        name: sort_by
        required: false
        schema:
          default: lastModifiedTime
          enum:
          - lastModifiedTime
          - -lastModifiedTime
          type: string
        style: form
      responses:
        '200':
          content:
            application/json:
              example:
              - account_token: my_account_token_12
                amount: 9.11
                card_token: my_credit_card_token7794
                created_time: 2023-09-26 11:53:48.228000+00:00
                currency_code: USD
                detail_object:
                  acquirer:
                    system_trace_audit_number: 0
                  acquirer_fee_amount: 0
                  acquirer_reference_data: 4.355106395860054E22
                  acting_user_token: user_token4632
                  amount: 9.11
                  approval_code: 946791
                  batch_number: 2021048291031352
                  card:
                    last_four: 4489
                    metadata: {}
                  card_acceptor:
                    city: OAKLAND
                    country_code: US
                    mcc: 5814
                    mid: 555600244811
                    name: SWEET TREATS 0484
                    postal_code: 94612
                    state: CA
                  card_token: my_credit_card_token7794
                  clearing_record_sequence_number: 0
                  created_time: 2023-09-26 11:53:46+00:00
                  currency_code: USD
                  currency_conversion:
                    network:
                      conversion_rate: 1
                      original_amount: 9.11
                      original_currency_code: 840
                  duration: 378
                  fees:
                    amount: 0.19131
                    credit_debit: C
                    type: INTERCHANGE_FEE
                  gpa:
                    available_balance: 0
           

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/marqeta/refs/heads/main/openapi/marqeta-statements-api-openapi.yml