Adds a new remitter ids
post
/service/remitters
This endpoint is used to add new remittance IDs.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
sourceCode(required): string
Source from which request is initiated
Request Body that contains data required for creating a new remitterids
Nested Schema : RemitterIdServiceRequestDataDTO-allOf[0]
Type:
Show Source
object-
additionalInfo:
string
Additional information provided by corporate for further use
-
ibanReqd:
string
Flag that indicates if IBAN is to be generated or not
-
realCustomerNo(required):
string
Minimum Length:
1Maximum Length:20Customer number for which Remitter list id is maintained -
reconInfo:
string
Reference number provided by corporate for reconciliation purpose
-
remitterId(required):
string
Minimum Length:
1Maximum Length:35Pattern:^[a-zA-Z0-9]+$Identification number of the Remitter which is the second part of the VAI account number -
validityEndDate:
string
Date till which Remitter id will be active
-
validityStartDate:
string
Date from which Remitter id will be active
-
virtualIdentifier(required):
string
Minimum Length:
1Maximum Length:15Virtual Identifier
Response
Supported Media Types
- application/json
- application/xml
- text/csv
201 Response
Returns message of succes or failure
Headers
-
Location: string
URL of newly created remitterids
Root Schema : RemitterIdServiceResponseDtoWrapper
Type:
Show Source
object-
data:
object RemitterIdServiceResponseDataDto
-
messages:
object RemitterIdServiceResponseDto
Nested Schema : RemitterIdServiceResponseDto
Type:
Show Source
object-
codes:
array codes
-
status:
string
Nested Schema : RemitterIdServiceResponseDataDto-allOf[0]
Type:
Show Source
object-
additionalInfo:
string
Additional information provided by corporate for further use
-
authStatus:
string
Authorization Status of Virtual Account
-
checkerDateStamp:
string
Date and Time when some action on Virtual Account is authorized
-
checkerId:
string
Checker ID of Virtual Account
-
ibanAccountNo:
string
IBAN for the Identifier
-
ibanReqd:
string
Flag that indicates if IBAN is to be generated or not
-
identifierAccountNo:
string
Identifier Account which is VirtualIdentifier + remitterId
-
makerDateStamp:
string
Date and Time when Virtual Account is created or modified or closed or reopened
-
makerId:
string
Maker ID of Virtual Account
-
modNo:
integer
Version number of Virtual Account
-
onceAuth:
string
Flag that indicated if Virtual Account is authorized once or not
-
realCustomerNo:
string
Minimum Length:
1Maximum Length:20Customer number for which Remitter list id is maintained -
reconInfo:
string
Reference number provided by corporate for reconciliation purpose
-
recordStatus:
string
Record Status of Virtual Account
-
remitterId:
string
Minimum Length:
1Maximum Length:35Pattern:^[a-zA-Z0-9]+$Identification number of the Remitter which is the second part of the VAI account number -
remitterListId:
string
Minimum Length:
1Maximum Length:35Pattern:^[a-zA-Z0-9]+$Unique identification number to identify Remitter list -
validityEndDate:
string
Date till which Remitter id will be active
-
validityStartDate:
string
Date from which Remitter id will be active
-
virtualIdentifier:
string
Minimum Length:
1Maximum Length:15Virtual Identifier
Nested Schema : RemitterIdServiceResponseCode
Type:
Show Source
object-
Code:
string
-
Desc:
string
-
Language:
string
-
Type:
string
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error