GET transactions Request

The GET transactions request is a “reverse webhook” (meaning, it is triggered by Nuvei not the Marketplace Platform), which is used to retrieve the transactions (order records) from a URL endpoint on the Marketplace Platform’s server.
The request is filtered for a specific processing/reporting period, where the order record date_created must be between the start_date and end_date parameters:

GET /v1/transactions?{start_date}&{end_date}&{seller_id}

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)
• seller_id  – The ID of the seller in the Marketplace Platform system. (optional)

Example:

Authorization: Basic base64(username:{apiKey})
GET https://DemoMarketplace.com/nuvei/v1/transactions?&start_date=2021-12-07&end_date=2022-02-28

The response contains a list of transactions that were created or updated during this the interval.

transactions Class

Each of these transactions is presented as a transactions class that includes the parameters described in the following table:

transactions Input Parameters

Example Responses of transactions Class

{
    "transactions": [
        {
            "amount": 200.00,
            "currency": "GBP",
            "date_created": "2021-04-12T05:45:39Z",
            "last_updated":"2021-04-26T05:45:39Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A",
            "payment_state": "PAID",
            "payment_batch_number": null,
            "refund_id": null,
            "seller_id": "1111",
            "seller_name": "Seller 1",
            "transaction_type": "ORDER_AMOUNT",
            "cart_id": "34991440"
        },
        {
            "amount": 16.00,
            "currency": "GBP",
            "date_created": "2021-04-12T05:45:39Z",
            "last_updated":"2021-04-26T05:45:39Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A",
            "payment_state": "PAID",
            "payment_batch_number": null,
            "refund_id": null,
            "seller_id": "1111",
            "seller_name": "Seller 1",
            "transaction_type": "COMMISSION_FEE",
            "cart_id": "34991440"
        },
        {
            "amount": 4.00,
            "currency": "GBP",
            "date_created": "2021-04-12T05:45:39Z",
            "last_updated":"2021-04-26T05:45:39Z",
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A",
            "payment_state": "PAID",
            "payment_batch_number": null,
            "refund_id": null,
            "seller_id": "1111",
            "seller_name": "Seller 1",
            "transaction_type": "COMMISSION_VAT",
            "cart_id": "34991440"
        },
    ],
    "total_count": 3
}

transaction_type Parameter

Each transactions class includes a transaction_type which represents “FROM:TO” Accounting Flows.
In the table below, for flows only showing one side, the second side is always the “Nuvei temporary holding account”.

transaction_type Descriptions

The final amount paid by the customer for an order is the sum of:

• ORDER_AMOUNT
• ORDER_AMOUNT_TAX
• ORDER_SHIPPING_AMOUNT
• ORDER_SHIPPING_AMOUNT_TAX

The final amount refunded to the customer for an order is the sum of:

• REFUND_ORDER_AMOUNT
• REFUND_ORDER_AMOUNT_TAX
• REFUND_ORDER_SHIPPING_AMOUNT
• REFUND_ORDER_SHIPPING_AMOUNT_TAX