Mark a SEPA XML file as uploaded

PUT

sepa-xml-files

{id}

uploaded

curl -X PUT \
 /sepa-xml-files/{id}/uploaded \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "autoCaptureAfterDays": ""
}'

{
  "id": "ad8f7a6d-1b0b-4e1a-8e1a-0b1b0b1b0b1b",
  "uploaded": true,
  "uniqueMessageId": "COKSDE33XXX-2021-01-01-12-00-00-000000000",
  "generatedAt": "2023-11-07T05:31:56Z",
  "sepaXmlPayments": [
    {
      "id": "ad8f1c1e-0b0a-4e1a-8b0a-0b0a4e1a8b0a",
      "type": "debit",
      "createdAt": "<any>",
      "dueDate": "2023-11-07T05:31:56Z",
      "remittanceInformation": "#Fynn - Debit for invoice 123",
      "endToEndId": "Fynn-123",
      "amount": 100,
      "sepaMandate": {
        "id": "ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a",
        "status": "active",
        "creditorIdentifier": "<string>",
        "mandateReference": "MNDT-2021-0001",
        "bankAccount": {
          "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
          "iban": "DE12500105170648489890",
          "bic": "PBNKDEFFXXX",
          "accountHolder": "Max Mustermann",
          "bankName": "Commerzbank"
        },
        "sequenceType": "FRST",
        "sepaType": "core"
      },
      "invoice": {
        "id": "00000000-0000-0000-0000-000000000000",
        "customer": {
          "id": "00000000-0000-0000-0000-000000000000",
          "customerNumber": "CUSTOMER-000",
          "timeZone": "Europe/Berlin",
          "firstName": "John",
          "lastName": "Doe",
          "currencyCode": "EUR",
          "companyName": "Acme Inc.",
          "datevId": "123456789",
          "status": "STATUS_ACTIVE"
        },
        "paymentMethod": {
          "id": "<string>",
          "gatewayName": "wallet",
          "type": "sepa_debit",
          "default": true,
          "status": "active",
          "enabled": true,
          "name": "<string>",
          "creationDate": "2023-11-07T05:31:56Z",
          "expirationDate": "2023-11-07T05:31:56Z"
        },
        "type": "TYPE_INVOICE",
        "currencyCode": "EUR",
        "number": "RE-0000000001",
        "status": "STATUS_DRAFT",
        "finalizationDate": "2023-11-07T05:31:56Z",
        "dueDate": "2023-11-07T05:31:56Z",
        "dunningLevel": 123,
        "dunningStatus": "none",
        "payDate": "2023-11-07T05:31:56Z",
        "invoiceAddress": "<any>",
        "internalNote": "This invoice is with a special discount.",
        "netAmount": {},
        "grossAmount": {},
        "taxAmount": {},
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "unpaidAmount": {}
      },
      "transaction": "<any>",
      "autoCaptureAt": "2023-11-07T05:31:56Z"
    }
  ],
  "mediaId": "ad8f7a6d-1b0b-4e1a-8e1a-0b1b0b1b0b1b"
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

SepaXmlStatement identifier

Body

The updated SepaXmlStatement resource

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

SepaXmlStatement resource updated

string

Example:

"ad8f7a6d-1b0b-4e1a-8e1a-0b1b0b1b0b1b"

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.

uniqueMessageId

string

The unique message ID of the SEPA XML file

Example:

"COKSDE33XXX-2021-01-01-12-00-00-000000000"

generatedAt

string

The date and time when the SEPA XML file was generated

sepaXmlPayments

object[]

The SEPA XML payments included in this SEPA XML file

sepaXmlPayments.id

string

Example:

"ad8f1c1e-0b0a-4e1a-8b0a-0b0a4e1a8b0a"

sepaXmlPayments.type

enum<string>

default:debit

Possible values:

credit: Credit
debit: Debit

Available options:

credit,

debit

Example:

"debit"

sepaXmlPayments.createdAt

any

sepaXmlPayments.dueDate

string | null

sepaXmlPayments.remittanceInformation

string | null

Example:

"#Fynn - Debit for invoice 123"

sepaXmlPayments.endToEndId

string | null

Example:

"Fynn-123"

sepaXmlPayments.amount

integer

Example:

100

sepaXmlPayments.sepaMandate

object

sepaXmlPayments.sepaMandate.id

string

Example:

"ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a"

sepaXmlPayments.sepaMandate.status

enum<string>

The status of the mandate

Possible values:

active: The mandate is active and can be used for payments
revoked: The customer has revoked the mandate or a payment was rejected by the bank. The mandate can not be used for payments anymore

Available options:

active,

revoked

Example:

"active"

sepaXmlPayments.sepaMandate.creditorIdentifier

string

sepaXmlPayments.sepaMandate.mandateReference

string

The reference of the mandate

Example:

"MNDT-2021-0001"

sepaXmlPayments.sepaMandate.bankAccount

object

The bank account of the mandate

sepaXmlPayments.sepaMandate.sequenceType

enum<string>

The sequence type of the mandate

Possible values:

FRST: The sepa mandate is used for the first time for a recurring payment
RCUR: The sepa mandate was already used the first time and is now used for recurring payments
FNAL: The sepa mandate is used for the last time for a recurring payment
OOFF: The sepa mandate is only allowed to be used for one payment

Available options:

FRST,

RCUR,

FNAL,

OOFF

Example:

"FRST"

sepaXmlPayments.sepaMandate.sepaType

enum<string>

The type of the mandate

Possible values:

CORE: The core scheme is used for payments between consumers and companies
B2B: The B2B scheme is used for payments between companies. No refund is possible
COR1: The COR1 scheme is used for payments between consumers and companies. The payment is processed faster than with the core scheme

Available options:

CORE,

B2B,

COR1

Example:

"core"

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.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

sepaXmlPayments.invoice.customer

object

The customer of the invoice.

sepaXmlPayments.invoice.paymentMethod

object | null

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

sepaXmlPayments.invoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

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.

Example:

"EUR"

sepaXmlPayments.invoice.number

string

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

Example:

"RE-0000000001"

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.finalizationDate

string | null

sepaXmlPayments.invoice.dueDate

string | null

sepaXmlPayments.invoice.dunningLevel

integer

sepaXmlPayments.invoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

sepaXmlPayments.invoice.payDate

string | null

sepaXmlPayments.invoice.invoiceAddress

any | null

The invoice address of the invoice.

sepaXmlPayments.invoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

sepaXmlPayments.invoice.netAmount

object

The net amount of the invoice.

sepaXmlPayments.invoice.grossAmount

object

sepaXmlPayments.invoice.taxAmount

object

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

Example:

{ "field1": "value1", "field2": "value2" }

sepaXmlPayments.invoice.unpaidAmount

object

sepaXmlPayments.transaction

any

The transaction of the payment.

sepaXmlPayments.autoCaptureAt

string | null

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.

Example:

"ad8f7a6d-1b0b-4e1a-8e1a-0b1b0b1b0b1b"

Delete a SEPA XML file Get a Sepa XML payment

curl -X PUT \
 /sepa-xml-files/{id}/uploaded \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "autoCaptureAfterDays": ""
}'

