Description: Fetch player payments
Ratelimit: 5 per 10s
Scope: payments.read
Required parameters
Name Type Description
serverId number The server id
uuid string The player uuid
Query parameters
Name Type Description Default
only-completed boolean If you wan't to fetch only completed payments false
status string The status of the payments you wan't to fetch (enum: complete | declined | refund | chargeback | paymentProcessing) All status
page number The page number (min: 1) 1
perpage number The limit of elements per page (min: 1, max: 100) 10
search string The search query (only first 50 characters will be considered) ❌
sortby string The column to sort by id
sortdir string The direction to sort by (enum: asc | desc) desc
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_ONLY-COMPLETED The value doesn't follow the requirements
400 INVALID_PAGE The value doesn't follow the requirements
400 INVALID_PERPAGE The value doesn't follow the requirements
400 INVALID_SEARCH The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_SORTBY The value doesn't follow the requirements
400 INVALID_SORTDIR The value doesn't follow the requirements
400 INVALID_STATUS The value doesn't follow the requirements
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 PLAYER_NOT_FOUND The uuid doesn't refer to an existing player
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data[]:
    • id: string
    • packageName: string
    • packagePrice: number
    • packageId: number
    • paymentId: number
    • currency: string
    • amount: number
    • status: string
    • date: date
  • pagination:
    • currentPage: number
    • perPage: number
    • total: number
    • totalFiltered: number
    • totalOnPage: number
    • sort:
      • by: string
      • dir:
    • search: string | null