To use our API for Orders you have to authenticate. See our Authentication document for instructions on how authentication works.

This API is a REST service and has the following capabilities.

1 Get Settlements
- 1.1 Parameters
- 1.2 Example
  - 1.2.1 Response
2 GetTransactions
- 2.1 Parameters
- 2.2 Example
  - 2.2.1 Response

Get Settlements

Used to get settlements for a given period of time.

HTTP Verb: GET

Parameters

Parameter	Required	Description

Parameter	Required	Description
merchantId	true	Id of the specific merchant that is making the action. Must have access to merchantId.
dateFrom	true	Start of period.
dateTo	true	Start of period.

Example

https://externalapistaging.pei.is/api/settlements?merchantid=4&datefrom=2018-4-1&dateto=2018-4-30

Response

[
    {
        "settlementNumber": "0000000",
        "merchantId": 4,
        "settlementDate": "2018-04-05T08:40:09",
        "totalAmount": 8815,
        "depositAmount": 8864,
        "cancelledAmount": 0,
        "interest": 62,
        "discount": 0,
        "capitalIncomeTax": 13,
        "numberOfTransactions": 1,
        "numberOfClaims": 1,
        "numberOfCardTransactions": 0,
        "totalClaimAmount": 8815,
        "totalCardAmount": 0
    }
]

GetTransactions

Used to get settlement transactions

HTTP Verb: GET

Parameters

Parameter	Required	Description

Parameter	Required	Description
merchantId	true	Id of the specific merchant that is making the action. Must have access to merchantId.
settlementNumber	true	Id of the settlment as listed in Get Settlments

Example

https://externalapistaging.pei.is/api/settlements/transactions?merchantid=4&settlementnumber=0000000

Response

[
    {
        "settlementNumber": "0000000",
        "merchantId": 4,
        "settlementDate": "2018-04-05T08:40:09",
        "account": "123456789123",
        "paymentMethod": 0,
        "kaupId": 111111,
        "orderId": "asdfghjkl",
        "paymentNumber": "1/4",
        "dueDate": "2018-03-13T00:00:00",
        "finalDueDate": "2018-03-28T00:00:00",
        "buyerSsn": "0000000009",
        "billNumber": "000GKK8",
        "paymentDate": "2018-04-05T08:02:36",
        "principal": 8815,
        "cancelledAmount": 0,
        "interest": 62,
        "discount": 0,
        "capitalIncomeTax": 13,
        "depositAmount": 8864
    }
]