Mark a SEPA XML file as uploaded

PUT

sepa-xml-files

{id}

uploaded

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

SepaXmlStatement identifier

Body

autoCaptureAfterDays

integer | null

The number of days after which the payment should be captured automatically. 0 means immediately. If you are using the bank account synchronization, you should set this value to null. The amount will be captured automatically, when the bank account synchronization is processed.

Advantages of using the bank account synchronization:

more accurate payment status and payment date
correct accounting of the payment
declines are handled automatically
less manual work

Required range: 0 < x < 90

Response

200 - application/json

generatedAt

string

The date and time when the SEPA XML file was generated

string

mediaId

string

The media file containing the SEPA XML statement(s) as zip. See <a href ="#tag/Media/operation/getDownloadToken">Download media</a> for more information.

sepaXmlPayments

object[]

The SEPA XML payments included in this SEPA XML file

sepaXmlPayments.amount

integer

sepaXmlPayments.autoCaptureAt

string | null

sepaXmlPayments.createdAt

any

sepaXmlPayments.dueDate

string | null

sepaXmlPayments.endToEndId

string | null

sepaXmlPayments.id

string

sepaXmlPayments.invoice

object | null

The invoice of the payment. In case of a cart payment or manual payment intent, the invoice is null.

sepaXmlPayments.invoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

sepaXmlPayments.invoice.customer

object

The customer of the invoice.

sepaXmlPayments.invoice.customFields

object | null

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

sepaXmlPayments.invoice.dueDate

string | null

sepaXmlPayments.invoice.dunningLevel

integer

sepaXmlPayments.invoice.dunningStatus

enum<string>

default:

none

Available options:

reminder,

dunning,

none

sepaXmlPayments.invoice.finalizationDate

string | null

sepaXmlPayments.invoice.grossAmount

object

sepaXmlPayments.invoice.id

string

The unique identifier of the invoice.

sepaXmlPayments.invoice.internalNote

string | null

deprecated

The notice of the invoice.

sepaXmlPayments.invoice.invoiceAddress

any | null

The invoice address of the invoice.

sepaXmlPayments.invoice.netAmount

object

The net amount of the invoice.

sepaXmlPayments.invoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

sepaXmlPayments.invoice.payDate

string | null

sepaXmlPayments.invoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

sepaXmlPayments.invoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

sepaXmlPayments.invoice.taxAmount

object

sepaXmlPayments.invoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

sepaXmlPayments.invoice.unpaidAmount

object

sepaXmlPayments.remittanceInformation

string | null

sepaXmlPayments.sepaMandate

object

sepaXmlPayments.transaction

any

The transaction of the payment.

sepaXmlPayments.type

enum<string>

default:

debit

Possible values:

credit: Credit
debit: Debit

Available options:

credit,

debit

uniqueMessageId

string

The unique message ID of the SEPA XML file

uploaded

boolean

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?

Delete a SEPA XML file Get a Sepa XML payment

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Mark a SEPA XML file as uploaded

Authorizations

Path Parameters

Body

Response