Skip to content
GAMPEONCreate
New project

Start a GAMPEONS purchase

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

The price comes from the server. The order expires after one hour.

Not available with access tokens.

Rate limit: 20 per hour 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
packageId
required
string
terms
required

Exact current purchase terms

string

Example generated

{
"packageId": "example",
"terms": "example"
}

Order

Media typeapplication/json
object
mode
required

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

string
Allowed values: off sandbox
order
required
object
id
required
string
packageId
required
string
coins
required

Amount in GAMPEONS

integer
priceCents
required

Euro cents

integer
currency
required
string
status
required
string
Allowed values: pending expired paid refunded charged_back
provider
required

sandbox: simulated payment with POST /v1/wallet/orders/:id/sandbox-pay. xsolla: Xsolla test payment through POST /v1/wallet/orders/:id/checkout.

string
Allowed values: sandbox xsolla
createdAt
required

Unix time in milliseconds

integer format: int64
expiresAt
required

Unix time in milliseconds

integer format: int64
paidAt
required
One of:

Unix time in milliseconds

integer format: int64
closedAt
required
One of:

Unix time in milliseconds

integer format: int64
withdrawableUntil
required
One of:

Set while the purchase can still be withdrawn

integer format: int64
checkout
required
object
provider
required

sandbox: simulated payment with POST /v1/wallet/orders/:id/sandbox-pay. xsolla: Xsolla test payment through POST /v1/wallet/orders/:id/checkout.

string
Allowed values: sandbox xsolla

Example

{
"mode": "off",
"order": {
"status": "pending",
"provider": "sandbox"
},
"checkout": {
"provider": "sandbox"
}
}

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, 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: monthly_limit, 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"
}

Error codes: terms_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"
}

Limit: 20 per hour 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