Change/Replacement card

To change or replacement a customer's card you need to execute a POST request and all the new card data need to be specified in a JSON object inside the body of the request.

CASE CHANGE

If the card is changed, the data is copied from the old card.

Below a JSON example with the mandatory attributes:

{
"cardsRecords": [
    {
        "card": {
            "oldCardBarcode": 3001000410186,
            "newCardBarcode": 3001001560637
        }
    }
]
}

card section

Field	Description	Type	Mandatory
newCardBarcode	New card barcode	Varchar(50)	✓
oldCardBarcode	Old card barcode	Varchar(50)	✓

CASE REPLACEMENT
Below a JSON example with the mandatory attributes:

{
"cardsRecords": [
    {
        "card": {
            "oldCardBarcode": 3001000410186,
            "circuit": "SO",
            "entityCode": 383,
            "changeType": "REPLACEMENT",
            "cardType": "FIDELITY",
            "active": "T",
            "earnedPoints": 4,
            //"oldExpirationDate": "2015-05-20 17:30:51",
            "cardSubtype": 1,
            "newCardBarcode": 3001001560637,
            "issueDate": "2021-03-18 17:32:51",
            "activationDate": "2021-03-18 17:32:51",
            "expirationDate": null
        }
    }
]
}

card section

Field	Description	Type	Mandatory
newCardBarcode	New card barcode	Varchar(50)	✓
oldCardBarcode	Old card barcode	Varchar(50)	✓
changeType	Type of change card. ('CHANGE': change card, 'REPLACEMENT': replacement card)	Varchar(250)	✓
cardType	Card type (referenced on the relative master table). This is a fixed value to specify in the call	Varchar(250)	✓
cardSubtype	Card subtype (referenced on the relative master table)	Varchar(250)	✓
circuit	Circuit of card (referenced on the relative master table). This is a fixed value to specify in the call	Varchar(250)	✓
issueDate	Date of issue of the card	Date	✓
active	It indicates if the card is active or not	Char(1) - Values allowed 'T' - active, 'F' - not active	✓
activationDate	Data of activation	Date	✓
expirationDate	Expiration date	Date
oldExpirationDate	Expiration date for old card (default NOW)	Date
entityCode	Shop that issued the card	Varchar(250)	✓
earnedPoints	Total point earned	Decimal(10)

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
    "cardsRecords": [
        {
            "card": {
                "oldCardBarcode": 3001000410186,
                "circuit": "SO",
                "entityCode": 383,
                "changeType": "REPLACEMENT",
                "cardType": "FIDELITY",
                "active": "T",
                "earnedPoints": 4,
                //"oldExpirationDate": "2015-05-20 17:30:51",
                "cardSubtype": 1,
                "newCardBarcode": 3001001560637,
                "issueDate": "2021-03-18 17:32:51",
                "activationDate": "2021-03-18 17:32:51",
                "expirationDate": null
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Change/Replacement card

Request

Request Code Samples

Responses