Bank Payment Events

The following Bank Payment Events are available to Subscribe to in the Events API. Fore more information about how to subscribe to Events, see the main page for events: Events API and Subscribing to Events

To get more details about a Bank Payment in an Event and it's related mappings to Invoices after update, see GET - {bankPaymentId}API/

BANK_PAYMENT_CREATED - A new incoming bank payment has been created

JSON
    
{    "type": "BANK_PAYMENT_CREATED",    "payload": {        "bankPaymentId": 18, // Id of the Bank Payment used to fetch latest and detailed data from /bank-payments/        "amount": 50000,        "currencyCode": "SEK",         "bookingDate": "2024-09-08", // Booking date from the bank        "valueDate": "2024-09-08", // Booking date from the bank        "fundSourceType": "PAYMENT_TO_ACCOUNT", // The type of funds source, where PAYMENT_TO_ACCOUNT represents actual funds received and CREDIT_INVOICE represents a credit invoice the sender wishes to utilize. enum: [PAYMENT_TO_ACCOUNT,CREDIT_INVOICE]        "createdDate": "2024-09-09T14:50:44.045Z" // Time of processing bank data    }}
Copy

BANK_PAYMENT_UPDATED - A incoming bank payment has been updated - Update related to a bank payments or bank credit reference being matched to one or several outstanding invoice(s), refunded or manually marked as ignored.

JSON
    
{    "type": "BANK_PAYMENT_UPDATED",    "payload": {        "bankPaymentId": 18, // Id of the Bank Payment used to fetch latest and detailed data from /bank-payments/        "mappingDate": "2024-09-09T14:52:38.386Z", // Time of mapping        "fundSourceType": "PAYMENT_TO_ACCOUNT", // The type of funds source, where PAYMENT_TO_ACCOUNT represents actual funds received and CREDIT_INVOICE represents a credit invoice the sender wishes to utilize. enum: [PAYMENT_TO_ACCOUNT,CREDIT_INVOICE]        "mappings": [            {                "invoiceNumber": 116692, // Invoice Number the specific amount has been matched to.                "creditInvoiceNumber": null,  // The credit Invoice Number used when Fund Source Type is CREDIT_INVOICE.                "amount": 20000,                "currencyCode": "SEK",                "paymentId": 451988 // The Payment ID for the matched payment connected to a specific Invoice            }        ]    }}
Copy

We would love to get request for new Events, create a ticket in our support portal and we will look into it!

Last updated on

Was this page helpful?