Payout summary

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

Returns a summary of payouts for each currency code in a date range.

Parameters

200

400

Example

Parameters3 fields

• start_datestring · date-timerequiredin 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-timerequiredin 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 datetime 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.

200

Response14 fields

Payout summaries

• summary_total_fee_correction_amountinteger · int64required

  The total amount of fee correction, in minor units

• summary_payout_date_startstring · date-timerequired

  ISO 8601 formatted date-time string

• summary_total_release_amountinteger · int64required

  The total amount of money released from holdback, in minor units

• summary_settlement_currencystringrequired

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

• summary_payout_date_endstring · date-timerequired

  ISO 8601 formatted date-time string

• summary_total_tax_amountinteger · int64required

  The total amount of tax, in minor units

• summary_total_settlement_amountinteger · int64required

  The total amount of the settlement in question, in minor units

• summary_total_holdback_amountinteger · int64required

  The total amount of money withheld, in minor units

• summary_total_reversal_amountinteger · int64required

  The total amount of reversals, in minor units

• summary_total_return_amountinteger · int64required

  The total amount of returns, in minor units

• summary_total_fee_amountinteger · int64required

  The total amount of fees, in minor units

• summary_total_commission_amountinteger · int64required

  The total amount of commissions, in minor units

• summary_total_sale_amountinteger · int64required

  The total amount of sales, in minor units

• summary_total_repay_amountinteger · int64required

  The total amount of money that has been repaid by the merchant from the debt, in minor units

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/summary

Response200400

Response 200· Payout summaries

[
  {
    "summary_total_fee_correction_amount": 550,
    "summary_payout_date_start": "2016-12-14T07:52:26Z",
    "summary_total_release_amount": 550,
    "summary_settlement_currency": "USD",
    "summary_payout_date_end": "2016-12-14T07:52:26Z",
    "summary_total_tax_amount": 550,
    "summary_total_settlement_amount": 550,
    "summary_total_holdback_amount": 550,
    "summary_total_reversal_amount": 550,
    "summary_total_return_amount": 550,
    "summary_total_fee_amount": 500,
    "summary_total_commission_amount": 550,
    "summary_total_sale_amount": 500,
    "summary_total_repay_amount": 550
  }
]

18 linesCopy

Response 400· Bad request

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

7 linesCopy