Credit Transfer v1

Creating a Sephpa object

$creditTransferFile = new SephpaCreditTransfer(
    'Name of the initiating party', 
    'A Unique ID of the file',
    SephpaCreditTransfer::SEPA_PAIN_001_001_03
);

Parameters

Parameter	Type	Default	Description	Note
initgPty / Nm	string		Initiating Party / Name
msgId	string		Message Identification
-	int		ISO 20022 XML Message version	Only use the SephpaCreditTransfer::SEPA_PAIN_001_* constants.
orgId	string[]	[]	Organization identifier	It is recommended not to use this. If used, the array must have a at least one of the keys - id (an Identifier of the organization) - bob (A BIC or BEI that identifies the organization).
initgPtyId	string	null	An ID of the initiating party	Only use if you know for what it is for.
$checkAndSanitize	bool	true	Toggles if the inputs are checked for validity.	You can turn this off if you are confident that your inputs are well formed e.g. if you sanitized them before storing them in your database.

Getting a payment collection

$creditTransferCollection = $creditTransferFile->addCollection([
    'pmtInfId' => 'A Unique ID of the collection in this file',
    'dbtr'     => 'Some Debtor Information (Name, Address)',
    'iban'     => 'DE02120300000000202051'
]);

The function addCollection takes an array of key-value-pairs.

Available keys

Key	Type		Default	Description	Note
pmtInfId	string	required		Payment Information Identification
dbtr	string	required		Debtor name
iban	string	required		IBAN
bic	string	depends		BIC	The BIC is only required for version pain.001.002.03 but not for pain.001.001.03 and pain.001.003.03
ccy	string	optional	'EUR'	Currency
btchBookg	string	optional		Batch Booking
ctgyPurp	string	optional
reqdExctnDt	string	optional	today	Requested Execution Date
ultmtDbtr	string	optional		Ultimate Debtor

Adding Payments

$creditTransferCollection->addPayment([
    'pmtId'    => 'A Unique ID of the payment in this collection',
    'instdAmt' => 1.23,
    'cdtr'     => 'Some Creditor Information (Name, Address)',
    'iban'     => 'DE27100777770209299700'
]);

The function addPayment takes an array of key-value-pairs.

Available keys

Key	Type		Description	Note
pmtId	string	required	Payment Identification
instdAmt	float/string	required	Instructed Amount	A string must be able to be interpreted as a float. One is allowed to use both ',' and '.' as decimal point.
iban	string	required	IBAN
cdtr	string	required	Creditor
bic	string	depends	BIC	The BIC is only required for version pain.001.002.03 but not for pain.001.001.03 and pain.001.003.03
ultmtCdtr	string	optional	Ultimate Creditor
ultmtDbtr	string	optional	Ultimate Debtor
ultmtDbtrId	string	optional	Ultimate Debtor Identifier
rmtInf	string	optional	Remittance Information
purp	string	optional	Purpose