Zum Hauptinhalt springen
PUT
/
sepa-xml-files
/
{id}
/
uploaded
cURL
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": "<unknown>",
      "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": "<unknown>",
        "internalNote": "This invoice is with a special discount.",
        "netAmount": {},
        "grossAmount": {},
        "taxAmount": {},
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "unpaidAmount": {}
      },
      "transaction": "<unknown>",
      "autoCaptureAt": "2023-11-07T05:31:56Z"
    }
  ],
  "mediaId": "ad8f7a6d-1b0b-4e1a-8e1a-0b1b0b1b0b1b"
}

Autorisierungen

​
Authorization
string
header
erforderlich

Value for the Authorization header parameter.

Pfadparameter

​
id
string
erforderlich

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
Erforderlicher Bereich: 0 <= x <= 90

Antwort

SepaXmlStatement resource updated

​
id
string
Beispiel:

"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

Beispiel:

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

​
generatedAt
string<date-time>

The date and time when the SEPA XML file was generated

​
sepaXmlPayments
object[]

The SEPA XML payments included in this SEPA XML file

​
mediaId
string

The media file containing the SEPA XML statement(s) as zip. See Download media for more information.

Beispiel:

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