Skip to content
Documentation menu

Vouchereto API · v1

Settlements & reports

Captured redemptions are paid out weekly, per currency. Each settlement lists every redemption it contains.

How it works

  • A settlement covers the redemptions captured in one weekly period, per currency.
  • gross_minor is the sum captured, commission_minor your agreed commission, net_minor what we pay you.
  • Cancelled and expired reservations are never included. Captures are final, so a settlement never changes after it is created.

API

GET /v1/settlements returns your latest 100 settlements, newest first. Test keys always get an empty list: no money moves in the sandbox.

list settlements
GET /v1/settlements

{
  "data": [
    {
      "id": "8c51…",
      "object": "settlement",
      "currency": "USD",
      "period_start": "2026-10-12T00:00:00.000Z",
      "period_end": "2026-10-19T00:00:00.000Z",
      "gross_minor": 1250000,
      "commission_minor": 31250,
      "net_minor": 1218750,
      "status": "paid"
    }
  ],
  "pagination": { "has_more": false, "next_cursor": null }
}

CSV report

Download the line-level CSV of any settlement in the merchant portal → Settlements. One row per captured redemption:

vouchereto-settlement-8c51….csv
redemption_id,captured_at,customer_ref,voucher_last4,amount_minor,currency
f4e8b730-294e-4351-a85d-dc525dcadc18,2026-10-14T09:12:44.118Z,user_8842,2WNZ,5000,USD
2b91c0d2-7a55-4b0e-9a1f-3c3e2d9b8f20,2026-10-14T11:40:02.507Z,user_1203,M3QK,2500,USD
CSV columns
ColumnMeaning
redemption_idMatches the id you stored at reserve time
captured_atUTC
customer_refYour customer id
voucher_last4Last 4 characters of the code
amount_minorMinor units
currencyISO 4217