Volante API Service

200

OK

SubscriptionInfo

404

Not Found

ErrorResponse

500

Internal Server Error

ErrorResponse

Body

message
required

Message data in JSON format to convert to native format.

string

Query

format
required

Format of the input message. Example: SWIFT

Get accepted values by calling /v2/construct/catalog

string

Query

version
required

Version of the input message. Example: SRG 2021

Get accepted values by calling /v2/construct/catalog

string

Query

name
required

Name of the input message. Example: MT103

Get accepted values by calling /v2/construct/catalog

string

Query

validations
optional

Validation nodes which needs to be executed. Value should be in a CSV format. Example: Default,Validation1

Get supported validations from /v2/construct/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the parsed message object will not be validated.

string

Query

constructorOptions
optional

Option to include comma separated key value pair to control the message construction process. Key and Value are case-sensitive.

Pattern : <key:value>,<key:value>

Example : ext-name:VAPI

The constructorOptions listed below are supported as global level (for all constructors, irrespective of formats) options to control construction results.

1) suppressErrors

The suppressErrors option allows users to define the errors that should be ignored during message construction process. Users can specify multiple error codes as comma-separated values (CSV) and enclose the key-value pair within double quotes.

In some instances, multiple error codes could be present in a single error. VAPI treats each error code individually.

If any one of the multiple error codes from the exception is specified by the user, VAPI will suppress that exception.

The order in which the user provides the error codes to be suppressed does not matter.

If multiple errors contain the same error codes, and the user provides that error code, all those errors will be suppressed.

Syntax: “suppressErrors:${errorCodes}”

Example: “suppressErrors:M50,XML125”

2) ext-name

The ext-name option allows users to define the client extension name to call the configured Pre/Post Hook flows in the "message-info-ext.json". Users must pass this ext-name option to customize and override the default behavior of the standard constructors available in VAPI using Pre/Post hook flows.

Syntax: ext-name:Name of the client like 'GS'

Example: ext-name:GS

3) includeAdditionalErrorFields

Option to include additional fields in the error section of the VAPI response - fieldName and fieldValue.

Case 1: includeAdditionalErrorFields == false OR includeAdditionalErrorFields not specified in mappingOptions

By default, only the fieldId will be generated, if available. In this case, fieldName and fieldValue will not be included in the response.

Case 2: includeAdditionalErrorFields == true

Along with fieldId, fieldName and fieldValue will also be generated, if available, making it easier for users to identify the field associated with the error.

fieldId: Field id that uniquely identifies the field. This is the qualified name with indexes for repeatable sections included.

fieldName: Field name that uniquely identifies the field, excluding specific instances of repeatable sections. This is the qualified name without indexes, indicating the field’s location without specifying its occurrence in repeatable sections.

fieldValue: The value assigned to the field.

Note: These are optional fields. They will only be included in the response if the exception contains this information. This updated error response structure is supported in both REST and JAVA APIs.

Syntax: includeAdditionalErrorFields:true/false

Example: includeAdditionalErrorFields:true

string

200

OK

ConstructorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

500

Internal Server Error

ErrorResponse

200

OK

ConstructorCatalogResponse

401

Unauthorized

ErrorResponse

404

Not found

No Content

Query

format
required

Format of the input message. Example: SWIFT

Get accepted values by calling /v2/construct/catalog

string

Query

version
required

Version of the input message. Example: SRG 2021

Get accepted values by calling /v2/construct/catalog

string

Query

name
required

Name of the input message. Example: MT103

Get accepted values by calling /v2/construct/catalog

string

200

OK

string

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

404

Not found

No Content

500

Internal Server Error

ErrorResponse

200

OK

string

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

404

Not found

No Content

500

Internal Server Error

ErrorResponse

200

OK

CreatorCatalogResponse

401

Unauthorized

ErrorResponse

404

Not found

No Content

Body

message
required

Clearing specific input message.

string

Query

sourceFormat
required

Format of the source message. Example: CBPR+

Get accepted values by calling /v2/creator/catalog

string

Query

sourceVersion
required

Version of the source message. Example: 2.1

Get accepted values by calling /v2/creator/catalog

