Get bank account transaction details

GET

payment

bank-account-transactions

{id}

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

{
  "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",
  "assignments": [
    {
      "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
      "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",
          "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": {}
      },
      "transaction": {
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "type": "payment",
        "status": "<any>",
        "description": "Payment for invoice #123",
        "documentNumber": "123456789",
        "currencyCode": "EUR",
        "amount": 500,
        "refundedAmount": 123,
        "chargedAmount": 500,
        "feeAmount": 50,
        "createdAt": "2023-11-07T05:31:56Z",
        "paidAt": "2023-11-07T05:31:56Z"
      },
      "amount": {},
      "fee": {},
      "matchedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "unassignedAmount": {}
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

BankAccountTransaction identifier

Response

200

application/json

BankAccountTransaction resource

string

suggestedInvoice

object | null

suggestedInvoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

suggestedInvoice.customer

object

The customer of the invoice.

suggestedInvoice.paymentMethod

object | null

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

suggestedInvoice.paymentMethod.id

string

suggestedInvoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

suggestedInvoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

suggestedInvoice.paymentMethod.default

boolean

suggestedInvoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

suggestedInvoice.paymentMethod.enabled

boolean

suggestedInvoice.paymentMethod.name

string | null

suggestedInvoice.paymentMethod.creationDate

string

suggestedInvoice.paymentMethod.expirationDate

string | null

suggestedInvoice.paymentMethod.card

object

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

suggestedInvoice.paymentMethod.sepaDebit

object

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

suggestedInvoice.paymentMethod.paypal

object

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

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"

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"

suggestedInvoice.number

string

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

Example:

"RE-0000000001"

suggestedInvoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

suggestedInvoice.finalizationDate

string | null

suggestedInvoice.dueDate

string | null

suggestedInvoice.dunningLevel

integer

suggestedInvoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

suggestedInvoice.payDate

string | null

suggestedInvoice.invoiceAddress

any | null

The invoice address of the invoice.

suggestedInvoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

suggestedInvoice.netAmount

object

The net amount of the invoice.

suggestedInvoice.grossAmount

object

suggestedInvoice.taxAmount

object

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" }

suggestedInvoice.unpaidAmount

object

suggestedCustomer

object | null

valueDate

string

bookingDate

string

paymentDate

string

usageDescription

string

Example:

"Kundennummer 1234567890 Rechnung 1234567890"

endToEndId

string | null

Example:

"1234567890"

counterParty

object | null

amount

object

fee

object

status

enum<string>

Available options:

STATUS_RECEIVED,

STATUS_BOOKED,

STATUS_MANUAL_MATCHING_REQUIRED,

STATUS_IGNORED,

outstanding_amount,

suggestions_available

receivedAt

string

bookedAt

string | null

mandateId

string | null

Example:

"MAN1234567890"

source

enum<string>

The source of the bank account transaction.

Available options:

klarna

Example:

"klarna"

type

enum<string>

The type of the bank account transaction.

Available options:

debit,

credit

Example:

"debit"

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"

assignments

object[]

All assignments to invoices and their transactions. Can be one or multiple, if the bank transaction was split into multiple invoices. Use case: A customer pays multiple invoices with one bank transaction.

assignments.id

string

Example:

"ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c"

assignments.invoice

object

assignments.invoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

assignments.invoice.customer

object

The customer of the invoice.

assignments.invoice.paymentMethod

object | null

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

assignments.invoice.paymentMethod.id

string

assignments.invoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

assignments.invoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

assignments.invoice.paymentMethod.default

boolean

assignments.invoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

assignments.invoice.paymentMethod.enabled

boolean

assignments.invoice.paymentMethod.name

string | null

assignments.invoice.paymentMethod.creationDate

string

assignments.invoice.paymentMethod.expirationDate

string | null

assignments.invoice.paymentMethod.card

object

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

assignments.invoice.paymentMethod.sepaDebit

object

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

assignments.invoice.paymentMethod.paypal

object

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

assignments.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"

assignments.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"

assignments.invoice.number

string

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

Example:

"RE-0000000001"

assignments.invoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

assignments.invoice.finalizationDate

string | null

assignments.invoice.dueDate

string | null

assignments.invoice.dunningLevel

integer

assignments.invoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

assignments.invoice.payDate

string | null

assignments.invoice.invoiceAddress

any | null

The invoice address of the invoice.

assignments.invoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

assignments.invoice.netAmount

object

The net amount of the invoice.

assignments.invoice.grossAmount

object

assignments.invoice.taxAmount

object

assignments.invoice.customFields

object | null

Example:

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

assignments.invoice.unpaidAmount

object

assignments.transaction

object

assignments.transaction.id

string

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

assignments.transaction.type

enum<string>

default:payment

Available options:

payment,

refund

Example:

"payment"

assignments.transaction.status

any

The status of the transaction.

Possible values:

new: The transaction is new and not yet processed. A new transaction is created when a payment is initiated.
authorized: The transaction is authorized and can be captured.
authorizing: The transaction is authorizing. No actions can be performed on the transaction.
waiting: The transaction is waiting for a response from the payment provider, or a customer input. No actions can be performed on the transaction.
offsite_authorization_required: The transaction requires an offsite authorization, e.g. 3D Secure. The customer is informed about the required authorization and redirected to the payment provider.
booked: The transaction is captured and booked on the account.
captured: The transaction is captured and will be booked on the account.
dispute: The transaction is disputed.
manual: Legacy status. Do not use.
canceled: The transaction is canceled, e.g. by the customer during the payment process, or by the merchant.
pending: The transaction is pending, and will be processed soon by the payment provider.
expired: The transaction is expired, e.g. because the customer did not complete the payment process in time.
processing: The transaction is processing, e.g. because the payment provider is currently processing the payment.
failed: The transaction failed, e.g. because the payment provider could not process the payment.
unknown: The transaction status is unknown.
refunded: The transaction is fully refunded.
payedout: The transaction was a payout.
partial_refunded: The transaction is partially refunded.
refund_failed: The transaction refund failed.

assignments.transaction.description

string

The description of the transaction.

Example:

"Payment for invoice #123"

assignments.transaction.documentNumber

string

The internal reference number of the transaction.

Example:

"123456789"

assignments.transaction.currencyCode

object

The currency code of the transaction.

assignments.transaction.amount

integer

The original amount which was requested.

Example:

500

assignments.transaction.refundedAmount

integer

The amount which was refunded.

assignments.transaction.chargedAmount

integer

The amount which was charged to the payment method.

Example:

500

assignments.transaction.feeAmount

integer | null

The amount of the transaction fee.

Example:

50

assignments.transaction.createdAt

string

The date when the transaction was created.

assignments.transaction.paidAt

string | null

The date when the transaction was charged.

assignments.amount

object

assignments.fee

object

assignments.matchedAt

string

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.

Was this page helpful?

Suggest edits Raise issue

Get the status count of the bank account transactions Assign invoices to the bank account transaction.

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

{
  "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",
  "assignments": [
    {
      "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
      "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",
          "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": {}
      },
      "transaction": {
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "type": "payment",
        "status": "<any>",
        "description": "Payment for invoice #123",
        "documentNumber": "123456789",
        "currencyCode": "EUR",
        "amount": 500,
        "refundedAmount": 123,
        "chargedAmount": 500,
        "feeAmount": 50,
        "createdAt": "2023-11-07T05:31:56Z",
        "paidAt": "2023-11-07T05:31:56Z"
      },
      "amount": {},
      "fee": {},
      "matchedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "unassignedAmount": {}
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get bank account transaction details

Authorizations

Path Parameters

Response