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

cURL

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

import requests

url = "https://coreapi.io/payment/bank-account-transactions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://coreapi.io/payment/bank-account-transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/payment/bank-account-transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "data": [
    {
      "id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
      "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": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
          "default": true,
          "status": "active",
          "enabled": true,
          "name": "Visa (4242)",
          "creationDate": "2024-01-15T10:30:00+00:00",
          "expirationDate": "2026-12-31T23:59:59+00:00",
          "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": "[e-mail]",
            "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
          }
        },
        "type": "TYPE_INVOICE",
        "currencyCode": "EUR",
        "number": "RE-0000000001",
        "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": {}
      },
      "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": {},
      "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
    }
  }
}

Autorisierungen

Authorization · string · header · erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Abfrageparameter

page · integer · Standard: 1

The collection page number

limit · integer · Standard: 30

The number of items per page

Erforderlicher Bereich: 0 <= x <= 100

status · string

status[] · string[]

order[receivedAt] · enum<string>

Verfügbare Optionen: asc, desc

order[bookingDate] · enum<string>

Verfügbare Optionen: asc, desc

order[bookedAt] · enum<string>

Verfügbare Optionen: asc, desc

Antwort

200

application/json

BankAccountTransaction collection

data · object[]

Show child attributes

meta · object

Show child attributes