string

Query

sourceName
optional

Name of the source message. Example: pacs.008.001.08. This is an optional request parameter. It will be automatically identified based on the input message, if the sourceName is not specified.

Get accepted values by calling /v2/creator/catalog

string

Query

sourceValidations
optional

Validation nodes which needs to be executed for source message. Value should be in a CSV format. Example: Default,Validation1

Get supported validations from /v2/creator/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the parsed source message object will not be validated.

string

Query

targetVersion
optional

Version of the target message. This is an optional request parameter. If targetVersion is not specified, the default value will be set to '1.0'. Example: 1.0

string

Query

targetName
optional

Name of the Volante Standard message. Example: BankToCustomerDebitCreditNotification. This is an optional request parameter. It will be automatically identified based on the input message, if the targetName is not specified.

Get accepted values by calling /v2/creator/catalog

string

Query

targetValidations
optional

Validation nodes which needs to be executed for target message. Value should be in a CSV format. Example : Default,Validation1

Get supported validations from /v2/creator/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the target message object will not be validated.

string

Query

cascadeError
optional

It supports Boolean value. Default value for cascadeError is false (not present or null).

cascadeError value applies to the legs like Source leg(Parse and Validation of Source Message), Mapping leg(Transformation of Source message to Target message), and Target leg(Validation and Serialization of Target message). Within a leg, errors will always be cascaded.

If the cascadeError is set to true, then the subsequent legs will be executed even if there are any errors in the current leg. Otherwise, execution will be stopped at the current leg itself.

If all the errors are of Warn severity in the current leg, then the subsequent legs will be executed irrespective of the cascadeError value.

Irrespective of the cascadeError value, the execution will stop at the mapping leg, only if any mapping exceptions occurred with severity ERROR or Higher. Reason : In case of mapping errors the target object will be partially constructed and hence proceeding to the next step is not viable.

boolean

Query

payloadEncoding
optional

Encoding type of the input and output message. This is an optional field. Accepted Values are: Base64

Note: In case of unsupported value, input is treated as plain text.

string

Query

includePayload
optional

Option to include the parsed message as JSON in the response. Accepted Values are: Always, Never and OnError. Default value is Never.

Note: Default value will be used, if this parameter is not present.

string

Query

mappingOptions
optional

Option to include comma separated key value pair to control the creator result. Key and Value are case-sensitive.

Pattern : <key:value>,<key:value>

Example : ApplicationMode:I,MessagePriority:U

The mappingOptions listed below are supported as global level (for all creators, irrespective of formats) options to control creation results. Additionally, more number of mappingOptions are supported at the transformation level. For example, a mappingOption ApplicationMode:I is supported only in CBPR+ to SWIFT transformation. Refer to VAPI readme document for more information.

1) minifyOutput

Option to minify the transformed output by controlling the line separators and indentation (tabs). It will work only if the transformed output is of XML or JSON format.

Allowed Values: true/false

Case1: minifyOutput == true

No LineFeed and Tab (\n and \t) characters will be present in the transformed output.

Case2: minifyOutput == false OR mappingOptions == null OR minifyOutput not specified in mappingOptions.

Line Separator (\n) will be present in the transformed output.

Syntax: minifyOutput:true/false

Example: minifyOutput: true

2) suppressErrors

The suppressErrors option allows users to define the errors that should be ignored during message transformation process. Users can specify multiple error codes as comma-separated values (CSV) and enclose the key-value pair within double quotes.

In some instances, multiple error codes could be present in a single error. VAPI treats each error code individually.

If any one of the multiple error codes from the exception is specified by the user, VAPI will suppress that exception.

The order in which the user provides the error codes to be suppressed does not matter.

If multiple errors contain the same error codes, and the user provides that error code, all those errors will be suppressed.

Syntax: “suppressErrors:${errorCodes}”

Example: “suppressErrors:M50,XML125”

3) includeTruncationInfo

Option to include the data loss or truncation information along with truncation indicator, which specifies whether truncation occurred during the mapping, in the output. During ISO to MT translations data loss or truncation may occur, and to enforce VAPI to capture that information, users must pass this key-value pair.

Allowed Values: true/false

