A.P.I dokumentation

(API: Application Programming Interface)

Kontobalance

Du kan, som ERP udbyder, bruge vores HTTPS/REST API til at hente saldo på en konto.
Denne side omhandler alene API funktioner til at modtage saldo på konti.

Alle anmodninger skal godkendes, se mere her: beregning af godkendelses header


Saldo kan hentes fra:
GET
https://api.bankintegration.dk/report/balance?requestId=<RequestId>
POST
https://api.bankintegration.dk/report/balance

På en anmodning om saldo sendes et JSON objekt tilbage i svarets body.

{
  "account": "52470021527478",
  "requestId": "REQ_01",
  "created": "2015-05-21T12:45:23+02:00",
  "currency" : "DKK",
  "name": "Driftkonto",
  "bic": "DABADKKK",
  "from": "2015-05-20",
  "to": "2015-05-21",
  "entries": [ 
    {
      "date": "2015-05-20",
      "amount": 25417.0,
      "type": 1, // Opening
    },
    {
      "date": "2015-05-20",
      "amount": 28001.75,
      "type": 2, // Closing
    },
    {
      "date": "2015-05-21",
      "amount": 28001.75,
      "type": 1, // Opening
    }
  ]
}
GET anmodninger

Saldo kan hentes via. en GET anmodning. På anmodningen skal som minimum sættes RequestId.

Øvrige parametre på GET anmodninger kan være:

  • "requestId": ERP udbyderens ID på anmodning. Returneres i svaret.
  • "type": Type af saldi der ønskes returneret.
    - Kan være 1="Opening" for dagens åbende saldo, 2="Closing" for lukkende saldo eller 3 (1+2) for begge
  • from: Fra dato, inklusive. Format kan være "yyyy-MM-dd" eller "yyMMdd".
  • to: Til dato, inklusive. Format kan være "yyyy-MM-dd" eller "yyMMdd".

Angives "type" ikke returneres saldi af både type 1="Opening" og 2="Closing". "Opening" er den saldo der findes på konto når banken "åbner", "Closing" er saldo ved dagens afslutning.
Angives fra dato ikke sættes denne til dags dato. Angives til dato ikke sættes denne ligeledes til dags dato (Dato i UTC, bemærk korrektion for tisdzone og sommer/vinter-tid). Fra dato kan ikke være større end til dato.

POST anmodninger:

Kontoudtog kan alternativt hentes med en POST admodning.

I anmodnings body indsættes et JSON objekt til at angive samme parametre som ved GET anmodninger.

  • requestId: [string, required] ERP udbyderens ID på anmodning. Returneres i svaret.
  • type: [integer, optional] Type af saldi (1="Opening" eller 2="Closing") der ønskes returneret.
  • from: [date, optional] Fra dato. Format kan være "yyyy-MM-dd" eller "yyMMdd".
  • to: [date, optional] Til dato. Format kan være "yyyy-MM-dd" eller "yyMMdd".
{
  "requestId": "string",
  "type": "string",
  "from": "date",
  "to": "date"
}
Svar på anmodninger

Svaret på en GET/POST anmodning indeholder et JSON objekt i body.

  • account: [string] Konto nr. for saldo anmodning.
  • requestId: [string] ERP udbyders ID for anmodning. Kopieret fra anmodning.
  • created: [datetime] Tidspunkt for oprettelse af svar i UTC.
  • currency: [string] Valuta for konto.
  • name: [string] Navn på konto (fra banken).
  • bic: [string] Bankens Swift/BIC nr.
  • from: [date] Dato for start, fra request, eller sidste saldo der findes.
  • to: [date] Dato for slut dato, fra request.
  • entries: [object, array] Et array af saldi værdier

{
  "account": "string",
  "requestId": "string",
  "created": "datetime",
  "currency" : "string",
  "name": "string",
  "bic": "string",
  "from": "date",
  "to": "date",
  "entries": [ "object:AccountBalanceEntry", "object:AccountBalanceEntry" ]
}
AccountBalanceEntry

  • date: [date] Dato for saldo.
  • amount: [double] Beløb for saldo.
  • type: [enum] Type af saldo. Kan være 1="Opening" for saldo ved åbning eller 2="Closing" for saldo ved clearing

{
  "date": "date",
  "amount": "double",
  "type": "enum, [1="Opening", 2="Closing"]"
}