11. Payment Products and Models

  • Updated
Follow
  • General information
  • Single payments
    • sepa-credit-transfers
    • instant-sepa-credit-transfers
    • target-2-payments
    • cross-border-credit-transfers
  • Recurrent paymentsendToEndIdentification
    • sepa-credit-transfers
    • instant-sepa-credit-transfers
    • target-2-payments
    • cross-border-credit-transfers

 

General informationType

The Berlin Group standard defines 4 mandatory payment products to be supported

  1. sepa-credit-transfers
  2. instant-sepa-credit-transfers
  3. target-2-payments
  4. cross-boData Elementrder-credit-transfers

Through XS2A you can initiate single and recurrent payments with all 4 products. Each payment product requires its own payment model.

Important: you must declare the model with the element "@type" in the payload during payment initiation.

 

Single payments

You can work with single payments through /payments endpoints.

 

sepa-credit-transfers

model = PaymentInitiationSctJson

11-1.png

Data Element Type Presence Comment
endToEndIdentification Max35Text optional  
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
remittanceInformationUnstructured Max140Text optional  
 
Example
{"@type": "PaymentInitiationSctJson",
"endToEndIdentification": "STC20190228001293",
"debtorAccount" : {"iban": "DE54500105173424724776"},
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorAgent": "MOEALUL1XXX",
"creditorName": "creditor_name"}
 
 
 

 

instant-sepa-credit-transfers

model = PaymentInitiationSctInstJson

11-1.png

Data Element Type Presence Comment
endToEndIdentification Max35Text optional  
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
remittanceInformationUnstructured Max140Text optional  
 
