Load/Reload API

post

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

A vendor initiates a request message for load/reload through API. The Credit+ Issuing system receivesthe message and validatesfor all input fields. The API will load/reload the wallet details of the system. Further, when the GST rate is configured and the cardholder hasinitiated a transaction request through API for prepaid devices/debit/credit devices, the system sends the GST amount (total CGST and SGST/UTGST or IGST) as the response message for the transaction requests received. It is a part of multi-currency programs and multi-purpose GPR wallets.

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 Code	Error Code	Error Description
400	102	Suspected fraud.
400	119	Transaction not permitted.
400	997	Either Passcode flag is blank or length is not 1.
400	997	Either Passcode is blank or Length is greater than 200 whereas Passcode flag is Y.
400	997	Passcode should be blank when Passcode flag is N.
400	997	Either Form Factor Type is blank or not valid, Please Enter Valid form factor types as per the request.
400	997	Form Factor field is blank.
400	997	Card Number in Form Factor field is blank.
400	997	Card Pack ID in Form Factor field is blank.
400	997	Form Factor length should be in between 10 to 24.
400	997	Either expiry date is blank or Length is greater than 4 whereas form factor type is CRD.
400	997	Expiry date is not in expected 'yyMM' format whereas form factor type is CRD.
400	997	Either Transaction Counter is Blank, Not Number or Length is greater than 100.
400	997	Either Transaction Type is blank or not valid, Valid Transaction Types are O / R.
400	997	Either Authorization reference Number (RRN) is blank or Length is not equal to 12.
400	997	Either Trace Audit Number is blank or Length is not equal to 6.
400	997	Either Transaction Code is blank or not valid, Valid Transaction Codes are IL / LC.
400	997	Transaction Date Time should not be blank.
400	997	Transaction Date Time is not in expected 'yyyyMMddHHmmss' format.
400	997	If Merchant Category Code 'MCC' is not blank then it should be a 4 digit numeric value.
400	997	If Remark is not blank then length should be less than 100
400	997	Previous Wallet currency Can Not be Null Or Empty
400	997	First Wallet Currency is mandatory, it can not be blank.
400	997	Billing Currency code Length is not equal to 3.
400	997	Transaction Amount should not be blank and should be greater than Zero.
400	997	If Currency Conversion Rate is not blank then it should be greater than Zero.
400	997	Either Transaction Currency is blank or currency code Length is not equal to 3.
500	API522	Invalid Transaction Channel or interface.
500	API523	Invalid Transaction Channel or interface
500	API433	User does not have permission to access this
500	VALFRM007	Invalid Card Pack ID
500	VALFRM007	CPI linked to multiple Active Card(s)
500	VALFRM007	Error Fetching Device
500	VALFRM018	Card not active
500	136	Invalid Card
500	136	Invalid Form factor type (CRD/CPI)
500	140	Error finding transaction uniqueness
500	141	RRN and trace audit number combination is not unique.
500	APIREV001	REVERSAL failed
500	171	Device status is not normal
500	382	Invalid Program Code
500	170	Invalid product type (Prepaid) of device
500	CALGSTTAX	Failed in For GST Calculation
500	MARKUP004	Error, GST fees inserting into transaction history
500	892	Error while populating business date
500	141.9	Billing/Wallet Currency is Mandatory!
500	141.1	Transaction and Wallet Currency should be same for GPR/Gift Cards
500	142	Wallet not available for Currency
500	142.1	Wallet Number is Mandatory for Multi wallet GPR Cards
500	142.9	Invalid Wallet Number and Currency Combination
500	55	Wallet is not active
500	92	Delivery Date is null
500	23	Error while fetching travel plan currency
500	292	Other: Error in Aggregate Limit Fetch
500	92	Transaction currency not defined
500	92	Transaction amount not defined
500	92	Transaction Currency and amount not defined
500	92	Initial load is already completed for device, please use reload
500	92	Transaction not permitted
500	CONRATE010	Conversion rate is not defined for program currency
500	CONRATE020	Conversion rate is not defined for wallet plan currency
500	CONRATE020	Conversion rate is not defined for default wallet currency
500	111	Incorrect Billing Amount - Calculation Error!
500	DEVICE_LIMIT_VALIDATION	ERROR: DEVICE LIMIT VIOLATED
500	92	Conversion rate is not defined for travel currency
500	API00018	N0 Active Trip Present
500	FEMA00016	INSERTION in TRAVEL_TRIP_HISTORY failed
500	API00016	Error while fetching details of upcoming trip
500	838	Error. Client usage counter
500	TXNFEES002	Error, Calculate Transaction fees
500	MRKUPFEE001	Error, Calculate Markup fee and with tax
500	TXNFEE001	Error, transaction amount inserting into transaction history
500	TRNFEE002	Error, fees inserting into transaction history
500	SERTAX003	Error, Service tax inserting transaction history
500	MARKUP004	Error failed Markup fees inserting into transaction history
500	MARKUP015	Error failed Markup service tax
500	APILC001	Error, failed loading balance
400	911	Failed in Wallet Activation
500	API002	Load and re-load validation failed due to internal error. Please contact system admin
500	92	Initial load is already completed for device, please use reload
500	VALEXP001	Expiry Date cannot be null
500	VALEXP002	Expiry Date is not matching
500	VALEXP004	Expiry Date is null
500	VALEXP005	Invalid/Incorrect Expiry Date
500	VALEXP006	Expiry Date should be null
400	997	Program code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Program Code field value must have max length 6.
400	997	Device Plan code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Device Plan Code field value must have max length 10.
400	997	Only alphanumeric characters and underscore are allowed.
400	997	Card Number Alias field value must have max length 24.
400	CNA001	Bank Does Not Exists
400	CNA002	Card Number Alias Functionality is not applicable for this Institution
400	CNA003	Record does not exists for the given details
400	CNA005	Multiple device numbers are active for given details
400	CNA006	Error while fetching device details

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

