API Reference

Fetch Wallet

post
https://uatmea-iss-apigw.creditpluspinelabs.com/deviceapi/apis/v1/services/wallet/fetchwallet

Credit+ Issuing system will receive the Fetch Wallet API request call and respond back with the Fetch Wallet API response. If the response issuccessful, then wallet details of all the wallets configured for the given device number in the request is given else appropriate error message is displayed. This Request is applicable only for Prepaid and Credit product.

NOTE:

The API, if sent with Card Number Alias (CNA), will fetch the corresponding associated device for further processing only if DEVICE _STATUS_CODE = NORMAL (0) OR (DEVICE_STATUS_CODE = UPGRADE (9) AND UPGRADE_STATUS = 1.

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 CodeDescription
201000Successful
400400Request Parameters Validation Failure: invalid request
201404Device(s) does not exist
201500Request processing error
400997Form Factor Type is mandatory
400997Form Factor Type field is invalid
400997Form Factor field is mandatory
500999Internal Error
400999Invalid Request Type
201VALFRM003Invalid Device
201VALFRM004Invalid Device
201VALFRM005Invalid Card Pack Id
201VALFRM023Error while validating form factor
201VALFRM045Device not found
201VALFRM046Error getting device information
201VALFRM046Invalid product type
400CNA001Bank Does Not Exists
400CNA002Card Number Alias Functionality is not applicable for this Institution
400CNA003Record does not exist for the given details
400CNA005Multiple device numbers are active for given details
400CNA006Multiple device numbers are active for given details
500913Backward offset time limit violated.
400994Invalid Request - Unrecognized field.
400988Encryption type Not Supported.
400913Forward offset time limit violated.
400994Invalid Encryption Request Parameters
400994Cryptography error
400994Invalid Encryption-Algorithm header value
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Accessing channel. Numeric, can be 31 or 32.

Allowed:
string
enum
required
length ≤ 3

Indicates the data that is being sent in formFactor attribute. Valid values are CRD (Card Number), CPI (Card Pack ID), or CNA (Card Number Alias). Not NULL.

Allowed:
string
required
length between 10 and 24

Card Number, Card Pack ID, or Card Number Alias depending on the formFactorType value. Minimum length not applicable for CNA.

string
enum

Product type of Device. Valid values are P (Pre-paid) or C (Credit). Required only when formFactorType is CNA and multiple devices are linked with same CNA.

Allowed:
string
length ≤ 6

Program attached to the device. Alphanumeric. Required only when formFactorType is CNA and multiple devices are linked with same CNA.

string
length ≤ 10

Device Plan Code attached with the device. Alphanumeric. Required only when formFactorType is CNA and multiple devices are linked with same CNA.

string
required

Current UTC timestamp in milliseconds. Numeric. AES key expiration criteria depend on input UTC timestamp. Applicable only for encrypted requests.

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?