PRN-165
7 months ago by Jon Bullock
As of the 2nd November 2023, two new fields will be added to the Create Card endpoint. These fields will also be added to the response of the Retrieve Card endpoint.
IsSingleUse and IsNonReloadable are boolean fields that, if set to true, determine whether the card can only be used once, and/or loaded once respectfully. See the below example of a Create Card request with the new fields included.
{
"CardType":"Physical",
"CardProduct": 10023,
"CustomerReference": "CustNo12345A",
"ActivateNow": true,
"Freetext1": "Comments for the card manufacturer here",
"Freetext2": "And in this field too.",
"nameOnCard": "Mr Johnny Bloggs",
"IsSingleUse" : true,
"IsNonReloadable" : false,
"CardHolder": {
"Title": "Mr.",
"FirstName": "John",
"MiddleName": "Bruce",
"LastName": "Bloggs",
"DateOfBirth": "1982-02-19",
"Mobile": "07755123456",
"Email": "[email protected]"
},
"Address": {
"AddressLine1": "32 Metropolis Ave",
"AddressLine2": "Mountain Drive",
"City": "London",
"PostCode": "SW11 2LD",
"Country": "GBR"
},
"fulfilment": {
"AddressLine1": "32 Metropolis Ave",
"AddressLine2": "Mountain Drive",
"City": "London",
"PostCode": "SW11 2LD",
"Country": "GBR"
},
"ManufacturingDetails":
{
"CardManufacturer": "AB Note",
"DeliveryMethod": 0,
"CarrierType": "Type 1",
"Quantity": 1,
"Language": "HU",
"ThermalLine1": "asdeoivh2neriuvnqkr",
"ThermalLine2" : "asjkfnkerjnkwe",
"EmbossLine4" : "jdwncwlkejr",
"VanityName" : "Name Mane",
"ImageDetails":
{
"ImageId": "An image id",
"LogoFrontId" : "A logo ID",
"LogoBackId": "Another logo ID"
}
}
}
Documentation
For more information on the Create Card available fields, see Create Card - Field Descriptions
The new fields will also be included in the response when using the Retrieve Card endpoint. See the below example of a response with the fields included.
{
"cardType": "Physical",
"publicToken": "638050230",
"status": "Active",
"cardStatusCode": "00",
"cardStatusDescription": "00 (Active)",
"balance": {
"currencyCode": "GBP",
"cardBalance": 300.67,
"pendingAmount": -74,
"availableBalance": 226.67
},
"cardDetails": {
"customerReference": "",
"fullNameOnCard": "Mr John Smith",
"maskedPan": "529955******4384",
"startDate": "2022-09-28",
"expiryDate": "2023-09-28"
},
"cardHolder": {
"title": "Mr",
"firstName": "John",
"middleName": "",
"lastName": "Smith",
"dateOfBirth": "1963-11-22",
"mobile": "",
"email": ""
},
"cardProduct": {
"scheme": "Sandbox Scheme",
"product": 1234,
"productShortName": "Sandbox"
},
"controlGroups": {
"limitsGroup": 1,
"usageGroup": 0,
"recurringFeeGroup": 0,
"webServiceFeeGroup": -1,
"authFeeGroup": 0,
"mccGroup": 0,
"cardLinkageGroup": 0,
"calendarGroup": -1,
"fxGroup": 0,
"paymentTokenUsageGroup": 0
},
"3DS": [],
"designId": "Sandbox",
"childCards": [],
"siblingCards": [],
"address": {
"addressLine1": "32 Eastern Lane",
"addressLine2": "",
"addressLine3": "",
"city": "",
"state": "",
"county": "",
"postCode": "S11 7AA",
"country": "826"
},
"fulfilment": {
"addressLine1": "32 Eastern Lane",
"addressLine2": "",
"addressLine3": "",
"city": "",
"state": "",
"county": "",
"postCode": "S11 7AA",
"country": "826"
},
"freetext1": "Comments for the card manufacturer here",
"freetext2": "And in this field too.",
"IsSingleUse" : true,
"IsNonReloadable" : false
}