Pre-Settlement Transaction API

Information about all the transactions created or updated within a certain interval can be retrieved by using an action based on GET HTTP request. The response will contain a transaction list in JSON format that returns all the transactions that were created or updated in the interval start_date – end_date.

Only a limited amount of details for each transaction will be provided.

Definition: GET /v1/transactions?{start_date}&{end_date}

Where:
  • {start_date} – format: {Year(4)}-{month(2)}-{day(2)}T{Hour(2)}:{Minute(2)}:{Second(2)}Z)
  • {end_date} – format: {Year(4)}-{month(2)}-{day(2)}T{Hour(2)}:{Minute(2)}:{Second(2)}Z)

Request Model:

GET /v1/transactions?{start_date}&{end_date}
Authorization: Basic Pre-shared-APIKEY

Response Model:

{
    "transactions": [
        {
            "amount": 0.80,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "COMMISSION_VAT",
            "vat_rate": 22
        },
        {
            "amount": 3.33,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "COMMISSION_FEE",
            "vat_rate": 24
        },
        {
            "amount": 0,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "ORDER_SHIPPING_AMOUNT",
            "vat_rate": null
        },
        {
            "amount": 10.00,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id": "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "ORDER_AMOUNT",
            "vat_rate": null
        },
        {
            "amount": 1.60,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "COMMISSION_VAT",
            "vat_rate": 24
        },
        {
            "amount": 6.66,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "COMMISSION_FEE",
            "vat_rate": 24
        },
        {
            "amount": 0,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "ORDER_SHIPPING_AMOUNT",
            "vat_rate": null
        },
        {
            "amount": 10.00,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "shop_id": 6221,
            "shop_name": "Best Shop",
            "transaction_type": "ORDER_AMOUNT",
            "vat_rate": null
        }
    ],
    "total_count": 8
}

The transaction_type field contains the following information:

  • COMMISSION_VAT
  • COMMISSION_FEE
  • ORDER_SHIPPING_AMOUNT
  • ORDER_AMOUNT
  • MANUAL_CREDIT
  • MANUAL_CREDIT_VAT
  • ORDER_AMOUNT_TAX
  • ORDER_SHIPPING_AMOUNT_TAX
  • REFUND_ORDER_AMOUNT
  • REFUND_ORDER_SHIPPING_AMOUNT
  • REFUND_COMMISSION_FEE
  • REFUND_COMMISSION_VAT
  • REFUND_ORDER_AMOUNT_TAX
  • REFUND_ORDER_SHIPPING_AMOUNT_TAX
  • SUBSCRIPTION_FEE
  • SUBSCRIPTION_VAT

Only the transactions with payment_state = “PAID” will be settled in the current settlement cycle.