---
title: "Renew or replace a credit card in Lume and sync in PayCredit"
method: POST
path: "/card/renewal"
tags: ["Credit cards"]
---

# Renew or replace a credit card in Lume and sync in PayCredit

`POST /card/renewal`

## Request

- Base URL: `http://<host-url>`
- URL: `http://<host-url>/card/renewal`
- Auth: HTTP bearer

Renews or replaces an existing credit card identified by its token. The request controls the card action, generated image/XML delivery, expiry date, reason, and remarks. The returned card details may be synchronized with PayCredit immediately or queued for synchronization.

## Headers

- `unique-request-id` string

## Request body

- CardRenewalRequestDto: Request to renew or replace an existing credit card and configure the card details returned by Lume.
  - `card_action` integer, required: Card action: 1 - REPLACE, 2 - RENEW.
  - `exp_date` string: Expiry date in format yyyy-MM-dd HH:mm:ss.
  - `image_delivery` integer, required: How to deliver the card image and details: 1 - plain base64 image with encrypted pan, cvv, token, expiry, and emboss_name; 2 - encrypted image bytes with encrypted pan, cvv, token, expiry, and emboss_name; 3 - JSON data details without an image; 4 - encrypted image bytes with masked pan, cvv, token, expiry, and emboss_name.
  - `image_fields` ImageFields, required: Controls which card fields are included with image delivery.
    - `show_cvv` boolean: Whether CVV is included with the image delivery response.
    - `show_emboss_name` boolean: Whether the emboss name is included with the image delivery response.
    - `show_expiry` boolean: Whether expiry is included with the image delivery response.
    - `show_token` boolean: Whether the card token is included with the image delivery response.
  - `image_name` string, required: Image template name for the card to be generated.
  - `reason` string: Reason for renewing or replacing the card.
  - `remarks` string: Remarks for the API request.
  - `token` integer, required: Token of the existing card to renew or replace.
  - `user_id` string: Optional user identifier associated with the renewal or replacement request.
  - `xml_fields` XmlFields, required: Controls which card fields are included in XML output.
    - `show_cvv` boolean: Whether CVV is included in the XML output.
    - `show_emboss_name` boolean: Whether the emboss name is included in the XML output.
    - `show_expiry` boolean: Whether expiry is included in the XML output.
    - `show_token` boolean: Whether the card token is included in the XML output.

## Response `200`

Credit card renewed/replaced in BL, PC sync pending

- CreateBLCreditCardResponseDto
  - `3ds_enrollment_failure_reason` boolean
  - `ac_id` integer
  - `bill_act_amt` number, double
  - `bill_blk_amt` number, double
  - `bill_pnd_amt` number, double
  - `cvv` string
  - `emboss_name` string
  - `epan` string
  - `expiry` string
  - `image_base64` string
  - `is_3ds_enrolled` boolean
  - `last_four_digit` string
  - `load_ccy` string
  - `mpan` string
  - `token` integer

## Other responses

- `201`: Credit card renewed/replaced in BL and synced in PC
- `400`: Validation error/Bad Request
- `500`: Server Error

---

[API](https://skmtc.dev/paymentology/apis/paycredit-api.md) - [All operations](https://skmtc.dev/paymentology/apis/paycredit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/paycredit-api/revisions/cc56df9c933b?raw)