Case1: includeTruncationInfo == true

Data loss or truncation information will be captured in the transformation result.

And, the transformation result will include the truncationIndicator flag, which is set to either true or false.

Case2: includeTruncationInfo == false OR mappingOptions == null OR includeTruncationInfo not specified in mappingOptions.

Data loss or truncation information won’t be captured in the transformation result.

And, the transformation result will not include the truncationIndicator flag.

Note: This is a beta release for truncationInfo and currently it is available for some mappings such as CBPR+ -> SWIFT transformation, version SRG 2022 onwards.

Syntax: includeTruncationInfo:true/false

Example: includeTruncationInfo:true

4) ext-name

The ext-name option allows users to define the client extension name to call the configured Pre/Post Hook flows in the "mapping-info-ext.json". Users must pass this ext-name option to customize and override the default behavior of the standard mappings available in VAPI using Pre/Post hook flows.

Syntax: ext-name:Name of the client like 'GS'

Example: ext-name:GS

5) input.format

In case of Creator Outbound service, when the input is Volante Standard format, it can be parsed in both JSON and XML formats. By default, VAPI Creator parses/accepts the input Volante Standard message in JSON format. However, if the user has XML input, an additional input parameter needs to be passed through the mappingOption to enforce VAPI to parse the VS message in XML format.

Syntax: input.format:XML/JSON

Example: input.format:XML

6) output.format

In case of Creator Inbound service, when the output is Volante Standard format, it can be serialized in both JSON and XML formats. By default, VAPI Creator serializes/generates the output Volante Standard message in JSON format. However, if the user wants XML output, an additional input parameter needs to be passed through the mappingOption to enforce VAPI to serialize the VS message in XML format.

Syntax: output.format:XML/JSON

Example: output.format:XML

7) includeAdditionalErrorFields

Option to include additional fields in the error section of the VAPI response - fieldName and fieldValue.

Case 1: includeAdditionalErrorFields == false OR includeAdditionalErrorFields not specified in mappingOptions

By default, only the fieldId will be generated, if available. In this case, fieldName and fieldValue will not be included in the response.

Case 2: includeAdditionalErrorFields == true

Along with fieldId, fieldName and fieldValue will also be generated, if available, making it easier for users to identify the field associated with the error.

fieldId: Field id that uniquely identifies the field. This is the qualified name with indexes for repeatable sections included.

fieldName: Field name that uniquely identifies the field, excluding specific instances of repeatable sections. This is the qualified name without indexes, indicating the field’s location without specifying its occurrence in repeatable sections.

fieldValue: The value assigned to the field.

Note: These are optional fields. They will only be included in the response if the exception contains this information. This updated error response structure is supported in both REST and JAVA APIs.

Syntax: includeAdditionalErrorFields:true/false

Example: includeAdditionalErrorFields:true

string

200

OK

CreatorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

500

Internal Server Error

ErrorResponse

Body

message
required

Volante Standard input message.

string

Query

sourceVersion
optional

Version of the source message. This is an optional request parameter. If sourceVersion is not specified, the default value will be set to '1.0'. Example: 1.0

string

Query

sourceName
optional

Name of the Volante Standard message. Example: BankToCustomerDebitCreditNotification. This is an optional request parameter. It will be automatically identified based on the input message, if the sourceName is not specified.

Get accepted values by calling /v2/creator/catalog

string

Query

sourceValidations
optional

Validation nodes which needs to be executed for source message. Value should be in a CSV format. Example: Default,Validation1

Get supported validations from /v2/creator/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the parsed source message object will not be validated.

string

Query

targetFormat
required

Format of the target message. Example: CBPR+

Get accepted values by calling /v2/creator/catalog

string

Query

targetVersion
required

Version of the target message. Example: 2.0

Get accepted values by calling /v2/creator/catalog

string

Query

targetName
optional

Name of the target message. Example: pacs.008.001.08. This is an optional request parameter. It will be automatically identified based on the input message, if the targetName is not specified.

Get accepted values by calling /v2/creator/catalog

string

Query

targetValidations
optional

Validation nodes which needs to be executed for target message. Value should be in a CSV format. Example : Default,Validation1

