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

post

http://<host-url>/card/renewal

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to renew or replace an existing credit card and configure the card details returned by Lume.

card_action

int32

enum

required

1 to 2

Card action: 1 - REPLACE, 2 - RENEW.

Allowed:

exp_date

string

^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Expiry date in format yyyy-MM-dd HH:mm:ss.

image_delivery

int32

enum

required

1 to 4

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.

Allowed:

image_fields

object

required

Fields included when image_delivery returns card image data.

image_name

string

required

length between 1 and 50

Image template name for the card to be generated.

reason

string

length between 0 and 255

Reason for renewing or replacing the card.

remarks

string

length between 0 and 200

Remarks for the API request.

token

int64

required

Token of the existing card to renew or replace.

user_id

string

length between 0 and 50

Optional user identifier associated with the renewal or replacement request.

xml_fields

object

required

Fields included in XML card data returned by Lume.

Headers

unique-request-id

string

Unique identifier of a request.

Responses

400

Validation error/Bad Request

500

Server Error

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Credit card renewed/replaced in BL, PC sync pending

201Credit card renewed/replaced in BL and synced in PC