API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Get a SEPA XML file
Returns a generated SEPA XML file.
Required permissions:sepa-xml:read
Authorizations
Value for the Authorization header parameter.
Path Parameters
SepaXmlStatement identifier
Response
The date and time when the SEPA XML file was generated
The media file containing the SEPA XML statement(s) as zip. See <a href ="#tag/Media/operation/getDownloadToken">Download media</a> for more information.
The SEPA XML payments included in this SEPA XML file
The invoice of the payment. In case of a cart payment or manual payment intent, the invoice is null.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
2 - 255
Can be empty. In this case the default currency of the tenant is used.
2 - 255
The ID of the customer in DATEV
2 - 255
Can be empty if the customer is a company.
2 - 255
Can be empty if the customer is a company.
2 - 255
STATUS_ACTIVE
, STATUS_ARCHIVED
, STATUS_SUSPENDED
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
reminder
, dunning
, none
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
wallet
, sepa_debit
, stripe
, fake_provider
, paypal
, bank_transfer
, go_cardless
, testing
active
, action_required
, expired
, revoked
, gateway_unconfigured
sepa_debit
, card
, paypal
, bank_transfer
, wallet
, fake_provider
STATUS_DRAFT
, STATUS_PAID
, STATUS_CANCELLED
, STATUS_CLOSED
, STATUS_REFUNDED
, STATUS_REMINDED
, STATUS_UNPAID
, STATUS_NEW
, STATUS_FINALIZING
The type of the invoice.
TYPE_INVOICE
, TYPE_CREDIT
, TYPE_REFUND
, TYPE_REMINDER
, TYPE_CANCEL
, TYPE_DUNNING
The bank account of the mandate
The reference of the mandate
The type of the mandate
Possible values:
CORE
: The core scheme is used for payments between consumers and companiesB2B
: The B2B scheme is used for payments between companies. No refund is possibleCOR1
: The COR1 scheme is used for payments between consumers and companies. The payment is processed faster than with the core scheme
CORE
, B2B
, COR1
The sequence type of the mandate
Possible values:
FRST
: The sepa mandate is used for the first time for a recurring paymentRCUR
: The sepa mandate was already used the first time and is now used for recurring paymentsFNAL
: The sepa mandate is used for the last time for a recurring paymentOOFF
: The sepa mandate is only allowed to be used for one payment
FRST
, RCUR
, FNAL
, OOFF
The status of the mandate
Possible values:
active
: The mandate is active and can be used for paymentsrevoked
: The customer has revoked the mandate or a payment was rejected by the bank. The mandate can not be used for payments anymore
active
, revoked
The transaction of the payment.
Possible values:
credit
: Creditdebit
: Debit
credit
, debit
The unique message ID of the SEPA XML file
Indicates if the SEPA XML file was uploaded to the bank already. If not, the file can be deleted. If yes, all transactions will be marked as waiting, until the grace period of the bank is over.
Was this page helpful?