Skip to content
GAMPEONCreate
GAMPEON on Discord
New project

Sandbox: simulate a payment

POST
/v1/wallet/orders/{id}/sandbox-pay
curl --request POST \
  --url https://api.gampeon.com/v1/wallet/orders/example/sandbox-pay \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

Only in sandbox mode with simulated payments (provider: sandbox). Stands in for the payment provider confirming the payment and credits the GAMPEONS.

Not available with access tokens.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Order ID (ord_…)

Header Parameters

Section titled “Header Parameters”
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.

Responses

Section titled “Responses”

200

Section titled “200”

Paid

Media typeapplication/json
object
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
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 

{
  "order": {
    "status": "pending",
    "provider": "sandbox"
  },
  "wallet": {
    "mode": "off",
    "payoutProgram": "none"
  }
}

400

Section titled “400”

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

401

Section titled “401”

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"
}

403

Section titled “403”

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"
}

404

Section titled “404”

Error codes: not_found

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"
}

409

Section titled “409”

Error codes: order_not_pending, order_expired, 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"
}

503

Section titled “503”

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