userId

string

length between 6 and 30

Acquirer ID assigned to the third party system (Processing bin is in network membership). If data is received in this field, it will be ignored. User ID that was created during API onboarding will always be used.

transactionCounter

string

required

length ≤ 100

Unique number for each transaction. Not NULL.

sessionKey

string

required

length ≤ 50

Validation - If the session is active and bank code must be derived from it. If incorrect or not active, then reject the transaction. Not NULL.

channel

string

required

length ≤ 2

^\d{2}$

CSC / AGT / Network Code associated with Acquirer ID. Fix length 2, Numeric only. Not NULL.

passCodeFlag

string

enum

required

length ≤ 1

Allowed:

passCode

string

length ≤ 200

Login password given to Acquirer ID (it should be hashed with SHA5 algorithm). If Pass Code Flag is 'Y', then this should be Not NULL else this should be NULL.

formFactorType

string

enum

required

length ≤ 3

To identify, if it is Card Number (CRD) or Card Pack ID (CPI) or Card Number Alias (CNA). Either CRD or CPI or CNA. Not NULL.

Allowed:

formFactor

string

required

length between 10 and 24

It is Card Number or Card Pack ID or Card Number Alias. Minimum length 10 (minimum length is not applicable for CNA). Should be alphanumeric and underscore in case of 'CNA' form factor type. Not NULL.

formFactorExpiryDate

string

length ≤ 4

^\d{2}\d{2}$

It is the date on which the device will expire. For formFactorType: CRD, Not NULL. For formFactorType: CPI, it is optional and if received it is validated and in case of failure error is sent. Data format YYMM.

transactionType

string

enum

required

Transaction Type Indicator: Original (O) or Reversal (R). Either 'O' or 'R'. Not NULL.

Allowed:

rrn

string

required

length ≤ 12

^\d{12}$

Mandatory and Unique Authorization reference Number. Fix length 12. Not NULL.

traceAuditNumber

string

required

length ≤ 6

^\d{6}$

A number assigned by the originator of a transaction to uniquely identify a transaction throughout its life. Fix length is 6. Not NULL.

transactionCode

string

enum

required

Either LC - Reload (Credit) or IL - Initial Load (Credit). If this is NULL, then internal exception is shown to user. API treats both IL and LC in the same way. Not NULL.

Allowed:

transactionDatetime

string

required

^\d{4}\d{2}\d{2}\d{2}\d{2}\d{2}$

Transaction date & time of the transaction Acceptor. Format 'YYYYMMDDHHMMSS'. Not NULL.

