v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get Expired Cards Report

get/v3/report/cardexpiration

Query parameters

merchantIdinteger required

Merchant id

dateRangestring

Date type filter. Values: Lifetime, Month, NextMonth, Custom

startDatestring date required

Start date in MM/DD/YYYY format (Only needed if dateTypeFilter is set to Custom)

endDatestring date required

End date in MM/DD/YYYY format (Only needed if dateTypeFilter is set to Custom)

expiredOnlyboolean required

Return only expired cards?

limitinteger

offsetinteger

Response

200

recordCountinteger

Example response

{
  "records": [
    {
      "accountVaultId": 9295727,
      "customerId": 10673908,
      "customerName": "John Doe",
      "accountNumberLast4": "1111",
      "expirationDate": "2018-02-28T00:00:00",
      "cardType": "Visa",
      "isDefault": true,
      "cardId": "y15QvOteHZGBm7LH3GNIlTWbA1If",
      "primaryContact": "7701112223",
      "created": "2017-04-28T20:56:04.113Z",
      "modified": "2017-04-28T20:56:04.113Z"
    }
  ],
  "recordCount": 2
}