PayNow

BanResult

idFlakeIdRequired
banBanDtoOptional
Represents a ban that blocks customers matching any of its identities from purchasing in the store.
idFlakeIdRequired
created_atstringRequired
The date and time the ban was created.
created_byActorDtoRequired
Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.
idFlakeIdOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
enabledbooleanRequired
Indicates whether the ban is currently enforced.
identitiesBanIdentityDto[]Required
The identities the ban applies to. A customer matching any one of them is banned.
ban_typeenumRequired
Possible enum values
  • unknown
  • steam
  • ip
  • customer
  • customer_name
  • email
ban_type_valuestringRequired
The value to match for 'ban_type': the Steam ID, IP address, customer ID, customer name or email address respectively.
reasonstringRequired
The reason recorded for the ban.
store_idFlakeIdRequired
expires_atstringOptional
The date and time the ban lifts, or null when the ban is permanent.
updated_atstringOptional
The date and time the ban was last updated, or null when it has never been updated.
updated_byActorDtoOptional
Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.
idFlakeIdOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
store_idFlakeIdOptional
Example
{
  "id": "411486491630370816",
  "ban": {
    "id": "411486491630370816",
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "enabled": true,
    "identities": [
      {
        "ban_type": "unknown",
        "ban_type_value": "string"
      }
    ],
    "reason": "string",
    "store_id": "411486491630370816",
    "expires_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "updated_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    }
  },
  "store_id": "411486491630370816"
}