mcc

string

length ≤ 4

^\d{4}$

Merchant Category Code. If it is present, then Numeric without any fraction, Fixed length 4.

acceptorTerminalId

string

Identification code of acceptor terminal. This is mandatory for Closed Loop Programs.

acceptorMerchantId

string

Identification of acquiring entity. This is mandatory for Closed Loop Programs.

acceptorNameLocation

string

Name & location of acceptor. This is mandatory for Closed Loop Programs.

remarks

string

length ≤ 100

User remarks. If it is present, then it should of Max. length 100.

memo

string

length ≤ 100

Indicates the additional information related to refund. Maximum length: 100.

emvData

string

Emv data for the device.

acquirerCountryCode

string

Country code for acquirer.

walletNumber

string

length ≤ 24

Wallet Number linked to the device. Mandatory for GPR Product as well as multicurrency wallet. Maximum length 24.

transactionCurrency

string

required

length ≤ 3

^\d{3}$

3 digit numeric currency code in which the amount is specified. Numeric ISO Currency Code. Not NULL.

transactionAmount

string

required

Numeric Value for Financial Transaction and Non-Financial Transaction with fee. Must have a valid Greater than 0. Not NULL.

currencyConversionRate

string

Conversion rate used by third party to convert amount. This data should be captured only as information. If it is present, then Numeric, Greater than 0.

billingCurrency

string

required

length ≤ 3

^\d{3}$

3 character Billing currency code in which the billing amount is specified. If there is no conversion, same currency as that in transactionCurrency should be sent. Data to be passed, if currency conversion is involved in transaction processing. Not Null.

billingAmount

string

If there is no conversion, same amount as that in transactionAmount is sent.

serviceTax

number

Tax amount. If received in request, it will not be used for further processing. System will charge the service tax if configured for that program and that will be sent in response.

fee

number

Fee. If received in request, it will not be used for further processing. System will charge the fee if configured for that program and that will be sent in response.

markupFee

number

Mark-up fee. If received in request, it will not be used for further processing. System will charge the mark-up fee if configured for that program and that will be sent in response.

tripId

string

This is the trip id for which new load balance request is initiated.

tripType

string

enum

This is the travel type for which a new load balance request is raised. Possible values: 0 (Active Trip), 1 (New Trip). This field is mandatory if the Value check box for Type ID is selected from the Card Management > Institution Parameter Setup > System Codes. Else this field is optional if the Value check box is not selected.

Allowed:

travelTypeCode

string

enum

This is the travel type code. Not null, Valid values are: 'LEISUR', 'BSNESS', 'EMPLMT', 'DFAULT', 'MEDICI', 'EMIGRN', 'CULTRL', 'STUDNT'. This field is mandatory, if the Travel Wise Load Limit check box is selected for a transaction type at Card Management > Institution Parameter Setup > Credit transactions for load. Mandatory if tripId is present.

travelStartDate

string

^\d{2}\d{2}\d{4}$

This is the start date of travel. Not null, Date format ddMMyyyy. This field is mandatory, if the Travel Wise Load Limit check box is selected for a transaction type at Card Management > Institution Parameter Setup > Credit transactions for load. Mandatory if tripId is present.

travelEndDate

string

^\d{2}\d{2}\d{4}$

This is the end date of travel. Not null, Date format ddMMyyyy. This field is mandatory, if the Travel Wise Load Limit check box is selected for a transaction type at Card Management > Institution Parameter Setup > Credit transactions for load. Mandatory if tripId is present.

destinationCountry

string

length ≤ 3

^\d{3}$

This is the travel destination country. Not null, Length should be 3. It should be a valid ISO numeric country code. This field is mandatory, if the Travel Wise Load Limit check box is selected for a transaction type at Card Management > Institution Parameter Setup > Credit transactions for load. Mandatory if tripId is present.

walletNumber2

string

length ≤ 24

Wallet Number linked to the device. Mandatory for GPR Product as well as multicurrency wallet. Maximum length 24.

transactionCurrency2

string

length ≤ 3

^\d{3}$

3 digit numeric currency code in which the amount is specified. Numeric ISO Currency Code.

transactionAmount2

number

