API Reference

Stoplist and Stoplist Withdrawal API

post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/cardholder/stopListWithdrawal

The interface componentsends a request using this API to stoplist and withdraw stoplist of respective cards. It is applicable for prepaid, credit and debit products issued on Pine Labs platform. For Apple Pay, if the status of a device or a wallet is updated, then the system automatically updates the status of the token.
Why would I need to use this resource?
Third party can use thisservice to stop list and stop list withdrawal of the card in Pine Labs system. Card can be stoplisted for the below mentioned reasons: • Lost • Stolen • Counterfeit • Returned • Expired • Damaged Card • Emergency Replacement • Erroneous Card
Card can be withdrawn for the below mentioned reasons: • Found card • Capture card • Bank decision • Overdue card • Stop list card • Miscellaneous • Unblocked card • Replacement Cancellation

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.
  • Reason: This is the description of the error code returned by Credit+ Issuing application.
HTTP CodeError CodeReason
400997Form Factor field is mandatory.
400997Form Factor field value must have max length 24.
400997Form Factor field value must have min length 10.
400997Transaction Flag field is mandatory.
400997Transaction Flag field is invalid.
400997Form Factor Type field is mandatory.
400997Form Factor Type field is invalid.
400997Reason Code field is mandatory.
400997Form Factor Expiry Date field is mandatory.
400997Form Factor Expiry Date field must be in yyMM format.
400997Form Factor Expiry Date is not allowed for FormFactorType 'CPI'.
400997Remark field value must have max length 100.
201STPLST000Successful.
400999Internal error.
400STPLST000Successful.
400VALPAS002Not valid Acquirer id.
400VALPAS003Acquirer is not active.
400VALPAS004Incorrect Password.
400VALPAS005Error while validating password.
400STPLST001Invalid transaction code.
400STPLST002Invalid transaction flag.
400998Invalid Device.
400998Device is not stoplisted.
400998Error while getting device details.
400998Invalid Card Pack Id.
400998Invalid Client.
400998Invalid form factor type.
400998Device status is not normal.
400998Device is invalid for sale.
400998Device is not block.
400998Device is not normal.
400998Invalid device.
400998Error getting device.
400998Invalid device plan.
400998Error getting device plan.
400998Not allowed for Static Virtual Card/Limited Validity Virtual Card.
400998Device is already delivered. Please use another pack id.
400998Bin of device(s) for entered card pack id is stoplisted.
400998Range of device(s) for entered card pack id is stoplisted.
400998Device(s) for entered card pack id is stoplisted.
400998Country is stoplisted.
400998Invalid Device Number.
400998Not allowed for Virtual Cards.
400998Device is already Activated.
400998Device is Cancelled.
400998Device is Replaced.
400998Device is Expired.
400998Device is stoplisted.
400998Device is not Normal.
400998Device is not Delivered.
400998Device is not Registered.
400998Device cannot be activated as activation mode is not configured as MANUAL.
400998Device not Found.
400998Error getting device information.
400998Invalid Product type.
400998Error while validating form factor.
400INVCHA001Invalid channel -
400INVCHA002Channel Error -
400HDEERR001Error in Device and Device Plan Selection.
400998Expiry Date can not be null.
400998Expiry Date is not matching.
400BPINU002Error in Device Selection.
400GETCNT002Invalid card pack id.
400VALEXP004Expiry Date is null.
400VALEXP005Expiry Date is not matching.
400VALEXP006Expiry Date should be null.
400VALEXP007Error while validating expiry date.
400STPLST047Error while getting device details.
400STPLST048Device is not stoplisted Or Device is replaced with new number.
400GETDEV001Invalid device.
400GETDEV002Invalid Card pack id.
400GETDEV003Invalid client code.
400GETDEV004Error while fetching device number.
400STPCRD001Device number is mandatory.
400STPCRD002Service code is mandatory.
400STPCRD017DEVICE details not found.
400STPCRD004Device is not activated.
400STPCRD018Device_Plan not found.
400STPCRD006Error fetching Device_Plan.
400STPCRD007No paired device present for activation.
400STPCRD019No Data in DEVICE_WALLET_LINK.
400STPCRD008Error fetching DEVICE_WALLET_LINK.
400STPCRD009Service is allowed for device having paired device.
400STPCRD010Service is allowed only for Travel purpose DEVICE.
400STPCRD011Service not allowed, Device status is -
400STPCRD012This request is not permitted. Stop list history of this DEVICE is not present.
400STPCRD013This request is not permitted. DEVICE is not stop listed.
400STPCRD014This request is not permitted.
400STPLST003Invalid Device Number.
400STPLST004Invalid reason code.
400STPLST008Invalid status code.
400STPLST040Can Not Insert Into SERVICE_DETAILS For DEVICE Number:: and Service Code ::]
400STPLST005Invalid reason code.
400STPLST008Error while Extracting Card Pack Id from Device Table.
400HDE903Error Occurred during Device Replace Update.
400HDE904Other-Error Occurred during Device Replace Update.
400STPLST006Invalid reason code.
400HDE120Withdrawal Denied due to sticky reason code.
400STPLST020Error while withdrawing card from stoplist.
400STPLST021Error while withdrawing card from stoplist.
400STPLST036Error while withdrawing card from stoplist.
400STPLST037Error while withdrawing card from stoplist.
400HDE120Error while withdrawing card from stoplist.
400STPLST023Error while withdrawing card from stoplist.
400STPLST024Error while withdrawing card from stoplist.
400STPLST025Error while withdrawing card from stoplist.
400STPLST026Error while withdrawing card from stoplist.
400STPLST027Error while withdrawing card from stoplist.
400STPLST028Error while withdrawing card from stoplist.
400STPLST029Error while withdrawing card from stoplist.
400STPLST030Error while withdrawing card from stoplist.
400STPLST031Error while withdrawing card from stoplist.
400STPLST032Error while withdrawing card from stoplist.
400STPLST034Error while withdrawing card from stoplist
400STPLST033Error while withdrawing card from stoplist.
400STPLST035Error while withdrawing card from stoplist.
400STPLST007Error while withdrawing card from stoplist.
400HDE001Error while withdrawing card from stoplist.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
length ≤ 3

