Sandbox

A simulated chain for your sandbox vault: deposits, withdrawals and claims, recorded as if confirmed on-chain. Not in production.

Read the sandbox vault

GET/v1/sandbox/vault

What your sandbox vault holds, per asset, and what's free: not reserved for rewards.

Responses

Deposit into the sandbox vault

POST/v1/sandbox/deposits

Records a deposit into your sandbox vault, as if confirmed on-chain, and sends a vault.deposit_confirmed webhook. Rewards are reserved from the vault, so fund it first; rewards waiting for funds are paid from a deposit, oldest first. The same reference again, unchanged, changes nothing.

Request Body

application/json

referenceRequired

string·min 1·max 128

amountRequired

object

Responses

Withdraw from the sandbox vault

POST/v1/sandbox/withdrawals

Records a withdrawal of free money from your sandbox vault, and sends a vault.withdrawal_confirmed webhook. Money reserved for rewards can't be withdrawn.

Request Body

application/json

referenceRequired

string·min 1·max 128

amountRequired

object

Responses

Simulate a claim

POST/v1/sandbox/claims

Records your vault paying a user part or all of what they can claim, as if confirmed on-chain. Their claimable rewards are paid oldest first, and each sends a reward.claimed webhook. Applied in order with the user's spend events, right after the answer.

Request Body

application/json

referenceRequired

string·min 1·max 128

userIdRequired

string·min 1·max 128

amountRequired

object

Read the sandbox vault

Responses

200Your sandbox vault, per asset: all it holds, and what's free, not reserved for rewards.

Show Child AttributesHide Child Attributes

400`InvalidRequest`: the request doesn't match the API. `part` says where: Payload, Query, Params or Headers.

401`Unauthorized`: the `x-api-key` header is missing, or isn't an active key.

403`IntegratorSuspended`: your integrator is suspended. Contact Gave.

429`RateLimited`: too many requests for this key, or too many failed authentications. Retry after `retryAfterSeconds`.

503`Unavailable`: Gave couldn't complete the request right now. Retry the same request, with backoff.

Deposit into the sandbox vault

Request Body

Show Child AttributesHide Child Attributes

Responses

200The simulated transaction is recorded. `duplicate` is true when this exact one was sent before: nothing changed.

400`InvalidRequest`: the request doesn't match the API. `part` says where: Payload, Query, Params or Headers.

401`Unauthorized`: the `x-api-key` header is missing, or isn't an active key.

403`IntegratorSuspended`: your integrator is suspended. Contact Gave.

409`SimulationConflict`: this reference was used with other content. Use a new reference.

422`SimulationRefused`: the vault refuses it, as the real one will: a withdrawal of money reserved for rewards, or a claim of more than the user can claim.

429`RateLimited`: too many requests for this key, or too many failed authentications. Retry after `retryAfterSeconds`.

503`Unavailable`: Gave couldn't complete the request right now. Retry the same request, with backoff.

Withdraw from the sandbox vault

Request Body

Show Child AttributesHide Child Attributes

Responses

200The simulated transaction is recorded. `duplicate` is true when this exact one was sent before: nothing changed.

400`InvalidRequest`: the request doesn't match the API. `part` says where: Payload, Query, Params or Headers.

401`Unauthorized`: the `x-api-key` header is missing, or isn't an active key.

403`IntegratorSuspended`: your integrator is suspended. Contact Gave.

409`SimulationConflict`: this reference was used with other content. Use a new reference.

422`SimulationRefused`: the vault refuses it, as the real one will: a withdrawal of money reserved for rewards, or a claim of more than the user can claim.

429`RateLimited`: too many requests for this key, or too many failed authentications. Retry after `retryAfterSeconds`.

503`Unavailable`: Gave couldn't complete the request right now. Retry the same request, with backoff.

Simulate a claim

Request Body

Show Child AttributesHide Child Attributes

Responses

202The simulated transaction is recorded. `duplicate` is true when this exact one was sent before: nothing changed.

400`InvalidRequest`: the request doesn't match the API. `part` says where: Payload, Query, Params or Headers.

401`Unauthorized`: the `x-api-key` header is missing, or isn't an active key.

403`IntegratorSuspended`: your integrator is suspended. Contact Gave.

409`SimulationConflict`: this reference was used with other content. Use a new reference.

422`SimulationRefused`: the vault refuses it, as the real one will: a withdrawal of money reserved for rewards, or a claim of more than the user can claim. | `UserNotEnrolled`: enroll the user with `PUT /v1/users/{userId}` first.

429`RateLimited`: too many requests for this key, or too many failed authentications. Retry after `retryAfterSeconds`.

503`Unavailable`: Gave couldn't complete the request right now. Retry the same request, with backoff.