{
  "id": "ad8f7a6d-1b0b-4e1a-8e1a-0b1b0b1b0b1b",
  "uploaded": true,
  "uniqueMessageId": "COKSDE33XXX-2021-01-01-12-00-00-000000000",
  "generatedAt": "2023-11-07T05:31:56Z",
  "sepaXmlPayments": [
    {
      "id": "ad8f1c1e-0b0a-4e1a-8b0a-0b0a4e1a8b0a",
      "type": "debit",
      "createdAt": "<any>",
      "dueDate": "2023-11-07T05:31:56Z",
      "remittanceInformation": "#Fynn - Debit for invoice 123",
      "endToEndId": "Fynn-123",
      "amount": 100,
      "sepaMandate": {
        "id": "ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a",
        "status": "active",
        "creditorIdentifier": "<string>",
        "mandateReference": "MNDT-2021-0001",
        "bankAccount": {
          "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
          "iban": "DE12500105170648489890",
          "bic": "PBNKDEFFXXX",
          "accountHolder": "Max Mustermann",
          "bankName": "Commerzbank"
        },
        "sequenceType": "FRST",
        "sepaType": "core"
      },
      "invoice": {
        "id": "00000000-0000-0000-0000-000000000000",
        "customer": {
          "id": "00000000-0000-0000-0000-000000000000",
          "customerNumber": "CUSTOMER-000",
          "timeZone": "Europe/Berlin",
          "firstName": "John",
          "lastName": "Doe",
          "currencyCode": "EUR",
          "companyName": "Acme Inc.",
          "datevId": "123456789",
          "status": "STATUS_ACTIVE"
        },
        "paymentMethod": {
          "id": "<string>",
          "gatewayName": "wallet",
          "type": "sepa_debit",
          "default": true,
          "status": "active",
          "enabled": true,
          "name": "<string>",
          "creationDate": "2023-11-07T05:31:56Z",
          "expirationDate": "2023-11-07T05:31:56Z"
        },
        "type": "TYPE_INVOICE",
        "currencyCode": "EUR",
        "number": "RE-0000000001",
        "status": "STATUS_DRAFT",
        "finalizationDate": "2023-11-07T05:31:56Z",
        "dueDate": "2023-11-07T05:31:56Z",
        "dunningLevel": 123,
        "dunningStatus": "none",
        "payDate": "2023-11-07T05:31:56Z",
        "invoiceAddress": "<any>",
        "internalNote": "This invoice is with a special discount.",
        "netAmount": {},
        "grossAmount": {},
        "taxAmount": {},
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "unpaidAmount": {}
      },
      "transaction": "<any>",
      "autoCaptureAt": "2023-11-07T05:31:56Z"
    }
  ],
  "mediaId": "ad8f7a6d-1b0b-4e1a-8e1a-0b1b0b1b0b1b"
}

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