Transaction flag to stoplist or withdraw stoplist of respective card. Must be STP (Stoplist Card) or WDR (Withdraw Card from stoplist). Not NULL. Fixed length: 3.

Allowed:
string
enum
required
length ≤ 3

Identifies if it is a Card Number (CRD) or Card Pack ID (CPI). Not NULL. Must be CRD or CPI. Maximum length: 3.

Allowed:
string
required
length between 10 and 24

Card Number or Card Pack ID. Not NULL. Minimum length: 10 (not applicable for CNA). Maximum length: 24.

string
^[0-9]{4}$

Date on which the card number will expire. Mandatory for formFactorType CRD. Valid format: YYMM. Should not be populated for formFactorType CPI.

string
required

For STP: Must be 5 (Lost), 6 (Stolen), 7 (Counterfeit), 8 (Returned), 12 (Expired), 19 (Damaged Card), 20 (Emergency Replacement), or 21 (Erroneous Card). For WDR: Must be 1 (Found card), 2 (capture card), 3 (Bank decision), 4 (Overdue card), 5 (Stoplist card), 6 (Miscellaneous), 7 (Unblocked card), or 8 (Replacement Cancellation).

string
length ≤ 100

Brief description about the stoplist and stoplist withdrawal transaction operations being performed. Maximum Length: 100.

string
required
length ≤ 2
^[0-9]{2}$

Network Code associated to Acquirer ID. Not NULL. Fixed length: 2.

Headers
string
^[a-zA-Z0-9-]{1,50}$

API Consumer must share a Correlation-ID in the HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate universally unique identifier (UUID) of length 32 or 36 that is compliant with RFC 4122. The maximum supported length is 50 alphanumeric characters. For example, ac97d177-9345-4934-8343-0f91a7a02836. If the Correlation-ID is not received in the incoming request, the system generates the UUID dynamically and assigns it to the request.

string

API Consumer can share Source in the HTTP header for API requests. For the list of Source values, see the Pre-conditions for HTTP Header of REST API topic in the Pre-requisite for Rest API section.

Response

Updated about 1 year ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?