GET

List all payouts

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

Returns a collection of payouts.

Parameters5 fields

start_datestring · date-timeoptionalin query
ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. For example 2020-01-23 -> 2020-01-23T00:00:00Z. For this reason we recommend too use the full datetime like 2020-01-23T00:00:00Z.
end_datestring · date-timeoptionalin query
ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults to the start of the day, ie 00:00:00. This might lead to unwanted side effects like when the start date and end date might be the same because it would request payouts between 2020-01-23T00:00:00Z and 2020-01-23T00:00:00Z. Instead we advise to use a full date time like 2020-01-23T23:59:59Z.
currency_codestringoptionalin query
An optional currency code to filter the result for different currencies. If not provided the result returned in the response might include multiple results grouped by the currency. The currency should be provided by an ISO 4217 Currency Code like USD, EUR, AUD or GBP.
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

Response33 fields

A collection of payouts

payouts[]array<object>required
26 fields in payouts
- totalsobjectrequired
  18 fields in totals
  - commission_amountinteger · int64required
    The total amount of commissions, in minor units
  - repay_amountinteger · int64required
    The total amount of money that has been repaid by the merchant from the debt, in minor units
  - sale_amountinteger · int64required
    The total amount of sales, in minor units
  - holdback_amountinteger · int64required
    The total amount of money withheld, in minor units
  - tax_amountinteger · int64optional
    The total amount of tax, in minor units
  - settlement_amountinteger · int64required
    The total amount of the settlement in question, in minor units
  - fee_correction_amountinteger · int64optional
    The total amount of fee correction, in minor units
  - reversal_amountinteger · int64required
    The total amount of reversals, in minor units
  - release_amountinteger · int64required
    The total amount of money released from holdback, in minor units
  - return_amountinteger · int64required
    The total amount of returns, in minor units
  - fee_amountinteger · int64required
    The total amount of fees, in minor units
  - charge_amountinteger · int64required
    The total amount of charges, in minor units. The additional field detailed_type contains the purpose of the charge
  - credit_amountinteger · int64required
    The total amount of credits, in minor units. The additional field detailed_type contains the purpose of the credit
  - fee_refund_amountinteger · int64required
    The total amount of refunded fees in a given settlement, in minor units.
  - tax_refund_amountinteger · int64required
    The total amount of refunded tax in a given settlement, in minor units.
  - deposit_amountinteger · int64required
    The increase of your debt balance with Kustom if your returns, fees, and other charges exceed your sales within this settlement period. This debt will be deducted from your next settlements and describes the amount that is increasing your debt balance, to be seen in the closing_debt_balance. In minor units.
  - opening_debt_balance_amountinteger · int64required
    Your negative balance with Kustom from previous settlements, if your returns, fees, and other charges exceeded your sales. This amount equals the closing_debt_balance of your last settlement unless Kustom has invoiced you separately for the amount. In minor units.
  - closing_debt_balance_amountinteger · int64required
    Your debt balance after the settlement. This amount will be the opening debt balance of your next settlement and helps you understand which amounts will be deducted from your next settlements. In minor units.
- payment_referencestringrequired
  The reference id of the payout
- payout_datestring · date-timerequired
  ISO 8601 formatted date-time string
- currency_codestringrequired
  ISO 4217 Currency Code. Like USD, EUR, AUD or GBP.
- currency_code_of_registration_countrystringoptional
  ISO 4217 Currency Code of the country you are registered in.
- merchant_settlement_typestringrequired
  Whether the amounts are net or gross
  - GROSS
  - NET
  - GROSS_FEE
- merchant_idstringrequired
  The merchant id
- transactionsstringoptional
  Link to the transactions that are part of this payout
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.

GET https://api.kustom.co/settlements/v1/payouts

Response 200· A collection of payouts

{
  "payouts": [
    {
      "totals": {
        "commission_amount": 550,
        "repay_amount": 550,
        "sale_amount": 500,
        "holdback_amount": 550,
        "tax_amount": 550,
        "settlement_amount": 550,
        "fee_correction_amount": 550,
        "reversal_amount": 550,
        "release_amount": 550,
        "return_amount": 550,
        "fee_amount": 500,
        "charge_amount": 500,
        "credit_amount": 500,
        "fee_refund_amount": 500,
        "tax_refund_amount": 500,
        "deposit_amount": 500,
        "opening_debt_balance_amount": 500,
        "closing_debt_balance_amount": 500
      },
      "payment_reference": "XISA93DJ",
      "payout_date": "2016-12-14T07:52:26Z",
      "currency_code": "USD",
      "currency_code_of_registration_country": "EUR",
      "merchant_settlement_type": "NET",
      "merchant_id": "<string>",
      "transactions": "https://{settlements_api}/transactions?payment_reference=XISA93DJ"
    }
  ],
  "pagination": {
    "count": 10,
    "total": 42,
    "next": "http://example.com/collection?offset=21&size=10",
    "prev": "http://example.com/collection?offset=0&size=10",
    "offset": 10
  }
}

40 lines

Response 400· Bad request

{
  "error_code": "<string>",
  "error_messages": [
    "<string>"
  ],
  "correlation_id": "2fe0311b-adc5-45e5-ac2b-963dac83c88b"
}

7 lines

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