Update card renewal

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

Use case

In this example, we will demonstrate how to update the details of a pending card renewal using the cardRenewalId parameter.

Card renewal details can be modified only when the renewal status is WAITING, APPROVED, or REJECTED.

Use case data
API parameters with values

We will update the card renewal details for renewal event C001664282475.

...card-renewals/C001664282475/update

We will update the shipping address details.

"deliveryAddress": {
    "postCode": "10145",
    "countryCode": "EE",
    "city": "Tallinn",
    "county": "Harju",
    "streetAddress": "Maakri 30",
    "phoneCountryCode": "+372",
    "phoneNumber": "55555555"
  }

We will update the card design.

"designCode": "12"

Sample API call

To edit card renewal details, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/card-renewals/{cardRenewalId}/update

Learn more about the update card renewal endpoint in the Tuum developer portal.

Sample request

Below is a sample API request to edit card renewal details.

{
  "deliveryAddress": {
    "postCode": "10145",
    "countryCode": "EE",
    "city": "Tallinn",
    "county": "Harju",
    "streetAddress": "Maakri 30",
    "phoneCountryCode": "+372",
    "phoneNumber": "55555555"
  },
  "designCode": "12"
}

Sample response

Below you will find the response to the API request:

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "cardRenewalId": "C001664282475",
        "cardId": "C001664282669",
        "panReference": "6021016994855227698",
        "productCode": "INTERNAL_ACCOUNT_6MONTH_M",
        "productScheme": "MASTERCARD",
        "productClass": "DEBIT",
        "productType": "PHYSICAL",
        "accountId": "C001664282652",
        "personId": "ID-30569",
        "statusCode": "WAITING",
        "expiryDate": "2026-03-31",
        "renewalCreatedDateTime": null,
        "designCode": "12",
        "mainCardId": null,
        "accountOwnerPersonId": "ID-30569",
        "deliveryAddress": {
            "postCode": "10145",
            "countryCode": "EE",
            "city": "Tallinn",
            "county": "Harju",
            "streetAddress": "Maakri 30",
            "phoneCountryCode": "+372",
            "phoneNumber": "55555555"
        },
        "shippingDetailsId": "C001664282690",
        "cardDeliveryMethod": "COURIER",
        "tenantCode": "MB"
    }
}

Result

As a result, the card renewal delivery address and design were successfully updated. The API response returns a dataset containing the updated renewal details.

Last updated

Was this helpful?