Skip to main content
GET
/
api
/
adm
/
reports
/
creditCardUpdater
Get Credit Card Updater Report
curl --request GET \
  --url https://localhost:44371/api/adm/reports/creditCardUpdater \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Generates a report of credit card updates received from automatic card updater services provided by payment processors. When cards are replaced due to expiration, loss, theft, or account changes, card networks notify merchants through account updater services. Helps update payment methods and reduce failures.

​
Input

  • Query Parameters: request (GetCreditCardUpdaterReportQueryRequest) — Filtering options including:
    • startDate (datetime, required) — Report start date.
    • endDate (datetime, required) — Report end date.
    • companyId (guid, optional) — Filter by company identifier.
    • updateType (string, optional) — Filter by update type.

​
Output

Returns a GetCreditCardUpdaterReportQueryResponse containing card update data or an empty list if none found.

​
Example Request

GET /api/admin/reports/credit-card-updater?startDate=2025-01-01&endDate=2025-01-31&updateType=Expired
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "updates": [
    {
      "customerId": "CUST_12345",
      "oldCardLast4": "1234",
      "newCardLast4": "5678",
      "oldExpirationDate": "12/24",
      "newExpirationDate": "12/27",
      "updateDate": "2025-01-15T10:00:00Z",
      "updateReason": "CardExpired"
    }
  ],
  "totalCount": 1
}

​
Errors

  • 400 Bad Request — Missing required date range or invalid filter parameters.
  • 401 Unauthorized — Missing or invalid authentication token.
  • 404 Not Found — No card updates exist matching specified filters.

​
Notes

  • Update types: CardExpired, CardReplaced, AccountClosed, ContactCardholder.
  • Account updater services may have additional fees.
  • Not all card networks participate in updater programs.
  • Updates should be applied promptly to prevent payment failures.
  • Empty results return success with empty updates array.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
CompanyId
string<guid>
​
StartDate
string<date-time>
​
EndDate
string<date-time>

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]