Get monthly statement

Monthly Statement

Request
Security:
Bearer
path Parameters
version
required
string
query Parameters
person_guid
required
string <uuid>

Unique ID of the person

wallet_guid
string <uuid>

Unique ID of the wallet associated with the account

account_guid
string <uuid>

Unique ID of the account (Required for Reg Z statements)

card_proxy
string

Card proxy

month
integer <int32> [ 1 .. 12 ]

Statement month

year
integer <int32> [ 1753 .. 9999 ]

Statement year

client_reference_id
string

client_reference_id from Person

stmt_date
string <date-time>

Statement date

format
string (StatementFormat)
Enum: "JSON" "PDF"
account_type
string
error_code
string
error_description
string
Responses
200

Returns the monthly statement

401

Unauthorized

500

Server Error

get/api/{version}/statements
Request samples
curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/statements?person_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&wallet_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&account_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&card_proxy=string&month=1&year=1753&client_reference_id=string&stmt_date=2019-08-24T14%3A15%3A22Z&format=JSON&account_type=string&error_code=string&error_description=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "month": 0,
  • "year": 0,
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "mask_card_number": "string",
  • "card_proxy": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "mailing_address_line1": "string",
  • "mailing_address_line2": "string",
  • "mailing_city": "string",
  • "mailing_state": "string",
  • "mailing_postal_code": "string",
  • "mailing_country": "string",
  • "beginning_balance": 0,
  • "ending_balance": 0,
  • "total_credits": 0,
  • "other_debits": 0,
  • "total_fees": 0,
  • "total_atm_and_purchases": 0,
  • "ytd_fees": 0,
  • "purchases": 0,
  • "count": 0,
  • "transactions": [
    • {
      • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
      • "txn_date": "2019-08-24T14:15:22Z",
      • "post_date": "2019-08-24T14:15:22Z",
      • "txn_type": "string",
      • "account_currency": "string",
      • "amount": 0,
      • "request_code": "string",
      • "request_code_description": "string",
      • "transfer_outside_instrument_guid": "cca1153f-d66b-470e-aef7-99ec47a3fcdb",
      • "transfer_account_first_name": "string",
      • "transfer_account_last_name": "string",
      • "transfer_institution_name": "string",
      • "mask_account_number": "string",
      • "ledger_balance": 0,
      • "acceptor_id": "string",
      • "acceptor_name_loc": "string",
      • "txn_location": "string",
      • "txn_city": "string",
      • "txn_country": "string",
      • "txn_description": "string",
      • "reference_number": "string"
      }
    ],
  • "client_reference_id": "string",
  • "reg_z_details": {
    • "stmt_date": "2019-08-24T14:15:22Z",
    • "billing_cycle_start": "2019-08-24T14:15:22Z",
    • "billing_cycle_end": "2019-08-24T14:15:22Z",
    • "account_status": "string",
    • "payments": 0,
    • "other_credits": 0,
    • "purchases": 0,
    • "cash_advances": 0,
    • "balance_transfer": 0,
    • "total_interest": 0,
    • "credit_limit": 0,
    • "available_credit": 0,
    • "ending_bal": 0,
    • "min_payment": 0,
    • "payment_duedate": "2019-08-24T14:15:22Z",
    • "ytd_fees": 0,
    • "processing_fees": 0,
    • "carried_balance_fees": 0,
    • "ytd_interest": 0,
    • "fees": [
      • {
        • "txn_date": "2019-08-24T14:15:22Z",
        • "amount": 0,
        • "txn_description": "string"
        }
      ],
    • "interest_charges": [
      • {
        • "interest_type": "string",
        • "interest_rate": 0,
        • "bal_subjectto_inrate": 0,
        • "interest_amount": 0
        }
      ],
    • "apr_changes": [
      • {
        • "penalty_apr": 0,
        • "penaltyapr_applicable_dt": "2019-08-24T14:15:22Z",
        • "penaltyapr_end_dt": "2019-08-24T14:15:22Z",
        • "penaltyapr_grace_period": 0,
        • "revised_apr_purchases": 0,
        • "revised_apr_cashadv": 0,
        • "revisedapr_applicable_dt": "2019-08-24T14:15:22Z",
        • "revisedapr_end_dt": "2019-08-24T14:15:22Z"
        }
      ],
    • "payment": [
      • {
        • "mob": 0,
        • "date": "2019-08-24T14:15:22Z",
        • "disbursement_principal": 0,
        • "disbursement_fee": 0,
        • "total": 0,
        • "fee": 0,
        • "principal": 0,
        • "balance": 0,
        • "paid_principal": 0,
        • "paid_interest": 0,
        • "available_balance": 0,
        • "cycle": "string",
        • "type": "string",
        • "status": "string"
        }
      ],
    • "additional_regz_data": {
      • "late_payment_warning": "string",
      • "minimum_payment_warning": "string",
      • "interest_rate_change": "string",
      • "counseling_info": "string",
      • "account_term_change": "string",
      • "statement_info": "string",
      • "statement_faq": "string",
      • "additional_data": "string"
      }
    },
  • "mask_account_number": "string"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.