Bans

Get Bans

GEThttps://api.paynow.gg/v1/stores/{storeId}/bans

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Query parameters

ban_typeenumOptional

ban_type_valuestringOptional

reasonstringOptional

limitintegerOptional

The maximum number of items to return in a single request.

afterFlakeIdOptional

Returns items after the specified ID. Used for forward pagination through results.

beforeFlakeIdOptional

Returns items before the specified ID. Used for backward pagination through results.

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Response

200OKBanDto[]

Show fields

created_atstringRequired

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

enabledbooleanRequired

idFlakeIdRequired

identitiesBanIdentityDto[]Required

ban_typeenumRequired

Possible enum values

unknown
steam
ip
customer
customer_name
email

ban_type_valuestringRequired

reasonstringRequired

store_idFlakeIdRequired

expires_atstringOptional

updated_atstringOptional

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/bans" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.bans.getBans();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/bans", headers=headers)

Response200

[
  {
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "enabled": true,
    "id": "411486491630370816",
    "identities": [
      {
        "ban_type": "unknown",
        "ban_type_value": "string"
      }
    ],
    "reason": "string",
    "store_id": "411486491630370816",
    "updated_at": "2024-01-01T00:00:00Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "expires_at": "2024-01-01T00:00:00Z"
  }
]

Create Ban

POSThttps://api.paynow.gg/v1/stores/{storeId}/bans

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Request body

expires_atstringOptional

identitiesBanIdentityDto[]Optional

ban_typeenumRequired

Possible enum values

unknown
steam
ip
customer
customer_name
email

ban_type_valuestringRequired

reasonstringOptional

Response

201CreatedBanDto

Show fields

created_atstringRequired

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

enabledbooleanRequired

idFlakeIdRequired

identitiesBanIdentityDto[]Required

ban_typeenumRequired

Possible enum values

unknown
steam
ip
customer
customer_name
email

ban_type_valuestringRequired

reasonstringRequired

store_idFlakeIdRequired

expires_atstringOptional

updated_atstringOptional

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/bans" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string",
  "identities": [
    {
      "ban_type": "unknown",
      "ban_type_value": "string"
    }
  ],
  "expires_at": "2024-01-01T00:00:00Z"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.bans.createBan({
  reason: "string",
  identities: [
    {
      ban_type: "unknown",
      ban_type_value: "string",
    },
  ],
  expires_at: "2024-01-01T00:00:00Z",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "reason": "string",
    "identities": [
        {
            "ban_type": "unknown",
            "ban_type_value": "string",
        },
    ],
    "expires_at": "2024-01-01T00:00:00Z",
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/bans", headers=headers, json=payload)

Response201

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "enabled": true,
  "id": "411486491630370816",
  "identities": [
    {
      "ban_type": "unknown",
      "ban_type_value": "string"
    }
  ],
  "reason": "string",
  "store_id": "411486491630370816",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "expires_at": "2024-01-01T00:00:00Z"
}

Get Ban

GEThttps://api.paynow.gg/v1/stores/{storeId}/bans/{banId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

banIdFlakeIdRequired

Response

200OKBanDto

Show fields

created_atstringRequired

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

enabledbooleanRequired

idFlakeIdRequired

identitiesBanIdentityDto[]Required

ban_typeenumRequired

Possible enum values

unknown
steam
ip
customer
customer_name
email

ban_type_valuestringRequired

reasonstringRequired

store_idFlakeIdRequired

expires_atstringOptional

updated_atstringOptional

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/bans/{banId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.bans.getBan("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/bans/{banId}", headers=headers)

Response200

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "enabled": true,
  "id": "411486491630370816",
  "identities": [
    {
      "ban_type": "unknown",
      "ban_type_value": "string"
    }
  ],
  "reason": "string",
  "store_id": "411486491630370816",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "expires_at": "2024-01-01T00:00:00Z"
}

Update Ban

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/bans/{banId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

banIdFlakeIdRequired

Request body

expires_atstringOptional

identitiesBanIdentityDto[]Optional

ban_typeenumRequired

Possible enum values

unknown
steam
ip
customer
customer_name
email

ban_type_valuestringRequired

reasonstringOptional

Response

200OKBanDto

Show fields

created_atstringRequired

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

enabledbooleanRequired

idFlakeIdRequired

identitiesBanIdentityDto[]Required

ban_typeenumRequired

Possible enum values

unknown
steam
ip
customer
customer_name
email

ban_type_valuestringRequired

reasonstringRequired

store_idFlakeIdRequired

expires_atstringOptional

updated_atstringOptional

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/bans/{banId}" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string",
  "identities": [
    {
      "ban_type": "unknown",
      "ban_type_value": "string"
    }
  ],
  "expires_at": "2024-01-01T00:00:00Z"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.bans.updateBan("411486491630370816", {
  reason: "string",
  identities: [
    {
      ban_type: "unknown",
      ban_type_value: "string",
    },
  ],
  expires_at: "2024-01-01T00:00:00Z",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "reason": "string",
    "identities": [
        {
            "ban_type": "unknown",
            "ban_type_value": "string",
        },
    ],
    "expires_at": "2024-01-01T00:00:00Z",
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/bans/{banId}", headers=headers, json=payload)

Response200

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "enabled": true,
  "id": "411486491630370816",
  "identities": [
    {
      "ban_type": "unknown",
      "ban_type_value": "string"
    }
  ],
  "reason": "string",
  "store_id": "411486491630370816",
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "expires_at": "2024-01-01T00:00:00Z"
}

Delete Ban

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/bans/{banId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

banIdFlakeIdRequired

Response

204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/bans/{banId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.bans.deleteBan("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/bans/{banId}", headers=headers)

Check For Ban By Identities

POSThttps://api.paynow.gg/v1/stores/{storeId}/bans/check

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Request body

identitiesBanIdentityDto[]Required

ban_typeenumRequired

Possible enum values

unknown
steam
ip
customer
customer_name
email

ban_type_valuestringRequired

Response

200OKCheckForBanIDByIdentitiesResponseDto

Show fields

is_bannedbooleanRequired

ban_idFlakeIdOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/bans/check" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "identities": [
    {
      "ban_type": "unknown",
      "ban_type_value": "string"
    }
  ]
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.bans.checkForBanByIdentities({
  identities: [
    {
      ban_type: "unknown",
      ban_type_value: "string",
    },
  ],
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "identities": [
        {
            "ban_type": "unknown",
            "ban_type_value": "string",
        },
    ],
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/bans/check", headers=headers, json=payload)

Response200

{
  "is_banned": true,
  "ban_id": "411486491630370816"
}