Get supported validations from /v2/creator/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the target message object will not be validated.

string

Query

cascadeError
optional

It supports Boolean value. Default value for cascadeError is false (not present or null).

cascadeError value applies to the legs like Source leg(Parse and Validation of Source Message), Mapping leg(Transformation of Source message to Target message), and Target leg(Validation and Serialization of Target message). Within a leg, errors will always be cascaded.

If the cascadeError is set to true, then the subsequent legs will be executed even if there are any errors in the current leg. Otherwise, execution will be stopped at the current leg itself.

If all the errors are of Warn severity in the current leg, then the subsequent legs will be executed irrespective of the cascadeError value.

Irrespective of the cascadeError value, the execution will stop at the mapping leg, only if any mapping exceptions occurred with severity ERROR or Higher. Reason : In case of mapping errors the target object will be partially constructed and hence proceeding to the next step is not viable.

boolean

Query

payloadEncoding
optional

Encoding type of the input and output message. This is an optional field. Accepted Values are: Base64

Note: In case of unsupported value, input is treated as plain text.

string

Query

includePayload
optional

Option to include the parsed message as JSON in the response. Accepted Values are: Always, Never and OnError. Default value is Never.

Note: Default value will be used, if this parameter is not present.

string

Query

mappingOptions
optional

Option to include comma separated key value pair to control the creator result. Key and Value are case-sensitive.

Pattern : <key:value>,<key:value>

Example : ApplicationMode:I,MessagePriority:U

The mappingOptions listed below are supported as global level (for all creators, irrespective of formats) options to control creation results. Additionally, more number of mappingOptions are supported at the transformation level. For example, a mappingOption ApplicationMode:I is supported only in CBPR+ to SWIFT transformation. Refer to VAPI readme document for more information.

1) minifyOutput

Option to minify the transformed output by controlling the line separators and indentation (tabs). It will work only if the transformed output is of XML or JSON format.

Allowed Values: true/false

Case1: minifyOutput == true

No LineFeed and Tab (\n and \t) characters will be present in the transformed output.

Case2: minifyOutput == false OR mappingOptions == null OR minifyOutput not specified in mappingOptions.

Line Separator (\n) will be present in the transformed output.

Syntax: minifyOutput:true/false

Example: minifyOutput: true

2) suppressErrors

The suppressErrors option allows users to define the errors that should be ignored during message transformation process. Users can specify multiple error codes as comma-separated values (CSV) and enclose the key-value pair within double quotes.

In some instances, multiple error codes could be present in a single error. VAPI treats each error code individually.

If any one of the multiple error codes from the exception is specified by the user, VAPI will suppress that exception.

The order in which the user provides the error codes to be suppressed does not matter.

If multiple errors contain the same error codes, and the user provides that error code, all those errors will be suppressed.

Syntax: “suppressErrors:${errorCodes}”

Example: “suppressErrors:M50,XML125”

3) includeTruncationInfo

Option to include the data loss or truncation information along with truncation indicator, which specifies whether truncation occurred during the mapping, in the output. During ISO to MT translations data loss or truncation may occur, and to enforce VAPI to capture that information, users must pass this key-value pair.

Allowed Values: true/false

Case1: includeTruncationInfo == true

Data loss or truncation information will be captured in the transformation result.

And, the transformation result will include the truncationIndicator flag, which is set to either true or false.

Case2: includeTruncationInfo == false OR mappingOptions == null OR includeTruncationInfo not specified in mappingOptions.

Data loss or truncation information won’t be captured in the transformation result.

And, the transformation result will not include the truncationIndicator flag.

Note: This is a beta release for truncationInfo and currently it is available for some mappings such as CBPR+ -> SWIFT transformation, version SRG 2022 onwards.

Syntax: includeTruncationInfo:true/false

Example: includeTruncationInfo:true

4) ext-name

The ext-name option allows users to define the client extension name to call the configured Pre/Post Hook flows in the "mapping-info-ext.json". Users must pass this ext-name option to customize and override the default behavior of the standard mappings available in VAPI using Pre/Post hook flows.

Syntax: ext-name:Name of the client like 'GS'

