Developer portal

Search card renewals

Here, you will learn how to search card renewals in Tuum.

Use case

In this example, we will demonstrate how to find the card renewal events that are waiting for review.

Use case data
API parameters with values

Searching for renewal events related to cards expiring in November 2025. Dates must be provided in the format: YYYY-MM-DD.

...search?renewalDateRangeStartDate=2025-11-01&renewalDateRangeEndDate=2025-11-30...

The search retrieves card renewals that are in the WAITING status.

...statusCode=WAITING...

The request retrieves search results from page 1, with a page size of 10.

...pageNumber=1&pageSize=10

Sample API call

To find card renewal details, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v2/card-renewals/search

Learn more about the search card renewals endpoint in the Tuum developer portal.

Sample request

Below is a sample API request to retrieve card renewal details for cards expiring in November 2025 that are in WAITING status. The sample request body is as follows:

No request body.

Sample response

Below you will find the response to the API request:

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "values": [
            {
                "cardRenewalId": "C001664282474",
                "cardId": "C001664282441",
                "panReference": null,
                "productCode": "ZEROCARDS",
                "productScheme": "MASTERCARD",
                "productClass": "CREDIT",
                "productType": "PHYSICAL",
                "accountId": "C001664282441",
                "personId": "ID-1022",
                "statusCode": "WAITING",
                "expiryDate": "2025-11-30",
                "renewalCreatedDateTime": null,
                "designCode": "XXX",
                "mainCardId": null,
                "accountOwnerPersonId": "ID-1022",
                "deliveryAddress": {
                    "postCode": "54312",
                    "countryCode": "ES",
                    "city": "Madrid",
                    "county": "SPAIN",
                    "streetAddress": "Avenida Carlos",
                    "phoneCountryCode": "+34",
                    "phoneNumber": "913 440 557"
                },
                "shippingDetailsId": "C001664282460",
                "cardDeliveryMethod": "COURIER",
                "tenantCode": "MB"
            },
            {
                "cardRenewalId": "C001664282473",
                "cardId": "C001664282443",
                "panReference": null,
                "productCode": "ZEROCARDS",
                "productScheme": "MASTERCARD",
                "productClass": "CREDIT",
                "productType": "PHYSICAL",
                "accountId": "C001664282445",
                "personId": "ID-1021",
                "statusCode": "WAITING",
                "expiryDate": "2025-11-30",
                "renewalCreatedDateTime": null,
                "designCode": "XXX",
                "mainCardId": null,
                "accountOwnerPersonId": "ID-1021",
                "deliveryAddress": {
                    "postCode": "40",
                    "countryCode": "DE",
                    "city": "Berlin",
                    "county": null,
                    "streetAddress": "Teststrasse",
                    "phoneCountryCode": "+49",
                    "phoneNumber": "123456789"
                },
                "shippingDetailsId": "C001664282462",
                "cardDeliveryMethod": "COURIER",
                "tenantCode": "MB"
            }
        ],
        "pageNumber": 1,
        "pageSize": 10,
        "endReached": true,
        "sort": null
    }
}

Result

A list of card renewal entries that match the provided search parameters. Each entry includes a cardRenewalId, which is required to update, approve, reject, or complete a card renewal.

PreviousCard renewalsNextStart card renewal manually

Last updated

Was this helpful?