Bank Account Transaction

Get bank account transactions

Get the bank account transactions. Bank account transactions are synchronized (e.g. by Klarna Sync) or uploaded statements from the bank account. The bank account transactions are matched with invoices and transactions. If the bank account transaction is not matched, it is shown in the list of bank account transactions with the status “matching required”. If the bank account transaction is matched, it is shown in the list of bank account transactions with the status “booked” or “outstanding amount”. If the bank account transaction is ignored, the transaction won’t be processed and is not shown in the list of bank account transactions anymore.

^{Required permissions: bank-account-transaction:read}

GET

payment

bank-account-transactions

curl -X GET \
 /payment/bank-account-transactions \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "<string>",
      "suggestedInvoice": {
        "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",
          "card": {
            "brand": "Visa",
            "last4": "4242",
            "expMonth": 12,
            "expYear": 2022,
            "cardHolder": "Max Mustermann"
          },
          "sepaDebit": {
            "iban": "DE8937*********3232",
            "bic": "COBADEFFXXX",
            "mandateReference": "MNDT-2021-123456",
            "signingDate": "2021-01-01T00:00:00+00:00"
          },
          "paypal": {
            "email": "max@mustermann.de",
            "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
          }
        },
        "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": {}
      },
      "suggestedCustomer": {
        "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"
      },
      "valueDate": "2023-11-07T05:31:56Z",
      "bookingDate": "2023-11-07T05:31:56Z",
      "paymentDate": "2023-11-07T05:31:56Z",
      "usageDescription": "Kundennummer 1234567890 Rechnung 1234567890",
      "endToEndId": "1234567890",
      "counterParty": {
        "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
        "alias": "Girokonto",
        "iban": "DE12500105170648489890",
        "bic": "PBNKDEFFXXX",
        "accountHolder": "Max Mustermann",
        "bankName": "Commerzbank"
      },
      "amount": {},
      "fee": {},
      "status": "STATUS_RECEIVED",
      "receivedAt": "2023-11-07T05:31:56Z",
      "bookedAt": "2023-11-07T05:31:56Z",
      "mandateId": "MAN1234567890",
      "source": "klarna",
      "type": "debit",
      "transactionCode": "RCDT",
      "unassignedAmount": {}
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Query Parameters

page

integer

default:1

The collection page number

limit

integer

default:30

The number of items per page

Required range: 0 <= x <= 100

status

string

status[]

string[]

order[receivedAt]

enum<string>

Available options:

asc,

desc

order[bookingDate]

enum<string>

Available options:

asc,

desc

order[bookedAt]

enum<string>

Available options:

asc,

desc

Response

200

application/json

BankAccountTransaction collection

data

object[]

data.id

string

data.suggestedInvoice

object | null

data.suggestedInvoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

data.suggestedInvoice.customer

object

The customer of the invoice.

data.suggestedInvoice.paymentMethod

object | null

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

data.suggestedInvoice.paymentMethod.id

string

data.suggestedInvoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

data.suggestedInvoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

data.suggestedInvoice.paymentMethod.default

boolean

data.suggestedInvoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

data.suggestedInvoice.paymentMethod.enabled

boolean

data.suggestedInvoice.paymentMethod.name

string | null

data.suggestedInvoice.paymentMethod.creationDate

string

data.suggestedInvoice.paymentMethod.expirationDate

string | null

data.suggestedInvoice.paymentMethod.card

object

The card data of the payment method, if the type is "card"

data.suggestedInvoice.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

data.suggestedInvoice.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

data.suggestedInvoice.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"

data.suggestedInvoice.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"

data.suggestedInvoice.number

string

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

Example:

"RE-0000000001"

data.suggestedInvoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

data.suggestedInvoice.finalizationDate

string | null

data.suggestedInvoice.dueDate

string | null

data.suggestedInvoice.dunningLevel

integer

data.suggestedInvoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

data.suggestedInvoice.payDate

string | null

data.suggestedInvoice.invoiceAddress

any | null

The invoice address of the invoice.

data.suggestedInvoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

data.suggestedInvoice.netAmount

object

The net amount of the invoice.

data.suggestedInvoice.grossAmount

object

data.suggestedInvoice.taxAmount

object

data.suggestedInvoice.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" }

data.suggestedInvoice.unpaidAmount

object

data.suggestedCustomer

object | null

data.valueDate

string

data.bookingDate

string

data.paymentDate

string

data.usageDescription

string

Example:

"Kundennummer 1234567890 Rechnung 1234567890"

data.endToEndId

string | null

Example:

"1234567890"

data.counterParty

object | null

data.amount

object

data.fee

object

data.status

enum<string>

Available options:

STATUS_RECEIVED,

STATUS_BOOKED,

STATUS_MANUAL_MATCHING_REQUIRED,

STATUS_IGNORED,

outstanding_amount,

suggestions_available

data.receivedAt

string

data.bookedAt

string | null

data.mandateId

string | null

Example:

"MAN1234567890"

data.source

enum<string>

The source of the bank account transaction.

Available options:

klarna

Example:

"klarna"

data.type

enum<string>

The type of the bank account transaction.

Available options:

debit,

credit

Example:

"debit"

data.transactionCode

string | null

The transaction code as defined in ISO 20022. See: https://www.iso20022.org/sites/default/files/2020-08/BTC_ExternalCodeListDescription_31Aug2020.doc

Example:

"RCDT"

data.unassignedAmount

object

The amount that is not assigned to any invoice or transaction. Can be negative if the bank transaction is assigned to invoices and transactions with a higher amount than the bank transaction amount.

meta

object

Get a bank account transaction assignment Accept the suggestions

curl -X GET \
 /payment/bank-account-transactions \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "<string>",
      "suggestedInvoice": {
        "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",
          "card": {
            "brand": "Visa",
            "last4": "4242",
            "expMonth": 12,
            "expYear": 2022,
            "cardHolder": "Max Mustermann"
          },
          "sepaDebit": {
            "iban": "DE8937*********3232",
            "bic": "COBADEFFXXX",
            "mandateReference": "MNDT-2021-123456",
            "signingDate": "2021-01-01T00:00:00+00:00"
          },
          "paypal": {
            "email": "max@mustermann.de",
            "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
          }
        },
        "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": {}
      },
      "suggestedCustomer": {
        "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"
      },
      "valueDate": "2023-11-07T05:31:56Z",
      "bookingDate": "2023-11-07T05:31:56Z",
      "paymentDate": "2023-11-07T05:31:56Z",
      "usageDescription": "Kundennummer 1234567890 Rechnung 1234567890",
      "endToEndId": "1234567890",
      "counterParty": {
        "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
        "alias": "Girokonto",
        "iban": "DE12500105170648489890",
        "bic": "PBNKDEFFXXX",
        "accountHolder": "Max Mustermann",
        "bankName": "Commerzbank"
      },
      "amount": {},
      "fee": {},
      "status": "STATUS_RECEIVED",
      "receivedAt": "2023-11-07T05:31:56Z",
      "bookedAt": "2023-11-07T05:31:56Z",
      "mandateId": "MAN1234567890",
      "source": "klarna",
      "type": "debit",
      "transactionCode": "RCDT",
      "unassignedAmount": {}
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get bank account transactions

Authorizations

Query Parameters

Response