Wallet Closure or Refund Request API

post

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

A cardholder can do both Refund, Closure functions for the prepaid devicesseparately as well as together. The Credit+ Issuing system will receive the request. Now, the system will process the request and will perform the necessary validations. Once the validations are successful, it sends a Wallet Closure or Refund Request service request. If a validation fails, it sends the corresponding error in the response message. This API can be processed for all prepaid devices statuses configured in the system.

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	Reason
401	997	Either Channel is blank or not valid, Please enter Valid Channel.
400	997	Request logged successfully and can be approved after locking period, i.e. block release date, locking period for this wallet is days. Request Number NOTE: The locking period day is calculated in the message text field based on the configuration made at the wallet plan.
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 Passcode flag is blank or length is not 1.
400	997	Subsequent Action can be blank but if it present must have values A / D.
400	997	Either Refund Reference Number is blank or length is not 12 whereas Subs action is A / D.
400	997	Either Close Device is blank or not valid, Valid Close Device values are Y / N.
400	997	Either Refund Reason is blank or length is greater than 100.
400	997	Either Mode of Refund is blank or not valid, Valid Mode of Refund are CA / DD / CH
400	997	Remarks can be blank but if it is present length must be less than 100.
400	997	Wallet Detail list should at least have one record if value of subs action is
400	997	Wallet Number is Mandatory if Device is Multi currency Device or if GPR card close Device value is N.
400	997	Payout Currency is mandatory if device is multi-currency Device and currency code Length should be equal to 3.
400	997	Form Factor field is mandatory
400	997	Form Factor Type field is invalid.
400	997	Form Factor Type is mandatory
400	997	Program Code field should only contain [A-Z 0-9] and underscore and must start and end with alphanumeric character.
400	997	Tolerance Type can be blank but if it present must have values N / P.
404	902	Invalid Form Factor for provided Institution.
500	401	User Or Bank do not support API.
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	Product Type field is invalid.
400	997	Only alphanumeric characters and underscore are allowed.
400	997	FORM_FACTOR field value must have max length 24.
400	CNA006	Multiple device numbers are active for given details
400	CNA002	Card Number Alias Functionality is not applicable for this Institution
400	CNA003	Record does not exists for the given details
400	CNA001	Bank Does Not Exists
500	-20004	Error: Currency conversion failed for money transfer limit validation.
500	-20004	Error: VISA/ Mooney transfer limit violated.
500	-20004	Error: GET_TARGET_WALLET
500	20004	Error: GET_LIMIT_PLAN_ATTRIBUTES
500	REF012	Agent wallet not defined.
500	REF013	Error while fetching Agency wallet details.
500	REF079	Unapproved load transaction(s) exists. Refund not allowed.
500	REF083	Unapproved Miscellaneous Debit/ Credit transaction(s) exists. Refund not allowed.
500	REF083	Wallet Balance has changed, Refund Not Allowed
500	REF057	Locking period is till LV_BLOCK_RELEASE_DATE Request can be processed only after the locking period.
500	61	Cumulative balance error/rate not defined
500	REF014	Lv_Acc_Prog_Cur_Amt= Lv_Acc_Prog_Cur_Amt
500	REF055	Insufficient balance after considering the refund amount and calculation of minimum balance / retention amount.
500	REF018	Error Occurred during cancelation of wallet
500	REF016	Insufficient available balance.
500	REF017	Insufficient balance after considering the refund amount and calculation of minimum balance / retention amount.
500	REF080	Refund Amount in refund currency should not be zero.
500	REF019	Error while processing Refund Transaction
500	REF011	Error updating balance for agency’s wallet.
500	REF011	Error updating balance for Corporates wallet.
500	-20005	Error fetching cumulative balance.
500	-20005	Client Program Activity Information Not Found. Line
500	-20007	Error: VALIDATE_DEVICE_LIMITS
500	44000	Exceeded Maximum number of load for Client.
500	-20002	Error: GET_LIMIT_PLAN_ATTRIBUTES
500	-20003	is greater than per transaction amount limit
500	REF058	ERROR OCURRED WHILE UPDATEING REFUND AMOUNT
500	913	Backward offset time limit violated.
400	994	Invalid Request - Unrecognized field.
400	988	Encryption type Not Supported.
400	913	Forward offset time limit violated.
400	994	Invalid Encryption Request Parameters
400	994	Cryptography error
400	994	Invalid Encryption-Algorithm header value

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

sessionKey

string

required

Free text. Not Null.

channel

string

enum

required

CSC / AGT / Network Code associated to Acquirer ID. Can contain values '31', '32' Only. Not NULL.

Allowed:

passCodeFlag

string

enum

required

length ≤ 1

Flag to enable the pass code. Should be 'Y' or 'N'. Max length is 1. Not NULL.

Allowed:

passCode

string

length ≤ 200

Login Password given to Acquirer ID (it should be hashed with SHA5 algorithm). If PassCodeFlag is 'Y', then this should be Not NULL. Else, this should be NULL. If it is present, max length is 200.

formFactorType

string

enum

required

length ≤ 3

To identify if it is a Card Number (CRD) or Card Pack ID (CPI) or Card Number Alias (CNA). Maximum length: 3. Either CRD or CPI or CNA. Not NULL.

Allowed:

formFactor

string

required

length between 10 and 24

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

refundReferenceNumber

string

length ≤ 11

^\d{11}$

Reference Number Identifier. Not Null if Subaction is A OR D, this cannot be blank and length must be equal to 11.

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. Maximum Length: 6. This field is required only when formFactorType is CNA and multiple devices are linked with same CNA.

devicePlanCode

string

length ≤ 10

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

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

closeDevice

string

enum

required

Indicates closure for device requested. Value can be either of Y or N Only.

Allowed:

refundReason

string

required

length ≤ 100

Free style text for user reason behind closure. Cannot be blank or more than 100 chars.

modeOfRefund

string

enum

required

Indicates mode of refund. Valid Mode of Refunds can be 'CA', 'DD', 'CH'.

Allowed:

merchantLocation

string

Name & location of merchant.

remarks

string

length ≤ 100

Comments on Reason for Refund. If Present Length must be < 100.

memo

string

length ≤ 100

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

subsAction

string

enum

Any action to be performed after Refund. Values can be A - Approve Action or D - Decline Action.

Allowed:

walletDetailList

array of objects

required

length between 1 and 16

Contains wallet information. Atleast 1 record. Max 16 records.

walletDetailList*

timestamp

string

required

^\d+$

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

Headers

Correlation-ID

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.

Encryption-Algorithm

string

enum

required

API Consumer must share Encryption-Algorithm as a key (value: DES168) in HTTP header in order to encrypt the API requests.

Allowed:

Source

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

201Request processed successfully