Delete Beneficiary API

The Delete Beneficiary API is used for deletion of beneficiary.

URL: https://domain/api/onboarding/ v1/beneficiary/delete

HTTP Method: GET

Request parameters

Body

Parameter	Description	Example
Encrypted
token mandatory	`String` Token is the Encrypted body of the below request AES-192-CBC bits Encryption	Pl8F5kDZcvADIiursiA vvbHNuL9Wv5eaFdorGV FU6FKfIEnV/YskkzJlA ov2ZHJWnqGNLOXfBq4S Qqw8Ep4sK0gCAAkRXAT Cb1nSY6s=
Decrypted
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 - 4`
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`	11001188721
urn conditional	A unique reference number for the card(urn)	70000000008
beneficiaryId mandatory	`String` A unique Beneficiary Id for the beneficiary. `Character Limit` - 15	874743484374
beneficiaryMobileNumber conditional	`Numeric`To be passed in case of Beneficiary type code is 3 `Character Limit - 20`
accountNumber conditional	`String` Conditional with Urn, customer id, customer mobile`Character Limit - 15`	43453245642

Sample request

Request packet (Encrypted)

{ 

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

Request packet (Decrypted)

{ 
    "messageCode": "2030", 
    "clientTxnId": "2077145URNDELETE1313412", 
    "requestDateTime": "20161031214559", 
    "urn": 1435,     
    "beneficiaryId": "51465570" 
}

Response parameters

Parameter	Description	Example
Encrypted
token	Token is the Encrypted body of the below request AES-192-CBC bits Encryption	Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/ \nYskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb \n1nSY6s=
Decrypted
messageCode	Code to Identity create card response type	1011
clientTxnId	Value copied from the request	20150701235959xhstiesqfds
responseDateTime	Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format	20161031214559
clientId	Uniquely ID for the client .	9712938648
responseCode	Contains the status of the transaction. 201 indicates CREATED. Please refer Appendix for other response codes	201
responseMessage	Response message based on response code will be sent	Card creation successful
bankId	Bank ID is provided by platform to identify issuer/PPI of the program.	7020
customerId	Unique value passed in the request will be echoed else unique value generated by the platform if not passed in the request	89342546
accosaTransactionId	Unique id for a particular transaction generated in Prepaid	3591893
beneficiaryId	A unique Beneficiary Id for the beneficiary.	874743484374
accountNumber	conditional with Urn, customer id, customer mobile	43453245642

API error codes

Error Code	Description
00	SUCCESS
1055	MALFORMED_REQUEST
1085	PRODUCT NOT ALLOWED
1052	SYSTEM_ERROR
1032	INVALID_CLIENT_CHANNEL
1081	OPERATION NOT ALLOWED
1080	IP_NOT_ALLOWED
1049	INVALID SECURE CODE
1051	CHECKSUM FAILURE
1093	INVALID CLIENT TXN ID
1320	REQUEST_DATETIME_IS_MANDATORY
1031	INVALID BANK ID
1264	BANK ID NOT PRESENT
1262	CLIENT ID NOT PRESENT
1310	XCONSUMERKEY NOT PRESENT
1030	INVALID MESSAGE
1311	SECURE CODE NOT PRESENT
10080	INVALID BENEFICIARY ID
1361	INVALID ACCOUNT NUMBER

Sample response

Packet sample (Encrypted)

{ 

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

Packet sample (Decrypted)

{ 
    "responseCode": "00", 
    "responseMessage": "SUCCESS", 
    "messageCode": 2031, 
    "clientTxnId": "207458URNACC3722134061", 
    "clientId": "1", ]
    "responseDateTime": "2023/10/10 12:54:39", 
    "bankId": 7020, 
    "beneficiaryId": 51465570 
}