Example: ext-name:GS

5) input.format

In case of Creator Outbound service, when the input is Volante Standard format, it can be parsed in both JSON and XML formats. By default, VAPI Creator parses/accepts the input Volante Standard message in JSON format. However, if the user has XML input, an additional input parameter needs to be passed through the mappingOption to enforce VAPI to parse the VS message in XML format.

Syntax: input.format:XML/JSON

Example: input.format:XML

6) output.format

In case of Creator Inbound service, when the output is Volante Standard format, it can be serialized in both JSON and XML formats. By default, VAPI Creator serializes/generates the output Volante Standard message in JSON format. However, if the user wants XML output, an additional input parameter needs to be passed through the mappingOption to enforce VAPI to serialize the VS message in XML format.

Syntax: output.format:XML/JSON

Example: output.format:XML

7) includeAdditionalErrorFields

Option to include additional fields in the error section of the VAPI response - fieldName and fieldValue.

Case 1: includeAdditionalErrorFields == false OR includeAdditionalErrorFields not specified in mappingOptions

By default, only the fieldId will be generated, if available. In this case, fieldName and fieldValue will not be included in the response.

Case 2: includeAdditionalErrorFields == true

Along with fieldId, fieldName and fieldValue will also be generated, if available, making it easier for users to identify the field associated with the error.

fieldId: Field id that uniquely identifies the field. This is the qualified name with indexes for repeatable sections included.

fieldName: Field name that uniquely identifies the field, excluding specific instances of repeatable sections. This is the qualified name without indexes, indicating the field’s location without specifying its occurrence in repeatable sections.

fieldValue: The value assigned to the field.

Note: These are optional fields. They will only be included in the response if the exception contains this information. This updated error response structure is supported in both REST and JAVA APIs.

Syntax: includeAdditionalErrorFields:true/false

Example: includeAdditionalErrorFields:true

string

200

OK

CreatorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

500

Internal Server Error

ErrorResponse

Body

transformerRequest
required

JSON Example: { "message":"ezE6RjAxVEVTVEdCV", "sourceFormat":"SWIFT", "sourceVersion":"SRG 2020", "sourceName":"MT103", "sourceValidations":"Default", "targetFormat":"CBPR+", "targetVersion":"1.0", "targetName":"pacs.008.001.08", "targetValidations":"Default", "cascadeError":"true", "payloadEncoding":"Base64", "includePayload":"Always", "mappingOptions":"ApplicationMode:I" }

XML Example: <TransformerRequest> <message><![CDATA[ezE6RjAxVEVTVEdCV]]></message> <sourceFormat>SWIFT</sourceFormat> <sourceVersion>SRG 2021</sourceVersion> <sourceName>MT103</sourceName> <sourceValidations>Default</sourceValidations> <targetFormat>CBPR+</targetFormat> <targetVersion>1.0</targetVersion> <targetName>pacs.008.001.08</targetName> <targetValidations>Default</targetValidations> <cascadeError>true</cascadeError> <payloadEncoding>Base64</payloadEncoding> <includePayload>Always</includePayload> <mappingOptions>ApplicationMode:I</mappingOptions> </TransformerRequest>

Values for the above parameters can be obtained from /v2/transformer/catalog endpoint.

TransformerRequest

200

OK

TransformerResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

500

Internal Server Error

ErrorResponse

200

OK

TransformerCatalogResponse

401

Unauthorized

ErrorResponse

404

Not found

No Content

Body

message
required

Message to be transformed.

string

Query

sourceFormat
required

Format of the source message. Example: SWIFT

Get accepted values by calling /v2/transformer/catalog

string

Query

sourceVersion
required

Version of the source message. Example: SRG 2021

Get accepted values by calling /v2/transformer/catalog

string

Query

sourceName
optional

Name of the source message. Example: MT103. This is an optional request parameter. It will be automatically identified based on the input message, if the sourceName is not specified.

Get accepted values by calling /v2/transformer/catalog

string

Query

sourceValidations
optional

Validation nodes which needs to be executed for source message. Value should be in a CSV format. Example: Default,Validation1

Get supported validations from /v2/transformer/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the parsed source message object will not be validated.