Example
{"@type": "PaymentInitiationSctInstJson",
"debtorAccount" : {"iban": "DE54500105173424724776"},
 
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorName": "creditor_name"}
 
 

 

target-2-payments

model = PaymentInitiationTarget2Json

11-2.png

Data Element Type Presence Comment
endToEndIdentification Max35Text optional  
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
chargeBearer Charge Bearer optional  
remittanceInformationUnstructured Max140Text optional  

 

Example
{"@type": "PaymentInitiationTarget2Json",
"endToEndIdentification": "STC20190228001293",
"debtorAccount" : {"iban": "DE54500105173424724776"},
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorAgent": "MOEALUL1XXX",
"creditorName": "creditor_name",
"chargeBearer": "SLEV",
"remittanceInformationUnstructured": "Some specific payment details to be given here"}
 

 

cross-border-credit-transfers

model = PaymentInitiationCrossBorderJson

11-3.png

Data Element Type Presence Comment
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
chargeBearer Charge Bearer optional  
remittanceInformationUnstructured Max140Text optional  
 

Example
{"@type": "PaymentInitiationCrossBorderJson",
"debtorAccount" : {"iban": "DE54500105173424724776"},
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorAgent": "MOEALUL1XXX",
"creditorName": "creditor_name",
"chargeBearer": "SLEV",
"remittanceInformationUnstructured": "Some specific payment details to be given here"}
 
 

 

Recurrent payments

You can work with recurrent payments through /periodic-payments endpoints.

 

sepa-credit-transfers

model = PeriodicPaymentInitiationSctJson

11-4.png

Data Element Type Presence Comment
startDate ISODate mandatory  
executionRule string optional

Permitted values:

  • "following"
  • "preceeding"
endDate ISODate optional If not given, it is an infinite standing order.
frequency Frequency Code mandatory

Permitted values:

  • Daily
  • Weekly
  • EveryTwoWeeks
  • Monthly
  • EveryTwoMonths
  • Quarterly
  • SemiAnnual
  • Annual
dayOfExecution Max2Text conditional

This string consists of up two characters.

Leading zeroes are not allowed.
endToEndIdentification Max35Text optional  
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
remittanceInformationUnstructured Max140Text optional  
 
 

 

Example
{"@type": "PeriodicPaymentInitiationSctJson",
"endToEndIdentification": "STC20190228001293",
"debtorAccount" : {"iban": "DE54500105173424724776"},
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorAgent": "MOEALUL1XXX",
"creditorName": "creditor_name",
"startDate": "2019-01-31",
"executionRule": "following",
"frequency": "Monthly",
"dayOfExecution": "1"}

 

instant-sepa-credit-transfers

model = PeriodicPaymentInitiationSctInstJson

11-4.png

Data Element Type Presence Comment
startDate ISODate mandatory  
executionRule string optional

Permitted values:

  • "following"
  • "preceeding"
endDate ISODate optional If not given, it is an infinite standing order.
frequency Frequency Code mandatory

Permitted values:

  • Daily
  • Weekly
  • EveryTwoWeeks
  • Monthly
  • EveryTwoMonths
  • Quarterly
  • SemiAnnual
  • Annual
dayOfExecution Max2Text conditional

This string consists of up two characters.

Leading zeroes are not allowed.
endToEndIdentification Max35Text optional  
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
remittanceInformationUnstructured Max140Text optional  
 
Example
{"@type": "PeriodicPaymentInitiationSctInstJson",
"debtorAccount" : {"iban": "DE54500105173424724776"},
 
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorName": "creditor_name",
"startDate": "2019-01-31",
"endDate": "2019-12-31",
"executionRule": "following",
"frequency": "Monthly",
"dayOfExecution": "1"}
 

 

 

target-2-payments

model = PaymentInitiationTarget2Json

11-5.png

Data Element Type Presence Comment
startDate ISODate mandatory  
executionRule string optional

Permitted values:

  • "following"
  • "preceeding"
endDate ISODate optional If not given, it is an infinite standing order.
frequency Frequency Code mandatory

Permitted values:

  • Daily
  • Weekly
  • EveryTwoWeeks
  • Monthly
  • EveryTwoMonths
  • Quarterly
  • SemiAnnual
  • Annual
dayOfExecution Max2Text conditional

This string consists of up two characters.

Leading zeroes are not allowed.
endToEndIdentification Max35Text optional  
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
chargeBearer Charge Bearer optional  
remittanceInformationUnstructured Max140Text optional  
 
Example
{"@type": "PeriodicPaymentInitiationTarget2Json",
"endToEndIdentification": "STC20190228001293",
"debtorAccount" : {"iban": "DE54500105173424724776"},
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorAgent": "MOEALUL1XXX",
"creditorName": "creditor_name",
"chargeBearer": "SLEV",
"remittanceInformationUnstructured": "Some specific payment details to be given here",
"startDate": "2019-01-31",
"endDate": "2019-12-31",
"executionRule": "preceeding",
"frequency": "EveryTwoWeeks",
"dayOfExecution": "1"}

 

cross-border-credit-transfers

model = PaymentInitiationCrossBorderJson

11-5.png

Data Element Type Presence Comment
startDate ISODate mandatory  
executionRule string optional

Permitted values:

  • "following"
  • "preceeding"
endDate ISODate optional If not given, it is an infinite standing order.
frequency Frequency Code mandatory

Permitted values:

  • Daily
  • Weekly
  • EveryTwoWeeks
  • Monthly
  • EveryTwoMonths
  • Quarterly
  • SemiAnnual
  • Annual
dayOfExecution Max2Text conditional

This string consists of up two characters.

Leading zeroes are not allowed.
endToEndIdentification Max35Text optional  
debtorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
instructedAmount Amount mandatory  
creditorAccount Account Reference mandatory

XS2A Sandbox requires "iban" element from Account Reference.

Other elements - e.g. "bban", "maskedPan", etc - are not accepted.
creditorAgent BICFI optional  
creditorName Max70Text mandatory  
creditorAddress Address optional  
chargeBearer Charge Bearer optional  
remittanceInformationUnstructured Max140Text optional  
 
Example
{"@type": "PeriodicPaymentInitiationCrossBorderJson",
"debtorAccount" : {"iban": "DE54500105173424724776"},
"instructedAmount": {"currency": "EUR", "amount": "100.67"},
"creditorAccount": {"iban": "LU280019400644750000"},
"creditorAgent": "MOEALUL1XXX",
"creditorName": "creditor_name",
"chargeBearer": "SLEV",
"remittanceInformationUnstructured": "Some specific payment details to be given here",
"startDate": "2019-01-31",
"executionRule": "preceeding",
"frequency": "Monthly",
"dayOfExecution": "31"}

 

 
 
 

Related articles

Powered by Zendesk