Get a payouts summary (CSV)

https://api.kustom.co/settlements/v1/reports/payout-with-transactions

More information about this CSV format is available at: https://docs.kustom.co/contents/order-management/settlements/settlement-reports

Parameters

200

400

404

Example

Parameters1 field

• payment_referencestringrequiredin query

  The reference id of the payout

200

Response0 fields

A payout

No response body — this status returns headers only.

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.

404

Response3 fields

Not found

• 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/reports/payout-with-transactions

Response200400404

Response 200· A payout

No response body.

This status returns headers only — there is nothing to parse.

—

Response 400· Bad request

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

7 linesCopy

Response 404· Not found

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

7 linesCopy