Skip to main content
The SepaData interface is the primary input for generating SEPA XML files. It contains all the information needed to create a valid SEPA credit transfer or direct debit XML document.

​
Interface Definition

​
painVersion
PAIN_VERSIONS
The SEPA pain format version to use.Valid values:
  • pain.001.001.02 - Credit Transfer v02
  • pain.001.003.02 - Credit Transfer v02 (alternative)
  • pain.001.001.03 - Credit Transfer v03
  • pain.001.003.03 - Credit Transfer v03 (alternative)
  • pain.008.001.01 - Direct Debit v01
  • pain.008.003.01 - Direct Debit v01 (alternative)
  • pain.008.001.02 - Direct Debit v02
  • pain.008.003.02 - Direct Debit v02 (alternative)
Default: pain.001.001.03
​
xmlVersion
string
The XML version to use in the declaration.Default: 1.0
​
xmlEncoding
string
The XML encoding to use in the declaration.Default: UTF-8
​
xsiNamespace
string
The XSI namespace URL for the XML schema instance.Default: http://www.w3.org/2001/XMLSchema-instance
​
xsiXmls
string
The base URL for the ISO 20022 XML schema.Default: urn:iso:std:iso:20022:tech:xsd:
​
localInstrumentation
LOCAL_INSTRUMENTATION
The local instrument code for direct debit transactions.Valid values:
  • CORE - SEPA Core Direct Debit
  • COR1 - SEPA Core Direct Debit with 1-day lead time
  • B2B - SEPA Business-to-Business Direct Debit
Only applicable for direct debit (pain.008.x) formats.
​
sequenceType
SEQUENCE_TYPE
The sequence type for direct debit transactions.Valid values:
  • FRST - First direct debit in a series
  • RCUR - Recurring direct debit
  • OOFF - One-off direct debit
  • FNAL - Final direct debit in a series
Only applicable for direct debit (pain.008.x) formats.
​
batchBooking
boolean
Whether to use batch booking for all payment information blocks.Default: true
​
id
string
required
The unique message identification for the SEPA XML file.Constraints:
  • Maximum length: 35 characters
  • Must be unique
​
creationDate
Date
required
The date and time when the SEPA XML is created.Will be formatted as ISO 8601 (YYYY-MM-DDThh:mm:ss) in the output XML.
​
initiatorName
string
required
The name of the party initiating the payment.Constraints:
  • Minimum length: 1 character
  • Maximum length: 70 characters
​
positions
CreditorPayments[]
required
An array of creditor payment information blocks. Each position represents a group of payments from/to a single creditor/debtor account.See CreditorPayments for the structure of each position.

​
Example

import { createSepaXML } from 'sepa-js-xml';
import dayjs from 'dayjs';

const sepaData = {
  painVersion: 'pain.001.001.03',
  id: 'Test1345',
  creationDate: dayjs.utc('2022-06-16').toDate(),
  initiatorName: 'Test Company',
  positions: [
    {
      id: 'Test123',
      batchBooking: false,
      iban: 'DE02701500000000594937',
      bic: 'SSKMDEMM',
      requestedExecutionDate: dayjs.utc('2022-06-16').toDate(),
      name: 'Pos 1',
      payments: [
        {
          id: '123',
          amount: 230,
          currency: 'EUR',
          name: 'Money Company',
          iban: 'DE02701500000000594937',
          bic: 'SSKMDEMM',
          remittanceInformation: 'Money please',
          end2endReference: 'lol',
        },
      ],
    },
  ],
};

const xml = createSepaXML(sepaData);

CreditorPayments

Payment information block structure

Payment

Individual payment transaction details

Options

XML generation options

Build docs developers (and LLMs) love

Get started for freeTalk to us