Fund Transfer API

This API will be used to do intra wallet fund transfer.

Environment: https://domain/api/onboarding/v2/transferFunds

HTTP Method: GET

Request parameters

Header

ParameterDescriptionExample
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 Prepaid2000
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., 100100
secureCode
mandatory
String Uniquely identifies the client on payload level for performing operations.AfYtlO5kqdySIjXyNmGg3F

Body

ParameterDescriptionExample

Encrypted

token
mandatory
String Token is the Encrypted body of the below request AES-192-CBC bits EncryptionPl8F5kDZcvADIiursiA
vvbHNuL9Wv5eaFdorGV
FU6FKfIEnV/YskkzJlA
ov2ZHJWnqGNLOXfBq4S
Qqw8Ep4sK0gCAAkRXAT
Cb1nSY6s=

Decrypted

messageCode
mandatory
Numeric Code to Identify load card request type. Character Limit - 41080
clientTxnId
mandatory
String Unique ID generated by the client for each transaction. Character Limit - 14GOUd789hhhjfscs
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 - 4
Senders.urn
conditional
A unique reference number for the card(urn)70000000008
Senders.customerId
optional
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 - 2011001188721
Senders.accountNumber
optional
StringID of the sender wallet
Character Limit - 15
"20006bbbaa78”
Senders. transactionAmount
mandatory
NumericTransaction amount for which card/wallet to been debit. It is in implied decimals based on the currency. For ex. INR 5.25 is 000000000525 in implied decimal format.
Character Limit - 12
10000
Sender.accountNumberCurrency
optional
NumericCurrency according to ISO-4217.
Character Limit - 3
356
Senders. sourceAccountType
optional
NumericThis will be handle from beneficiary part.
Character Limit - 2
12
Senders. sourceAccount
optional
StringSource account is the account from which funding is happening.
Character Limit - 30
123456789
receivers. urn
mandatory
NumericA unique reference number for the generated card.
Character Limit - 11
70000000008
receivers. customerId  
optional
StringA customer id from client system to be shared.
Character Limit - 20
89342546
receivers. accountNumber
mandatory
StringID of the receivers wallet.
Character Limit - 30
“20006bbbaa78_1”
receivers. transactionAmount
mandatory
NumericTransaction amount for which card/wallet to been debit. It is in implied decimals based on the currency. For ex. INR 5.25 is 000000000525 in implied decimal format. Character Limit - 12`
reserved1
optional
StringImpl Id to identify what kind of Fund transfer
Character Limit - 500
O|70010
reserved2
optional
StringImpl Id to identify what kind of Fund transfer Character Limit - 500\PG Debit
reserved3
optional
StringImpl Id to identify what kind of Fund transfer Character Limit - 500Monthly settlement 
reserved4
optional
String Impl Id to identify what kind of Fund transfer Character Limit - 500I|70010
reserved5
optional
String Impl Code to identify what kind of Fund transferCharacter Limit - 500PG Credit
reserved6
optional
String Reason for fund transfer Character Limit - 500Monthly settlement

Sample request

Request packet (Encrypted)

{  

“token”:"Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb1nSY6s="  

}  

Request packet (Decrypted)

{  
    "messageCode": "1680",  
    "clientTxnId": "FunDTrJMphIBit011111111018111101112177111111111295",  
    "requestDateTime": "20220717101432",  
   "senders": [  

        {    
            "urn": 414934,  
            " accountNumber ": "10008dd1c78_13", 
            "transactionAmount": "1500",  
            "sourceAccountType": 1,  
            "sourceAccount": "1234",  
            "reserved1": "O|10009",  
            "reserved2": "PG Load",  
            "reserved3": "201607040918K4"  
        }  
    ],  
    "receivers": [  
        {  
            "urn": 414935,  
            "customerId": "payu49",  
            "accountNumber": "10008dd1c78_12", 
            "transactionAmount": "1500",  
            "reserved4": "I|10009",  ]
            "reserved5": "PG Load",  
            "reserved6": "2016aasd07040918"  
        }  
    ]  
}  

Response parameters

ParameterDescriptionExample

Encrypted

tokenToken is the Encrypted body of the below request AES-192-CBC bits EncryptionPl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/
YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb
1nSY6s=

Decrypted

messageCodeCode to Identity create card response type1011
clientTxnIdValue copied from the request20150701235959xhstiesqfds
responseDateTimeResponse date time in the format YYYYMMDDHHMMSS with time in 24 hr format20161031214559
clientIdUniquely ID for the client .9712938648
responseCodeContains the status of the transaction. 201 indicates CREATED. Please refer Appendix for other response codes201
responseMessageResponse message based on response code will be sentCard creation successful
bankIdBank ID is provided by platform to identify issuer/PPI of the program.7020
urnA unique reference number for the generated card.70000000008
customerIdUnique value passed in the request will be echoed else unique value generated by the platform if not passed in the request89342546
accosaTransactionIdUnique id for a particular transaction generated in Prepaid3591893

API error codes

Error CodeDescription
00 SUCCESS
1055MALFORMED_REQUEST
1085PRODUCT NOT ALLOWED
1052SYSTEM_ERROR
1032INVALID_CLIENT_CHANNEL
1081OPERATION NOT ALLOWED
1080IP_NOT_ALLOWED
1049INVALID SECURE CODE
1051CHECKSUM FAILURE
1093INVALID CLIENT TXN ID
1320REQUEST_DATETIME_IS_MANDATORY
1031INVALID BANK ID
1264BANK ID NOT PRESENT
1262CLIENT ID NOT PRESENT
1310XCONSUMERKEY NOT PRESENT
1030INVALID MESSAGE
1311SECURE CODE NOT PRESENT
1088INVALID DATE FORMAT

Sample response

Packet sample (Encrypted)

{ 
“token”:"Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb1nSY6s=" 
} 

Packet sample (Decrypted)

Failure scenario

{ 
    "urn": 414934, 
    "customerId": "payu47", 
    "responseCode": "1501", 
    "messageCode": 1681, 
    "clientTxnId": "FunDTrJMphIBit011111018111101112177111111111295", 
    "clientId": 2000, 
    "responseDateTime": "20230913143701", 
    "accosaTransactionId": 2623908, 
    "responseMessage": "SYSTEM ERROR", 
    "bankId": 1234 
}