Skip to main content
POST
/
api
/
pay
/
{projectId}
/
companyProjectCreditCardPaymentsInfo
/
getCreditCardUpdaterResult
Get Account Updater Results
curl --request POST \
  --url https://localhost:44371/api/pay/{projectId}/companyProjectCreditCardPaymentsInfo/getCreditCardUpdaterResult \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "publicKey": "<string>",
  "isForAllProjectsInCompany": true,
  "paymentInfoIds": [
    "<string>"
  ],
  "creditCardUpdaterStatuses": [
    "NED"
  ]
}
'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Returns results from automatic card updater service which notifies merchants when stored cards are replaced, expired, or closed. Use to update payment tokens and prevent billing failures.

​
Input

  • Path Parameter: projectId (guid, required) — Project identifier for authentication.
  • Body: request (CreditCardUpdaterResultQueryRequest, required) — Query filters.

​
Output

Returns a CreditCardUpdaterResultQueryResponse containing AU update results.

​
Example Request

POST /api/payment/{projectId}/credit-card-payment-info/updater-results
Content-Type: application/json
X-API-Key: {your-api-key}

{
  "startDate": "2025-10-01",
  "endDate": "2025-10-31"
}

​
Example Response

{
  "success": true,
  "code": 200,
  "results": [
    {
      "oldCardLast4": "1111",
      "newCardLast4": "2222",
      "newExpiration": "06/2026",
      "updateReason": "Card Expired"
    }
  ]
}

​
Errors

  • 401 Unauthorized — Invalid or missing API key.
  • 400 Bad Request — Invalid date range.

​
Notes

  • AU updates are provided by card networks, not all cards participate.
  • Update stored payment tokens based on AU results to prevent failures.
  • Results include old/new card details and update reason.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
projectId
string<guid>
required

The project identifier for authentication.

Body

application/json

Query parameters for filtering AU results by date range or card.

Represents the filters available when querying credit card updater batch results.

​
publicKey
string
required

Used to encrypt sensitive data in the response

Minimum string length: 1
​
isForAllProjectsInCompany
boolean

Indicates whether to include all projects within the company.

​
paymentInfoIds
string<guid>[] | null

The identifiers of the payment information records to include.

​
creditCardUpdaterStatuses
enum<string>[] | null

The account updater statuses to filter by.

Available options:
NED,
NAN,
CCH,
UNA,
DEC,
CUR,
NUP,
ACL,
ERR

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. Represents the response returned when querying credit card updater results.

​
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:
[]