Load API

This API is called by the client to create a credit transaction entry into the wallet. This API can be called during following scenarios:

When the customer loads the wallet by other payment mode like DC, CC, Net Banking (usually supported by the Payment Gateway)
When merchant wants to load the customer’s wallet (Ex. Load monthly allowance, Load money through Just-in time funding, gives refund or cashback)
When a customer receives money from peers.
Client can raise this load request basis Customer’s URN and sub wallet Id.

Environment: https://domain/mob1/api/onboarding/v1/creditAccount

HTTP Method: PATCH

Request parameters

Header

Parameter	Description	Example
x-api-key mandatory	`String` This is a unique key.	7fe1c0de
clientId mandatory	`String` Uniquely identifies the client. During program enrolment each client is provided with a unique client id by Prepaid	2000
bankId mandatory	`Numeric` Bank Id is provided by Prepaid Aero during program enrolment to uniquely identify the card issuer.	7000
entityId mandatory	`Numeric` Defaults to parent branch i.e., 100	100
secureCode mandatory	`String` Uniquely identifies the client on payload level for performing operations.	AfYtlO5kqdySIjXyNmGg3F

Body

Parameter	Description	Example
token mandatory	`String` Token is the Encrypted body of the below request AES-192-CBC bits Encryption
messageCode mandatory	`Numeric` Code to Identify load card request type. `Character Limit - 4`	1080
clientTxnId mandatory	`String` Unique ID generated by the client for each transaction. `Character Limit - 14`	GOUd789hhhjfscs
requestDateTime mandatory	`Numeric` Local Date and time stamp when the transaction originated from the client in YYYYMMDDHHMMSS with time in 24 hr format. `Character Limit - 14`	20161031214559
customerMobile conditional	`Numeric` Mobile number of the cardholder. It is conditional with customer ID and URN, i.e., either one of them should be present. Append 91 at the beginning of this field for India International Code. `Character Limit - 13`	919888888888
customerId conditional	`String` Customer ID (entityCIF), which uniquely identifies the cardholder in the client system. It is conditional with mobile number and URN, i.e., either one of them should be present. `Character Limit - 20`	10011887211
urn conditional	`String` A unique reference number for the generated card. Need to share this in request body of the APIs. It is conditional with mobile number and Customer ID, i.e., either one of them should be present. `Character Limit - 11`	70000000008
subwalletId conditional	`String` Specific Wallet ID to load the money to the wallet of the card. Conditional wtih accountNumber (either one). `Character Limit - 20`	MOB5378a27c_1
accountNumber conditional	`Numeric` Specific account number to load the money to the wallet of the card. It is conditional with subwalletId (either one).`Character Limit - 16`	604010000445
sourceType optional	`Numeric` Check the source type of funding.`Character Limit - 2`	Wallet-0/account-1
sender mandatory	`String` Name of wallet, account holder from where fund is coming to prepaid system.`Character Limit - 10`	Bank name(HDFC)Amazon,JustInPay
sourceAccount optional	`String` Source account is the account from which funding is happening. `Character Limit - 30`	XBC12345778
transactionAmount mandatory	`Numeric` Load amount for which card has been loaded. It is in implied decimals by two digits. For example, INR 5.25 is 525 in implied decimal. `Character Limit - 12`	525
fee optional	`Numeric` Fee collected for the transaction in implied decimal by 2 digits. `Character Limit - 10`	100
originalClientTxnId conditional	`String` Unique ID generated by the client for each transaction. In case of refund we should send it. `Character Limit - 500`	20150701235959xhstiesqfds
LoadCurrency optional	`String` Currency in which Load is taking place. `Character Limit - 500`	If this field is not provided by the client, then default option is INR only
refundFileId optional	`String` Used to store the file related information for this request. `Character Limit - 500`	201607040918424092qE93qKGGE3456.csv
fundFlowType mandatory	`String` Used to store fundFlowType for Reload/Unload requests. `Character Limit - 20`	O,I,IO,OR,IR,IOR
implId	`String` Refer IMPL Mapping List for the IMPL ID and descriptions.	IR
implType mandatory	`String` Refer IMPL Mapping List for the IMPL type and descriptions.	P2M_W2A_O, P2M_W2A_O_R or P2P_W2A_I, P2P_W2A_I_R
pgNo optional	`String` In case of PG load PG No will be capture.	Pg-122
orderId optional	`String` In case of PG load order ID will be capture.	O12314

