Get a payout request

curl --request GET \
  --url https://api.gameboost.com/v2/payouts/{payoutRequest} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": 123,
    "method": "<string>",
    "note": "<string>",
    "status": "requested",
    "requested_amount_eur": "<string>",
    "requested_amount_usd": "<string>",
    "received_amount_eur": "<string>",
    "received_amount_usd": "<string>",
    "is_warehouse": true,
    "created_at": 123,
    "updated_at": 123,
    "paid_at": 123,
    "rejected_at": 123,
    "completed_at": 123
  }
}

GET

payouts

{payoutRequest}

Get a payout request

curl --request GET \
  --url https://api.gameboost.com/v2/payouts/{payoutRequest} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": 123,
    "method": "<string>",
    "note": "<string>",
    "status": "requested",
    "requested_amount_eur": "<string>",
    "requested_amount_usd": "<string>",
    "received_amount_eur": "<string>",
    "received_amount_usd": "<string>",
    "is_warehouse": true,
    "created_at": 123,
    "updated_at": 123,
    "paid_at": 123,
    "rejected_at": 123,
    "completed_at": 123
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payoutRequest

string

required

The ID of the payout request. Can be retrieved from the list of payout requests.

Response

A single payout request

data

object

Payout request object representing a partner withdrawal request

Show child attributes

data.id

integer

Unique identifier for the payout request

data.method

string

Payment method for the payout (e.g., PayPal, bank transfer, cryptocurrency)

data.note

string | null

Optional note or description about the payout request

data.status

enum<string>

Current status of the payout request (requested, processing, completed, rejected, canceled)

Available options:

requested,

rejected,

processing,

completed,

canceled

data.requested_amount_eur

string

Amount requested for payout in EUR currency

data.requested_amount_usd

string

Amount requested for payout converted to USD

data.received_amount_eur

string

Final amount received after fees and processing in EUR

data.received_amount_usd

string

Final amount received after fees and processing in USD

data.is_warehouse

boolean

Indicates if this payout is from warehouse balance instead of main balance

data.created_at

integer

Unix timestamp when the payout request was created

data.updated_at

integer

Unix timestamp of the last modification to the payout request

data.paid_at

integer | null

Unix timestamp when the payout was processed and paid

data.rejected_at

integer | null

Unix timestamp when the payout request was rejected

data.completed_at

integer | null

Unix timestamp when the payout was successfully completed

List payout requests Account Order Purchased

⌘I

Getting Started

REST API

Webhooks

Get a payout request

Authorizations

Path Parameters

Response