Skip to main content

Report API (0.2)

Download OpenAPI specification:Download

Returns the ledgers you have access to

Returns the ledgers you have access to.

For a description of ledgers see TODO.

If you are integrating a single merchant it may be enough to hit this endpoint once manually to identify the ledgerId.

There is no need to specify the merchant or sale unit. The response contains all ledgers that are available for the API keys used.

The settlesFor part of the response looks a bit different for eCom sales units and Vippsnummer. For eCom it looks like this:

{
  "settlesFor": [
      {
       "type": "epayment",
       "msn": "123455"
      }
    ]
}

while for a Vippsnummer you will get

{
  "settlesFor": [
    {
      "type": "vippsnummer",
      "vippsnummer": "NO/123455"
    }
  ]
}

The full response example below displays the eCom case.

query Parameters
msn
string
Example: msn=123456

Filters for ledgers that settles for the given MSN

vippsnummer
string
Example: vippsnummer=123456

Filters for ledgers that settles for the given Vippsnummer

header Parameters
Authorization
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). It is valid for 1 hour in the test environment and 24 hours in the production environment.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Returns a list of payments/transactions.

Returns a list of payments/transactions.

path Parameters
ledgerId
required
string
query Parameters
ledgerDate
string <Date>
Example: ledgerDate=2022-01-20
fromLedgerDate
string <Date>
Example: fromLedgerDate=2022-01-19
toLedgerDate
string <Date>
Example: toLedgerDate=2022-01-22
inPayout
string
Example: inPayout=2000010
sincePayout
string
Example: sincePayout=2000010
header Parameters
Authorization
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1Ni...

The access token is a base64-encoded string that is required for all API calls. It is a JWT (JSON Web Token). It is valid for 1 hour in the test environment and 24 hours in the production environment.

Responses

Response samples

Content type
{
  • "items": [
    ]
}