Skip to content
Docs
Get playground access
GET

List transactions in a payout

https://api.kustom.co/settlements/v1/transactions

Returns a collection of transactions.

Parameters4 fields
  • payment_referencestringoptionalin query

    The reference id of the payout

  • order_idstringoptionalin query

    The Kustom assigned order id reference

  • sizeinteger · int64optionalin query

    How many elements to include in the result. If no value for size is provided, a default of 20 will be used. A maximum of 500 can be set.

  • offsetinteger · int64optionalin query

    The current offset. Describes “where” in a collection the current starts.

200
Response34 fields

A collection of payouts

  • transactions[]array<object>required
    27 fields in transactions
    • amountinteger · int64required

      Total amount of the specific transaction, in minor units

    • capture_idstringoptional

      Each capture on an order is assigned a unique identifier, referred to as the capture_id, which is provided exclusively for sale and fee transactions. In instances of partial shipments, an order may undergo multiple captures, each of which is reflected as a separate transaction with its own unique capture_id. It’s important to note that for certain transaction types such as RETURNS and REVERSALS, where captures do not exist, the API will return empty strings for the capture_ID field.

    • merchant_reference1stringoptional

      Merchant assigned reference, typically a reference to an order management system id

    • sale_datestring · date-timerequired

      ISO 8601 formatted date-time string

    • typestringrequired

      The type of transaction.

      • COMMISSION
      • SALE
      • REVERSAL
      • RETURN
      • TAX
      • FEE
      • FEE_REFUND
      • CORRECTION
      • REVERSAL_MERCHANT_PROTECTION
      • CHARGE
      • CREDIT
      • HOLDBACK
      • +1 more
    • capture_datestring · date-timerequired

      ISO 8601 formatted date-time string

    • payment_referencestringoptional

      Reference to the specific payout the transaction is part of, if available.

    • order_idstring · uuidrequired

      The Kustom assigned order id reference

    • payoutstringoptional

      Link to the payout that this transaction is part of

    • refund_idstringoptional

      The Kustom assigned id reference of a specific refund

    • short_order_idstringoptional

      The Kustom assigned short order id reference

    • merchant_reference2stringoptional

      Merchant assigned reference, typically a reference to an order management system id

    • currency_codestringrequired

      ISO 4217 Currency Code. Like USD, EUR, AUD or GBP.

    • purchase_countrystringrequired

      ISO Alpha-2 Country Code

    • vat_rateintegeroptional

      VAT (Value added tax) rate on Kustom fees

    • vat_amountintegeroptional

      VAT (Value added tax) amount on Kustom fees, in minor units

    • shipping_countrystringoptional

      ISO Alpha-2 Country Code

    • initial_payment_method_typestringoptional

      Payment method the consumer chose during checkout

    • initial_number_of_installmentsintegeroptional

      Number of installments the consumer chose during checkout in case of installment payments

    • initial_payment_method_monthly_downpaymentsintegeroptional

      Number of monthly downpayments that were chosen during the checkout in case of installment payments.

    • merchant_capture_referencestringoptional

      Your internal reference to the capture, that has been submitted during capturing an order via API

    • merchant_refund_referencestringoptional

      Your internal reference to the refund, that has been submitted during refunding an order via API

    • detailed_typestringoptional

      Detailed description of the transaction type

      • COMMISSION
      • CREDITED_CORRECTION
      • PURCHASE_FEE_PERCENTAGE
      • PURCHASE_FEE_PERCENTAGE_REFUND
      • LATE_RETURN_FEE
      • PURCHASE_FEE_FIXED
      • EXPIRY_FEE_GROSS
      • EXPIRY_FEE
      • SERVICING_FEE
      • RETURN_FEE
      • EXTRA_INVOICE_FEE
      • PURCHASE_RETURN
      • +31 more
    • tax_in_currency_of_registration_countryintegeroptional

      The tax amount on the respective fee, converted into the currency of your registration country. In case you are a German merchant selling in another currency then EUR or a Swedish merchant selling in another currency then SEK, we convert the VAT amount on the Kustom fees into the currency of the country you are registered in, based on the exchange rate of the capture date.

    • currency_code_of_registration_countrystringoptional

      ISO 4217 Currency Code of the country you are registered in.

    • klarna_commentstringoptional

      Any additional information necessary to provide more context about the transaction.

    • reversal_referencestringoptional

      Unique internal identifier, known as DisputeKRN, assigned to each dispute by Kustom. This identifier includes a dispute category and a numeric code, enabling efficient tracking and management of the dispute’s status.

  • paginationobjectrequired
    5 fields in pagination
    • countinteger · int64required

      The amount of elements in the current result

    • totalinteger · int64optional

      The total amount of elements that are available

    • nextstringoptional

      The URI to the next “page” of results.

    • prevstringoptional

      The URI to the previous “page” of results.

    • offsetinteger · int64optional

      The current offset. Describes “where” in a collection the current starts.

400
Response3 fields

Bad request

  • error_codestringrequired

    ERROR_CODE

  • error_messages[]array<string>required

    Array of error messages

  • correlation_idstringrequired

    Unique id for this request used for troubleshooting.

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.