SWIFT::Factory::BasicHeader 0.03

SWIFT::Factory::BasicHeader is a Perl module that provides a Basic Header Block (Block 1) for a SWIFT message.

SYNOPSIS

use SWIFT::Factory::BasicHeader;
my $hdr1=SWIFT::Factory::BasicHeader->new();

This module is primarily intended to be used by the different SWIFT::Factory::MTnnn modules to provide full SWIFT messages for input to the SWIFT network.

Nevertheless, there is nothing prohibiting an application to directly use this module for whatever purpose.

Given reasonable parameter values in the constructor, the string method in this module will return a Basic Header Block (Block nbr 1) that can be used in a SWIFT message sent to the SWIFT network.

CONSTRUCTOR

new( APPLICATION_ID=>F, SERVICE_ID=>1, BIC=>VALIDBIC, TERMINAL=>X, BRANCH_CODE=>XXX, SESSION_NBR=>0, INPUT_SEQUENCE_NBR=>0)

The parameters may be given in arbitrary order. Many parameters have builtin default values. If the calling application doesnt provide the parameter at all, the object will apply the default value.

APPLICATION_ID=>

Optional. A one character value that indicates the application within which the message is being sent.

Valid values are:

F (FIN = All user-to-user, FIN system and FIN system msgs),
A (GPA = Most GPA system mesgs)
and
L (Certain GPA msgs, for ex. LOGIN).

Default value: F, which is the most commonly used application.

To set this value, use one of:

SWIFT::Factory::BasicHeader->APP_ID_FIN,
SWIFT::Factory::BasicHeader->APP_ID_GPA,
and
SWIFT::Factory::BasicHeader->APP_ID_GPA_LOG.

Yes, these are constants, and yes, since they are class methods they are available before calling the constructor.

Opposit of the object methods that are functional only after having called the new() constructor.

SERVICE_ID=>

Optional. A numeric value that identifies the type of data that is being sent. Maximum two characters long. See the relevant SWIFT handbook for details.
Default value: 1, which will output as 01.

BIC=>

Technically optional, but it will probably quite rarely make sense to instantiate an object of this class without specifying a BIC. An eight character value that contains a valid receiver BIC.

TERMINAL=>

Optional. A one character value that identifies the receiving terminal.
Default value: X.

BRANCH_CODE=>

Optional. A three character value that identifies the branch code at the receiver.
Default value: XXX.

SESSION_NBR=>

Optional. A numeric value. Maximum four characters long. See the relevant SWIFT handbook for details.

Default value: 0, which will output as 0000.

INPUT_SEQUENCE_NBR=>

Optional. A numeric value. Maximum six characters long. See the relevant SWIFT handbook for details.

Default value: 0, which will output as 000000.