luniumpay-com Sandbox API
Fictitious financial journeys and deterministic simulation controls.
Fictitious financial journeys and deterministic simulation controls.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/luniumpay-com:luniumpay-com-sandbox-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Luniumpay Com Sandbox API
version: 1.48.0
contact:
name: Lunium
email: contato@luniumpay.com
url: https://luniumpay.com/integrar?utm_source=openapi&utm_medium=spec
x-documentation-revision: 2026-09-17.4
x-lunium-partners:
name: Lunium Partners — comunidade oficial de integradores
url: https://t.me/+FerOZMRRP_g5MDk5
description: Avisos operacionais, mudanças de contrato e troca entre parceiros. Nunca publique uma chave de API no grupo.
description: 'Operations tagged Sandbox across 2 of this provider''s published API definitions: api.json, luniumpay-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.luniumpay.com
description: Produção
security:
- ApiKey: []
tags:
- name: Sandbox
description: Fictitious financial journeys and deterministic simulation controls.
paths:
/sandbox:
get:
tags:
- Sandbox
summary: Discover sandbox capabilities
description: Supported journeys, scenarios by flow, QR semantics, limits and simulation control routes. Inclui cashout_depix e scenarios_by_flow.cashout_depix para DePix/Liquid → PIX.
security:
- ApiKeyAuth: []
responses:
'200':
description: Sandbox result; sandbox=true; no real funds move.
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
description: Missing or invalid key.
'403':
description: Requires a sandbox key.
'404':
description: Operation not found for this key.
'409':
description: State conflict or divergent idempotency parameters.
'503':
description: Simulator unavailable; never falls through to a real provider.
operationId: getSandbox
x-operation-id-source: derived
servers:
- url: https://api.luniumpay.com
description: Produção
/sandbox/cashin/{cashin_id}/pay:
post:
tags:
- Sandbox
summary: Simulate payment of a test PIX charge
description: Only the owning sandbox key can confirm. Replays never duplicate credits. This endpoint cannot confirm a production payment.
security:
- ApiKeyAuth: []
responses:
'200':
description: Sandbox result; sandbox=true; no real funds move.
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
description: Missing or invalid key.
'403':
description: Requires a sandbox key.
'404':
description: Operation not found for this key.
'409':
description: State conflict or divergent idempotency parameters.
'503':
description: Simulator unavailable; never falls through to a real provider.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
payer_tax_number:
type: string
description: Optional synthetic payer document; a mismatch simulates a refund.
required: []
parameters:
- name: cashin_id
in: path
required: true
schema:
type: string
operationId: postSandboxCashinByCashinIdPay
x-operation-id-source: derived
servers:
- url: https://api.luniumpay.com
description: Produção
/sandbox/operations/{operation_id}/resolve:
post:
tags:
- Sandbox
summary: Resolve an uncertain sandbox operation
description: Only a test operation already in an uncertain state can be resolved. Same outcome can be replayed safely. Para venda DePix, operation_id é o cashout_id sbx_..., criado com settlement_uncertain, já em PROCESSING. sent conclui; failed passa por REFUNDING e REFUNDED após cerca de 4 segundos.
security:
- ApiKeyAuth: []
responses:
'200':
description: Sandbox result; sandbox=true; no real funds move.
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: 'outcome ausente ou diferente de sent e failed: erro outcome_invalido, acao corrigir, sandbox=true. A checagem vem antes de procurar a operação, e nada muda no simulador (desde a 1.44.1; antes, um corpo sem outcome podia responder 200 sem resolver nada).'
content:
application/json:
schema:
$ref: '#/components/schemas/Erro'
example:
erro: outcome_invalido
acao: corrigir
detail: 'Informe outcome: sent ou failed.'
sandbox: true
'401':
description: Missing or invalid key.
'403':
description: Requires a sandbox key.
'404':
description: Operation not found for this key.
'409':
description: State conflict or divergent idempotency parameters.
'503':
description: Simulator unavailable; never falls through to a real provider.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
outcome:
type: string
enum:
- sent
- failed
required:
- outcome
parameters:
- name: operation_id
in: path
required: true
schema:
type: string
operationId: postSandboxOperationsByOperationIdResolve
x-operation-id-source: derived
servers:
- url: https://api.luniumpay.com
description: Produção
/sandbox/events:
get:
tags:
- Sandbox
summary: Inspect generated sandbox events
description: Returns generated events even if no webhook was configured. Use /webhooks/deliveries for actual callback attempts.
security:
- ApiKeyAuth: []
responses:
'200':
description: Sandbox result; sandbox=true; no real funds move.
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
description: Missing or invalid key.
'403':
description: Requires a sandbox key.
'404':
description: Operation not found for this key.
'409':
description: State conflict or divergent idempotency parameters.
'503':
description: Simulator unavailable; never falls through to a real provider.
parameters:
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 200
default: 50
operationId: getSandboxEvents
x-operation-id-source: derived
servers:
- url: https://api.luniumpay.com
description: Produção
/sandbox/reset:
post:
tags:
- Sandbox
summary: Reset this key’s fictitious state
description: Deletes only the owning key’s simulated state. Previously queued webhook deliveries retain their history. Production keys are refused.
security:
- ApiKeyAuth: []
responses:
'200':
description: Sandbox result; sandbox=true; no real funds move.
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
description: Missing or invalid key.
'403':
description: Requires a sandbox key.
'404':
description: Operation not found for this key.
'409':
description: State conflict or divergent idempotency parameters.
'503':
description: Simulator unavailable; never falls through to a real provider.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
confirm:
type: boolean
const: true
required:
- confirm
operationId: postSandboxReset
x-operation-id-source: derived
servers:
- url: https://api.luniumpay.com
description: Produção
/sandbox/qr/{cashin_id}.svg:
get:
tags:
- Sandbox
summary: Non-payable sandbox QR image
description: Encodes SANDBOX:NAO_PAGAVEL:; not a bank PIX code. No payment action or customer data.
security: []
parameters:
- name: cashin_id
in: path
required: true
schema:
type: string
pattern: ^ci_sbx_[a-f0-9]{24}$
responses:
'200':
description: Synthetic SVG QR.
content:
image/svg+xml:
schema:
type: string
operationId: getSandboxQr{cashinId}Svg
x-operation-id-source: derived
servers:
- url: https://api.luniumpay.com
description: Produção
components:
schemas:
Erro:
type: object
description: Erro da API; campos podem variar por caminho, inclusive respostas de infraestrutura. Combine código HTTP com erro e acao quando presentes; detail é para exibição, não decisão. Tolere códigos novos.
properties:
erro:
type: string
description: Codigo estavel de erro. Ramifique por ele, nunca pelo texto de detail. Esta lista e gerada a partir dos codigos que a API realmente emite.
x-known-values:
- amount_invalido
- asset_invalido
- br_code_indisponivel
- br_code_invalido
- br_code_sem_valor
- brl_amount_invalido
- campos_conflitantes
- campos_obrigatorios
- carencia_primeiro_deposito
- carteira_indisponivel
- carteira_nao_liberada
- cashin_indisponivel
- cashout_indisponivel
- catalogo_indisponivel
- chave_ausente
- chave_desconhecida
- chave_incorreta
- chave_nao_encontrada
- chave_obrigatoria
- conflito
- consulta_indisponivel
- corpo_grande_demais
- cotacao_divergente
- cotacao_expirada
- cotacao_indisponivel
- cotacao_recusada
- criacao_recusada
- custodia_desligada
- deposit_obrigatorio
- destino_invalido
- devolucao_indisponivel
- documento_invalido
- em_conciliacao
- em_processamento
- email_invalido
- email_obrigatorio
- endpoint_nao_respondeu
- erro_interno
- external_id_divergente
- formato_invalido
- funding_source_invalido
- ja_entregue
- limite_consultas
- limite_de_chaves_teste
- limite_diario
- limite_diario_recebedor
- limite_do_pagador
- limite_indisponivel
- liquidante_indisponivel
- mandate_contraparte_nao_autorizada
- mandate_valor_acima_do_teto
- memo_obrigatorio
- metodo_nao_permitido
- muitas_tentativas
- muitos_pedidos_abertos
- nao_autenticado
- nao_encontrado
- nao_permitido
- nao_processavel
- origem_igual_destino
- outcome_invalido
- pagador_bloqueado
- pagador_recusado_pelo_provedor
- pagamentos_indisponiveis
- payer_tax_invalido
- payer_tax_number_invalido
- payout_address_invalido
- payout_address_obrigatorio
- payout_nao_liberado
- payout_recusado
- pix_key_invalida
- pix_key_obrigatoria
- provedor_indisponivel
- provedor_sem_resposta
- rate_limit
- rede_indisponivel
- referencia_recusada
- refund_address_imutavel
- refund_address_invalida
- requisicao_invalida
- saldo_insuficiente
- sandbox_sem_cashin
- sandbox_sem_saldo
- sandbox_sem_saque
- saque_comissao_diario
- saque_indisponivel
- status_invalido
- tax_number_obrigatorio
- taxa_alterada
- tempo_esgotado
- temporariamente_indisponivel
- tipo_ambiguo
- valor_abaixo_do_minimo
- valor_acima_do_maximo
- valor_invalido
- webhook_nao_configurado
- webhook_url_invalida
acao:
type: string
enum:
- corrigir
- repetir
- esperar
- parar
- falar_com_suporte
description: 'corrigir = o pedido esta errado, repetir identico nunca funciona · repetir = falha transitoria nossa, tente de novo · esperar = cota renova, volte depois · parar = nao repita, fale com a gente · falar_com_suporte = nao repita em laco; preserve request_id e external_id e encaminhe a Lunium (ex.: config_provedor).'
detail:
type: string
description: Texto para humano. Nunca ramifique por ele.
limits:
type: object
description: Presente nos erros de limite, ja convertido na moeda da ordem.
docs:
type: string
format: uri
request_id:
type: string
description: Identificador desta requisicao. Vai tambem no header X-Request-ID e e o que citar no suporte. Se voce enviar X-Request-ID no formato [A-Za-z0-9._:-]{8,64}, ele e preservado de ponta a ponta.
examples:
- req_62f05f21b3794830a241
code:
type: string
deprecated: true
description: 'Alias LEGADO de `erro` — SUNSET: deixa de ser enviado em 2026-11-09. NAO ramifique por ele; use `erro` (canonico). Nunca vem sem `erro`.'
securitySchemes:
ApiKey:
type: apiKey
in: header
name: X-API-Key
description: Chave criada em `POST /keys`. Aparece uma única vez — guarde no momento da criação.
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: Your key. `lun_test_…` is sandbox (moves nothing); `lun_…` is production.
externalDocs:
description: Mínimos e máximos por moeda e rede
url: https://docs.luniumpay.com/minimos
x-refined-from:
- api.json
- luniumpay-com-openapi.json