Skip to main content
API docs by Redocly

Reporting API (v3)

E-mail: developer@vippsmobilepay.com


Reporting API allows you to query all transactions taking place at any of your MobilePay payment locations (payment points).

General notes

All dates use the (ISO 8601-1:2019) format.
Date format - YYYY-MM-DD.
Date-time format - YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss+00:00.

fetch a list of payment points

Authorizations:
apiKeyopenId
query Parameters
pagesize
integer >= 1
Default: 100

Number of payment points to be returned.

pagenumber
integer >= 1
Default: 1

Responses

Response samples

Content type
application/json
{
  • "pageSize": 0,
  • "nextPageNumber": 0,
  • "paymentPoints": [
    ]
}

fetch a list of transactions

Authorizations:
apiKeyopenId
query Parameters
transferid
string <uuid>
paymentpointid
string <uuid>
startdate
string <date-time>
enddate
string <date-time>
pagesize
integer >= 1
Default: 100

Number of transactions to be returned.

pagenumber
integer >= 1
Default: 1
sortdirection
string
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "pageSize": 0,
  • "nextPageNumber": 0,
  • "transactions": [
    ]
}

fetch a list of transfers

Authorizations:
apiKeyopenId
query Parameters
paymentpointid
string <uuid>
startdate
string <date>
Example: startdate=2021-11-30
enddate
string <date>
Example: enddate=2021-11-30
reference
string

Bank reference number used for aggregated transfer to receiver account.

pagesize
integer >= 1
Default: 100

Number of transfers to be returned.

pagenumber
integer >= 1
Default: 1
sortdirection
string
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "pageSize": 0,
  • "nextPageNumber": 0,
  • "transfers": [
    ]
}

fetch single transfer

Authorizations:
apiKeyopenId
path Parameters
transferid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "totalTransferredAmount": 268.94,
  • "currencyCode": "DKK",
  • "paymentPointId": "f29aded7-4abb-4e8e-a778-5cb45a5dd4cb"
}