post https://sandbox-api.helix.q2.com/card/renewalOverride
Override the base Helix card renewal eligibility criteria during a card's renewal period. A card's renewal period begins on the first day of the prior month of the card's expiration and ends the day before the client's scheduled monthly renewal job.
Card must be in an eligible status listed below to perform a card renewal override:
VerifiedReissuedPendingVerificationReissuedPendingVerificationDigitalActivePhysicalIntiatedDigitalActivePhysicalPending
Use of this endpoint requires approval from Q2 and your bank partner.
Error Codes
Click to expand
| Code | Message (en-US) | Notes |
|---|---|---|
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 61400 | Program is not authorized to use this endpoint. Please contact your relationship manager for details. | |
| 198100 | Card '{CardId}' cannot be renewed before the renewal period. | Renewal period begins on the 1st day of the month prior to the card expiration month. |
| 198101 | Card '{CardId}' cannot be used on or after the card renewal job date. | CardId no longer eligible for card renewal via job, please use card/reissue route to renew card |
| 198102 | Card '{CardId}' cannot be used after the card expiration date. | Card is expired and must use either /card/initiate or /card/createDigital depending on your card issuance type |
| 198103 | Card '{CardId}' status {cardStatus} is invalid for renewal override. Please review /card/renewalOveride API documentation for eligible card statuses | Card must be in a status of Verified, PendingVerification, ReissuedPendingVerification or DigitalActivePhysicalPending |
| 198104 | Invalid request | Correct the request and retry |
| 198106 | Invalid card renewal override | |
| 198107 | Invalid card renewal override reason | Override reason must be a string value of 20 or less |
| 198108 | Invalid request after renewal job date run on different month | Card is no longer eligible for card renewal via job, please use card/reissue route to renew card |
| 198109 | Card {request.cardId} cannot be used because of its expire date in future year. | Card must be in an eligible renewal period |