string

Query

targetFormat
required

Format of the target message. Example: CBPR+

Get accepted values by calling /v2/transformer/catalog

string

Query

targetVersion
required

Version of the target message. Example: 2.1

Get accepted values by calling /v2/transformer/catalog

string

Query

targetName
optional

Name of the target message. Example: pacs.008.001.08. This is an optional request parameter. It will be automatically identified based on the input message, if the targetName is not specified.

Get accepted values by calling /v2/transformer/catalog

string

Query

targetValidations
optional

Validation nodes which needs to be executed for target message. Value should be in a CSV format. Example: Default,Validation1

Get supported validations from /v2/transformer/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the target message object will not be validated.

string

Query

cascadeError
optional

It supports Boolean value. Default value for cascadeError is false (not present or null).

cascadeError value applies to the legs like Source leg(Parse and Validation of Source Message), Mapping leg(Transformation of Source message to Target message), and Target leg(Validation and Serialization of Target message). Within a leg, errors will always be cascaded.

If the cascadeError is set to true, then the subsequent legs will be executed even if there are any errors in the current leg. Otherwise, execution will be stopped at the current leg itself.

If all the errors are of Warn severity in the current leg, then the subsequent legs will be executed irrespective of the cascadeError value.

Irrespective of the cascadeError value, the execution will stop at the mapping leg, only if any mapping exceptions occurred with severity ERROR or Higher. Reason : In case of mapping errors the target object will be partially constructed and hence proceeding to the next step is not viable.

boolean

Query

payloadEncoding
optional

Encoding type of the input parameters message, originalMessageValue and transformed output message. This is an optional field. Accepted Values are: Base64

Note: In case of unsupported value, input is treated as plain text.

string

Query

includePayload
optional

Option to include the parsed message as JSON in the response. Accepted Values are: Always, Never and OnError. Default value is Never.

Note: Default value will be used, if this parameter is not present.

string

Query

mappingOptions
optional

Option to include comma separated key value pair to control the transformation. Key and Value are case-sensitive.

Pattern : <key:value>,<key:value>

Example : ApplicationMode:I,MessagePriority:U

The mappingOptions listed below are supported as global level (for all transformers, irrespective of formats) options to control transformation results. Additionally, more number of mappingOptions are supported at the transformation level. For example, a mappingOption ApplicationMode:I is supported only in CBPR+ to SWIFT transformation. Refer to VAPI readme document for more information.

1) minifyOutput

Option to minify the transformed output by controlling the line separators and indentation (tabs). It will work only if the transformed output is of XML or JSON format.

Allowed Values: true/false

Case1: minifyOutput == true

No LineFeed and Tab (\n and \t) characters will be present in the transformed output.

Case2: minifyOutput == false OR mappingOptions == null OR minifyOutput not specified in mappingOptions.

Line Separator (\n) will be present in the transformed output.

Syntax: minifyOutput:true/false

Example: minifyOutput: true

2) ORGNLMSGNAME

Some of the mappings require original or correlation message details along with the actual message. The allowed values for originalMessageName will vary for every transformation. Refer respective mapping spec to know more about allowed values. Ex: Original message details are required in case of COV Return Message transformations.

Note: ORGNLMSGNAME and ORGNLMSGVALUE must be present together.

Syntax: ORGNLMSGNAME:Messgae_Name

Example: ORGNLMSGNAME:MT103

3) ORGNLMSGVALUE

Some of the mappings require original or correlation message details along with the actual message. This option allows users to specify the original message value for the respective original message.

Note: ORGNLMSGNAME and ORGNLMSGVALUE must be present together.

Syntax: ORGNLMSGVALUE:Message_Sample

4) suppressErrors

The suppressErrors option allows users to define the errors that should be ignored during message transformation process. Users can specify multiple error codes as comma-separated values (CSV) and enclose the key-value pair within double quotes.

In some instances, multiple error codes could be present in a single error. VAPI treats each error code individually.

If any one of the multiple error codes from the exception is specified by the user, VAPI will suppress that exception.

The order in which the user provides the error codes to be suppressed does not matter.

