Skip to content

    Reporting API

    The Reporting API enables you to retrieve information about payouts and their associated payments programmatically. A payout is an amount that Nets pays to you. A payment is either an ordinary payment from one of your customers or a deposit from you to Nets to adjust the balance on your Nets account. The data that can be retrieved using this API corresponds to the information accessible from the Payouts section in Easy Portal.

    This API is an idempotent REST API for retrieving data from Nets. It contains no methods to create or modify resources. All requests require a valid authorization header.

    The code samples contain the test environment's base address. Make sure to replace that base address with the corresponding live environment address.

    Scroll down for code samples, example requests and responses.
    Select a language for code samples from the tabs or the mobile navigation menu.

    Retrieve payouts

    GET /report/v1/payouts

    Retrieves the payouts for a given date range. This method supports pagination. Specify the range of payouts to retrieve by using pageNumber together with pageSize. The total number of payouts is returned in the response property named numberOfPayouts, which you can use to decide if there are more payouts beyond the requested range.

    Parameters

    • Authorizationstringrequired

      The secret API key.

    • merchantNumberinteger (int64)optional

      The merchant number. Use this parameter only if you are a Nets partner using the service with your partner API key.

    • currencystringoptional

      Include only payouts with the specified currency. If not specified, payouts of all currencies are returned. Should be formatted according to an ISO 4217 3-letter currency code, for example 'SEK'.

    • fromDatestring (date)required

      The starting date of the report period, for example '2018-01-01'. Should be formatted according to the definition of full-date in RFC3339.

    • toDatestring (date)required

      The ending date of the report period, for example '2018-12-31'. Should be formatted according to the definition of full-date in RFC3339.

    • pageNumberinteger (int32)optional

      The page number to be retrieved (zero-based). Default value is 0 (first page). See also pageSize.

    • pageSizeinteger (int32)optional

      The size of each page. Default value is 100. See also pageNumber.

    Retrieve payouts

    var client = new RestClient("https://test.api.dibspayment.eu/report/v1/payouts?merchantNumber=SOME_INTEGER_VALUE&currency=SOME_STRING_VALUE&fromDate=SOME_STRING_VALUE&toDate=SOME_STRING_VALUE&pageNumber=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE");
    var request = new RestRequest(Method.GET);
    request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
    IRestResponse response = client.Execute(request);

    Responses

    • 200SUCCESSoptional
      • numberOfPayoutsinteger (int32)optional

        The total number of payouts matching the specified date and currency criteria in the request. Use this property to decided if there are more items to fetch beyond the requested range.

      • payoutsarrayoptional

        The array of payouts objects.

        • idstringoptional

          The unique payout identifier (a UUID).

        • referencestringoptional

          The reference used on bank account statements.

        • datestring (date)optional

          The date of the payout, for example '2021-03-21'. Should be formatted according to the definition of full-date in RFC3339.

        • bankAccountIbanstringoptional

          The IBAN (Internaltional Bank Account Number) of the bank account that received the payout from Nets.

        • bankAccountBicstringoptional

          The BIC (Business Identifier Code) of the bank that holds the account that received the payout from Nets.

        • currencystringoptional

          The currency of the payout, for example 'SEK'.

        • amountinteger (int64)optional

          The total amount that has been paid to you, specified in the lowest monetary unit. For example, 9.99 USD is specified as 999.

        • chargedAmountinteger (int64)optional

          The sum of the amounts that have been charged by your customers. Specified in the lowest monetary unit, for example, 9.99 USD is specified as 999.

        • numberOfChargesinteger (int64)optional

          The total number of payment actions of type 'CHARGE' associated with this payout. See also paymentActions.paymentType.

        • refundedAmountinteger (int64)optional

          The sum of the amounts that have been refunded to your customers. Specified in the lowest monetary unit, for example, 9.99 USD is specified as 999.

        • numberOfRefundsinteger (int64)optional

          The total number of payment actions of type 'REFUND' associated with this payout. See also paymentActions.paymentType.

        • depositedAmountinteger (int64)optional

          The sum of the amounts that have been deposited by you. Specified in the lowest monetary unit, for example, 9.99 USD is specified as 999.

        • numberOfDepositsinteger (int64)optional

          The total number of payment actions of type 'DEPOSIT' associated with this payout. See also paymentActions.paymentType.

        • feesinteger (int64)optional

          The sum of all fees. Specified in the lowest monetary unit, for example, 9.99 USD is specified as 999.

        • feeVATpercentinteger (int64)deprecated

          Replaced by feeVATpercent.

        • feeTaxRateinteger (int64)optional

          Always 0 (zero) since there is no taxation on the fee. (Replaces the deprecated property feeVATpercent)

        • feeTaxAmountinteger (int64)optional

          Always 0 (zero) since there is no taxation on the fee.

        • transactionTaxDetailsarrayoptional

          A list of tax details for the payments related to this payout. Contains multiple elements in case tax rates vary.

          • rateinteger (int64)optional

            The tax/VAT rate (in percent multiplied by 100). For example, the value 2500 corresponds to 25%. Defaults to 0 if not provided.

          • amountinteger (int64)optional

            The tax/VAT amount specified in the lowest monetary unit. Defaults to 0 if not provided.

    • 400Bad Requestoptional
    • 401Unauthorizedoptional
    • 404Resource Not Foundoptional
    • 500Unexpected Erroroptional
      • messagestringoptional

        An internal error message. This message is not meant to be presented to end users. Instead, this message can be logged and used for debugging purposes.

      • codestringoptional

        A numeric error code to be used for debugging purposes.

      • sourcestringoptional

        The source of the error, for example: 'internal'.

    {
        "numberOfPayouts": 1,
        "payouts": [
            {
                "id": "11ebb9ef6a7d4df0b20d59ad574e9761",
                "reference": "1141004762",
                "date": "2021-05-21",
                "bankAccountIban": "AA00BBBB111111",
                "bankAccountBic": "AAAABBCCDDD",
                "currency": "SEK",
                "amount": 34303,
                "chargedAmount": 143550,
                "numberOfCharges": 4,
                "refundedAmount": 106050,
                "numberOfRefunds": 3,
                "fees": 3197,
                "feeVATpercent": 0,
                "feeTaxRate": 0,
                "feeTaxAmount": 0,
                "transactionTaxDetails": [
                    {
                        "rate": 0,
                        "amount": 0
                    },
                    {
                        "rate": 2500,
                        "amount": 7500
                    }
                ]
            }
        ]
    }

    Retrieve payout details

    GET /report/v1/payouts/{id}

    Retrieves details for the specified payout. A payout always relates to one or more payment actions. The payment actions are included in the response and support pagination. Specify the range of actions to retrieve by using pageNumber together with pageSize. The total number of payment actions is returned in the response property named numberOfPaymentActions which you can use to decided if there are more items beyond the requested range.

    Parameters

    • Authorizationstringrequired

      The secret API key.

    • idstringrequired

      The unique identifier (a UUID) of the payout.

    • merchantNumberinteger (int64)required

      The merchant number. Use this parameter only if you are a Nets partner and uses the service with your partner API key.

    • pageNumberinteger (int32)optional

      The page number of the list of payment actions to be retrieved (zero-based). Default value is 0 (first page). See also pageSize.

    • pageSizeinteger (int32)optional

      The number of payment actions to be returned in each page. Default value is 100. See also pageNumber.

    Retrieve payout details

    var client = new RestClient("https://test.api.dibspayment.eu/report/v1/payouts/%7Bid%7D?merchantNumber=SOME_INTEGER_VALUE&pageNumber=SOME_INTEGER_VALUE&pageSize=SOME_INTEGER_VALUE");
    var request = new RestRequest(Method.GET);
    request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
    IRestResponse response = client.Execute(request);

    Responses

    • 200SUCCESSoptional
      • idstringoptional

        The unique payout identifier (a UUID).

      • referencestringoptional

        The reference used on bank account statements.

      • datestringoptional

        The date of the payout, for example '2021-03-21'. Should be formatted according to the definition of full-date in RFC3339.

      • bankAccountIbanstringoptional

        The IBAN (Internaltional Bank Account Number) of the bank account that the payout was addressed to.

      • bankAccountBicstringoptional

        The BIC (Business Identifier Code) of the bank that holds the account that received the payout from Nets.

      • currencystringoptional

        The currency of the payout formatted according to an ISO 4217 3-letter currency code, for example 'SEK'.

      • amountinteger (int64)optional

        The amount that was paid to you, specified in the lowest monetary unit. For example, 9.99 USD is specified as 999.

      • chargedAmountinteger (int64)optional

        The amount that your customer was charged. Specified in the lowest monetary unit, for example, 9.99 USD is specified as 999.

      • refundedAmountinteger (int64)optional

        The amount that was refunded to your customer. Specified in the lowest monetary unit, for example, 9.99 USD is specified as 999.

      • depositedAmountinteger (int64)optional

        The amount that was deposited by you. Specified in the lowest monetary unit, for example, 9.99 USD is specified as 999.

      • feesinteger (int64)optional

        The total amount of all fees added to the payment actions.

      • feeVATpercentinteger (int64)deprecated
      • feeTaxRateinteger (int64)optional

        Always 0 (zero) since there is no taxation on the fees. (Replaces the deprecated property feeVATpercent)

      • feeTaxAmountinteger (int64)optional

        Always 0 (zero) since there is no taxation on the fees.

      • transactionTaxDetailsarrayoptional

        A list of tax details for the payments related to this payout. Contains multiple elements in case tax rates vary.

        • rateinteger (int64)optional

          The tax/VAT rate (in percent multiplied by 100). For example, the value 2500 corresponds to 25%. Defaults to 0 if not provided.

        • amountinteger (int64)optional

          The tax/VAT amount specified in the lowest monetary unit. Defaults to 0 if not provided.

      • numberOfPaymentActionsinteger (int32)optional

        The total number of payment actions in this settlement. Use this property to decide if there are more items to retrieve beyond the requested range.

      • paymentActionsarrayoptional

        The list payment actions associated with this payout. Supports pagination by specifying pageNumber and pageSize in the request. See also numberOfPaymentActions.

        • idstringoptional

          The unique identifier (a UUID) of this payment action.

        • paymentIdstringoptional

          The payment identifier (a UUID).

        • paymentActionstringoptional

          The payment action. Possible values are: 'CHARGE', 'REFUND', and 'DEPOSIT'.

          CHARGE, REFUND, DEPOSIT

        • paymentMethodstringoptional

          The payment method that was used, for example 'PayPal' or 'Visa'.

        • paymentTypestringoptional

          The type of payment, for example 'CARD' or 'INVOICE'.

        • timestampstring (date-time)optional

          The date and time of the payment action, for example '2021-07-02T12:00:00.0000+02:00'.

        • referencestringoptional

          A reference to recognize the payment. Usually a number sequence (order number).

        • invoiceNumberstringoptional

          A number to identify an invoice.

        • amountinteger (int64)optional

          The total amount of the payment, specified in the lowest monetary unit. For example, 9.99 USD is specified as 999.

        • vatAmountinteger (int64)deprecated

          The VAT (value-added tax) of the payment, specified in the lowest monetary unit. For example, 9.99 USD is specified as 999.

        • currencystringoptional

          The currency of the payment, for example 'SEK'.

        • feeinteger (int64)optional

          The total fee amount of the payment, specified in the lowest monetary unit.

        • flexibleFeeinteger (int64)optional

          The flexible part of the fee, specified in the lowest monetary unit.

        • fixedFeeinteger (int64)optional

          The fixed part of the fee, specified in the lowest monetary unit.

        • feeVATpercentinteger (int64)deprecated

          Replaced by feeVATpercent.

        • feeTaxRateinteger (int64)optional

          Always 0 (zero) since tax is never added to the fee. (Replaces the deprecated property feeVATpercent)

        • feeTaxAmountinteger (int64)optional

          Always 0 (zero) since tax is never added to the fee.

        • transactionTaxDetailsarrayoptional

          A list of tax details. Contains multiple elements in case an order includes items with different tax rates.

          • rateinteger (int64)optional

            The tax/VAT rate (in percent multiplied by 100). For example, the value 2500 corresponds to 25%. Defaults to 0 if not provided.

          • amountinteger (int64)optional

            The tax/VAT amount specified in the lowest monetary unit. Defaults to 0 if not provided.

        • subscriptionIdstringoptional

          A subscription identifier.

    • 400Bad Requestoptional
    • 401Unauthorizedoptional
    • 404Resource Not Foundoptional
    • 500Unexpected Erroroptional
      • messagestringoptional

        An internal error message. This message is not meant to be presented to end users. Instead, this message can be logged and used for debugging purposes.

      • codestringoptional

        A numeric error code to be used for debugging purposes.

      • sourcestringoptional

        The source of the error, for example: 'internal'.

    {
        "id": "11ebb9ef6a7d4df0b20d59ad574e9761",
        "reference": "1141004762",
        "date": "2021-05-21",
        "bankAccountIban": "AA00BBBB1111111",
        "bankAccountBic": "AAAABBCCDDD",
        "currency": "SEK",
        "amount": 34303,
        "chargedAmount": 143550,
        "refundedAmount": 106050,
        "fees": 3197,
        "feeVATpercent": 0,
        "feeTaxRate": 0,
        "feeTaxAmount": 0,
        "transactionTaxDetails": [
            {
                "rate": 2500,
                "amount": 7500
            },
            {
                "rate": 0,
                "amount": 0
            }
        ],
        "numberOfPaymentActions": 7,
        "paymentActions": [
            {
                "id": "014d000060a6cb7b8f5e642e3ca552b0",
                "paymentId": "0008000060a6cb58859b391024b1f21a",
                "paymentAction": "CHARGE",
                "paymentMethod": "Visa",
                "paymentType": "CARD",
                "timestamp": "2021-05-20T20:50:03.269Z",
                "reference": "Monthly subscription",
                "amount": 37500,
                "vatAmount": 7500,
                "currency": "SEK",
                "fee": -475,
                "flexibleFee": -375,
                "fixedFee": -100,
                "feeVATpercent": 0,
                "feeTaxRate": 0,
                "feeTaxAmount": 0,
                "transactionTaxDetails": [
                    {
                        "rate": 2500,
                        "amount": 7500
                    }
                ],
                "subscriptionId": "a14ac89987f94f8bba08132a7ce6f1b1"
            }
        ]
    }