API Reference

Request Embossing API

The Request Embossing API is used to request embossing for instant cards. When requested, the device application is processed and queued for the device production batch. The embossing file will then be generated through the existing file process. The API request is encrypted. Refer to Message Level Security - AES Encryption section in the CR+ REST API Security Requirements attachment document for detailed information on encryption of JSON payload. It is applicable for instant cards of prepaid, credit and debit products issued on Pine Labs

HTTP Status and Response Status Matrix

  • HTTP Code: This is the response status code issued by a server in response to a client's request made to the server.
  • Error Code: This is the error code returned by Credit+ Issuing application in the ‘code’ field of the response message indicating if the request was processed successfully or failed.
  • Description: This is the description of the error code returned by Credit+ Issuing application.
  • Details: This is the detailed description of the error code returned by Credit+ Issuing application
HTTP CodeError CodeDescriptionDetails
200OKThe server has successfully processed your request.
400MISSING_REQUIRED_FIELDMissing Required Field 'mobile.number''Mobile number' field is mandatory when only last 4 digit of device number are provided.
400MISSING_REQUIRED_FIELDMissing Required Field 'mobile.isdCode''ISD Code' field is mandatory when only last 4 digits of device number are provided.
400MISSING_REQUIRED_FIELDMissing Required Field 'device.number', 'device.packID'At least one field must be present - 'deviceNumber' or 'packID'.
400MISSING_REQUIRED_FIELDMissing Required Field 'device.delivery'.Missing Required Field 'device.delivery'.
400MISSING_REQUIRED_FIELDMissing Required Field 'ProductType'.Missing Required Field 'ProductType'
400RECORD_NOT_FOUNDRecord not found for given search criteria(s) - ''.Device linked to 'device.number' : XXXX<LAST 4 Digits of DeviceNumber> not found.
400RECORD_NOT_FOUNDDevice Production Batch is not executed for the card.
400TIMESTAMP_ERRORRequest timestamp is in past.Request timestamp of '<"dataValidUntilTimestamp">' field value '' is in past.
400ERR_CODE_INVALID_FIELD_FORMATInvalid Field Value 'dataValidUntilTimestamp'.dataValidUntilTimestamp field must be in ISO 8601 format.
400ERR_DB_PROCError inside PRC_INST_DEVICE_DELIVERY_CONF
403AUTHORIZATION_ERRORUser in not authorized to access requested resource.
409RESOURCE_ALREADY_EXISTSEmbossing restricted for Card Pack ID.One card linked to the Card Pack ID has been embossed/delivered. Use particular Device Number to Request Embossing for other.
409RESOURCE_ALREADY_EXISTSEmbossing has already been requested for the device.
500SYSTEM_ERRORAn unexpected error has occurred with the service you have requested.
Language
URL
Click Try It! to start a request and see the response here!