If multiple errors contain the same error codes, and the user provides that error code, all those errors will be suppressed.

Syntax: "suppressErrors:${errorCodes}"

Example: "suppressErrors:M50,XML125"

5) includeTruncationInfo

Option to include the data loss or truncation information along with truncation indicator, which specifies whether truncation occurred during the mapping, in the output. During ISO to MT translations data loss or truncation may occur, and to enforce VAPI to capture that information, users must pass this key-value pair.

Allowed Values: true/false

Case1: includeTruncationInfo == true

Data loss or truncation information will be captured in the transformation result.

And, the transformation result will include the truncationIndicator flag, which is set to either true or false.

Case2: includeTruncationInfo == false OR mappingOptions == null OR includeTruncationInfo not specified in mappingOptions.

Data loss or truncation information won’t be captured in the transformation result.

And, the transformation result will not include the truncationIndicator flag.

Note: This is a beta release for truncationInfo and currently it is available for some mappings such as CBPR+ -> SWIFT transformation, version SRG 2022 onwards.

Syntax: includeTruncationInfo:true/false

Example: includeTruncationInfo:true

6) ext-name

The ext-name option allows users to define the client extension name to call the configured Pre/Post Hook flows in the "mapping-info-ext.json". Users must pass this ext-name option to customize and override the default behavior of the standard mappings available in VAPI using Pre/Post hook flows.

Syntax: ext-name:Name of the client like 'GS'

Example: ext-name:GS

7) includeAdditionalErrorFields

Option to include additional fields in the error section of the VAPI response - fieldName and fieldValue.

Case 1: includeAdditionalErrorFields == false OR includeAdditionalErrorFields not specified in mappingOptions

By default, only the fieldId will be generated, if available. In this case, fieldName and fieldValue will not be included in the response.

Case 2: includeAdditionalErrorFields == true

Along with fieldId, fieldName and fieldValue will also be generated, if available, making it easier for users to identify the field associated with the error.

fieldId: Field id that uniquely identifies the field. This is the qualified name with indexes for repeatable sections included.

fieldName: Field name that uniquely identifies the field, excluding specific instances of repeatable sections. This is the qualified name without indexes, indicating the field’s location without specifying its occurrence in repeatable sections.

fieldValue: The value assigned to the field.

Note: These are optional fields. They will only be included in the response if the exception contains this information. This updated error response structure is supported in both REST and JAVA APIs.

Syntax: includeAdditionalErrorFields:true/false

Example: includeAdditionalErrorFields:true

string

Header

originalMessageName
optional

Name of the original message. Example: MT202COV

To handle COV Return messages, transformer service requires original or correlation message details.

The allowed values for originalMessageName will vary for every transformation. Refer respective mapping spec to know more about allowed values.

This input is only required in case of COV Return Message transformations.

Note: originalMessageName & originalMessageValue must be present together.

string

Header

originalMessageValue
optional

Original message value.

To handle COV Return messages, transformer service requires original or correlation message details.

This option allows users to specify the original message value for COV Return message transformation.

If payloadEncoding is set to Base64, then originalMessageValue needs to be in Base64 format.

Note: originalMessageName & originalMessageValue must be present together.

string

200

OK

TransformerResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

500

Internal Server Error

ErrorResponse

Body

ValidatorRequest
required

JSON Example: { "message": "ezE6RjAxVEVTVEdCV", "format": "SWIFT", "version": "SRG 2021", "name": "MT103", "validations": "Default", "payloadEncoding": "Base64", "includePayload": "Always", "validatorOptions": "key:value" }

XML Example: <ValidatorRequest> <message><![CDATA[ezE6RjAxVEVTVEdCV]]></message> <format>SWIFT</format> <version>SRG 2021</version> <name>MT103</name> <validations>Default</validations> <payloadEncoding>Base64</payloadEncoding> <includePayload>Always</includePayload> <validatorOptions>key:value</validatorOptions> </ValidatorRequest>

Values for the above parameters can be obtained from /v2/validator/catalog endpoint.

ValidatorRequest

200

OK

ValidatorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

500

Internal Server Error

ErrorResponse

200

OK

ValidatorCatalogResponse

