API Reference

Client Profile Information API (V1)

post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/client/profileinfo

This API receivesthe client profile information from Pine Labssystem. It works for all device statuses.

It is applicable for prepaid, credit and debit products issued on Pine Labs platform.

NOTE: This API would be consumed by users who are presently using version 1 of this API. For users who are consuming version 2 of this API, refer to section ‘Client Profile Information API (V2)’.

Why would I need to use this resource?

Third party can be enabled for profile information service to the cardholder using this API resource. Cardholder can see all the wallet and device details along with the demographic’s details using this API.

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
200000Successful
404997FORM_FACTOR field is mandatory.
404997FORM_FACTOR_TYPE field is mandatory.
404998Invalid Client.
404997FORM_FACTOR_TYPE field value must have max length 3.
404997FORM_FACTOR field value must have max length 24.
403900Invalid User.
404998Device(s) does not exist.
404998Invalid Device.
201318Error while retriving data from Wallet Detail.
201318Error while retriving data from Device Detail.
201318Error while retriving data from Client Detail.
201GETCNT001Invalid device.
201GETCNT002Invalid Card pack ID.
201GETCNT004Error while retriving client.
201GETCNT003Invalid client code.
201VALPRA001Error while validating primary/add on client.
500999Internal server error.
400994Invalid Encryption-Algorithm header value
400994Invalid Encryption Request Parameters
400994Cryptography error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
length ≤ 3

Identifies if it is a Card Number, Client ID, or Card Pack ID. Not NULL. Valid values: CRD (Card Number), CLI (Client ID), CPI (Card Pack ID). Maximum length: 3.

Allowed:
string
required
length between 10 and 24

Card Number, Client ID, or Card Pack ID. Not NULL. Minimum length: 10. Maximum length: 24.

string
enum

Product type of Device. Required when formFactorType is CNA and multiple devices are linked. Valid values: P, C, D.

Allowed:
string
length ≤ 6
^[a-zA-Z0-9]+$

Program attached to the device. Required when formFactorType is CNA and multiple devices are linked. Alphanumeric. Maximum length: 6.

string
length ≤ 10
^[a-zA-Z0-9]+$

Device Plan Code attached with the device. Required when formFactorType is CNA and multiple devices are linked. Alphanumeric. Maximum length: 10.

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

API Consumer must share Correlation-ID in HTTP header for API requests. The Correlation-ID must be unique for each request. It is recommended to generate a 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 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?