Skip to content
CardzoneDevelopers
Navigation

PlayerLookupResponse

Fields

  • status
    found
    or
    not_found
    or
    unavailable
    or
    unsupported
    required

    found: show profile next to the entered ID and let the customer confirm it. not_found: the game reported that the ID does not exist, or it is malformed for the game. Ask the customer to check it; ordering is still allowed. unavailable: the game could not answer right now. Let the customer continue without a profile. unsupported: this product has no player lookup.

  • product_id
    string
    required
    format: uuid
  • recipient
    map of
    string
    required

    The recipient that was looked up, after trimming. Send the customer's own input when creating the order; the profile never replaces it.

  • profile
    object
    or null
    required

    Present only when status is found.

    • display_name
      string
      or null
      required

      In-game name to show the customer.

    • username
      string
      or null
      required

      Account handle, when the game has one separate from the name.

    • image_url
      string
      or null
      required

      Avatar URL, when the game's source exposes one.

      format: uri
  • product_code
    optional
    string
    or null

Type to search…

↑↓ navigate↵ selectEsc close