Get ledgers
Returns the ledgers you have access to.
If you are integrating a single
merchant it may be enough to hit this endpoint once manually to identify
the ledgerId
, and then put that in your configuration.
If you are integrating for an accounting system or similar, you should
call this endpoint periodically in order to synchronize the list
of ledgers you have access to.
There is no need to specify the merchant or sales unit. The response contains all ledgers that are available for the API keys used.
The settlesForRecipientHandles
part of the response looks a bit different for eCom sales
units and Vippsnummer. For eCom it looks like this:
{
"settlesForRecipientHandles": [ "api:123455" ]
}
while for a Vippsnummer you will get
{
"settlesForRecipientHandles": [ "NO:123455" ]
}
The full response example below displays the eCom case.
query Parameters
settlesForRecipientHandles | string Example: settlesForRecipientHandles=api:123456 Filters for ledgers that settles for the given settlesForRecipientHandle |
cursor | string Example: cursor=eyJhZnRlckxlZGdlcklkIjoieHh4eCIsInNldHRsZXNGb3JSZWNpcGllbnRIYW5kbGVzIjpudWxsfQ== We limit the amount of rows returned to reduce the amount of data we need to process on each request. If the total number of rows is greater than that amount we return a cursor in addition to the rows in the body. This cursor given can be used with this parameter to fetch the next set of ledgers. If this is used, no other parameters is needed. |
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). The access token is fetched from the |
Vipps-System-Name | string <= 30 characters Example: woocommerce The name of the ecommerce solution. One word in lowercase letters is good. See http-headers. |
Vipps-System-Version | string <= 30 characters Example: 5.4.0 The version number of the ecommerce solution. See http-headers. |
Vipps-System-Plugin-Name | string <= 30 characters Example: vipps-woocommerce The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers. |
Vipps-System-Plugin-Version | string <= 30 characters Example: 1.2.1 The version number of the ecommerce plugin (if applicable). See http-headers. |
Responses
Response samples
- 200
- 500
- default
{- "cursor": "eyJhZnRlckxlZGdlcklkIjoieHh4eCIsInNldHRsZXNGb3JSZWNpcGllbnRIYW5kbGVzIjpudWxsfQ==",
- "items": [
- {
- "ledgerId": "302321",
- "currency": "NOK",
- "payoutBankAccount": {
- "scheme": "BBAN:NO",
- "id": "86011117947"
}, - "firstPayout": "2000001",
- "lastPayout": "2000045",
- "owner": {
- "scheme": "business:NO:ORG",
- "id": "987654321"
}, - "settlesForRecipientHandles": [
- "api:123455"
]
}
]
}
Fetch report by date
Complete report of entries on an account for a given "ledger date". A "ledger date" normally lasts from midnight to midnight in the timezone of the merchant; but it can be configured to other cutoffs such as 04:00 to 04:00. The caller should periodically poll for a report for the next date to download, and interpret HTTP 404 as a signal to try again later.
path Parameters
ledgerId required | string Ledger ID provided by GET:/settlement/v1/ledgers |
ledgerDate required | string^\d{4}-\d{2}-\d{2} Date in format yyyy-MM-dd |
account required | string Enum: "funds" "fees" One of |
query Parameters
cursor | string Example: cursor=eyJhZnRlckxlZGdlcklkIjoieHh4eCIsInNldHRsZXNGb3JSZWNpcGllbnRIYW5kbGVzIjpudWxsfQ== We limit the amount of rows returned to reduce the amount of data we need to process on each request. If the total number of rows is greater 'than that amount we return a cursor in addition to the rows in the body. This cursor given can be used with this parameter to fetch the next set of ledgers. If this is used, no other parameters is needed. |
header Parameters
Vipps-System-Name | string <= 30 characters Example: woocommerce The name of the ecommerce solution. One word in lowercase letters is good. See http-headers. |
Vipps-System-Version | string <= 30 characters Example: 5.4.0 The version number of the ecommerce solution. See http-headers. |
Vipps-System-Plugin-Name | string <= 30 characters Example: vipps-woocommerce The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers. |
Vipps-System-Plugin-Version | string <= 30 characters Example: 1.2.1 The version number of the ecommerce plugin (if applicable). See http-headers. |
Responses
Response samples
- 200
- 401
- 500
- default
{- "cursor": "eyJsZWRnZXJJZCI6Inh4eCIsInN0YXJ0VHJhbnNhY3Rpb25JZCI6IjAwMDAwMDAwMDEiLCJzdGFydFRpbWUiOiIyMDIwLTExLTIwVDE0OjEzOjM4LjU3MDgzN1oiLCJlbmRUaW1lIjpudWxsLCJzdGFydExlZGdlckRhdGUiOiIyMDIwLTExLTIwIiwiZW5kTGVkZ2VyRGF0ZSI6bnVsbH0=",
- "items": [
- {
- "pspReference": "3343121302",
- "time": "2020-10-05T10:21:54.141089+0200",
- "ledgerDate": "2020-10-05",
- "entryType": "refund",
- "reference": "Vipps utbet. 2000023",
- "currency": "NOK",
- "amount": 49900,
- "balanceBefore": 49900,
- "balanceAfter": 49900,
- "recipientHandle": "NO:123455"
}
], - "tryLater": false
}
Fetch report by feed
Continuous stream of data. Upon reaching the end of the feed, the cursor
will not become empty and items
can
become an empty list. One should retry to fetch the same cursor
until new data and a new cursor
will be returned.
Unless in the need of data with low latency try not to poll the endpoint too often and effectively batch your reports.
path Parameters
ledgerId required | string Ledger ID provided by GET:/settlement/v1/ledgers |
account required | string Enum: "funds" "fees" One of |
query Parameters
cursor | string Example: cursor=eyJhZnRlckxlZGdlcklkIjoieHh4eCIsInNldHRsZXNGb3JSZWNpcGllbnRIYW5kbGVzIjpudWxsfQ== We limit the amount of rows returned to reduce the amount of data we need to process on each request. If the total number of rows is greater than that amount we return a cursor in addition to the rows in the body. This cursor given can be used with this parameter to fetch the next set of ledgers. If this is used, no other parameters is needed. |
header Parameters
Vipps-System-Name | string <= 30 characters Example: woocommerce The name of the ecommerce solution. One word in lowercase letters is good. See http-headers. |
Vipps-System-Version | string <= 30 characters Example: 5.4.0 The version number of the ecommerce solution. See http-headers. |
Vipps-System-Plugin-Name | string <= 30 characters Example: vipps-woocommerce The name of the ecommerce plugin (if applicable). One word in lowercase letters is good. See http-headers. |
Vipps-System-Plugin-Version | string <= 30 characters Example: 1.2.1 The version number of the ecommerce plugin (if applicable). See http-headers. |
Responses
Response samples
- 200
- 401
- 500
- default
{- "cursor": "eyJsZWRnZXJJZCI6Inh4eCIsInN0YXJ0VHJhbnNhY3Rpb25JZCI6IjAwMDAwMDAwMDEiLCJzdGFydFRpbWUiOiIyMDIwLTExLTIwVDE0OjEzOjM4LjU3MDgzN1oiLCJlbmRUaW1lIjpudWxsLCJzdGFydExlZGdlckRhdGUiOiIyMDIwLTExLTIwIiwiZW5kTGVkZ2VyRGF0ZSI6bnVsbH0=",
- "items": [
- {
- "pspReference": "3343121302",
- "time": "2020-10-05T10:21:54.141089+0200",
- "ledgerDate": "2020-10-05",
- "entryType": "refund",
- "reference": "Vipps utbet. 2000023",
- "currency": "NOK",
- "amount": 49900,
- "balanceBefore": 49900,
- "balanceAfter": 49900,
- "recipientHandle": "NO:123455"
}
], - "tryLater": false
}