Prizes
/
Get Customer Prizes

Get Customer Prizes

GET
https://api.vivamo.co/v1/customers/{externalCustomerId}/prizes

Retrieve prize records for a customer. Defaults to the current calendar year. Pass taxYear to retrieve records from a different year. Results are sorted by date won, most recent first.

Path parameters

    externalCustomerId
    string
    Required
    The customer identifier you provided when creating the record.

Query parameters

    taxYear
    integer
    Filter by tax year. Defaults to the current year if omitted.
    Required range: 2000 <= x <= 2100

Response

List of prize records.
    prizes
    array of object
    A W-2G prize record for a customer.
      personalTaxType
      string
      The operator's personal tax type.
        bingo
        string
        horse_racing
        string
      taxYear
      integer
      Tax year derived from the `dateWon` field.
      Examples:2026
      status
      string
      Current filing status of the prize record.
      Examples:recorded
        recorded
        string
        submitted
        string
        filed
        string
      reportableWinnings
      number
      IRS Box 1: gross winnings amount.
      Examples:1500
      dateWon
      string
      IRS Box 2: date the prize was won.
      Examples:2026-02-15T00:00:00.000Z
      typeOfWager
      string
      IRS Box 3: type of wager (e.g. `bingo`, `horse_racing`).
      Examples:bingo
      federalIncomeTaxWithheld
      number
      IRS Box 4: federal income tax withheld. Defaults to `0`.
      race
      string
      IRS Box 6: race name. Required for horse racing prizes.
      winningsFromIdenticalWagers
      number
      IRS Box 7: winnings from identical wagers.
      wagerAmount
      number
      Wager amount. Used for the 300x multiplier validation on horse racing prizes.
      ticketOrCardNumber
      string
      IRS Box 5: ticket or card number. Required for bingo prizes.
      Examples:TICKET-001
      payerInitials
      string
      IRS Box 8: first person to initiate the payout.
      payerLocation
      string
      IRS Box 10: window or location where the payout was made.
      cashierOrWindow
      string
      Cashier or window identifier.
      createdAt
      string
      Timestamp when the prize record was created.
Built with