401

Unauthorized

ErrorResponse

404

Not found

No Content

Body

message
required

Message to be validated.

string

Query

format
required

Format of the input message. Example: SWIFT

Get accepted values by calling /v2/validator/catalog

string

Query

version
required

Version of the input message. Example: SRG 2021

Get accepted values by calling /v2/validator/catalog

string

Query

name
required

Name of the input message. Example: MT103

Get accepted values by calling /v2/validator/catalog

string

Query

validations
optional

Validation nodes which needs to be executed. Value should be in a CSV format. Example: Default,Validation1

Get supported validations from /v2/validator/catalog

Note: If not present or value is null, the Default Validation node will be executed. If the value is empty String, then the parsed message object will not be validated.

string

Query

payloadEncoding
optional

Encoding type of the input message. This is an optional field. Accepted Values are: Base64

Note: In case of unsupported value, input is treated as plain text.

string

Query

includePayload
optional

Option to include the parsed message as JSON in the response. Accepted Values are: Always, Never and OnError. Default value is Never.

Note: Default value will be used, if this parameter is not present.

string

Query

validatorOptions
optional

Option to include comma separated key value pair to control the validation process. Key and Value are case-sensitive.

Pattern : <key:value>,<key:value>

Example : appHdrMandatory:true

The validatorOptions listed below are supported as global level (for all validators, irrespective of formats) options to control validation results.

1) appHdrMandatory

Option to make the AppHdr mandatory in case the user wishes to validate CBPR+ format messages.

Allowed Values: true/false

Case1: appHdrMandatory== true

appHdr must me available in the input message otherwise exception will be thrown as part of validation result.

Case2: appHdrMandatory == false OR validatorOptions == null OR appHdrMandatory not specified in validatorOptions.

appHdr is optional in the input message. No exception will be thrown if the input message doesn’t contain AppHdr.

Note: The appHdrMandatory property should not be set to true when validating the CBPR+ head.001.001.02 message because the entire input serves as the Payload for this message.

Syntax: appHdrMandatory:true/false

Example: appHdrMandatory:true.

2) suppressErrors

The suppressErrors option allows users to define the errors that should be ignored during message validation process. Users can specify multiple error codes as comma-separated values (CSV) and enclose the key-value pair within double quotes.

In some instances, multiple error codes could be present in a single error. VAPI treats each error code individually.

If any one of the multiple error codes from the exception is specified by the user, VAPI will suppress that exception.

The order in which the user provides the error codes to be suppressed does not matter.

If multiple errors contain the same error codes, and the user provides that error code, all those errors will be suppressed.

Syntax: "suppressErrors:${errorCodes}"

Example: "suppressErrors:M50,XML125"

3) ext-name

The ext-name option allows users to define the client extension name to call the configured Pre/Post Hook flows in the "message-info-ext.json". Users must pass this ext-name option to customize and override the default behavior of the standard validators available in VAPI using Pre/Post hook flows.

Syntax: ext-name:Name of the client like 'GS'

Example: ext-name:GS

4) includeAdditionalErrorFields

Option to include additional fields in the error section of the VAPI response - fieldName and fieldValue.

Case 1: includeAdditionalErrorFields == false OR includeAdditionalErrorFields not specified in mappingOptions

By default, only the fieldId will be generated, if available. In this case, fieldName and fieldValue will not be included in the response.

Case 2: includeAdditionalErrorFields == true

Along with fieldId, fieldName and fieldValue will also be generated, if available, making it easier for users to identify the field associated with the error.

fieldId: Field id that uniquely identifies the field. This is the qualified name with indexes for repeatable sections included.

fieldName: Field name that uniquely identifies the field, excluding specific instances of repeatable sections. This is the qualified name without indexes, indicating the field’s location without specifying its occurrence in repeatable sections.

fieldValue: The value assigned to the field.

Note: These are optional fields. They will only be included in the response if the exception contains this information. This updated error response structure is supported in both REST and JAVA APIs.

Syntax: includeAdditionalErrorFields:true/false

Example: includeAdditionalErrorFields:true

string

200

OK

ValidatorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

500

Internal Server Error

ErrorResponse