Sample request

Request packet (Encrypted)

{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFb CKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6Cmq RHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}

Request packet (Decrypted)

{
"messageCode": "1080",
"clientTxnId": "GOUd789hhhjfscs", "requestDateTime": "20220302153029", "urn": 70000000008, "transactionAmount": 1000,
"sender": "AMAZON",
"loadCurrency": "RM",
"sourceType": 0,
"subWalletId": "MOB5378a27c_1", "implId": "I|70130",
"implType": "P2M_A2W_I",
"fundFlowType": "I",
"fee": 0 }

Response parameters

Parameter	Description	Example
Encrypted
token	Token is the Encrypted body of the below request AES-192-CBC bits Encryption
Decrypted
messageCode	Code to Identify load response type	1081
clientTxnId	Value copied from the request	GOUd789hhhjfscs
responseDateTime	Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format	20161031214559
customerId	Customer Id(entityCIF), which uniquely identifies the cardholder in the client system.
Conditional with mobile number and Urn.	11001188721
responseCode	Contains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes	0
responseMessage	Response message based on response code will be sent	Success
urn	A unique reference number for the generated card by Prepaid system	70000000008
transactionAmount	Reload Amount passed with implied decimals by two digits	210000
availableBalance	Available Balance in the wallet after successful reload with implied decimals with two digits	210000
accosaRefNo	Auto generated sequence number	123212
availableCashLimit	Available Cash limit. It will be 0 by default	0

API error codes

Error Code	Description
00	SUCCESS
1009	CARD_CANCELLED_CLOSED_EXPIRED
1010	CARD_TEMPORARY_BLOCK
1012	CARD_PENDING_CANCELLATION
1013	AML_MIN_LIMIT
1030	INVALID_MESSAGE
1045	UNABLE_TO_PROCESS_REQUEST
1056	INVALID MESSAGE CODE
1058	INVALID_WALLETS
1093	INVALID CLIENT TXN ID
1101	UNKNOWN_SOURCE_ACCOUNT_TYPE
1121	CARD_CREDIT_DEBIT_BLOCK
1135	REFUND_AMOUNT_GREATER_THAN_ORIGINAL_TXN_AMOUNT
1246	ORIGINAL_TXN_NOT_EXIST
1247	SOURCE_ACC_TYPE_NOT_MACHED_WITH_IMPL
1303	CUSTOMER DETAILS NOT PRESENT
1304	MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED
1322	TRANSACTION AMOUNT CANNOT BE ZERO
1325	FUND FLOW TYPE MISMATCH
1326	IMPL ID MISMATCH
1353	COOLING OFF PERIOD BETWEEN TWO LOADS NOT COMPLETED
1354	CORPORATE_LEVEL_LIMIT_EXCEEDED
1357	WALLET DETAILS NOT FOUND
1359	INVALID LOAD AMOUNT
1366	PROGRAM IS INACTIVE
1368	PROGRAM NOT FOUND
1369	SUBWALLET OR ACCOUNTNO SHOULD BE PRESENT
1501	SYSTEM_ERROR_DB
1504	SYSTEM_CACHE_FAILURE
10153	AMOUNT IS NOT WITHIN MIN-MAX RANGE
10163	PROGRAM DAILY LIMIT EXCEEDED

HTTP status code

HTTP Status Code	HTTP Status Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error
503	Service Unavailable

Sample response

Packet sample (Encrypted)

 {
     “token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}

Packet sample (Decrypted)

{
"urn": 70000000008,
"customerId": "130172",
"responseCode": "00",
"messageCode": 1081,
"clientTxnId": "Reload_V3_IZramPNmR74", "responseMessage": "SUCCESS",
"accosaRefNo": "41348", "availableBalance": 1000, "availableCashLimit": 0, "transactionAmount": 1000
}