Skip to content
GAMPEONCreate
New project

Request a payout

POST
/v1/wallet/payouts
curl --request POST \
--url https://api.gampeon.com/v1/wallet/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: example' \
--data '{ "coins": 1 }'

Only earned GAMPEONS, from the minimum amount, one open request at a time. The rate is fixed at the time of the request.

Not available with access tokens.

Rate limit: 5 per day per account.

Idempotency-Key
required
string

Required. 8 to 100 characters (A-Z a-z 0-9 _ - : .). The same key with the same body returns the stored answer (replayed: true) without booking again.

Media typeapplication/json
object
coins
required
integer
>= 1

Example generated

{
"coins": 1
}

Requested

Media typeapplication/json
object
payout
required
object
id
required
string
coins
required

Amount in GAMPEONS

integer
rateMicros
required

Rate fixed when the payout was requested

integer
currency
required
string
amountCents
required

Euro cents

integer
status
required
string
Allowed values: requested paid rejected
provider
required
string
reason
required
One of:
string
createdAt
required

Unix time in milliseconds

integer format: int64
decidedAt
required
One of:

Unix time in milliseconds

integer format: int64
wallet
required
object
mode
required

off: payments are switched off. sandbox: payments are simulated, no real money moves.

string
Allowed values: off sandbox
balances
required
object
wallet
required

Bought or gifted. Spendable, never paid out

integer
pending
required

Earned, still in the holding period

integer
earned
required

Earned. Spendable and can be paid out

integer
payoutHold
required

Reserved for a payout request

integer
spendable
required

Wallet + earned

integer
locked
required

Locked after a chargeback. Buying, spending and payouts are blocked

boolean
sellerTerms
required

Seller terms accepted, prices can be set

boolean
payoutProgram
required
string
Allowed values: none pending approved rejected suspended
upcoming
required

Creator shares that unlock next

Array<object>
object
availableAt
required

Unix time in milliseconds

integer format: int64
coins
required

Amount in GAMPEONS

integer
limits
required
object
monthlyLimitCents
required

Euro cents

integer
usedCents
required

Spent or in open orders in the last 30 days

integer
rules
required
object
creatorShareBps
required

Creator share of each sale in basis points (7000 = 70 %)

integer
payoutRateMicros
required

Payout per earned GAMPEON in millionths of a euro (3800 = €0.0038)

integer
payoutCurrency
required
string
payoutMinCoins
required

Minimum payout

integer
holdDays
required

Days before a creator share can be spent or paid out

integer
withdrawalDays
required

Days to withdraw from an unused purchase

integer
monthlyLimitCents
required

Most an account can spend on GAMPEONS in 30 days

integer
minPrice
required

Lowest price for an item

integer
maxPrice
required

Highest price for an item

integer

Example

{
"payout": {
"status": "requested"
},
"wallet": {
"mode": "off",
"payoutProgram": "none"
}
}

Error codes: invalid_field, idempotency_key_required

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: unauthorized

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: token_not_allowed, payout_program_required, wallet_locked

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: below_minimum, payout_open, insufficient_funds, idempotency_conflict

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Limit: 5 per day per account. Error codes: rate_limited

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: payments_disabled

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Report a problem with this pageOther ways to give feedback