Numeric Value for Financial Transaction and Non-Financial Transaction with fee. Must have a valid Greater than 0.

currencyConversionRate2

number

Conversion rate used by third party to convert amount. Numeric, Greater than 0.

billingCurrency2

string

length ≤ 3

^\d{3}$

billingAmount2

number

If there is no conversion, same amount as that in transactionAmount is sent.

serviceTax2

number

Tax amount.

fee2

number

Fee.

markupFee2

number

Markup Fee.

walletNumber3

string

length ≤ 24

Wallet Number linked to the device. Mandatory for GPR Product as well as multicurrency wallet. Maximum length 24.

transactionCurrency3

string

length ≤ 3

^\d{3}$

3 digit numeric currency code in which the amount is specified. Numeric ISO Currency Code.

transactionAmount3

number

Numeric Value for Financial Transaction and Non-Financial Transaction with fee. Must have a valid Greater than 0.

currencyConversionRate3

number

Conversion rate used by third party to convert amount. Numeric, Greater than 0.

billingCurrency3

string

length ≤ 3

^\d{3}$

billingAmount3

number

If there is no conversion, same amount as that in transactionAmount is sent.

serviceTax3

number

Tax amount.

fee3

number

Fee.

markupFee3

number

Markup Fee.

walletNumber4

string

length ≤ 24

Wallet Number linked to the device. Mandatory for GPR Product as well as multicurrency wallet. Maximum length 24.

transactionCurrency4

string

length ≤ 3

^\d{3}$

3 digit numeric currency code in which the amount is specified. Numeric ISO Currency Code.

transactionAmount4

number

Numeric Value for Financial Transaction and Non-Financial Transaction with fee. Must have a valid Greater than 0.

currencyConversionRate4

number

Conversion rate used by third party to convert amount. Numeric, Greater than 0.

billingCurrency4

string

length ≤ 3

^\d{3}$

billingAmount4

number

If there is no conversion, same amount as that in transactionAmount is sent.

serviceTax4

number

Tax amount.

fee4

number

Fee.

markupFee4

number

Markup Fee.

walletNumber5

string

length ≤ 24

Wallet Number linked to the device. Mandatory for GPR Product as well as multicurrency wallet. Maximum length 24.

transactionCurrency5

string

length ≤ 3

^\d{3}$

3 digit numeric currency code in which the amount is specified. Numeric ISO Currency Code.

transactionAmount5

number

Numeric Value for Financial Transaction and Non-Financial Transaction with fee. Must have a valid Greater than 0.

currencyConversionRate5

number

Conversion rate used by third party to convert amount. Numeric, Greater than 0.

billingCurrency5

string

length ≤ 3

^\d{3}$

billingAmount5

number

If there is no conversion, same amount as that in transactionAmount is sent.

serviceTax5

number

Tax amount.

fee5

number

Fee.

markupFee5

number

Markup Fee.

walletNumber6

string

length ≤ 24

Wallet Number linked to the device. Mandatory for GPR Product as well as multicurrency wallet. Maximum length 24.

transactionCurrency6

string

length ≤ 3

^\d{3}$

3 digit numeric currency code in which the amount is specified. Numeric ISO Currency Code.

transactionAmount6

number

Numeric Value for Financial Transaction and Non-Financial Transaction with fee. Must have a valid Greater than 0.

currencyConversionRate6

number

Conversion rate used by third party to convert amount. Numeric, Greater than 0.

billingCurrency6

string

length ≤ 3

^\d{3}$

billingAmount6

number

If there is no conversion, same amount as that in transactionAmount is sent.

serviceTax6

number

Tax amount.

fee6

number

Fee.

markupFee6

number

Markup Fee.

productType

string

enum

Product type of Device. Allowed values (P/C/D). This field is required only when formFactorType is CNA and multiple devices are linked with same CNA.

Allowed:

programCode

string

length ≤ 6

^[A-Z0-9][A-Z0-9_]*[A-Z0-9]$

Program attached to the device. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Maximum Length: 6.

devicePlanCode

string

length ≤ 10

^[A-Z0-9][A-Z0-9_]*[A-Z0-9]$

Device Plan Code attached with the device. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA. Maximum Length: 10.

Headers

Correlation-ID

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.

Source

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

201Request processed successfully