For the complete documentation index, see llms.txt. This page is also available as Markdown.

Credit Trade Reports

Credit Trade Reports are sent to the credit bureau's monthly.

Get Credit Report List

Use this endpoint to retrieve a paginated list of credit reports.

Method: POST

Endpoint: {{env}}/api/creditreporting/filter

{
    "ReportId": "e6f7a8b9-...c0d1",
    "TransactionMethod": "SecuredCredit",
    "ReportingMonth": "2025-05",
    "CreatedAtFrom": "2026-05-01",
    "CreatedAtTo": "2026-07-01",
    "Pagination": {
        "PageNumber": 1,
        "ItemsPerPage": 10
    }
}

Input Parameters

Parameter
Type
Mandatory
Description

ReportId

Guid

No

Filter by specific report Id

TransactionMethod

String

No

Filter by card transaction method type

ReportingMonth

String

No

Reporting month. Format: yyyyMM

CreatedAtForm

Date

No

Format: yyyy-MM-dd

CreatedAtTo

Date

No

Format: yyyy-MM-dd

Pagination

No

PageNumber

Number

No

The respective page, starting at 1

ItemsPerPage

Number

No

The amount of items per page between 0 and

Response

Parameter
Type
Description

CurrentPage

Number

Current page of results

PageSize

Number

Number of items in page requested

TotalCount

Number

Total number of items queryable

Items

ReportId

Guid

Credit report Id

TransactionMethod

String

Card transaction method type

ReportingMonth

String

Reporting month

CreatedAt

DateTime

Record creation timestamp

Status

String

Report processing status

CreditBureau

String

Credit bureau the report was sent to

Get Credit Reporting Records

Use this endpoint to retrieve a paginated list of individual credit reporting records for a given report.

Method: POST

Endpoint: {{env}}/api/creditreporting/records/filter

Input Parameters

Parameter
Type
Mandatory
Description

ReportId

Guid

Yes

Filter by report Id

UserId

Guid

No

Filter by user Id

UserCardId

Guid

No

Filter by specific card Id

CardReferenceId

Guid

No

Card reference number of the card

TransactionMethod

String

No

Filter by card transaction method type

ReportingMonth

String

No

Reporting month. Format: yyyy-MM-dd or yyyyMM

CreatedAtFrom

Date

No

Format: yyyy-MM-dd

CreatedAtTo

Date

No

Format: yyyy-MM-dd

CreditBureau

String

No

Filter by credit bureau name

Pagination

No

PageNumber

Number

No

The respective page, starting at 1

ItemsPerPage

Number

No

The amount of items per page between 0 and 100

Response

Parameter
Type
Description

CurrentPage

Number

Current page of results

PageSize

Number

Number of items in page requested

TotalCount

Number

Total number of items queryable

Items

Id

Guid

Record Id

ReportId

Guid

Associated credit report Id

UserId

Guid

User Id

UserCardId

Guid

Card Id

CardReferenceId

String

Card reference Id

CreditBureau

String

Credit bureau the record was reported to

CreatedAt

DateTime

Record creation timestamp

UpdatedAt

DateTime

Record last updated timestamp

ReportingMonth

String

Reporting month

FirstName

String

Cardholder first name

LastName

String

Cardholder last name

DateOfBirth

String

Cardholder date of birth

HouseOrBuildingNumber

String

Street address house/building number

StreetName

String

Street name

City

String

City

Province

String

Province or state

PostalCode

String

Postal or zip code

AccountNumberLast4Digits

String

Last 4 digits of the card account number

EquifaxMemberNumber

String

Equifax member number

AccountType

String

Card account type

DateClosed

String

Date the account was closed (if applicable)

DateOfFirstMissedPaymentIfDelinquent

String

Date of first missed payment if account is delinquent

ActualPaymentReceived

String

Actual payment amount received

DateOfLastPayment

String

Date of most recent payment

AmountPastDue

String

Amount past due

CreditLimit

String

Credit limit of the account

CurrentBalance

String

Current account balance

DateAccountOpened

String

Date the account was opened

ExpectedPayment

String

Expected payment amount

HighestCreditUsed

String

Highest credit balance used

AccountStatus

String

Current account status

PaymentFrequencyType

String

Payment frequency (e.g. Monthly)

Last updated

Was this helpful?