Lunium。开发者
浏览与搜索接口
全部主题
LuniumPay 开发者文档 · 简体中文

API 参考文档

为中国企业及全球中文合作伙伴提供完整的 Pix、BRL 托管余额与加密资产接入说明。

API 1.44.7 · 66 项操作 · 60 条路径 · 中文版更新于2026年10月17日

开始使用

Lunium API 支持 Pix 收款、BRL 资金托管、加密资产交付、外部加密资产兑换 Pix,以及余额支付 Pix。托管收款须明确发送 destino=saldo,HTTP 收款单默认仍为 cripto。托管无需固定结算钱包。资产 / 网络可用性、费用、限额及资金冻结会动态变化,须查询对应密钥、余额、目录及预览接口。付款完成、结算及余额可用是不同状态。Pix 在可用时提供凭证 / E2E,不代表每笔加密资产交易都有这些字段。认证使用 X-API-Key。重试保持稳定 external_id 及相同 payload。公开付款核验:GET /v1/verificar/{e2e}。测试环境模拟 cash-in、资金托管、加密资产提现、Pix 对外付款、内部转账及 cash-out;通过 POST /sandbox/cashin/{cashin_id}/pay 确认不可真实付款的测试 Pix,不执行银行、交易所或链上交易。详见 https://docs.luniumpay.com/zh/sandbox 。错误可能包含 erro/acao/detail 及 request_id/agent_guidance,须兼容未知字段、事件及错误码。MCP:https://api.luniumpay.com/mcp,通过 tools/list 发现工具。手册:https://docs.luniumpay.com/zh/manual;英文版:https://docs.luniumpay.com/en/manual。本次文档对照已部署行为,金融请求字段保持原规范。AI 接入:https://docs.luniumpay.com/zh/integrar-com-ia;仅供测试的公共 MCP:https://api.luniumpay.com/mcp/onboarding;机器可读接入方案:https://docs.luniumpay.com/zh/integration.json 。2026年10月15日费率政策:余额充值每笔 R$ 1.00,无比例费用及佣金;直接购买 3.3% + R$ 1.00;余额兑换加密资产 3.3%,不再收取固定费用;余额通过 Pix 提现 1.5%。购买及转出另计合作伙伴佣金。参考汇率为 Binance 卖一价(ask),不加溢价;适用网络及处理成本在预览中列明。

基础地址:https://api.luniumpay.com。字段名、枚举、接口路径及示例原始值保持 API 规定的形式。BRL 为巴西雷亚尔,不是人民币。金额、限额、可用性及处理时间以当前密钥和具体交易的响应为准。

AI 智能体接入指南 · Lunium Mesh · 机器可读中文文档

Telegram 与运营支持

使用项目群及通知机器人跟踪运营;密钥与私有监控仅分享给授权人员。查看完整说明。

网络、限额与处理时间

各资产与网络的可用性、最低金额、费用及预计时间须在操作前查询。查看目录与限额。

幂等性与结果核对

创建前持久化操作意图与 external_id。重试时保留相同标识符及请求体;超时先查询原操作,不要重复付款。故障处理指南。

版本与变更

本中文参考依据 OpenAPI 1.44.7 生成,覆盖 66 项操作。下载现行规范,或查阅完整手册与历史变更记录。本次中文发布不代表执行过新的真实资金结算测试。

POST /leads

将商务或技术问题转交人工

公开接口,无需密钥,仅用于按量报价、合同、合作或文档未解决的场景。联系方式须由本人为本次联系提供,不应搜索、抓取或挪用其他用途的邮箱。无需人工联系即可开始测试:POST /keys/sandbox。

身份验证:无需 API 密钥

操作标识:contactIntegrationTeam

请求体

必填:是

application/json

字段类型必填说明
emailstring · email是

{"maxLength":200}

nomestring否

{"maxLength":120}

empresastring否

{"maxLength":120}

whatsappstring否

{"maxLength":40}

mensagemstring否

{"maxLength":1000}

fluxostring否

{"enum":["cashin","cashout","cashin_cashout","payout","outro","custody"]}

volume_mensalstring否

{"maxLength":60}

prazostring否

{"maxLength":60}

estagio_produtostring否

{"maxLength":60}

como_encontroustring否

用户自行申报的来源,与 UTM 分开,例如 chatgpt、google、indicacao。

consentimentoboolean是

确认用户提供联系方式,以接收对此次请求的回复。

{"const":true}

origemstring否

请求开始时所在页面或业务背景。

utm_sourcestring否
utm_mediumstring否
utm_campaignstring否
utm_contentstring否
utm_termstring否
ref_agentstring否
websitestring否

反垃圾隐藏字段,正常客户端应省略或留空。

示例 empresa_vinda_do_chatgpt

{
  "email": "integracao@empresa.com.br",
  "empresa": "Empresa Exemplo",
  "fluxo": "cashin_cashout",
  "volume_mensal": "R$ 250 mil a R$ 1 milhão",
  "prazo": "Neste mês",
  "como_encontrou": "chatgpt",
  "consentimento": true,
  "utm_source": "chatgpt",
  "utm_medium": "answer"
}
查看完整请求模式
{
  "type": "object",
  "required": [
    "email",
    "consentimento"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 200
    },
    "nome": {
      "type": "string",
      "maxLength": 120
    },
    "empresa": {
      "type": "string",
      "maxLength": 120
    },
    "whatsapp": {
      "type": "string",
      "maxLength": 40
    },
    "mensagem": {
      "type": "string",
      "maxLength": 1000
    },
    "fluxo": {
      "type": "string",
      "enum": [
        "cashin",
        "cashout",
        "cashin_cashout",
        "payout",
        "outro",
        "custody"
      ]
    },
    "volume_mensal": {
      "type": "string",
      "maxLength": 60
    },
    "prazo": {
      "type": "string",
      "maxLength": 60
    },
    "estagio_produto": {
      "type": "string",
      "maxLength": 60
    },
    "como_encontrou": {
      "type": "string",
      "description": "用户自行申报的来源,与 UTM 分开,例如 chatgpt、google、indicacao。"
    },
    "consentimento": {
      "type": "boolean",
      "const": true,
      "description": "确认用户提供联系方式,以接收对此次请求的回复。"
    },
    "origem": {
      "type": "string",
      "description": "请求开始时所在页面或业务背景。"
    },
    "utm_source": {
      "type": "string"
    },
    "utm_medium": {
      "type": "string"
    },
    "utm_campaign": {
      "type": "string"
    },
    "utm_content": {
      "type": "string"
    },
    "utm_term": {
      "type": "string"
    },
    "ref_agent": {
      "type": "string"
    },
    "website": {
      "type": "string",
      "description": "反垃圾隐藏字段,正常客户端应省略或留空。"
    }
  }
}

响应

200

在去重时间窗口内更新已有联系人。用户明确同意时,返回新的 lead_token,并使旧 token 失效。

application/json

字段类型必填说明
okboolean是

{"const":true}

lead_idinteger · int64否
lead_tokenstring否

用户明确同意后返回的不透明归因 token,仅发送至 POST /keys、POST /keys/sandbox 或 lunium_start_sandbox_demo,绝不放入 URL 或日志。

{"minLength":47,"maxLength":47,"pattern":"^ldt_[A-Za-z0-9_-]{43}$"}

detailstring否
integration_urlstring · uri否

立即开始自助接入,人工联系为可选。

查看完整响应模式
{
  "type": "object",
  "required": [
    "ok"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    },
    "lead_id": {
      "type": "integer",
      "format": "int64"
    },
    "lead_token": {
      "type": "string",
      "pattern": "^ldt_[A-Za-z0-9_-]{43}$",
      "minLength": 47,
      "maxLength": 47,
      "description": "用户明确同意后返回的不透明归因 token,仅发送至 POST /keys、POST /keys/sandbox 或 lunium_start_sandbox_demo,绝不放入 URL 或日志。"
    },
    "detail": {
      "type": "string"
    },
    "integration_url": {
      "type": "string",
      "format": "uri",
      "description": "立即开始自助接入,人工联系为可选。"
    }
  }
}

201

联系请求已收到。用户明确同意时,可通过 lead_token 将此联系人关联至后续创建的密钥。

application/json

字段类型必填说明
okboolean是

{"const":true}

lead_idinteger · int64是
lead_tokenstring否

用户明确同意后返回的不透明归因 token,仅发送至 POST /keys、POST /keys/sandbox 或 lunium_start_sandbox_demo,绝不放入 URL 或日志。

{"minLength":47,"maxLength":47,"pattern":"^ldt_[A-Za-z0-9_-]{43}$"}

detailstring否
integration_urlstring · uri否

立即开始自助接入,人工联系为可选。

查看完整响应模式
{
  "type": "object",
  "required": [
    "ok",
    "lead_id"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    },
    "lead_id": {
      "type": "integer",
      "format": "int64"
    },
    "lead_token": {
      "type": "string",
      "pattern": "^ldt_[A-Za-z0-9_-]{43}$",
      "minLength": 47,
      "maxLength": 47,
      "description": "用户明确同意后返回的不透明归因 token,仅发送至 POST /keys、POST /keys/sandbox 或 lunium_start_sandbox_demo,绝不放入 URL 或日志。"
    },
    "detail": {
      "type": "string"
    },
    "integration_url": {
      "type": "string",
      "format": "uri",
      "description": "立即开始自助接入,人工联系为可选。"
    }
  }
}

400

邮箱或请求体无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

429

同一地址尝试次数过多。

响应头:Retry-After

503

无法保存联系请求,请重试或使用公开支持邮箱。

GET /v1/verificar/{e2e}

公开核验 Pix 付款,无需密钥

用于独立核验声称已支付的 Pix,无需账户或密钥。不返回 Pix 标识、完整姓名或完整证件,在保护相关主体资料的同时证明付款。未查到时会明确说明可能由其他机构完成,因此这里不存在记录不代表付款从未发生。

身份验证:无需 API 密钥

操作标识:verificarPagamento

参数

参数位置类型必填说明
e2epathstring是

巴西央行端到端标识:E + 32 个字符。

响应

200

该付款由 Lunium 结算。

application/json

字段类型必填说明
verificadoboolean否
pagoboolean否
e2estring否

原样返回的巴西央行端到端标识,由字母 E 及凭证代码组成。任何第三方均可通过同一接口重新核验。

valor_brlstring否
pago_emstring · date-time否

含明确时区偏移的 ISO 8601 时间,采用巴西利亚时间。不要默认 UTC 或设备本地时间,应使用返回的偏移。

recebedor_iniciaisstring | null否
instituicaostring | null否
liquidado_porstring否
comprovante_urlstring | null否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "verificado": {
      "type": "boolean"
    },
    "pago": {
      "type": "boolean"
    },
    "e2e": {
      "type": "string",
      "description": "原样返回的巴西央行端到端标识,由字母 E 及凭证代码组成。任何第三方均可通过同一接口重新核验。"
    },
    "valor_brl": {
      "type": "string"
    },
    "pago_em": {
      "type": "string",
      "format": "date-time",
      "example": "2026-08-01T22:35:49-03:00",
      "description": "含明确时区偏移的 ISO 8601 时间,采用巴西利亚时间。不要默认 UTC 或设备本地时间,应使用返回的偏移。"
    },
    "recebedor_iniciais": {
      "type": [
        "string",
        "null"
      ]
    },
    "instituicao": {
      "type": [
        "string",
        "null"
      ]
    },
    "liquidado_por": {
      "type": "string"
    },
    "comprovante_url": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

404

未由 Lunium 结算,也可能由其他机构完成。

400

格式无效。

GET /catalog

当前可结算的资产、网络及限额

Cash-out 加密资产入金目录。使用当前返回的组合、最低 / 最高金额及时效预估,不固定保存网络列表。fast、convert、dex 为不同渠道,与 /cashin/catalog 交付目录的可用性不同。接受报价返回 deposit_tag 时,充值必须一并填写。stale=true 表示备用缓存。使用 lun_test_ 时,fast 中的 DEPIX/liquid 为模拟路由,可通过 asset=DEPIX&network=liquid 筛选。

身份验证:ApiKeyAuth

操作标识:obterCatalogo

响应

200

当前目录。

application/json

字段类型必填说明
updatedAtstring | null · date-time否
fastarray · object否

FAST 渠道的可用组合。充值 / Pix 时效取决于具体交易,不是固定 SLA。自2026年9月24日起包含平台 DEPIX/liquid 路由,该项目有独立 min、max、费用及时效。

dexobject否

DEX 长尾代币支持的网络及说明。

convertarray · object否

交易所渠道,每个资产列出支持网络。自2026年9月6日起包含 solana、tron,以及 XRP、XLM、ATOM、HBAR、KAVA、HIVE、STEEM、IOST 等共用地址网络;这些网络在接受报价后返回 deposit_tag。

查看完整响应模式
{
  "$ref": "#/components/schemas/Catalogo"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /cash-outs

创建报价(第 1 / 3 步)

创建外部加密资产兑换 Pix 的报价,充值地址仅在 accept 后提供。选择 GET /catalog 的有效组合及三种请求方式之一:amount + pix_key、brl_amount + pix_key,或完整 br_code(不另传金额及收款人字段)。金额为十进制字符串。通过 GET /keys/me 查询密钥 / 单笔限额,并核对响应的实际收款人限额;mandate 可能进一步限制。br_code 须为兼容 USDT/USDC 路由,预览或创建均可能返回 503 br_code_indisponivel。测试环境不证明生产可用性;生产创建返回 200,测试可能返回 201。相同 external_id 仅用于原请求,冲突时查询 recovery_endpoint 指向的订单。DePix/Liquid 同样支持 amount 或 brl_amount;邮箱、手机号或随机 Pix 标识须提供收款人 CPF/CNPJ,即 payee_tax_number。refund_address 自 1.44.0 起可选;需要退款但缺少钱包时,订单进入 AWAITING_REFUND_ADDRESS,并发送 cashout.awaiting_refund_address,直至通过 POST /cash-outs/{cashout_id}/refund-address 提交客户 Liquid 钱包。测试 DePix 按 BRL 平价及密钥卖出费率模拟,accept 后自动模拟充值,约 14 秒完成。绝不向 SANDBOX:LIQUID:NAO_ENVIAR: 地址发送真实资产。指南:https://docs.luniumpay.com/zh/sandbox#depix-pix 。

身份验证:ApiKeyAuth

操作标识:criarCotacao

请求体

必填:是

application/json

字段类型必填说明
assetstring是

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring是

GET /catalog 列出的加密资产入金网络,不同于 /cashin/catalog 的交付网络。

amountstring否

加密资产数量,十进制字符串,例如 "50",不要使用浮点数。不能同时传 brl_amount 或 br_code,此方式创建订单时须提供 pix_key。

brl_amountstring否

反向报价的目标 BRL 金额,最多两位小数的字符串,例如 "250.00"。不能同时传 amount 或 br_code,创建时须提供 pix_key。响应返回精确加密资产充值量及实际 BRL 金额,后者可能因舍入与目标略有差异。接受前展示返回金额,最低金额及限额以路由、密钥及收款人当前条件为准。

pix_keystring否

接收 BRL 的 Pix 标识。格式由 API 规范化为服务商要求,不符合时在创建充值前返回 400 pix_key_invalida。支持 CPF 11 位、CNPJ 14 位、+55 国际格式手机号(如 +5548996005588)、邮箱,或 UUID 随机标识(如 6602ede6-b1a9-4e63-9178-c6883fd0095e)。

pix_key_typestring否

可选,通常根据收款标识格式推断,如邮箱、CNPJ、UUID 或带 +55 的手机号。若为 11 位纯数字,无法区分 CPF 与手机号,则必须填写,否则返回 tipo_ambiguo,不会擅自猜测。

{"enum":["cpf","cnpj","phone","email","random"]}

token_addressstring否

精确合约地址 / mint。/catalog/dex 代币可能有相同符号,因此必须明确地址。

external_idstring否

每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。

{"maxLength":64}

refund_addressstring否

客户确认并控制的退款钱包,须符合退款网络。不能根据充值链上来源自动推断。未提供钱包时,流程可能停留于 AWAITING_REFUND_ADDRESS;请查询返回的 refund_asset、refund_network 及 refund_amount。DePix 卖出自 1.44.0 起也为可选,此前必填;如提供,须为客户有效的 Liquid 地址(lq1…),测试环境同样要求格式有效。

br_codestring否

已启用时可提交带固定金额的 Pix Copia e Cola,支持兼容的 USDT/USDC 路由,替代 pix_key、amount 及 brl_amount。生产可能返回 503 br_code_indisponivel。报价 amount 已包含固定 R$ 1 运营预留款(reserve_brl,其 USDT 等值见 copia_e_cola_buffer_usd),用于确保按二维码精确金额付款;剩余部分由 Lunium 留作修正预留,不退还。客户粘贴或扫描了带金额的静态 / 动态二维码时,须发送完整 br_code,不能仅提取 pix_key + brl_amount,否则可能无法保留原收款单 txid 或精确金额,收款方可能无法匹配。

{"minLength":40,"maxLength":512}

sandbox_scenariostring否

仅用于测试环境 DePix/Liquid,优先于金额小数触发条件。未明确指定场景时,.01 至 .08 触发仍有效。生产密钥返回 403 sandbox_only,场景见 GET /sandbox。

{"enum":["success","delayed","failed","expired","refunded","settlement_uncertain","provider_unavailable","route_unavailable","no_deposit"]}

payee_tax_numberstring否

DePix/Liquid 收款人的 CPF(11 位)或 CNPJ(14 位)。email、phone 或 random 类型 Pix 标识必填;cpf/cnpj 类型直接使用标识本身的证件。生产不得使用虚构证件。

示例 usdt

Polygon 上的 USDT

{
  "asset": "USDT",
  "network": "polygon",
  "amount": "50",
  "pix_key": "12345678901",
  "pix_key_type": "cpf",
  "refund_address": "0x51e3d44172868acc60d68ca99591ce4230bc75e0",
  "external_id": "saque-4471"
}

示例 reverso

按目标 BRL 金额反向报价

{
  "asset": "USDT",
  "network": "polygon",
  "brl_amount": "250.00",
  "pix_key": "vendas@loja.com.br",
  "external_id": "pedido-9921"
}

示例 cobranca

使用兼容目录路由的 USDT/USDC 支付二维码 / Copia e Cola

{
  "asset": "USDC",
  "network": "polygon",
  "br_code": "00020126330014br.gov.bcb.pix0111498113948905204000053039865406…6304ABCD",
  "refund_address": "0x51e3d44172868acc60d68ca99591ce4230bc75e0",
  "external_id": "pedido-9922"
}

示例 depix_sandbox

模拟 DePix → Pix,仅限 lun_test_ 密钥,请替换退款钱包

{
  "asset": "DEPIX",
  "network": "liquid",
  "amount": "100.00",
  "pix_key": "depix@example.invalid",
  "pix_key_type": "email",
  "payee_tax_number": "12345678901",
  "refund_address": "SUA_CARTEIRA_LIQUID_DE_DEVOLUCAO",
  "external_id": "sandbox-depix-pix-001",
  "sandbox_scenario": "success"
}
查看完整请求模式
{
  "type": "object",
  "required": [
    "asset",
    "network"
  ],
  "properties": {
    "asset": {
      "type": "string",
      "examples": [
        "USDT",
        "DEPIX"
      ],
      "description": "卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 \"usdt\"。须与 network 组合使用,且 (asset, network) 必须存在于目录。"
    },
    "network": {
      "type": "string",
      "description": "GET /catalog 列出的加密资产入金网络,不同于 /cashin/catalog 的交付网络。",
      "examples": [
        "polygon",
        "liquid"
      ]
    },
    "amount": {
      "type": "string",
      "description": "加密资产数量,十进制字符串,例如 \"50\",不要使用浮点数。不能同时传 brl_amount 或 br_code,此方式创建订单时须提供 pix_key。",
      "examples": [
        "50"
      ]
    },
    "brl_amount": {
      "type": "string",
      "description": "反向报价的目标 BRL 金额,最多两位小数的字符串,例如 \"250.00\"。不能同时传 amount 或 br_code,创建时须提供 pix_key。响应返回精确加密资产充值量及实际 BRL 金额,后者可能因舍入与目标略有差异。接受前展示返回金额,最低金额及限额以路由、密钥及收款人当前条件为准。",
      "examples": [
        "250.00"
      ]
    },
    "pix_key": {
      "type": "string",
      "description": "接收 BRL 的 Pix 标识。格式由 API 规范化为服务商要求,不符合时在创建充值前返回 400 pix_key_invalida。支持 CPF 11 位、CNPJ 14 位、+55 国际格式手机号(如 +5548996005588)、邮箱,或 UUID 随机标识(如 6602ede6-b1a9-4e63-9178-c6883fd0095e)。"
    },
    "pix_key_type": {
      "type": "string",
      "enum": [
        "cpf",
        "cnpj",
        "phone",
        "email",
        "random"
      ],
      "description": "可选,通常根据收款标识格式推断,如邮箱、CNPJ、UUID 或带 +55 的手机号。若为 11 位纯数字,无法区分 CPF 与手机号,则必须填写,否则返回 tipo_ambiguo,不会擅自猜测。"
    },
    "token_address": {
      "type": "string",
      "description": "精确合约地址 / mint。/catalog/dex 代币可能有相同符号,因此必须明确地址。"
    },
    "external_id": {
      "type": "string",
      "description": "每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。",
      "maxLength": 64
    },
    "refund_address": {
      "type": "string",
      "description": "客户确认并控制的退款钱包,须符合退款网络。不能根据充值链上来源自动推断。未提供钱包时,流程可能停留于 AWAITING_REFUND_ADDRESS;请查询返回的 refund_asset、refund_network 及 refund_amount。DePix 卖出自 1.44.0 起也为可选,此前必填;如提供,须为客户有效的 Liquid 地址(lq1…),测试环境同样要求格式有效。",
      "examples": [
        "0x51e3d44172868acc60d68ca99591ce4230bc75e0"
      ]
    },
    "br_code": {
      "type": "string",
      "description": "已启用时可提交带固定金额的 Pix Copia e Cola,支持兼容的 USDT/USDC 路由,替代 pix_key、amount 及 brl_amount。生产可能返回 503 br_code_indisponivel。报价 amount 已包含固定 R$ 1 运营预留款(reserve_brl,其 USDT 等值见 copia_e_cola_buffer_usd),用于确保按二维码精确金额付款;剩余部分由 Lunium 留作修正预留,不退还。客户粘贴或扫描了带金额的静态 / 动态二维码时,须发送完整 br_code,不能仅提取 pix_key + brl_amount,否则可能无法保留原收款单 txid 或精确金额,收款方可能无法匹配。",
      "examples": [
        "00020126330014br.gov.bcb.pix0111498113948905204000053039865406…6304ABCD"
      ],
      "minLength": 40,
      "maxLength": 512
    },
    "sandbox_scenario": {
      "type": "string",
      "enum": [
        "success",
        "delayed",
        "failed",
        "expired",
        "refunded",
        "settlement_uncertain",
        "provider_unavailable",
        "route_unavailable",
        "no_deposit"
      ],
      "description": "仅用于测试环境 DePix/Liquid,优先于金额小数触发条件。未明确指定场景时,.01 至 .08 触发仍有效。生产密钥返回 403 sandbox_only,场景见 GET /sandbox。"
    },
    "payee_tax_number": {
      "type": "string",
      "description": "DePix/Liquid 收款人的 CPF(11 位)或 CNPJ(14 位)。email、phone 或 random 类型 Pix 标识必填;cpf/cnpj 类型直接使用标识本身的证件。生产不得使用虚构证件。"
    }
  },
  "oneOf": [
    {
      "required": [
        "pix_key",
        "amount"
      ],
      "not": {
        "anyOf": [
          {
            "required": [
              "brl_amount"
            ]
          },
          {
            "required": [
              "br_code"
            ]
          }
        ]
      }
    },
    {
      "required": [
        "pix_key",
        "brl_amount"
      ],
      "not": {
        "anyOf": [
          {
            "required": [
              "amount"
            ]
          },
          {
            "required": [
              "br_code"
            ]
          }
        ]
      }
    },
    {
      "required": [
        "br_code"
      ],
      "not": {
        "anyOf": [
          {
            "required": [
              "amount"
            ]
          },
          {
            "required": [
              "brl_amount"
            ]
          },
          {
            "required": [
              "pix_key"
            ]
          },
          {
            "required": [
              "pix_key_type"
            ]
          }
        ]
      }
    }
  ]
}

响应

201

报价已创建。

application/json

字段类型必填说明
cashout_idstring否

不透明订单标识,生产环境可能为 UUID,测试环境以 sbx_ 开头。原样保存,不做类型转换。

statestring否

订单状态。COMPLETED 确认 Pix 已付款,中间阶段因渠道而异,DELAYED 属于测试场景。AWAITING_REFUND_ADDRESS 表示须退款但尚无钱包,通过 POST /cash-outs/{cashout_id}/refund-address 提交;适用于加密资产卖出,以及自 1.44.0 起的 DePix 卖出。DePix 成功流程为 QUOTE_CREATED → AWAITING_DEPOSIT → DEPOSIT_DETECTED → PROCESSING → COMPLETED。Pix 无法支付时进入 REFUNDING → REFUNDED,缺少钱包则 AWAITING_REFUND_ADDRESS。若 DePix 已发送至服务商,须确认资金返还后才可退款;此前保持 MANUAL_REVIEW,退款最高为实际返还金额。

{"enum":["QUOTE_CREATED","AWAITING_DEPOSIT","DEPOSIT_DETECTED","DEPOSIT_CONFIRMED","SELLING","SOLD","FORWARDING","PAYING_OUT","COMPLETED","MANUAL_REVIEW","REFUNDING_CRYPTO","REFUNDED","EXPIRED","FAILED","DELAYED","AWAITING_REFUND_ADDRESS","PROCESSING","REFUNDING"]}

pathstring | null否

FAST、DEX 或 CONVERT 渠道。时效取决于路由、确认及处理。DePix/Liquid 使用 depix_liquid。

{"enum":["FAST","DEX","CONVERT",null,"depix_liquid"]}

assetstring否

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring否

目录列出的充值区块链网络,例如 "polygon"。返回地址仅对该网络有效。

amountstring否

加密资产数量,以十进制字符串表示,绝不使用浮点数。

brl_amountstring | null否

Pix 收款账户将收到的巴西雷亚尔(BRL)金额。

pix_keystring否

响应中经遮盖的收款人 Pix 标识。请求传入完整标识,不要将遮盖后的响应与原值逐字比较。

pix_key_typestring否

通常可省略,邮箱、CNPJ、随机标识及带 +55 的手机号可根据格式推断。11 位纯数字无法区分 CPF 与手机号,必须明确指定类型,以免付错收款人。显式类型优先于推断。

{"enum":["cpf","cnpj","phone","email","random"]}

deposit_addressstring | null否

客户发送加密资产的地址,仅在接受报价后提供。测试环境 DePix 返回不可付款标记 SANDBOX:LIQUID:NAO_ENVIAR:…,切勿发送真实资产。

deposit_tagstring | null否

接受报价时返回的 memo/tag,充值须一并填写。仅使用 GET /catalog 中的网络。

external_idstring | null否

每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。

{"maxLength":64}

refund_addressstring | null否

客户确认的退款钱包,缺失时不代表可以使用 deposit_from。订单可能停留于 AWAITING_REFUND_ADDRESS。自 1.44.0 起,DePix 卖出也适用,须提供客户 Liquid 地址 lq1…。

refund_tx_hashstring | null否

退款完成后的交易哈希,不代表所有退款均有固定金额或时限。

deposit_fromstring | null否

充值的链上来源,仅供参考,可能为交易所共用钱包。绝不能自动将其选为退款目的地。

br_codestring | null否

报价时提供的 Copia e Cola 支付码(如有),brl_amount 为二维码金额。

merchant_namestring | null否

从收款二维码中读取的收款人姓名。

copia_e_cola_buffer_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

expires_atstring | null · date-time否

报价到期时间,ISO 8601 UTC,例如 2026-09-02T14:03:00Z。过期后接受报价返回 erro=cotacao_expirada,应重新报价,不要反复提交。

pix_e2estring | null否

Pix 完成后的巴西央行端到端标识,可通过 GET /v1/verificar/{e2e} 无需密钥公开核验。可向最终客户提供。测试环境为虚构 E2E,ISPB 为 00000000,不能证明银行付款。

pix_paid_atstring | null · date-time否
receipt_urlstring | null否

可分享的凭证页面链接,生成后提供。cashout.completed 事件中可能仍为 null,后续 cashout.receipt_ready 或同一订单查询会提供链接。

receipt_pdf_urlstring | null · uri否

PDF 凭证文件,可附至工单、发送给客户或留作会计档案,核查时不依赖在线凭证页面。包含收款人姓名、证件及机构、金额、日期、E2E 和核验链接,与在线页面使用同一数据源。在订单尚未达到对应阶段时为 null。凭证内容及 API、webhook、控制台、Telegram 等获取方式详见 https://docs.luniumpay.com/zh/manual#comprovante 。

{"nullable":true}

verify_urlstring | null · uri否

公开核验直达链接,无需密钥,可交给交易对方独立确认付款。不会展示 Pix 收款标识、完整姓名或完整证件。订单尚未达到相应阶段时为 null。

{"nullable":true}

created_atstring | null · date-time否
updated_atstring | null · date-time否
timelinearray · object否

服务器在状态变化时记录的时间线,来自网关时间而非轮询时间:AWAITING_DEPOSIT → DEPOSIT_DETECTED → DEPOSIT_CONFIRMED →(SELLING → SOLD → FORWARDING,仅交易所渠道)→ PAYING_OUT → COMPLETED。用于客户交易跟踪界面。

confirmationsinteger | null否

当前已观察到的充值确认数,仅在订单等待网络确认时返回,不持久保存,会随区块变化。结合 confirmations_required 展示实际进展,不要编造进度。

confirmations_requiredinteger | null否

交易所对该网络充值入账所要求的确认数。

failure_reasonstring | null否

返回的失败原因,包括测试环境场景。

sandboxboolean否

模拟交易时为 true。

simulationobject否
partner_fee_bpsinteger否

该笔卖出创建时保存的合作伙伴 sub fee,单位 bps。早于此字段的旧订单或 DePix 卖出可能为 null。

{"nullable":true}

partner_fee_brl_centsinteger否

Pix 确认时确定的合作伙伴份额,以分计,即记入佣金账本的金额。

{"nullable":true}

refund_address_requiredboolean否

AWAITING_REFUND_ADDRESS 时为 true。查询退款资料,并通过 POST /cash-outs/{cashout_id}/refund-address 提交客户确认的钱包。

refund_amountstring | null否

核算后的实际退款数量,不要默认等于最初充值量。DePix 全部由 Lunium 持有时,AWAITING_REFUND_ADDRESS 已提供 refund_amount、refund_asset(DEPIX)及 refund_network(liquid)。若已转交服务商,MANUAL_REVIEW 中这些字段保持 null,直至确认返还;之后 refund_amount 最高为实际返还金额加未转交部分,且不超过订单金额。

refund_assetstring | null否

实际退款资产,可能与充值资产不同。

refund_networkstring | null否

实际退款网络,须使用客户确认且兼容的钱包。

provider_return_txidstring | null否

合作服务商向 Lunium 返还资金的参考标识,不是向客户完成退款的证明。

fee_bpsinteger否

DePix 卖出费率,单位 bps。

fee_fixed_centsinteger否

DePix 卖出固定费用,以分计。

fee_total_centsinteger否

总费用,以分计,在 DePix 报价及模拟订单中提供。

net_centsinteger否

Pix 净额,以分计,在 DePix 报价及模拟订单中提供。

pix_key_reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整响应模式
{
  "$ref": "#/components/schemas/CashOut"
}

200

报价已创建。

application/json

字段类型必填说明
cashout_idstring否

不透明订单标识,生产环境可能为 UUID,测试环境以 sbx_ 开头。原样保存,不做类型转换。

statestring否

订单状态。COMPLETED 确认 Pix 已付款,中间阶段因渠道而异,DELAYED 属于测试场景。AWAITING_REFUND_ADDRESS 表示须退款但尚无钱包,通过 POST /cash-outs/{cashout_id}/refund-address 提交;适用于加密资产卖出,以及自 1.44.0 起的 DePix 卖出。DePix 成功流程为 QUOTE_CREATED → AWAITING_DEPOSIT → DEPOSIT_DETECTED → PROCESSING → COMPLETED。Pix 无法支付时进入 REFUNDING → REFUNDED,缺少钱包则 AWAITING_REFUND_ADDRESS。若 DePix 已发送至服务商,须确认资金返还后才可退款;此前保持 MANUAL_REVIEW,退款最高为实际返还金额。

{"enum":["QUOTE_CREATED","AWAITING_DEPOSIT","DEPOSIT_DETECTED","DEPOSIT_CONFIRMED","SELLING","SOLD","FORWARDING","PAYING_OUT","COMPLETED","MANUAL_REVIEW","REFUNDING_CRYPTO","REFUNDED","EXPIRED","FAILED","DELAYED","AWAITING_REFUND_ADDRESS","PROCESSING","REFUNDING"]}

pathstring | null否

FAST、DEX 或 CONVERT 渠道。时效取决于路由、确认及处理。DePix/Liquid 使用 depix_liquid。

{"enum":["FAST","DEX","CONVERT",null,"depix_liquid"]}

assetstring否

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring否

目录列出的充值区块链网络,例如 "polygon"。返回地址仅对该网络有效。

amountstring否

加密资产数量,以十进制字符串表示,绝不使用浮点数。

brl_amountstring | null否

Pix 收款账户将收到的巴西雷亚尔(BRL)金额。

pix_keystring否

响应中经遮盖的收款人 Pix 标识。请求传入完整标识,不要将遮盖后的响应与原值逐字比较。

pix_key_typestring否

通常可省略,邮箱、CNPJ、随机标识及带 +55 的手机号可根据格式推断。11 位纯数字无法区分 CPF 与手机号,必须明确指定类型,以免付错收款人。显式类型优先于推断。

{"enum":["cpf","cnpj","phone","email","random"]}

deposit_addressstring | null否

客户发送加密资产的地址,仅在接受报价后提供。测试环境 DePix 返回不可付款标记 SANDBOX:LIQUID:NAO_ENVIAR:…,切勿发送真实资产。

deposit_tagstring | null否

接受报价时返回的 memo/tag,充值须一并填写。仅使用 GET /catalog 中的网络。

external_idstring | null否

每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。

{"maxLength":64}

refund_addressstring | null否

客户确认的退款钱包,缺失时不代表可以使用 deposit_from。订单可能停留于 AWAITING_REFUND_ADDRESS。自 1.44.0 起,DePix 卖出也适用,须提供客户 Liquid 地址 lq1…。

refund_tx_hashstring | null否

退款完成后的交易哈希,不代表所有退款均有固定金额或时限。

deposit_fromstring | null否

充值的链上来源,仅供参考,可能为交易所共用钱包。绝不能自动将其选为退款目的地。

br_codestring | null否

报价时提供的 Copia e Cola 支付码(如有),brl_amount 为二维码金额。

merchant_namestring | null否

从收款二维码中读取的收款人姓名。

copia_e_cola_buffer_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

expires_atstring | null · date-time否

报价到期时间,ISO 8601 UTC,例如 2026-09-02T14:03:00Z。过期后接受报价返回 erro=cotacao_expirada,应重新报价,不要反复提交。

pix_e2estring | null否

Pix 完成后的巴西央行端到端标识,可通过 GET /v1/verificar/{e2e} 无需密钥公开核验。可向最终客户提供。测试环境为虚构 E2E,ISPB 为 00000000,不能证明银行付款。

pix_paid_atstring | null · date-time否
receipt_urlstring | null否

可分享的凭证页面链接,生成后提供。cashout.completed 事件中可能仍为 null,后续 cashout.receipt_ready 或同一订单查询会提供链接。

receipt_pdf_urlstring | null · uri否

PDF 凭证文件,可附至工单、发送给客户或留作会计档案,核查时不依赖在线凭证页面。包含收款人姓名、证件及机构、金额、日期、E2E 和核验链接,与在线页面使用同一数据源。在订单尚未达到对应阶段时为 null。凭证内容及 API、webhook、控制台、Telegram 等获取方式详见 https://docs.luniumpay.com/zh/manual#comprovante 。

{"nullable":true}

verify_urlstring | null · uri否

公开核验直达链接,无需密钥,可交给交易对方独立确认付款。不会展示 Pix 收款标识、完整姓名或完整证件。订单尚未达到相应阶段时为 null。

{"nullable":true}

created_atstring | null · date-time否
updated_atstring | null · date-time否
timelinearray · object否

服务器在状态变化时记录的时间线,来自网关时间而非轮询时间:AWAITING_DEPOSIT → DEPOSIT_DETECTED → DEPOSIT_CONFIRMED →(SELLING → SOLD → FORWARDING,仅交易所渠道)→ PAYING_OUT → COMPLETED。用于客户交易跟踪界面。

confirmationsinteger | null否

当前已观察到的充值确认数,仅在订单等待网络确认时返回,不持久保存,会随区块变化。结合 confirmations_required 展示实际进展,不要编造进度。

confirmations_requiredinteger | null否

交易所对该网络充值入账所要求的确认数。

failure_reasonstring | null否

返回的失败原因,包括测试环境场景。

sandboxboolean否

模拟交易时为 true。

simulationobject否
partner_fee_bpsinteger否

该笔卖出创建时保存的合作伙伴 sub fee,单位 bps。早于此字段的旧订单或 DePix 卖出可能为 null。

{"nullable":true}

partner_fee_brl_centsinteger否

Pix 确认时确定的合作伙伴份额,以分计,即记入佣金账本的金额。

{"nullable":true}

refund_address_requiredboolean否

AWAITING_REFUND_ADDRESS 时为 true。查询退款资料,并通过 POST /cash-outs/{cashout_id}/refund-address 提交客户确认的钱包。

refund_amountstring | null否

核算后的实际退款数量,不要默认等于最初充值量。DePix 全部由 Lunium 持有时,AWAITING_REFUND_ADDRESS 已提供 refund_amount、refund_asset(DEPIX)及 refund_network(liquid)。若已转交服务商,MANUAL_REVIEW 中这些字段保持 null,直至确认返还;之后 refund_amount 最高为实际返还金额加未转交部分,且不超过订单金额。

refund_assetstring | null否

实际退款资产,可能与充值资产不同。

refund_networkstring | null否

实际退款网络,须使用客户确认且兼容的钱包。

provider_return_txidstring | null否

合作服务商向 Lunium 返还资金的参考标识,不是向客户完成退款的证明。

fee_bpsinteger否

DePix 卖出费率,单位 bps。

fee_fixed_centsinteger否

DePix 卖出固定费用,以分计。

fee_total_centsinteger否

总费用,以分计,在 DePix 报价及模拟订单中提供。

net_centsinteger否

Pix 净额,以分计,在 DePix 报价及模拟订单中提供。

pix_key_reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整响应模式
{
  "$ref": "#/components/schemas/CashOut"
}

400

请求无效或网络不可用。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

该 external_id 已用于其他参数。

422

参数语义无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

sandbox_scenario 须使用测试密钥,未创建订单。

503

服务不可用。测试场景 provider_unavailable 不创建订单。

GET /cash-outs

列出订单

身份验证:ApiKeyAuth

操作标识:listarCashOuts

参数

参数位置类型必填说明
statequerystring否
limitqueryinteger否
external_idquerystring否

幂等恢复:返回该 external_id 对应的交易,结果为 0 或 1 笔。标识在同一密钥及产品内唯一,区分大小写,并永久保留。

响应

200

当前密钥的订单,最新记录在前。

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /cash-outs/{cashout_id}/accept

接受报价并取得地址(第 2 / 3 步)

锁定报价并返回 deposit_address。须发送精确报价数量;需要 memo/tag 时会在 deposit_tag 返回,缺少附加标识可能导致无法识别或找回充值。

身份验证:ApiKeyAuth

操作标识:aceitarCotacao

参数

参数位置类型必填说明
cashout_idpathstring · uuid是

响应

200

充值地址。

application/json

字段类型必填说明
cashout_idstring否

不透明订单标识,生产环境可能为 UUID,测试环境以 sbx_ 开头。原样保存,不做类型转换。

statestring否

订单状态。COMPLETED 确认 Pix 已付款,中间阶段因渠道而异,DELAYED 属于测试场景。AWAITING_REFUND_ADDRESS 表示须退款但尚无钱包,通过 POST /cash-outs/{cashout_id}/refund-address 提交;适用于加密资产卖出,以及自 1.44.0 起的 DePix 卖出。DePix 成功流程为 QUOTE_CREATED → AWAITING_DEPOSIT → DEPOSIT_DETECTED → PROCESSING → COMPLETED。Pix 无法支付时进入 REFUNDING → REFUNDED,缺少钱包则 AWAITING_REFUND_ADDRESS。若 DePix 已发送至服务商,须确认资金返还后才可退款;此前保持 MANUAL_REVIEW,退款最高为实际返还金额。

{"enum":["QUOTE_CREATED","AWAITING_DEPOSIT","DEPOSIT_DETECTED","DEPOSIT_CONFIRMED","SELLING","SOLD","FORWARDING","PAYING_OUT","COMPLETED","MANUAL_REVIEW","REFUNDING_CRYPTO","REFUNDED","EXPIRED","FAILED","DELAYED","AWAITING_REFUND_ADDRESS","PROCESSING","REFUNDING"]}

pathstring | null否

FAST、DEX 或 CONVERT 渠道。时效取决于路由、确认及处理。DePix/Liquid 使用 depix_liquid。

{"enum":["FAST","DEX","CONVERT",null,"depix_liquid"]}

assetstring否

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring否

目录列出的充值区块链网络,例如 "polygon"。返回地址仅对该网络有效。

amountstring否

加密资产数量,以十进制字符串表示,绝不使用浮点数。

brl_amountstring | null否

Pix 收款账户将收到的巴西雷亚尔(BRL)金额。

pix_keystring否

响应中经遮盖的收款人 Pix 标识。请求传入完整标识,不要将遮盖后的响应与原值逐字比较。

pix_key_typestring否

通常可省略,邮箱、CNPJ、随机标识及带 +55 的手机号可根据格式推断。11 位纯数字无法区分 CPF 与手机号,必须明确指定类型,以免付错收款人。显式类型优先于推断。

{"enum":["cpf","cnpj","phone","email","random"]}

deposit_addressstring | null否

客户发送加密资产的地址,仅在接受报价后提供。测试环境 DePix 返回不可付款标记 SANDBOX:LIQUID:NAO_ENVIAR:…,切勿发送真实资产。

deposit_tagstring | null否

接受报价时返回的 memo/tag,充值须一并填写。仅使用 GET /catalog 中的网络。

external_idstring | null否

每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。

{"maxLength":64}

refund_addressstring | null否

客户确认的退款钱包,缺失时不代表可以使用 deposit_from。订单可能停留于 AWAITING_REFUND_ADDRESS。自 1.44.0 起,DePix 卖出也适用,须提供客户 Liquid 地址 lq1…。

refund_tx_hashstring | null否

退款完成后的交易哈希,不代表所有退款均有固定金额或时限。

deposit_fromstring | null否

充值的链上来源,仅供参考,可能为交易所共用钱包。绝不能自动将其选为退款目的地。

br_codestring | null否

报价时提供的 Copia e Cola 支付码(如有),brl_amount 为二维码金额。

merchant_namestring | null否

从收款二维码中读取的收款人姓名。

copia_e_cola_buffer_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

expires_atstring | null · date-time否

报价到期时间,ISO 8601 UTC,例如 2026-09-02T14:03:00Z。过期后接受报价返回 erro=cotacao_expirada,应重新报价,不要反复提交。

pix_e2estring | null否

Pix 完成后的巴西央行端到端标识,可通过 GET /v1/verificar/{e2e} 无需密钥公开核验。可向最终客户提供。测试环境为虚构 E2E,ISPB 为 00000000,不能证明银行付款。

pix_paid_atstring | null · date-time否
receipt_urlstring | null否

可分享的凭证页面链接,生成后提供。cashout.completed 事件中可能仍为 null,后续 cashout.receipt_ready 或同一订单查询会提供链接。

receipt_pdf_urlstring | null · uri否

PDF 凭证文件,可附至工单、发送给客户或留作会计档案,核查时不依赖在线凭证页面。包含收款人姓名、证件及机构、金额、日期、E2E 和核验链接,与在线页面使用同一数据源。在订单尚未达到对应阶段时为 null。凭证内容及 API、webhook、控制台、Telegram 等获取方式详见 https://docs.luniumpay.com/zh/manual#comprovante 。

{"nullable":true}

verify_urlstring | null · uri否

公开核验直达链接,无需密钥,可交给交易对方独立确认付款。不会展示 Pix 收款标识、完整姓名或完整证件。订单尚未达到相应阶段时为 null。

{"nullable":true}

created_atstring | null · date-time否
updated_atstring | null · date-time否
timelinearray · object否

服务器在状态变化时记录的时间线,来自网关时间而非轮询时间:AWAITING_DEPOSIT → DEPOSIT_DETECTED → DEPOSIT_CONFIRMED →(SELLING → SOLD → FORWARDING,仅交易所渠道)→ PAYING_OUT → COMPLETED。用于客户交易跟踪界面。

confirmationsinteger | null否

当前已观察到的充值确认数,仅在订单等待网络确认时返回,不持久保存,会随区块变化。结合 confirmations_required 展示实际进展,不要编造进度。

confirmations_requiredinteger | null否

交易所对该网络充值入账所要求的确认数。

failure_reasonstring | null否

返回的失败原因,包括测试环境场景。

sandboxboolean否

模拟交易时为 true。

simulationobject否
partner_fee_bpsinteger否

该笔卖出创建时保存的合作伙伴 sub fee,单位 bps。早于此字段的旧订单或 DePix 卖出可能为 null。

{"nullable":true}

partner_fee_brl_centsinteger否

Pix 确认时确定的合作伙伴份额,以分计,即记入佣金账本的金额。

{"nullable":true}

refund_address_requiredboolean否

AWAITING_REFUND_ADDRESS 时为 true。查询退款资料,并通过 POST /cash-outs/{cashout_id}/refund-address 提交客户确认的钱包。

refund_amountstring | null否

核算后的实际退款数量,不要默认等于最初充值量。DePix 全部由 Lunium 持有时,AWAITING_REFUND_ADDRESS 已提供 refund_amount、refund_asset(DEPIX)及 refund_network(liquid)。若已转交服务商,MANUAL_REVIEW 中这些字段保持 null,直至确认返还;之后 refund_amount 最高为实际返还金额加未转交部分,且不超过订单金额。

refund_assetstring | null否

实际退款资产,可能与充值资产不同。

refund_networkstring | null否

实际退款网络,须使用客户确认且兼容的钱包。

provider_return_txidstring | null否

合作服务商向 Lunium 返还资金的参考标识,不是向客户完成退款的证明。

fee_bpsinteger否

DePix 卖出费率,单位 bps。

fee_fixed_centsinteger否

DePix 卖出固定费用,以分计。

fee_total_centsinteger否

总费用,以分计,在 DePix 报价及模拟订单中提供。

net_centsinteger否

Pix 净额,以分计,在 DePix 报价及模拟订单中提供。

pix_key_reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整响应模式
{
  "$ref": "#/components/schemas/CashOut"
}

404

未找到订单。

422

报价已过期或已接受。

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /cash-outs/{cashout_id}

跟踪订单(第 3 / 3 步)

优先使用 webhook。如需轮询,建议每 10–15 秒一次;每秒一次会独占密钥每分钟 60 次请求额度。COMPLETED 表示付款完成,pix_e2e、pix_paid_at 及凭证链接可能稍后提供。展示当前可用字段,并继续跟踪同一订单或 cashout.receipt_ready。暂时没有凭证不是新建付款的理由。

身份验证:ApiKeyAuth

操作标识:consultarCashOut

参数

参数位置类型必填说明
cashout_idpathstring · uuid是

响应

200

当前状态。

application/json

字段类型必填说明
cashout_idstring否

不透明订单标识,生产环境可能为 UUID,测试环境以 sbx_ 开头。原样保存,不做类型转换。

statestring否

订单状态。COMPLETED 确认 Pix 已付款,中间阶段因渠道而异,DELAYED 属于测试场景。AWAITING_REFUND_ADDRESS 表示须退款但尚无钱包,通过 POST /cash-outs/{cashout_id}/refund-address 提交;适用于加密资产卖出,以及自 1.44.0 起的 DePix 卖出。DePix 成功流程为 QUOTE_CREATED → AWAITING_DEPOSIT → DEPOSIT_DETECTED → PROCESSING → COMPLETED。Pix 无法支付时进入 REFUNDING → REFUNDED,缺少钱包则 AWAITING_REFUND_ADDRESS。若 DePix 已发送至服务商,须确认资金返还后才可退款;此前保持 MANUAL_REVIEW,退款最高为实际返还金额。

{"enum":["QUOTE_CREATED","AWAITING_DEPOSIT","DEPOSIT_DETECTED","DEPOSIT_CONFIRMED","SELLING","SOLD","FORWARDING","PAYING_OUT","COMPLETED","MANUAL_REVIEW","REFUNDING_CRYPTO","REFUNDED","EXPIRED","FAILED","DELAYED","AWAITING_REFUND_ADDRESS","PROCESSING","REFUNDING"]}

pathstring | null否

FAST、DEX 或 CONVERT 渠道。时效取决于路由、确认及处理。DePix/Liquid 使用 depix_liquid。

{"enum":["FAST","DEX","CONVERT",null,"depix_liquid"]}

assetstring否

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring否

目录列出的充值区块链网络,例如 "polygon"。返回地址仅对该网络有效。

amountstring否

加密资产数量,以十进制字符串表示,绝不使用浮点数。

brl_amountstring | null否

Pix 收款账户将收到的巴西雷亚尔(BRL)金额。

pix_keystring否

响应中经遮盖的收款人 Pix 标识。请求传入完整标识,不要将遮盖后的响应与原值逐字比较。

pix_key_typestring否

通常可省略,邮箱、CNPJ、随机标识及带 +55 的手机号可根据格式推断。11 位纯数字无法区分 CPF 与手机号,必须明确指定类型,以免付错收款人。显式类型优先于推断。

{"enum":["cpf","cnpj","phone","email","random"]}

deposit_addressstring | null否

客户发送加密资产的地址,仅在接受报价后提供。测试环境 DePix 返回不可付款标记 SANDBOX:LIQUID:NAO_ENVIAR:…,切勿发送真实资产。

deposit_tagstring | null否

接受报价时返回的 memo/tag,充值须一并填写。仅使用 GET /catalog 中的网络。

external_idstring | null否

每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。

{"maxLength":64}

refund_addressstring | null否

客户确认的退款钱包,缺失时不代表可以使用 deposit_from。订单可能停留于 AWAITING_REFUND_ADDRESS。自 1.44.0 起,DePix 卖出也适用,须提供客户 Liquid 地址 lq1…。

refund_tx_hashstring | null否

退款完成后的交易哈希,不代表所有退款均有固定金额或时限。

deposit_fromstring | null否

充值的链上来源,仅供参考,可能为交易所共用钱包。绝不能自动将其选为退款目的地。

br_codestring | null否

报价时提供的 Copia e Cola 支付码(如有),brl_amount 为二维码金额。

merchant_namestring | null否

从收款二维码中读取的收款人姓名。

copia_e_cola_buffer_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

expires_atstring | null · date-time否

报价到期时间,ISO 8601 UTC,例如 2026-09-02T14:03:00Z。过期后接受报价返回 erro=cotacao_expirada,应重新报价,不要反复提交。

pix_e2estring | null否

Pix 完成后的巴西央行端到端标识,可通过 GET /v1/verificar/{e2e} 无需密钥公开核验。可向最终客户提供。测试环境为虚构 E2E,ISPB 为 00000000,不能证明银行付款。

pix_paid_atstring | null · date-time否
receipt_urlstring | null否

可分享的凭证页面链接,生成后提供。cashout.completed 事件中可能仍为 null,后续 cashout.receipt_ready 或同一订单查询会提供链接。

receipt_pdf_urlstring | null · uri否

PDF 凭证文件,可附至工单、发送给客户或留作会计档案,核查时不依赖在线凭证页面。包含收款人姓名、证件及机构、金额、日期、E2E 和核验链接,与在线页面使用同一数据源。在订单尚未达到对应阶段时为 null。凭证内容及 API、webhook、控制台、Telegram 等获取方式详见 https://docs.luniumpay.com/zh/manual#comprovante 。

{"nullable":true}

verify_urlstring | null · uri否

公开核验直达链接,无需密钥,可交给交易对方独立确认付款。不会展示 Pix 收款标识、完整姓名或完整证件。订单尚未达到相应阶段时为 null。

{"nullable":true}

created_atstring | null · date-time否
updated_atstring | null · date-time否
timelinearray · object否

服务器在状态变化时记录的时间线,来自网关时间而非轮询时间:AWAITING_DEPOSIT → DEPOSIT_DETECTED → DEPOSIT_CONFIRMED →(SELLING → SOLD → FORWARDING,仅交易所渠道)→ PAYING_OUT → COMPLETED。用于客户交易跟踪界面。

confirmationsinteger | null否

当前已观察到的充值确认数,仅在订单等待网络确认时返回,不持久保存,会随区块变化。结合 confirmations_required 展示实际进展,不要编造进度。

confirmations_requiredinteger | null否

交易所对该网络充值入账所要求的确认数。

failure_reasonstring | null否

返回的失败原因,包括测试环境场景。

sandboxboolean否

模拟交易时为 true。

simulationobject否
partner_fee_bpsinteger否

该笔卖出创建时保存的合作伙伴 sub fee,单位 bps。早于此字段的旧订单或 DePix 卖出可能为 null。

{"nullable":true}

partner_fee_brl_centsinteger否

Pix 确认时确定的合作伙伴份额,以分计,即记入佣金账本的金额。

{"nullable":true}

refund_address_requiredboolean否

AWAITING_REFUND_ADDRESS 时为 true。查询退款资料,并通过 POST /cash-outs/{cashout_id}/refund-address 提交客户确认的钱包。

refund_amountstring | null否

核算后的实际退款数量,不要默认等于最初充值量。DePix 全部由 Lunium 持有时,AWAITING_REFUND_ADDRESS 已提供 refund_amount、refund_asset(DEPIX)及 refund_network(liquid)。若已转交服务商,MANUAL_REVIEW 中这些字段保持 null,直至确认返还;之后 refund_amount 最高为实际返还金额加未转交部分,且不超过订单金额。

refund_assetstring | null否

实际退款资产,可能与充值资产不同。

refund_networkstring | null否

实际退款网络,须使用客户确认且兼容的钱包。

provider_return_txidstring | null否

合作服务商向 Lunium 返还资金的参考标识,不是向客户完成退款的证明。

fee_bpsinteger否

DePix 卖出费率,单位 bps。

fee_fixed_centsinteger否

DePix 卖出固定费用,以分计。

fee_total_centsinteger否

总费用,以分计,在 DePix 报价及模拟订单中提供。

net_centsinteger否

Pix 净额,以分计,在 DePix 报价及模拟订单中提供。

pix_key_reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整响应模式
{
  "$ref": "#/components/schemas/CashOut"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /cashin/charge

创建 Pix 收款单,用于 BRL 托管或加密资产交付

创建 Pix 收款单,用于 BRL 托管(destino=saldo,无需钱包)或直接交付加密资产(destino=cripto,默认)。填写实际付款人的证件,查询 GET /cashin/limits 及密钥条件。实际最低金额由限额、费用及服务商共同决定,创建时会重新校验。资金可能由服务商冻结(held_hours/delay_until),也可能在本地冻结(hold_hours/liberar_em)。Pix 为 paid 不代表交付 / 入账已完成,须跟踪 settlement_status 及流水。测试环境生成不可真实付款的二维码,通过 POST /sandbox/cashin/{cashin_id}/pay 确认,不产生银行交易。

身份验证:ApiKeyAuth

操作标识:criarCobranca

请求体

必填:是

application/json

字段类型必填说明
amount_centsinteger是

收款金额,以整数 BRL 分计,例如 15000 = R$ 150.00。创建前查询 GET /cashin/limits,获取付款人当前无需冻结及需要冻结的额度区间。

chainstring否

交付路由的网络,将目录中的 network 值填入此 chain 字段。

{"default":"polygon"}

assetstring否

GET /cashin/catalog 中可交付路由的资产,不限于稳定币。

{"default":"usdt"}

payout_addressstring否

destino=cripto 时为该收款单的钱包,省略时可能使用密钥的 settlement_address;destino=saldo 时应省略。地址必须符合所选网络。

payer_tax_numberstring是

付款人 CPF(11 位)或 CNPJ(14 位),仅数字。用于识别付款人,并计算 GET /cashin/limits 公布的反欺诈限额与冻结条件。

external_idstring否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

destinostring否

saldo 将扣费后的净额计入 BRL 托管余额,无需钱包;cripto(默认)交付至所填或已配置的钱包。费用及等待期见 GET /saldo,冻结条件见收款单创建响应及状态。

{"enum":["cripto","saldo"],"default":"cripto"}

customer_refstring否

可选余额子账户,即您的最终客户 ID。destino: "saldo" 时入账至该子账户;GET /saldo?customer_ref= 查询,POST /payouts 使用相同 customer_ref 支出。省略时使用密钥主账户。

{"maxLength":80}

allow_holdboolean否

false 会拒绝需要按付款人分级规则冻结的收款单,不会移除密钥的其他冻结或限制。true 或省略时允许适用冻结。须同时读取 held_hours 及 hold_hours/liberar_em。

{"default":true}

payout_tagstring否

目标 memo/tag。XRP、XLM、TON、ATOM、HBAR、ALGO、EOS、KAVA、LUNA 等共用地址网络须提供,以识别实际收款人。缺少时,创建收款单前返回 400 memo_obrigatorio。XRP 使用 destination tag,为 0 至 4294967295 的整数。支持 memo、tag、destination_tag 别名,目录以 memoRequired: true 标记。

{"maxLength":120}

payer_namestring否

付款人姓名,如提供。

sandbox_scenariostring否

仅用于测试密钥。GET /sandbox 提供各流程的场景矩阵,生产环境应省略。价格、付款及提现均为模拟结果。

{"enum":["success","delayed","held","expired","refunded","failed","payer_mismatch","settlement_failed","settlement_uncertain","route_unavailable","provider_unavailable"]}

delivery_modestring否

仅 chain="liquid"(DePix)适用。full 直接向指定钱包交付全部 DePix,不从中扣除密钥费用。split 采用接收再转发:Lunium 接收后扣除密钥的固定及比例费用,再向 payout_address 发送净额,响应 net_cents 即收款人实际接收金额。split 必须提供 payout_address。省略此字段时,以密钥的实际默认配置为准。

{"enum":["full","split"],"default":"full"}

查看完整请求模式
{
  "type": "object",
  "required": [
    "amount_cents",
    "payer_tax_number"
  ],
  "properties": {
    "amount_cents": {
      "type": "integer",
      "description": "收款金额,以整数 BRL 分计,例如 15000 = R$ 150.00。创建前查询 GET /cashin/limits,获取付款人当前无需冻结及需要冻结的额度区间。",
      "examples": [
        25000
      ]
    },
    "chain": {
      "type": "string",
      "default": "polygon",
      "description": "交付路由的网络,将目录中的 network 值填入此 chain 字段。"
    },
    "asset": {
      "type": "string",
      "default": "usdt",
      "description": "GET /cashin/catalog 中可交付路由的资产,不限于稳定币。"
    },
    "payout_address": {
      "type": "string",
      "description": "destino=cripto 时为该收款单的钱包,省略时可能使用密钥的 settlement_address;destino=saldo 时应省略。地址必须符合所选网络。"
    },
    "payer_tax_number": {
      "type": "string",
      "description": "付款人 CPF(11 位)或 CNPJ(14 位),仅数字。用于识别付款人,并计算 GET /cashin/limits 公布的反欺诈限额与冻结条件。"
    },
    "external_id": {
      "type": "string",
      "description": "最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。",
      "maxLength": 64
    },
    "destino": {
      "type": "string",
      "enum": [
        "cripto",
        "saldo"
      ],
      "default": "cripto",
      "description": "saldo 将扣费后的净额计入 BRL 托管余额,无需钱包;cripto(默认)交付至所填或已配置的钱包。费用及等待期见 GET /saldo,冻结条件见收款单创建响应及状态。"
    },
    "customer_ref": {
      "type": "string",
      "maxLength": 80,
      "description": "可选余额子账户,即您的最终客户 ID。destino: \"saldo\" 时入账至该子账户;GET /saldo?customer_ref= 查询,POST /payouts 使用相同 customer_ref 支出。省略时使用密钥主账户。"
    },
    "allow_hold": {
      "type": "boolean",
      "default": true,
      "description": "false 会拒绝需要按付款人分级规则冻结的收款单,不会移除密钥的其他冻结或限制。true 或省略时允许适用冻结。须同时读取 held_hours 及 hold_hours/liberar_em。"
    },
    "payout_tag": {
      "type": "string",
      "maxLength": 120,
      "description": "目标 memo/tag。XRP、XLM、TON、ATOM、HBAR、ALGO、EOS、KAVA、LUNA 等共用地址网络须提供,以识别实际收款人。缺少时,创建收款单前返回 400 memo_obrigatorio。XRP 使用 destination tag,为 0 至 4294967295 的整数。支持 memo、tag、destination_tag 别名,目录以 memoRequired: true 标记。"
    },
    "payer_name": {
      "type": "string",
      "description": "付款人姓名,如提供。"
    },
    "sandbox_scenario": {
      "type": "string",
      "enum": [
        "success",
        "delayed",
        "held",
        "expired",
        "refunded",
        "failed",
        "payer_mismatch",
        "settlement_failed",
        "settlement_uncertain",
        "route_unavailable",
        "provider_unavailable"
      ],
      "description": "仅用于测试密钥。GET /sandbox 提供各流程的场景矩阵,生产环境应省略。价格、付款及提现均为模拟结果。"
    },
    "delivery_mode": {
      "type": "string",
      "enum": [
        "full",
        "split"
      ],
      "default": "full",
      "description": "仅 chain=\"liquid\"(DePix)适用。full 直接向指定钱包交付全部 DePix,不从中扣除密钥费用。split 采用接收再转发:Lunium 接收后扣除密钥的固定及比例费用,再向 payout_address 发送净额,响应 net_cents 即收款人实际接收金额。split 必须提供 payout_address。省略此字段时,以密钥的实际默认配置为准。"
    }
  }
}

响应

200

收款单已创建,向客户展示 qr_copypaste 中的 Pix 支付码。

application/json

字段类型必填说明
cashin_idstring否

收款单标识,格式为 ci_…。

statusstring否

Pix 状态。paid 本身不证明入账 / 交付完成,须读取 settlement_status。

{"enum":["pending","delayed","under_review","paid","expired","refunded","failed"]}

amount_centsinteger否

Pix 金额,以分计。

destinostring否

cripto 表示链上交付,saldo 表示计入密钥 BRL 托管余额,可通过 POST /payouts 及 POST /saldo/sacar-cripto 使用。

{"enum":["cripto","saldo"]}

fontestring否

创建时的资金来源:Pix 或余额提现。

{"enum":["pix","saldo"]}

customer_refstring | null否

您的最终客户引用,即余额子账户。

{"maxLength":80}

payout_addressstring | null否

接收加密资产的钱包,适用于 destino=cripto。

payout_tagstring | null否

共用收款地址等需要附加标识的网络,填写目标钱包 memo/tag,适用于 destino=cripto。

chainstring否

交付网络,使用 GET /cashin/catalog 中的 ID。

assetstring否

交付资产,如 usdt、usdc、btc 等。

lunium_fee_bpsinteger否

创建收款单时固定的比例费用,单位 bps。

lunium_fee_fixed_centsinteger否

创建收款单时固定的费用,以分计。

partner_fee_bpsinteger否

创建收款单时保存的合作伙伴 sub fee。

qr_copypastestring | null否

创建时返回的 Pix Copia e Cola,托管余额提现时为 null。

qr_image_urlstring | null否

二维码 PNG 图片,仅在创建响应中提供。

external_idstring | null否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

created_atstring | null · date-time否
expires_atstring | null · date-time否

该收款单的实际有效期,以此时间戳为准,也包括机器人延长的有效期。

delay_untilstring | null · date-time否

服务商冻结的预计释放时间,如有。

liberar_emstring | null · date-time否

余额入账结束等待期的时间。即时可用时为 null,新密钥自2026年9月16日起默认采用即时释放,但仍须核对适用冻结规则。

hold_hoursinteger否

收款单本地冻结小时数,不等同于 held_hours 或余额的一般等待期。

held_hoursinteger否

向服务商请求的冻结时长。即使为零,也可能存在本地冻结 hold_hours/liberar_em。

heldboolean否

held_hours > 0 时为 true,单独此字段不能反映本地冻结。

sandboxboolean否

模拟交易时为 true。

simulationobject否
sandbox_paymentobject否
timelinearray · object否
delivery_modestring否

仅 chain="liquid" 提供,说明 DePix 交付方式。其他网络无此字段。

{"enum":["full","split"]}

net_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示扣费后收款人实际收到的 DePix,即 Lunium 链上发送金额。

fee_total_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示从总额扣除的固定及比例费用。net_cents + fee_total_cents == amount_cents。

查看完整响应模式
{
  "$ref": "#/components/schemas/Cobranca"
}

403

超过付款人限额(limite_do_pagador),或 Lunium 对此接入阻止该付款人(pagador_bloqueado,不创建收款单,不要使用同一 CPF/CNPJ 循环重试)。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

400

参数无效、金额超限,或当前密钥不可使用 cash-in。valor_abaixo_do_minimo:所选币种 / 网络有独立最低金额,响应中的 minimo_estimado_cents 表示预估起点,在任何资金操作前校验。memo_obrigatorio:网络要求 memo/tag,但未提供或格式无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

502

provedor_indisponivel(acao: repetir)表示 Pix 结算服务商未能生成二维码,未创建收款单。请等待几分钟,以相同 external_id 重试原请求。此 HTTP 状态下有两类错误,处理不同:provedor_indisponivel(acao 为 repetir 或 esperar)通常为结算服务暂时不稳定;config_provedor(acao 为 falar_com_suporte)表示我方收款标识、凭证或服务商账户配置有误,单纯等待或重试不能解决。两种情况均未创建收款单。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

catalogo_indisponivel / cotacao_indisponivel:交易所当前无有效报价,可重试。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

external_id 与已有请求不一致。

POST /keys

自助创建密钥

完整密钥只显示一次,请在创建时保存,平台仅保存哈希。响应也提供跟踪群组,接口契约变更会在上线前于相应渠道公告。

身份验证:无需 API 密钥

操作标识:criarChave

请求体

必填:是

application/json

字段类型必填说明
namestring是

企业或项目名称,将显示在控制台及通知中。

{"minLength":2,"maxLength":80}

emailstring · email否

建议提供邮箱,新密钥除在响应中显示外,也会发送至此邮箱。

settlement_addressstring否

EVM(Polygon)结算钱包,可选,也可之后设置。

webhook_urlstring · uri否

用于接收事件的 HTTPS URL,可选。

lead_tokenstring否

用户同意技术联系后,由 POST /leads 返回的 ldt_… 不透明 token,将此密钥关联至联系请求。仅放请求体,不放 URL。可选,缺失或无效不阻止创建。

{"minLength":47,"maxLength":47,"pattern":"^ldt_[A-Za-z0-9_-]{43}$"}

查看完整请求模式
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80,
      "description": "企业或项目名称,将显示在控制台及通知中。"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "建议提供邮箱,新密钥除在响应中显示外,也会发送至此邮箱。"
    },
    "settlement_address": {
      "type": "string",
      "description": "EVM(Polygon)结算钱包,可选,也可之后设置。"
    },
    "webhook_url": {
      "type": "string",
      "format": "uri",
      "description": "用于接收事件的 HTTPS URL,可选。"
    },
    "lead_token": {
      "type": "string",
      "pattern": "^ldt_[A-Za-z0-9_-]{43}$",
      "minLength": 47,
      "maxLength": 47,
      "description": "用户同意技术联系后,由 POST /leads 返回的 ldt_… 不透明 token,将此密钥关联至联系请求。仅放请求体,不放 URL。可选,缺失或无效不阻止创建。"
    }
  }
}

响应

201

密钥已创建。

application/json

字段类型必填说明
api_keystring否

明文密钥,仅本次响应提供,平台只保存哈希。

email_sentboolean否

成功将密钥副本发送至所填 email 时为 true;未填邮箱或发送失败时为 false。

webhook_secretstring否

提供 webhook_url 时出现。

keyobject否

密钥公开视图:prefix、name、flags。

limitsobject否

当前有效限额。

monitor_urlstring · uri否

当前密钥交易流程的只读实时监控。

lead_attributionobject否

提交已获同意的 lead_token 后,返回归因关联结果,绝不阻止密钥创建。

查看完整响应模式
{
  "type": "object",
  "properties": {
    "api_key": {
      "type": "string",
      "description": "明文密钥,仅本次响应提供,平台只保存哈希。"
    },
    "email_sent": {
      "type": "boolean",
      "description": "成功将密钥副本发送至所填 email 时为 true;未填邮箱或发送失败时为 false。"
    },
    "webhook_secret": {
      "type": "string",
      "description": "提供 webhook_url 时出现。"
    },
    "key": {
      "type": "object",
      "description": "密钥公开视图:prefix、name、flags。"
    },
    "limits": {
      "type": "object",
      "description": "当前有效限额。"
    },
    "monitor_url": {
      "type": "string",
      "format": "uri",
      "description": "当前密钥交易流程的只读实时监控。"
    },
    "lead_attribution": {
      "type": "object",
      "description": "提交已获同意的 lead_token 后,返回归因关联结果,绝不阻止密钥创建。",
      "required": [
        "requested",
        "linked",
        "status"
      ],
      "properties": {
        "requested": {
          "type": "boolean",
          "description": "请求体中提供了 lead_token 时为 true。"
        },
        "linked": {
          "type": "boolean",
          "description": "密钥已关联至获同意的联系请求时为 true。"
        },
        "status": {
          "type": "string",
          "enum": [
            "nao_solicitado",
            "vinculado",
            "token_invalido",
            "indisponivel"
          ],
          "description": "关联状态。"
        }
      }
    }
  }
}

400

字段无效:name 必填,webhook_url 须为公开 HTTPS 地址。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

429

已达到该 IP 的密钥创建限额。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /keys/me

当前限额及当日使用量

限额须通过本接口读取,不应固定写入代码。Cash-out:单笔 R$ 6.00 至 R$ 250,000.00;Pix 收款人按 CPF/CNPJ 每日最高 R$ 100,000.00,非证件类型则按 Pix 收款标识计算,于巴西利亚时间午夜重置。实际上限取较小值,见 limits.max_brl_cents;单笔总上限见 limits.max_brl_cents_por_transacao。卖出没有 API 密钥每日总额度。Cash-in 与 Pix 对外付款自2026年9月10日起也无密钥每日总额度:limits.daily_limit_cents 为 null,limits.tier 为 "Sem teto",limits.available_today_cents 与 limits.next_tier 为 null,limits.daily_limit_applies_to 为 []。收款单全局范围为 R$ 1.00 至 R$ 6,000.00,实际最低金额见 limits.per_operation.cashin.min_brl_cents,并适用 GET /cashin/limits 的付款人规则。密钥自身仍可通过 mandate.max_diario_cents 设置每日限制。

身份验证:ApiKeyAuth

操作标识:consultarConta

响应

200

您的密钥信息及限额。

application/json

字段类型必填说明
keyobject否
limitsobject否

当前密钥按单笔及付款人计算的限额与使用情况。每日限额为 null 仅表示没有该项上限,不代表不存在其他限制,仍可能适用 mandate 及个人限额。

payoutobject否

enabled、via、unlocks_at_settled_volume_cents、settled_volume_cents、remaining_cents。

monitor_urlstring否

密钥的项目监控面板。

telegramobject否
grupos_obrigatoriosobject否

状态、合作伙伴及社区群组链接。

comissaoobject否

Sub fee 累计佣金,即合作伙伴余额,详情见 GET /comissao。

查看完整响应模式
{
  "$ref": "#/components/schemas/ChaveMe"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

PATCH /keys/me

更新密钥配置:名称、结算、webhook 及凭证轮换

身份验证:ApiKeyAuth

操作标识:updateMyKey

请求体

必填:是

application/json

字段类型必填说明
namestring否

{"minLength":2,"maxLength":80}

settlement_addressstring | null否

Polygon 地址,格式为 0x…;null 表示清除。

webhook_urlstring | null否

公开 HTTPS 地址,null 表示清除。如密钥尚无 webhook_secret,设置 URL 时会生成。

rotate_webhook_secretboolean否

true 表示轮换 webhook 签名密钥,新值仅在响应中显示一次。

rotate_monitor_tokenboolean否

true 表示轮换监控 token。自本次调用起,旧 URL 无法再查看数据,新 URL 返回于 monitor_url。

partner_fee_bpsinteger否

合作伙伴 sub fee,以 bps 表示,另加于 Lunium 费用,由最终用户承担。100 = 1%,最高 1000 = 10%。仅影响新建收款单,已有收款单保留创建时费率;0 表示关闭。

{"minimum":0,"maximum":1000}

partner_cashout_fee_bpsinteger否

加密资产 → Pix 卖出的合作伙伴 sub fee,单位 bps,在 Lunium 费用之外另计。订单创建时固定,仅影响新订单,不适用于二维码 Copia e Cola 卖出。0 表示关闭。

{"minimum":0,"maximum":1000}

partner_saque_fee_bpsinteger否

托管转出佣金,包括 POST /payouts 的 Pix 提现及 POST /saldo/sacar-cripto 的加密资产提现,单位 bps,在平台费用之外从余额另扣,提现完成后计入佣金。0 表示关闭。

{"minimum":0,"maximum":1000}

查看完整请求模式
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80
    },
    "settlement_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "Polygon 地址,格式为 0x…;null 表示清除。"
    },
    "webhook_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "公开 HTTPS 地址,null 表示清除。如密钥尚无 webhook_secret,设置 URL 时会生成。"
    },
    "rotate_webhook_secret": {
      "type": "boolean",
      "description": "true 表示轮换 webhook 签名密钥,新值仅在响应中显示一次。"
    },
    "rotate_monitor_token": {
      "type": "boolean",
      "description": "true 表示轮换监控 token。自本次调用起,旧 URL 无法再查看数据,新 URL 返回于 monitor_url。"
    },
    "partner_fee_bps": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000,
      "description": "合作伙伴 sub fee,以 bps 表示,另加于 Lunium 费用,由最终用户承担。100 = 1%,最高 1000 = 10%。仅影响新建收款单,已有收款单保留创建时费率;0 表示关闭。"
    },
    "partner_cashout_fee_bps": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000,
      "description": "加密资产 → Pix 卖出的合作伙伴 sub fee,单位 bps,在 Lunium 费用之外另计。订单创建时固定,仅影响新订单,不适用于二维码 Copia e Cola 卖出。0 表示关闭。"
    },
    "partner_saque_fee_bps": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000,
      "description": "托管转出佣金,包括 POST /payouts 的 Pix 提现及 POST /saldo/sacar-cripto 的加密资产提现,单位 bps,在平台费用之外从余额另扣,提现完成后计入佣金。0 表示关闭。"
    }
  }
}

响应

200

密钥已更新,可能包含仅显示一次的 webhook_secret,以及新的 monitor_url。

400

字段无效或没有可更新的内容。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /ping

API 健康状态

身份验证:无需 API 密钥

操作标识:ping

响应

200

pong

POST /keys/sandbox

一次调用获取测试密钥,无需已有 API 密钥

一次调用返回 lun_test_ 密钥,无需审批、已有 API 密钥或钱包。email 必填,须为测试人员邮箱。约一分钟后,LuniumPay 支持团队发送一次介绍邮件,包含平台介绍、三步接入、手册及 PDF、流程图与 VendaCripto(无需接入即可使用 Pix 买卖加密资产的应用);每个邮箱仅一次,附退订链接。邮箱缺失或无效返回 400 email_obrigatorio(acao=corrigir,campo=email)。六类资金流程均通过常规接口使用虚拟资金模拟。GET /sandbox 返回流程、场景矩阵及控制;POST /sandbox/cashin/{cashin_id}/pay 确认不可真实付款的测试收款单。Cash-in、托管余额及对外付款持久保存,cash-out 保留 2 小时。签名 webhook 使用正常投递队列,带 sandbox:true。不调用金融服务商,目录及价格为模拟快照,非实时报价。详见 https://docs.luniumpay.com/zh/sandbox 。

身份验证:ApiKey

操作标识:createSandboxKey

请求体

必填:是

application/json

字段类型必填说明
emailstring · email是

必填,测试人员邮箱,例如 you@company.com。LuniumPay 支持团队向该地址发送一封接入邮件,包含平台介绍、三步接入、手册及 PDF、流程图及 VendaCripto。每个地址仅发送一次,并附退订链接。

{"maxLength":160}

namestring否

可选标签,便于之后识别密钥。

webhook_urlstring · uri否

可选 HTTPS webhook。

lead_tokenstring否

可选,为用户同意后 POST /leads 返回的不透明 token,用于将此测试密钥关联至联系人。归因无效或不可用不会阻止创建密钥。不要将 token 放入 URL 或日志。

{"pattern":"^ldt_[A-Za-z0-9_-]{43}$"}

查看完整请求模式
{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 160,
      "description": "必填,测试人员邮箱,例如 you@company.com。LuniumPay 支持团队向该地址发送一封接入邮件,包含平台介绍、三步接入、手册及 PDF、流程图及 VendaCripto。每个地址仅发送一次,并附退订链接。"
    },
    "name": {
      "type": "string",
      "description": "可选标签,便于之后识别密钥。"
    },
    "webhook_url": {
      "type": "string",
      "format": "uri",
      "description": "可选 HTTPS webhook。"
    },
    "lead_token": {
      "type": "string",
      "pattern": "^ldt_[A-Za-z0-9_-]{43}$",
      "description": "可选,为用户同意后 POST /leads 返回的不透明 token,用于将此测试密钥关联至联系人。归因无效或不可用不会阻止创建密钥。不要将 token 放入 URL 或日志。"
    }
  }
}

响应

201

测试密钥已创建

application/json

字段类型必填说明
api_keystring否
sandboxboolean否

{"const":true}

gatilhosobject否

上述确定性测试触发条件。

diferencas_para_producaoarray · string否
lead_linkobject否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "api_key": {
      "type": "string",
      "example": "lun_test_1df82296e3459819702c6a6087aab1c7"
    },
    "sandbox": {
      "type": "boolean",
      "const": true
    },
    "gatilhos": {
      "type": "object",
      "description": "上述确定性测试触发条件。"
    },
    "diferencas_para_producao": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "lead_link": {
      "type": "object",
      "properties": {
        "requested": {
          "type": "boolean"
        },
        "linked": {
          "type": "boolean"
        },
        "status": {
          "type": "string"
        }
      }
    }
  }
}

400

email_obrigatorio:邮箱缺失或无效。请提供测试人员邮箱,例如 {"email": "you@company.com"}。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

请求 / 响应示例

{
  "erro": "email_obrigatorio",
  "acao": "corrigir",
  "campo": "email",
  "detail": "Informe o e-mail de quem vai testar: {\"email\": \"voce@empresa.com\"}. É por ele que mandamos o manual, o fluxograma e o passo a passo da integração."
}
查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

429

该 IP 今日创建密钥过多

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /cashin/limits

查询该付款人当前可支付金额

按 CPF/CNPJ 查询参考限额、已用额度,以及无需冻结 / 须冻结的分级区间。创建时会重新校验交易及密钥条件,包括无等待期托管。max_amount_cents 不能替代费用、路由 / 服务商最低金额或合同限制。资金可能在服务商或本地冻结,须核对收款单的 held_hours、hold_hours 及 liberar_em。不要在客户端固定写入分级限额。

身份验证:ApiKeyAuth

操作标识:getCashinLimits

参数

参数位置类型必填说明
payer_taxquerystring是

CPF 为 11 位数字,CNPJ 为 14 位,仅接受数字。

响应

200

当前分级限额状态

application/json

字段类型必填说明
payer_taxstring否

返回给您的值已遮盖,不提供完整资料。

stage—否

{"enum":["first_transaction","first_24h","mature","disabled","desconhecido"]}

max_amount_centsinteger否

含适用冻结的证件参考最高额度。创建时仍会核对密钥、最低金额及可用性。

used_centsinteger否
available_centsinteger | null否

当前阶段无需冻结即可接受的剩余额度,别名为 instant_available_cents。限额规则关闭时为 null(stage=disabled)。

limit_centsinteger | null否

限额规则关闭时为 null(stage=disabled)。

next_stageobject | null否

限额何时提高,以及提高至多少。

instant_available_centsinteger否

与 available_cents 相同,明确表示无需冻结即可接受的额度。

held_qrobject | null否

适用时提供需要冻结的额度条件。可能由服务商冻结,也可能是收款单本地冻结,须核对创建响应及状态。

查看完整响应模式
{
  "type": "object",
  "properties": {
    "payer_tax": {
      "type": "string",
      "description": "返回给您的值已遮盖,不提供完整资料。"
    },
    "stage": {
      "enum": [
        "first_transaction",
        "first_24h",
        "mature",
        "disabled",
        "desconhecido"
      ]
    },
    "max_amount_cents": {
      "type": "integer",
      "description": "含适用冻结的证件参考最高额度。创建时仍会核对密钥、最低金额及可用性。"
    },
    "used_cents": {
      "type": "integer"
    },
    "available_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "当前阶段无需冻结即可接受的剩余额度,别名为 instant_available_cents。限额规则关闭时为 null(stage=disabled)。"
    },
    "limit_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": " 限额规则关闭时为 null(stage=disabled)。"
    },
    "next_stage": {
      "type": [
        "object",
        "null"
      ],
      "description": "限额何时提高,以及提高至多少。"
    },
    "instant_available_cents": {
      "type": "integer",
      "description": "与 available_cents 相同,明确表示无需冻结即可接受的额度。"
    },
    "held_qr": {
      "type": [
        "object",
        "null"
      ],
      "description": "适用时提供需要冻结的额度条件。可能由服务商冻结,也可能是收款单本地冻结,须核对创建响应及状态。",
      "properties": {
        "stage": {
          "type": "string",
          "enum": [
            "held_qr"
          ]
        },
        "max_amount_cents": {
          "type": "integer"
        },
        "used_cents": {
          "type": "integer",
          "description": "过去 24 小时已付款及处理中的金额。"
        },
        "available_cents": {
          "type": "integer"
        },
        "hold_hours": {
          "type": "integer"
        },
        "explicacao": {
          "type": "string"
        }
      }
    }
  }
}

400

证件格式无效

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /cashin/{cashin_id}/status

Pix 收款单状态

分别查询 Pix 付款及入账 / 交付状态。paid 本身不代表加密资产已交付或余额可用;settlement_status=sent 表示入账 / 交付完成,托管余额仍须核对可用及冻结金额。delayed 表示服务商冻结,paid 配合 liberar_em 可能表示本地冻结。不要因交付尚未完成就要求再次付款。优先使用 webhook,轮询须遵守密钥请求频率限制。

身份验证:ApiKeyAuth

操作标识:getPixChargeStatus

参数

参数位置类型必填说明
cashin_idpathstring是

响应

200

当前状态,附服务器记录的时间线。

application/json

字段类型必填说明
cashin_idstring否

收款单标识,格式为 ci_…。

statusstring否

Pix 状态。paid 本身不证明入账 / 交付完成,须读取 settlement_status。

{"enum":["pending","delayed","under_review","paid","expired","refunded","failed"]}

settlement_statusstring | null否

入账 / 交付状态:sent 表示完成;incerto 须对账。Pix 已付款与资产交付是不同状态。

{"enum":["pending","sending","entregando","sent","incerto","failed",null]}

amount_centsinteger否

Pix 金额,以分计。

depix_received_centsinteger | null否

从结算服务商收到、尚未扣除密钥充值费用的金额,不是托管净入账。

usdt_amountstring | null否

结算返回的旧版数量字段,须结合 asset 及路由专有字段理解。

settlement_tx_hashstring | null否

交付链上哈希,或交易所内部交付标识。

settlement_tx_urlstring | null否

上述哈希的区块浏览器链接,如存在。

payout_addressstring | null否

接收加密资产的钱包,适用于 destino=cripto。

payout_tagstring | null否

共用收款地址等需要附加标识的网络,填写目标钱包 memo/tag,适用于 destino=cripto。

chainstring否

交付网络,使用 GET /cashin/catalog 中的 ID。

assetstring否

交付资产,如 usdt、usdc、btc 等。

payer_tax_numberstring否

应支付二维码的付款人 CPF/CNPJ。不同证件付款将退款,refund_reason 为 PAYER_MISMATCH。

external_idstring | null否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

expires_atstring | null · date-time否

该收款单的实际有效期,以此时间戳为准,也包括机器人延长的有效期。

paid_atstring | null · date-time否
settled_atstring | null · date-time否
destinostring否

cripto 表示链上交付,saldo 表示计入密钥 BRL 托管余额,可通过 POST /payouts 及 POST /saldo/sacar-cripto 使用。

{"enum":["cripto","saldo"]}

held_hoursinteger否

向服务商请求的冻结时长。即使为零,也可能存在本地冻结 hold_hours/liberar_em。

heldboolean否

held_hours > 0 时为 true,单独此字段不能反映本地冻结。

delay_untilstring | null · date-time否

服务商冻结的预计释放时间,如有。

liberar_emstring | null · date-time否

余额入账结束等待期的时间。即时可用时为 null,新密钥自2026年9月16日起默认采用即时释放,但仍须核对适用冻结规则。

e2estring | null否

收到的 Pix EndToEndId,即巴西央行端到端标识。

payer_namestring | null否

用户填写或银行识别的付款人姓名。

customer_refstring | null否

您的最终客户引用,即余额子账户。

{"maxLength":80}

refund_reasonstring | null否

status=refunded 时的退款原因,例如 PAYER_MISMATCH(付款证件不符)、TEST_AMOUNT(测试金额)或 PROVIDER_REJECTED。

refund_reason_detailstring | null否

便于人工阅读的退款原因。

created_atstring | null · date-time否
trilhostring否

交易渠道:casa、corretora、saldo 或 liquid,不构成时效承诺。

timelinearray · object否
tempos_tipicosobject否

按渠道统计的各阶段耗时中位数,单位秒,用于展示典型耗时,不是保证期限。

sandboxboolean否

模拟交易时为 true。

simulationobject否
delivery_modestring否

仅 chain="liquid" 提供,说明 DePix 交付方式。其他网络无此字段。

{"enum":["full","split"]}

net_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示扣费后收款人实际收到的 DePix,即 Lunium 链上发送金额。

fee_total_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示从总额扣除的固定及比例费用。net_cents + fee_total_cents == amount_cents。

settlement_proofstring否

独立于 Pix 付款的交付证据:none = 无已完成发送;broadcast = 已提供交易但尚无已记录确认;confirmed = 已记录确认凭证;reported = 已报告完成但无链上证明,包括托管入账 / 内部转账;simulated = 无真实资金的测试。没有确认记录不能证明失败,核验覆盖范围取决于网络及时间段。

{"enum":["none","broadcast","confirmed","reported","simulated"]}

settlement_confirmed_atstring · date-time否

记录链上确认的时间,仅 settlement_proof=confirmed 时填写。

{"nullable":true}

settlement_blockstring否

已确认区块号,以字符串保存,避免精度损失。

{"nullable":true}

查看完整响应模式
{
  "$ref": "#/components/schemas/StatusCobranca"
}

404

未找到

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /payouts

直接支付 Pix,不经过加密资产环节

发送 Pix,仅扣减通过 Pix 收到的主账户或 customer_ref 子账户可用 BRL 余额。先核对 GET /keys/me 的 payout.enabled,以及 GET /saldo 的 custodia_ativa、pix_rules 与费用。单笔 Pix 最高 R$ 6,000.00,仍受账户较低限额约束。收款人须有有效 CPF/CNPJ;若收款标识本身为 CPF/CNPJ,API 可从中提取。调用服务商前预留本金及费用;余额不足返回 402。请读取当前费用,并用交易的 fee_cents 对账。密钥限额及 mandate 仍然有效。使用稳定 external_id,超时后查询原订单。测试环境使用虚拟余额并按其 API 费用计算,不产生真实付款。USDT 钱包与 BRL 余额相互独立,接收外部 USDT 充值,不使用 /payouts;对应钱包付款流程使用 funding_source=crypto_usdt,不要求收款人证件,限额以报价及 API 条件为准,不适用 BRL 余额的 R$ 6,000 上限。测试密钥使用独立的钱包模拟器,不涉及真实资金。

身份验证:ApiKeyAuth

操作标识:createPixPayout

请求体

必填:是

application/json

字段类型必填说明
amount_centsinteger是

Pix 金额,以整数 BRL 分计,5000 = R$ 50.00。最高 600000(R$ 6,000.00),仍受账户较低限额约束,费用在此金额之外另行扣除。

{"minimum":1,"maximum":600000}

pix_keystring是

接收 BRL 的 Pix 收款标识:CPF、CNPJ、+55 手机号、邮箱或随机标识。11 位纯数字必须同时指定 pix_key_type("cpf" 或 "phone"),否则返回 erro=tipo_ambiguo,不会猜测。

pix_key_type—否

可选,通常根据收款标识格式推断,如邮箱、CNPJ、UUID 或带 +55 的手机号。若为 11 位纯数字,无法区分 CPF 与手机号,则必须填写,否则返回 tipo_ambiguo,不会擅自猜测。

{"enum":["cpf","cnpj","phone","email","random"]}

tax_numberstring否

收款人的有效 CPF 或 CNPJ,须通过校验位检查。邮箱、手机号及随机收款标识必填;收款标识本身为有效 CPF/CNPJ 时可省略,API 直接提取,如另行提供则须一致。证件格式校验不证明该 Pix 标识的实际归属。

beneficiary_namestring否

可选,收款人完整姓名,作为最终用户姓名发送给 Pix 服务商。不是必填项,允许向第三方 Pix 收款标识付款。

{"maxLength":120}

external_idstring否

最多 64 个字符的幂等标识。重试保持原金额、Pix 标识、类型、证件、customer_ref 及 funding_source。409 external_id_divergente 或 external_id_nao_verificavel 会返回 payout_id/recovery_endpoint,供查询原订单;不要为绕过冲突生成新 ID。

{"maxLength":64}

customer_refstring否

扣款子账户,适用于托管密钥。Pix 发送前先扣除本金、平台费用(saque_fee_bps)及服务商费用;服务商明确拒绝时冲回扣款。可用余额低于本金及费用时返回 402 saldo_insuficiente,费用字段见 GET /saldo 的 saque_fee_bps、saque_taxa_estimada_cents。使用与充值时相同的子账户引用,例如商户引用。

{"maxLength":80}

sandbox_scenariostring否

仅用于测试密钥。GET /sandbox 提供各流程的场景矩阵,生产环境应省略。价格、付款及提现均为模拟结果。

{"enum":["success","delayed","held","expired","refunded","failed","payer_mismatch","settlement_failed","settlement_uncertain","route_unavailable","provider_unavailable"]}

funding_sourcestring否

可选,仅接受 pix_brl。此接口扣减通过 Pix 收到的 BRL 余额,绝不扣减 USDT 钱包。

{"enum":["pix_brl"]}

查看完整请求模式
{
  "type": "object",
  "properties": {
    "amount_cents": {
      "type": "integer",
      "minimum": 1,
      "description": "Pix 金额,以整数 BRL 分计,5000 = R$ 50.00。最高 600000(R$ 6,000.00),仍受账户较低限额约束,费用在此金额之外另行扣除。",
      "maximum": 600000
    },
    "pix_key": {
      "type": "string",
      "description": "接收 BRL 的 Pix 收款标识:CPF、CNPJ、+55 手机号、邮箱或随机标识。11 位纯数字必须同时指定 pix_key_type(\"cpf\" 或 \"phone\"),否则返回 erro=tipo_ambiguo,不会猜测。"
    },
    "pix_key_type": {
      "enum": [
        "cpf",
        "cnpj",
        "phone",
        "email",
        "random"
      ],
      "description": "可选,通常根据收款标识格式推断,如邮箱、CNPJ、UUID 或带 +55 的手机号。若为 11 位纯数字,无法区分 CPF 与手机号,则必须填写,否则返回 tipo_ambiguo,不会擅自猜测。"
    },
    "tax_number": {
      "type": "string",
      "description": "收款人的有效 CPF 或 CNPJ,须通过校验位检查。邮箱、手机号及随机收款标识必填;收款标识本身为有效 CPF/CNPJ 时可省略,API 直接提取,如另行提供则须一致。证件格式校验不证明该 Pix 标识的实际归属。"
    },
    "beneficiary_name": {
      "type": "string",
      "maxLength": 120,
      "description": "可选,收款人完整姓名,作为最终用户姓名发送给 Pix 服务商。不是必填项,允许向第三方 Pix 收款标识付款。"
    },
    "external_id": {
      "type": "string",
      "description": "最多 64 个字符的幂等标识。重试保持原金额、Pix 标识、类型、证件、customer_ref 及 funding_source。409 external_id_divergente 或 external_id_nao_verificavel 会返回 payout_id/recovery_endpoint,供查询原订单;不要为绕过冲突生成新 ID。",
      "maxLength": 64
    },
    "customer_ref": {
      "type": "string",
      "maxLength": 80,
      "description": "扣款子账户,适用于托管密钥。Pix 发送前先扣除本金、平台费用(saque_fee_bps)及服务商费用;服务商明确拒绝时冲回扣款。可用余额低于本金及费用时返回 402 saldo_insuficiente,费用字段见 GET /saldo 的 saque_fee_bps、saque_taxa_estimada_cents。使用与充值时相同的子账户引用,例如商户引用。"
    },
    "sandbox_scenario": {
      "type": "string",
      "enum": [
        "success",
        "delayed",
        "held",
        "expired",
        "refunded",
        "failed",
        "payer_mismatch",
        "settlement_failed",
        "settlement_uncertain",
        "route_unavailable",
        "provider_unavailable"
      ],
      "description": "仅用于测试密钥。GET /sandbox 提供各流程的场景矩阵,生产环境应省略。价格、付款及提现均为模拟结果。"
    },
    "funding_source": {
      "type": "string",
      "enum": [
        "pix_brl"
      ],
      "description": "可选,仅接受 pix_brl。此接口扣减通过 Pix 收到的 BRL 余额,绝不扣减 USDT 钱包。"
    }
  },
  "required": [
    "amount_cents",
    "pix_key"
  ]
}

响应

403

管理端停用或 custodia_desligada。生产密钥默认启用;若出现此响应,应停止并联系支持,不要持续重试。未发送 Pix。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

external_id_divergente 或 external_id_nao_verificavel:通过 payout_id/recovery_endpoint 查询原交易,不改变参数或为同一意图生成新 ID。em_processamento:查询正在处理的原订单,不新建付款。

application/json

查看完整响应模式
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Erro"
    },
    {
      "type": "object",
      "properties": {
        "payout_id": {
          "type": "string",
          "description": "原 Pix 对外付款标识。"
        },
        "recovery_endpoint": {
          "type": "string",
          "description": "原 Pix 对外付款的相对 API 路径。"
        }
      }
    }
  ]
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

423

carencia_primeiro_deposito — 首次充值等待期,仅适用于约定了等待期的密钥;自2026年9月16日起,新密钥默认无此等待期。对应子账户须等待 libera_em 后才可提现,其他冻结规则仍可能适用。

application/json

字段类型必填说明
errostring否

{"enum":["carencia_primeiro_deposito"]}

acaostring否

{"enum":["esperar"]}

detailstring否
libera_emstring · date-time否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "erro": {
      "type": "string",
      "enum": [
        "carencia_primeiro_deposito"
      ]
    },
    "acao": {
      "type": "string",
      "enum": [
        "esperar"
      ]
    },
    "detail": {
      "type": "string"
    },
    "libera_em": {
      "type": "string",
      "format": "date-time"
    }
  }
}

503

saque_indisponivel:资金渠道或服务商不可用,本次尝试不新增预留或扣款。idempotencia_indisponivel:无法核对原订单,不创建新订单,但原订单可能已存在。请等待并查询同一 external_id,不要生成新 ID。

200

Pix 对外付款已创建,或幂等返回原交易。

application/json

字段类型必填说明
payout_idstring否
customer_refstring | null否

{"maxLength":80}

statusstring否

processing、sent、failed 或 refunded,须通过流水核对余额,并兼容新增状态。

amount_centsinteger否

收款人实际收到的金额。

fee_centsinteger | null否

amount_cents 之外的总费用:fee_service_total_cents + fee_provider_cents。已包含合作伙伴佣金,不要重复加上。

fee_service_centsinteger | null否

已保存的 Lunium 服务费,以分计,为会计组成项。客户界面及通知应使用 fee_service_total_cents。

fee_provider_centsinteger | null否

服务商费用:fee_cents 减去 fee_service_cents 及 fee_partner_cents。

pix_keystring否
pix_key_typestring否

{"enum":["cpf","cnpj","phone","email","random"]}

tax_numberstring | null否

收款人证件经遮盖后的值,如有;请求中该字段为可选。

external_idstring | null否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

errorstring | null否

failed/refunded 时的原因。

e2estring | null否

已发送 Pix 的 EndToEndId。

receiver_namestring | null否

付款后取得的收款人姓名,如可用;未取得时为 null。

receiver_tax_numberstring | null否
paid_atstring | null · date-time否
sent_atstring | null · date-time否
verify_urlstring | null否

公开 Pix 核验,GET /v1/verificar/{e2e}。

created_atstring | null · date-time否
updated_atstring | null · date-time否
sandboxboolean否

模拟交易时为 true。

simulationobject否
fee_partner_centsinteger否

本次提现从余额扣除的合作伙伴 sub fee,以分计,已包含在 fee_cents 中。

{"nullable":true}

fee_service_total_centsinteger | null否

客户合并服务费,即交易保存的 Lunium 费用加合作伙伴佣金,保留原分位舍入及历史费率。旧记录中平台组成项未知时为 null。生产及测试环境的付款响应与 payout.* webhook data 均提供此字段。仅加一次 fee_provider_cents 即得 fee_cents,不再加 fee_partner_cents。

{"minimum":0}

查看完整响应模式
{
  "$ref": "#/components/schemas/Payout"
}

400

已拒绝或失败,请读取返回的 erro、acao 及 detail(如有)。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

402

已拒绝或失败,请读取返回的 erro、acao 及 detail(如有)。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

500

已拒绝或失败,请读取返回的 erro、acao 及 detail(如有)。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /payouts

列出当前密钥的 Pix 对外付款

身份验证:ApiKeyAuth

操作标识:listPixPayouts

参数

参数位置类型必填说明
statusquerystring否
limitqueryinteger否
external_idquerystring否

幂等恢复:返回该 external_id 对应的交易,结果为 0 或 1 笔。标识在同一密钥及产品内唯一,区分大小写,并永久保留。

响应

200

列表,最新记录在前。空列表返回 200,不返回 403。

application/json

字段类型必填说明
payoutsarray · Payout否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "payouts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Payout"
      }
    }
  }
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

当前密钥尚未启用 Pix 对外付款。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /payouts/{payout_id}

Pix 对外付款状态

身份验证:ApiKeyAuth

操作标识:getPixPayout

参数

参数位置类型必填说明
payout_idpathstring是

响应

200

提现状态。

application/json

字段类型必填说明
payout_idstring否
customer_refstring | null否

{"maxLength":80}

statusstring否

processing、sent、failed 或 refunded,须通过流水核对余额,并兼容新增状态。

amount_centsinteger否

收款人实际收到的金额。

fee_centsinteger | null否

amount_cents 之外的总费用:fee_service_total_cents + fee_provider_cents。已包含合作伙伴佣金,不要重复加上。

fee_service_centsinteger | null否

已保存的 Lunium 服务费,以分计,为会计组成项。客户界面及通知应使用 fee_service_total_cents。

fee_provider_centsinteger | null否

服务商费用:fee_cents 减去 fee_service_cents 及 fee_partner_cents。

pix_keystring否
pix_key_typestring否

{"enum":["cpf","cnpj","phone","email","random"]}

tax_numberstring | null否

收款人证件经遮盖后的值,如有;请求中该字段为可选。

external_idstring | null否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

errorstring | null否

failed/refunded 时的原因。

e2estring | null否

已发送 Pix 的 EndToEndId。

receiver_namestring | null否

付款后取得的收款人姓名,如可用;未取得时为 null。

receiver_tax_numberstring | null否
paid_atstring | null · date-time否
sent_atstring | null · date-time否
verify_urlstring | null否

公开 Pix 核验,GET /v1/verificar/{e2e}。

created_atstring | null · date-time否
updated_atstring | null · date-time否
sandboxboolean否

模拟交易时为 true。

simulationobject否
fee_partner_centsinteger否

本次提现从余额扣除的合作伙伴 sub fee,以分计,已包含在 fee_cents 中。

{"nullable":true}

fee_service_total_centsinteger | null否

客户合并服务费,即交易保存的 Lunium 费用加合作伙伴佣金,保留原分位舍入及历史费率。旧记录中平台组成项未知时为 null。生产及测试环境的付款响应与 payout.* webhook data 均提供此字段。仅加一次 fee_provider_cents 即得 fee_cents,不再加 fee_partner_cents。

{"minimum":0}

查看完整响应模式
{
  "$ref": "#/components/schemas/Payout"
}

404

未找到

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /webhooks/deliveries

查询当前密钥的 webhook 投递历史

诊断已投递、失败及其原因,不返回原事件请求体。重发原始请求体须使用 retry 接口。

身份验证:ApiKeyAuth

操作标识:listWebhookDeliveries

参数

参数位置类型必填说明
statusquerystring否
eventquerystring否
limitqueryinteger否

响应

200

投递记录,最新在前。

application/json

字段类型必填说明
deliveriesarray · EntregaWebhook否
failed_countinteger否

本次响应中,已耗尽尝试次数的记录数。

查看完整响应模式
{
  "type": "object",
  "properties": {
    "deliveries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntregaWebhook"
      }
    },
    "failed_count": {
      "type": "integer",
      "description": "本次响应中,已耗尽尝试次数的记录数。"
    }
  }
}

400

筛选条件无效

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /webhooks/deliveries/{event_id}/retry

重发事件

在本次调用中尝试投递并返回结果;再次失败时,重新入队,并获得新的 12 次尝试机会。已收到 2xx 确认的事件不允许重发。

身份验证:ApiKeyAuth

操作标识:retryWebhookDelivery

参数

参数位置类型必填说明
event_idpathstring是

响应

200

本次投递成功。

application/json

字段类型必填说明
event_idstring否
deliveredboolean否

{"const":true}

status_codeinteger否
msinteger否
delivery_idstring否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string"
    },
    "delivered": {
      "type": "boolean",
      "const": true
    },
    "status_code": {
      "type": "integer"
    },
    "ms": {
      "type": "integer"
    },
    "delivery_id": {
      "type": "string"
    }
  }
}

202

本次未送达,已重新入队。

404

当前密钥下未找到记录

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

已送达,重发将造成重复

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /webhooks/test

立即发送测试事件

通过与生产相同的 HTTP 投递机制,向 webhook_url 发送 webhook.test,并返回接收端状态码及延迟。不移动资金,也不进入持久投递队列。首张真实收款单前可先测试,每分钟最多 6 次。

身份验证:ApiKeyAuth

操作标识:testWebhook

响应

200

您的接收端返回了 2xx。

application/json

字段类型必填说明
okboolean否
event_idstring否
delivery_idstring否
urlstring否
status_codeinteger否
msinteger否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "event_id": {
      "type": "string"
    },
    "delivery_id": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "status_code": {
      "type": "integer"
    },
    "ms": {
      "type": "integer"
    }
  }
}

400

尚未配置 webhook_url

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

429

每分钟测试次数超过 6 次

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

502

您的接收端未返回 2xx,请求响应说明了具体情况。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /cashin/charges

列出 / 恢复当前密钥的 cash-in 收款单

身份验证:ApiKeyAuth

操作标识:listPixCharges

参数

参数位置类型必填说明
external_idquerystring否

幂等恢复:返回该 external_id 对应的交易,结果为 0 或 1 笔。标识在同一密钥及产品内唯一,区分大小写,并永久保留。

statusquerystring否
startquerystring · date-time否
endquerystring · date-time否
limitqueryinteger否

响应

200

列表,最新记录在前。

application/json

字段类型必填说明
chargesarray · Cobranca否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "charges": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Cobranca"
      }
    }
  }
}

401

缺少 X-API-Key 或密钥无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

列表查询须提供 X-API-Key,不是公开接口。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /cashin/preview

Cash-in 预估,不创建交易

2026年10月15日政策:余额充值 R$ 1.00,无比例费用及佣金;直接购买 3.3% + R$ 1.00;余额兑换加密资产 3.3%,不再收固定费用;余额 Pix 提现 1.5%。购买及转出另计合作伙伴佣金。参考汇率为 Binance 卖一价,不加溢价;网络及处理成本在预览中列明。destino=saldo 时预览返回 BRL,net_cents=amount_cents-100,不执行兑换或创建收款单,也不是加密资产提现的扣款预览。

身份验证:ApiKeyAuth

操作标识:previewPixCharge

请求体

必填:是

application/json

字段类型必填说明
amount_centsinteger是

BRL 金额,以整数分计。实际最低金额取决于密钥、费用及路由。查询 GET /keys/me 及返回的 min_brl_cents/limits,不要固定使用示例最低金额。

{"minimum":1}

assetstring否

GET /cashin/catalog 中可交付路由的资产,不限于稳定币。

{"default":"usdt"}

chainstring否

交付路由的网络,将目录中的 network 值填入此 chain 字段。

{"default":"polygon"}

delivery_modestring否

仅 chain="liquid"(DePix)适用。full 直接向指定钱包交付全部 DePix,不从中扣除密钥费用。split 采用接收再转发:Lunium 接收后扣除密钥的固定及比例费用,再向 payout_address 发送净额,响应 net_cents 即收款人实际接收金额。split 必须提供 payout_address。省略此字段时,以密钥的实际默认配置为准。

{"enum":["full","split"],"default":"full"}

destinostring否

{"enum":["cripto","saldo"],"default":"cripto"}

查看完整请求模式
{
  "type": "object",
  "required": [
    "amount_cents"
  ],
  "properties": {
    "amount_cents": {
      "type": "integer",
      "minimum": 1,
      "description": "BRL 金额,以整数分计。实际最低金额取决于密钥、费用及路由。查询 GET /keys/me 及返回的 min_brl_cents/limits,不要固定使用示例最低金额。"
    },
    "asset": {
      "type": "string",
      "default": "usdt",
      "description": "GET /cashin/catalog 中可交付路由的资产,不限于稳定币。"
    },
    "chain": {
      "type": "string",
      "default": "polygon",
      "description": "交付路由的网络,将目录中的 network 值填入此 chain 字段。"
    },
    "delivery_mode": {
      "type": "string",
      "enum": [
        "full",
        "split"
      ],
      "default": "full",
      "description": "仅 chain=\"liquid\"(DePix)适用。full 直接向指定钱包交付全部 DePix,不从中扣除密钥费用。split 采用接收再转发:Lunium 接收后扣除密钥的固定及比例费用,再向 payout_address 发送净额,响应 net_cents 即收款人实际接收金额。split 必须提供 payout_address。省略此字段时,以密钥的实际默认配置为准。"
    },
    "destino": {
      "type": "string",
      "enum": [
        "cripto",
        "saldo"
      ],
      "default": "cripto"
    }
  }
}

响应

200

已应用当前密钥费用的报价。

application/json

查看完整响应模式
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "asset": {
          "type": "string",
          "description": "交付资产,原样返回请求值,如 usdt、usdc、depix、btc。"
        },
        "amount_cents": {
          "type": "integer",
          "description": "收款单金额,以分计,原样返回请求值。"
        },
        "admin_fee_bps": {
          "type": "integer"
        },
        "admin_fee_fixed_cents": {
          "type": "integer"
        },
        "fee_total_cents": {
          "type": "integer",
          "description": "从总额扣除的全部费用:固定费用 + Lunium 比例费用 + 合作伙伴 sub fee。恒等式为 fee_total_cents + net_cents == amount_cents,各方份额见 lunium_fee_cents 与 partner_fee_cents。"
        },
        "net_cents": {
          "type": "integer",
          "description": "用于为最终用户兑换加密资产的净额,已扣除适用合作伙伴 sub fee。"
        },
        "brl_per_usdt": {
          "type": "string",
          "description": "供阅读的舍入汇率,实际交付使用完整精度汇率。"
        },
        "usdt_amount": {
          "type": "string",
          "description": "旧版数量字段。平台渠道(DePix 及由 Lunium 自有钱包交付)表示交付数量;经兑换的路由(BTC、ETH、其他币种,及部分网络上的稳定币)表示用于购买的 USDT,不是客户收到的数量。展示钱包接收数量时,始终使用 asset_amount。"
        },
        "chain": {
          "type": "string",
          "description": "交付网络,原样返回并规范化请求值,例如 sol → solana、trc20 → tron。"
        },
        "asset_amount": {
          "type": "string",
          "description": "客户钱包预计收到的加密资产数量,已扣密钥费用、合作伙伴 sub fee,以及兑换路由的购买成本和网络提现费用 withdraw_fee。用于展示“您将收到”,测试环境使用相同字段。此值为预估,交付时按付款时的汇率重新计算。"
        },
        "withdraw_fee": {
          "type": "string",
          "description": "网络提现费用,以资产单位表示,已从 asset_amount 扣除。按每次发送固定收取,与金额无关,因此小额交易影响更大,例如 Bitcoin 网络上的 BTC。平台自有渠道为 \"0\"。换算 BRL 使用 withdraw_fee × brl_per_asset。"
        },
        "withdraw_min": {
          "type": "string",
          "description": "网络可发送的最低资产数量,适用于兑换路由。最低 BRL 金额已在 min_brl_cents 计算。"
        },
        "brl_per_asset": {
          "type": [
            "number",
            "null"
          ],
          "description": "本次预览每单位资产对应的 BRL,即净额 ÷ 购买数量,可用于将 withdraw_fee 及 asset_amount 换算为 BRL。仅供参考,无有效计算时为 null。"
        },
        "min_brl_cents": {
          "type": "integer",
          "description": "该路由在当前密钥费用条件下可交付的最低金额,以分计。"
        },
        "eta": {
          "type": "string",
          "description": "兑换路由的典型交付时间,不是合同最长时限。"
        },
        "amount": {
          "type": "string",
          "description": "asset_amount 的旧名称,仅兑换路由提供,优先使用 asset_amount。",
          "deprecated": true
        },
        "network_min": {
          "type": "string",
          "description": "withdraw_min 的旧名称,优先使用 withdraw_min。",
          "deprecated": true
        },
        "partner_fee_bps": {
          "type": "integer",
          "description": "本次报价适用的合作伙伴 sub fee,单位 bps,0 表示不使用。"
        },
        "lunium_fee_cents": {
          "type": "integer",
          "description": "Lunium 份额,含固定及比例部分。未设 sub fee 时等于 fee_total_cents。"
        },
        "partner_fee_cents": {
          "type": "integer",
          "description": "合作伙伴 sub fee 份额,加密资产交付后记入佣金。通过同一次向下取整结果的差额计算,合作伙伴佣金不改变 Lunium 份额。"
        },
        "sandbox": {
          "const": false
        },
        "delivery_mode": {
          "type": "string",
          "enum": [
            "full",
            "split"
          ],
          "description": "仅 chain=\"liquid\" 提供,说明 DePix 交付方式。其他网络无此字段。"
        },
        "destino": {
          "type": "string",
          "enum": [
            "cripto",
            "saldo"
          ]
        }
      },
      "description": "2026年10月15日政策:余额充值 R$ 1.00,无比例费用及佣金;直接购买 3.3% + R$ 1.00;余额兑换加密资产 3.3%,不再收固定费用;余额 Pix 提现 1.5%。购买及转出另计合作伙伴佣金。参考汇率为 Binance 卖一价,不加溢价;网络及处理成本在预览中列明。destino=saldo 时预览返回 BRL,net_cents=amount_cents-100,不执行兑换或创建收款单,也不是加密资产提现的扣款预览。"
    },
    {
      "type": "object",
      "description": "隔离的测试环境,使用含路由提现费用的模拟报价,不调用服务商。fee_bps 及 fee_fixed_cents 为模拟费率,不代表生产报价。",
      "required": [
        "sandbox",
        "synthetic",
        "amount_cents",
        "min_brl_cents",
        "fee_bps",
        "fee_fixed_cents",
        "partner_fee_bps",
        "asset",
        "chain",
        "usdt_amount",
        "asset_amount",
        "withdraw_fee",
        "withdraw_min",
        "brl_per_usdt",
        "brl_per_asset"
      ],
      "properties": {
        "sandbox": {
          "const": true
        },
        "synthetic": {
          "const": true
        },
        "amount_cents": {
          "type": "integer"
        },
        "min_brl_cents": {
          "type": "integer"
        },
        "fee_bps": {
          "type": "integer"
        },
        "fee_fixed_cents": {
          "type": "integer"
        },
        "partner_fee_bps": {
          "type": "integer"
        },
        "asset": {
          "type": "string"
        },
        "chain": {
          "type": "string"
        },
        "usdt_amount": {
          "type": "string"
        },
        "asset_amount": {
          "type": "string"
        },
        "withdraw_fee": {
          "type": "string"
        },
        "withdraw_min": {
          "type": "string"
        },
        "brl_per_usdt": {
          "type": "number"
        },
        "brl_per_asset": {
          "type": "number"
        }
      }
    }
  ]
}

400

金额超过密钥限额或参数无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /pix/keys/lookup

在核验服务可用时查询 Pix 收款人

辅助收款人查询。停用时返回 HTTP 200,且 verified=false、available=false、verification_status=not_performed、source=disabled,收款人资料为 null,不影响付款功能。可用时返回从 DICT 获取的资料,受缓存及限流约束。测试环境返回虚构资料,source=sandbox。不能仅凭 HTTP 200 判定已核验收款人;已知类型时,应明确发送 type。

身份验证:ApiKeyAuth

操作标识:consultarTitularChavePix

参数

参数位置类型必填说明
keyquerystring是

Pix 收款标识:CPF、CNPJ、邮箱、带或不带 +55 的手机号,或随机标识。

typequerystring否

可选,省略时按格式推断。

响应

200

已找到收款人。

application/json

字段类型必填说明
pix_keystring是

规范化后的 Pix 收款标识,手机号格式为 +55…。

pix_key_typestring是

所查询收款标识类型:"cpf"、"cnpj"、"phone"、"email" 或 "random"。

{"enum":["cpf","cnpj","phone","email","random"]}

owner_namestring | null是

DICT 中的持有人姓名。

owner_tax_numberstring | null否

已遮盖的 CPF/CNPJ,绝不返回完整值。

institution_namestring | null否

收款标识登记的金融机构。

ispbstring | null否

机构 ISPB,8 位数字。

verifiedboolean是

已查询收款人或在测试环境模拟时为 true(source=sandbox);未核验时为 false。

sourcestring是

{"enum":["dict","sandbox","disabled"]}

checked_atstring · date-time是
cachedboolean否

响应来自缓存时为 true。

sandboxboolean否

仅测试密钥提供,表示虚构收款人。

availableboolean否

查询不可用时为 false,也可能同时返回 HTTP 200。

optionalboolean否

查询为辅助功能,不是付款前提。

verification_statusstring否

未执行核验时为 not_performed。

detailstring否
查看完整响应模式
{
  "$ref": "#/components/schemas/TitularPix"
}

400

收款标识格式无效(pix_key_invalida)或缺失(pix_key_obrigatoria)。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

404

DICT 中不存在该收款标识(chave_nao_encontrada)。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

429

账户每分钟最多查询 5 次(limite_consultas),请读取 Retry-After。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

DICT 服务商不可用(provedor_indisponivel,可重试),或查询已停用(consulta_indisponivel,应等待)。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /saldo

BRL 托管余额:可用、冻结及后续资金释放

主账户或 customer_ref 子账户的 BRL 余额,返回可用、冻结金额、后续释放及实际托管条件。费用及等待期因密钥而异。收款单本地冻结、服务商冻结及余额等待期是不同规则。仅 disponivel_cents 可用于提现;GET /saldo/consolidado 汇总主账户及客户子账户。测试环境返回持久保存的虚拟余额,支持模拟充值、提现与转账。

身份验证:ApiKey

操作标识:getBalance

参数

参数位置类型必填说明
customer_refquerystring否

子账户,即您系统中的最终客户 ID。省略时查询密钥主账户余额。

响应

200

OK

application/json

字段类型必填说明
customer_refstring | null否

{"maxLength":80}

disponivel_centsinteger是
bloqueado_centsinteger是
total_centsinteger是
movimentosinteger否
proximas_liberacoesarray · object否

所查询主账户或 customer_ref 子账户的后续资金释放记录,最多 200 项,1.44.1 之前最多 20 项。不要假定更低上限。

custodia_ativaboolean否

false 表示当前密钥不能托管 BRL,destino="saldo" 会被拒绝。

carencia_horasinteger否

该密钥配置的等待期,即时入账时为零。收款单冻结及其他冻结入账仍独立适用。

deposito_fee_bpsinteger否

新余额充值始终为 0。

saque_taxa_estimada_centsinteger否

服务商固定费用或预估最低费用。比例计费须应用 saque_taxa_provedor_formula,此值不是所有提现的完整总价。

saque_fee_bpsinteger否

BRL 余额通过 Pix 提现的 Lunium 费率,标准 150 bps,另计合作伙伴佣金,处理费用单独列明。

saque_cripto_fee_bpsinteger否

加密资产扣款附加费为 0,Lunium 费用仅在兑换时计一次。

primeiro_deposito_emstring | null · date-time否

该子账户首次充值入账时间,null 表示从未充值。

carencia_atestring | null · date-time否

正在适用的首次充值等待期结束时间,否则为 null。还须读取 bloqueado_cents 及 proximas_liberacoes。

retencao_acima_centsinteger否

托管首笔合格付款的规则阈值,不表示超过此金额的每笔充值均冻结,仍取决于付款人分级及密钥条件。

deposito_fee_fixed_centsinteger否

新余额充值每笔固定 100 分,即 R$ 1.00。

saque_taxa_provedor_formulastring | null否

当前公式:固定费用(piso_cents),或带最低费用的比例计费。不要假定某个服务商始终可用。

saque_taxa_provedor_tipostring否

Pix 对外付款服务商当前计费类型。

{"enum":["fixo","percentual"]}

saque_taxa_provedor_piso_centsinteger否

固定费用或比例计费的最低费用,以分计。

sandboxboolean否

精简测试响应中为 true。

saque_partner_fee_bpsinteger否

Pix 及加密资产转出的合作伙伴 sub fee,在 Lunium 费用之外另计。

saque_fee_total_bpsinteger否

客户展示用合并服务费率,平台费率 + 合作伙伴附加费率,单位 bps,250 = 2.5%。与固定费用一起展示,不单列合作伙伴佣金。金额使用实际报价 / 已保存值,内部组成项分别按分舍入。生产及测试环境均适用。

{"minimum":0}

saque_cripto_conversao_fee_bpsinteger否

余额兑换加密资产的 Lunium 比例费用,基于无溢价 Binance 报价,标准 330 bps。

saque_cripto_conversao_fee_fixed_centsinteger否

为零,入金固定成本已在充值时收取。

deposito_partner_fee_bpsinteger否

为零,余额充值不产生合作伙伴佣金。

查看完整响应模式
{
  "type": "object",
  "required": [
    "disponivel_cents",
    "bloqueado_cents",
    "total_cents"
  ],
  "properties": {
    "customer_ref": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "disponivel_cents": {
      "type": "integer"
    },
    "bloqueado_cents": {
      "type": "integer"
    },
    "total_cents": {
      "type": "integer"
    },
    "movimentos": {
      "type": "integer"
    },
    "proximas_liberacoes": {
      "type": "array",
      "description": "所查询主账户或 customer_ref 子账户的后续资金释放记录,最多 200 项,1.44.1 之前最多 20 项。不要假定更低上限。",
      "items": {
        "type": "object",
        "properties": {
          "disponivel_em": {
            "type": "string",
            "format": "date-time"
          },
          "valor_cents": {
            "type": "integer"
          }
        }
      }
    },
    "custodia_ativa": {
      "type": "boolean",
      "description": "false 表示当前密钥不能托管 BRL,destino=\"saldo\" 会被拒绝。"
    },
    "carencia_horas": {
      "type": "integer",
      "description": "该密钥配置的等待期,即时入账时为零。收款单冻结及其他冻结入账仍独立适用。"
    },
    "deposito_fee_bps": {
      "type": "integer",
      "description": "新余额充值始终为 0。"
    },
    "saque_taxa_estimada_cents": {
      "type": "integer",
      "description": "服务商固定费用或预估最低费用。比例计费须应用 saque_taxa_provedor_formula,此值不是所有提现的完整总价。"
    },
    "saque_fee_bps": {
      "type": "integer",
      "description": "BRL 余额通过 Pix 提现的 Lunium 费率,标准 150 bps,另计合作伙伴佣金,处理费用单独列明。"
    },
    "saque_cripto_fee_bps": {
      "type": "integer",
      "description": "加密资产扣款附加费为 0,Lunium 费用仅在兑换时计一次。"
    },
    "primeiro_deposito_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "该子账户首次充值入账时间,null 表示从未充值。"
    },
    "carencia_ate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "正在适用的首次充值等待期结束时间,否则为 null。还须读取 bloqueado_cents 及 proximas_liberacoes。"
    },
    "retencao_acima_cents": {
      "type": "integer",
      "description": "托管首笔合格付款的规则阈值,不表示超过此金额的每笔充值均冻结,仍取决于付款人分级及密钥条件。"
    },
    "deposito_fee_fixed_cents": {
      "type": "integer",
      "description": "新余额充值每笔固定 100 分,即 R$ 1.00。"
    },
    "saque_taxa_provedor_formula": {
      "type": [
        "string",
        "null"
      ],
      "description": "当前公式:固定费用(piso_cents),或带最低费用的比例计费。不要假定某个服务商始终可用。"
    },
    "saque_taxa_provedor_tipo": {
      "type": "string",
      "enum": [
        "fixo",
        "percentual"
      ],
      "description": "Pix 对外付款服务商当前计费类型。"
    },
    "saque_taxa_provedor_piso_cents": {
      "type": "integer",
      "description": "固定费用或比例计费的最低费用,以分计。"
    },
    "sandbox": {
      "type": "boolean",
      "description": "精简测试响应中为 true。"
    },
    "saque_partner_fee_bps": {
      "type": "integer",
      "description": "Pix 及加密资产转出的合作伙伴 sub fee,在 Lunium 费用之外另计。"
    },
    "saque_fee_total_bps": {
      "type": "integer",
      "minimum": 0,
      "description": "客户展示用合并服务费率,平台费率 + 合作伙伴附加费率,单位 bps,250 = 2.5%。与固定费用一起展示,不单列合作伙伴佣金。金额使用实际报价 / 已保存值,内部组成项分别按分舍入。生产及测试环境均适用。"
    },
    "saque_cripto_conversao_fee_bps": {
      "type": "integer",
      "description": "余额兑换加密资产的 Lunium 比例费用,基于无溢价 Binance 报价,标准 330 bps。"
    },
    "saque_cripto_conversao_fee_fixed_cents": {
      "type": "integer",
      "description": "为零,入金固定成本已在充值时收取。"
    },
    "deposito_partner_fee_bps": {
      "type": "integer",
      "description": "为零,余额充值不产生合作伙伴佣金。"
    }
  }
}

401

缺少密钥或密钥无效

GET /saldo/extrato

余额流水:会计记录或按交易分组

最终用户动态应使用 visao=operacoes:每笔交易一个带符号总额,内部仅一个费用项(tipo=servico,descricao=Taxa),包含 Pix 固定费用及全部费用组成。退款另列。先分组再分页,通知按 origem_id 及 tipo 去重,不按费用会计项去重。不得将支出 / 费用显示为收入,也不得重复扣费。已配置合并展示的项目默认使用此视图;visao=movimentos 明确选择供后端对账使用的会计视图。其他项目仍默认逐笔会计流水,测试环境行为相同。内部费用归属及组成字段不应直接转发至客户通知。详见 https://docs.luniumpay.com/zh/manual#extrato-por-operacao 。

身份验证:ApiKey

操作标识:getBalanceStatement

参数

参数位置类型必填说明
customer_refquerystring否
limitqueryinteger否
visaoquerystring否

operacoes 将相关费用合并在对应交易内。省略时保留默认会计流水契约,项目特殊展示配置另行适用。

beforequerystring否

使用同一视图及 customer_ref 返回的 proxima_pagina。游标为十进制 bigint 字符串,不转换为 Number。分组视图以最早账本 ID 为锚点。

响应

200

OK

application/json

字段类型必填说明
movimentosarray · object否
proxima_paginastring | null否
visaostring否

仅分组视图提供。

{"const":"operacoes"}

has_moreboolean否

分组视图是否还有下一页,最后一页游标为 null。

示例 groupedOperation

visao=operacoes:Pix R$ 2.00 + 合并费用 R$ 1.05 = 扣款 R$ 3.05

{
  "visao": "operacoes",
  "movimentos": [
    {
      "id": "123",
      "tipo": "payout",
      "origem_tipo": "payout",
      "origem_id": "po_example",
      "customer_ref": "customer-42",
      "valor_cents": -305,
      "sentido": "debito",
      "valor_operacao_cents": -200,
      "taxas_cents": 105,
      "taxas": [
        {
          "tipo": "servico",
          "descricao": "Taxa",
          "valor_cents": 105,
          "efeito_saldo_cents": -105
        }
      ],
      "status": "sent",
      "status_label": "Concluído",
      "settlement_status": null,
      "descricao": "Saque por Pix",
      "movimentos_ids": [
        "123",
        "124",
        "125",
        "126"
      ],
      "criado_em": "2026-10-09T21:36:00Z",
      "atualizado_em": "2026-10-09T21:38:00Z",
      "disponivel_em": "2026-10-09T21:36:00Z",
      "disponivel": true
    }
  ],
  "proxima_pagina": null,
  "has_more": false
}
查看完整响应模式
{
  "type": "object",
  "properties": {
    "movimentos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "valor_cents": {
            "type": "integer",
            "description": "对 BRL 余额产生的带符号总影响,以分计。负数为扣款,正数为入账。分组视图已计入费用。"
          },
          "sentido": {
            "type": "string",
            "enum": [
              "credito",
              "debito"
            ]
          },
          "tipo": {
            "type": "string",
            "enum": [
              "cashin",
              "payout",
              "cashout",
              "estorno",
              "ajuste",
              "transfer_in",
              "transfer_out"
            ]
          },
          "origem_tipo": {
            "type": [
              "string",
              "null"
            ]
          },
          "origem_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "disponivel_em": {
            "type": "string",
            "format": "date-time"
          },
          "disponivel": {
            "type": "boolean"
          },
          "descricao": {
            "type": [
              "string",
              "null"
            ]
          },
          "criado_em": {
            "type": "string",
            "format": "date-time"
          },
          "customer_ref": {
            "type": [
              "string",
              "null"
            ]
          },
          "valor_operacao_cents": {
            "type": "integer",
            "description": "分组视图的带符号本金。无法关联本金的独立费用调整为零。"
          },
          "taxas_cents": {
            "type": "integer",
            "minimum": 0,
            "description": "分组视图已包含费用流水的绝对值总和,不是额外扣款。"
          },
          "taxas": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "tipo",
                "descricao",
                "valor_cents",
                "efeito_saldo_cents"
              ],
              "properties": {
                "tipo": {
                  "type": "string",
                  "enum": [
                    "servico"
                  ]
                },
                "descricao": {
                  "type": "string"
                },
                "valor_cents": {
                  "type": "integer",
                  "minimum": 0
                },
                "efeito_saldo_cents": {
                  "type": "integer"
                }
              }
            },
            "description": "客户费用明细中的 servico 已包含合作伙伴费用。当前合并展示将适用 Pix 费用及服务费计入交易总费用,不向客户单列合作伙伴佣金。"
          },
          "status": {
            "type": [
              "string",
              "null"
            ]
          },
          "status_label": {
            "type": [
              "string",
              "null"
            ],
            "description": "查询时已保存的状态。原始标签为葡萄牙语,产品界面可按已知状态 / 类型进行本地化,不修改账本原值。"
          },
          "settlement_status": {
            "type": [
              "string",
              "null"
            ]
          },
          "movimentos_ids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "分组视图中的原始账本 ID,用于对账,不代表额外动态记录。"
          },
          "atualizado_em": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "proxima_pagina": {
      "type": [
        "string",
        "null"
      ]
    },
    "visao": {
      "type": "string",
      "const": "operacoes",
      "description": "仅分组视图提供。"
    },
    "has_more": {
      "type": "boolean",
      "description": "分组视图是否还有下一页,最后一页游标为 null。"
    }
  }
}

401

缺少密钥或密钥无效

400

分组视图的 limit 或 before 游标格式错误。

POST /saldo/sacar-cripto

将 BRL 余额兑换并提取至自托管加密资产钱包

将可用 BRL 余额兑换为加密资产。选择 GET /cashin/catalog 中 entregavel=true 的路由,每次提现填写钱包及必要 memo,无需固定钱包。不支持 Liquid/DePix。交付前扣减 amount_cents 及平台提现费用;兑换及路由成本影响最终数量。通过 GET /cashin/{cashin_id}/status 跟踪 cashin_id。external_id 命名空间与收款单共用,没有公开的提现预览接口。

身份验证:ApiKey

操作标识:withdrawBalanceToCrypto

请求体

必填:是

application/json

字段类型必填说明
amount_centsinteger是

BRL 金额,以整数分计。实际最低金额取决于密钥、费用及路由。查询 GET /keys/me 及返回的 min_brl_cents/limits,不要固定使用示例最低金额。

{"minimum":100}

chainstring否

网络,支持别名:sol、trc20、erc20、bep20、arbitrum、base 等。

{"default":"polygon"}

assetstring否

小写资产代码,如 usdt、usdc、btc、eth、sol,须存在于 GET /cashin/catalog。

{"default":"usdt"}

payout_addressstring是

目标钱包,按所选网络校验。

tax_numberstring是

余额所属客户的 CPF(11 位)或 CNPJ(14 位)。

customer_refstring否

扣款子账户,省略时使用密钥主账户。

{"maxLength":80}

external_idstring否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

payout_tagstring否

目标 memo/tag。XRP、XLM、TON、ATOM、HBAR、ALGO、EOS、KAVA、LUNA 等共用地址网络必填,用于识别实际收款人。缺失时,创建收款单前返回 400 memo_obrigatorio。XRP destination tag 须为 0 至 4294967295 的整数。支持 memo、tag、destination_tag 别名,目录以 memoRequired: true 标记。

{"maxLength":120}

max_debited_centsinteger否

可选 BRL 扣款上限,包含本金及平台费用。超出时返回 409 taxa_alterada,不锁定汇率或代币数量。

{"minimum":0}

sandbox_scenariostring否

仅用于测试密钥。GET /sandbox 提供各流程的场景矩阵,生产环境应省略。价格、付款及提现均为模拟结果。

{"enum":["success","delayed","held","expired","refunded","failed","payer_mismatch","settlement_failed","settlement_uncertain","route_unavailable","provider_unavailable"]}

查看完整请求模式
{
  "type": "object",
  "required": [
    "amount_cents",
    "payout_address",
    "tax_number"
  ],
  "properties": {
    "amount_cents": {
      "type": "integer",
      "minimum": 100,
      "description": "BRL 金额,以整数分计。实际最低金额取决于密钥、费用及路由。查询 GET /keys/me 及返回的 min_brl_cents/limits,不要固定使用示例最低金额。"
    },
    "chain": {
      "type": "string",
      "default": "polygon",
      "description": "网络,支持别名:sol、trc20、erc20、bep20、arbitrum、base 等。"
    },
    "asset": {
      "type": "string",
      "default": "usdt",
      "description": "小写资产代码,如 usdt、usdc、btc、eth、sol,须存在于 GET /cashin/catalog。"
    },
    "payout_address": {
      "type": "string",
      "description": "目标钱包,按所选网络校验。"
    },
    "tax_number": {
      "type": "string",
      "description": "余额所属客户的 CPF(11 位)或 CNPJ(14 位)。"
    },
    "customer_ref": {
      "type": "string",
      "maxLength": 80,
      "description": "扣款子账户,省略时使用密钥主账户。"
    },
    "external_id": {
      "type": "string",
      "maxLength": 64,
      "description": "最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。"
    },
    "payout_tag": {
      "type": "string",
      "maxLength": 120,
      "description": "目标 memo/tag。XRP、XLM、TON、ATOM、HBAR、ALGO、EOS、KAVA、LUNA 等共用地址网络必填,用于识别实际收款人。缺失时,创建收款单前返回 400 memo_obrigatorio。XRP destination tag 须为 0 至 4294967295 的整数。支持 memo、tag、destination_tag 别名,目录以 memoRequired: true 标记。"
    },
    "max_debited_cents": {
      "type": "integer",
      "minimum": 0,
      "description": "可选 BRL 扣款上限,包含本金及平台费用。超出时返回 409 taxa_alterada,不锁定汇率或代币数量。"
    },
    "sandbox_scenario": {
      "type": "string",
      "enum": [
        "success",
        "delayed",
        "held",
        "expired",
        "refunded",
        "failed",
        "payer_mismatch",
        "settlement_failed",
        "settlement_uncertain",
        "route_unavailable",
        "provider_unavailable"
      ],
      "description": "仅用于测试密钥。GET /sandbox 提供各流程的场景矩阵,生产环境应省略。价格、付款及提现均为模拟结果。"
    }
  }
}

响应

200

已扣款并进入交付队列。返回与 POST /cashin/charge 相同的状态视图:cashin_id、status=paid(余额本身即付款来源)、chain、asset、payout_address、amount_cents、settlement_status、settlement_tx_hash;另有 fee_cents(平台扣除费用)、debited_cents(本金 + 费用)、fonte: "saldo"、destino: "cripto" 及 customer_ref。通过 GET /cashin/{cashin_id}/status 跟踪 settlement_status,直至 sent。

application/json

字段类型必填说明
fontestring否

{"enum":["saldo"]}

settlement_statusstring否
fee_centsinteger否

从余额扣除的 Lunium 费用。

partner_fee_centsinteger否

在 Lunium 费用之外,从余额另扣的合作伙伴 sub fee,自2026年9月24日起提供。

debited_centsinteger否

amount_cents + fee_cents + partner_fee_cents。

查看完整响应模式
{
  "$ref": "#/components/schemas/SaqueCripto"
}

400

rede_indisponivel | asset_invalido | payout_address_invalido | documento_invalido | valor_abaixo_do_minimo;memo_obrigatorio 表示网络要求 memo/tag,但未提供或无效。

402

saldo_insuficiente — 可用余额 < 本金 + 费用,请求响应提供 saldo 及 fee_cents。

409

external_id_divergente

423

carencia_primeiro_deposito — 约定了首次充值等待期的密钥适用,libera_em 表示释放时间。

503

entrega_indisponivel — 当前无可交付库存 / 路由,未扣款。

GET /mesh

智能体接入前须知

一次 GET 返回平台介绍、可结算流程、资产与网络、全部接口、获取密钥及生产接入方式、限额与数据模式,无需凭证。

身份验证:无需 API 密钥

操作标识:meshDiscovery

响应

200

发现文档。

application/json

字段类型必填说明
quem_somosobject否
como_falar_comigoobject否

REST、OpenAPI、MCP、A2A 及 Mesh。

capacidadesobject否
como_escolher_capacidadeobject否

业务意图 → 能力的反向索引,以及按属性筛选的说明。

execucaoobject否

每项能力提供接口、必填字段及可用示例。

ativos_e_redesobject否
limitesobject否
como_comecarobject否
regra_de_segurancaobject否
atribuicaoobject否
查看完整响应模式
{
  "$ref": "#/components/schemas/MeshDiscovery"
}

GET /mesh/economy

网络经济的公开规则

仅对直接推荐的第一级智能体,按实际已结算交易量的 0.10% 计奖励。注册、推荐动作、报价及测试环境本身均不产生奖励。

身份验证:无需 API 密钥

操作标识:meshEconomy

响应

200

当前规则。

application/json

字段类型必填说明
modelstring否
direct_ratestring否
direct_rate_bpsinteger否
max_paid_levelsinteger否
recruitment_rewardboolean否
requires_settled_transactionboolean否
revenue_share_capstring否
查看完整响应模式
{
  "$ref": "#/components/schemas/MeshEconomyPolicy"
}

POST /mesh/agents

注册智能体并获取测试环境凭证

一次调用完成注册及凭证签发。提供 referral_token 可验证推荐关系;未提供时作为根节点加入。

身份验证:无需 API 密钥

操作标识:meshRegisterAgent

请求体

必填:是

application/json

字段类型必填说明
namestring是

{"minLength":2,"maxLength":80}

descriptionstring否
contactstring否
agent_card_urlstring否
capabilitiesarray · string否
referral_tokenstring否

由推荐方签名的推荐证明,是建立推荐关系的唯一方式。由于涉及奖励,拒绝客户端自行申报 referred_by。

查看完整请求模式
{
  "$ref": "#/components/schemas/AgentRegistration"
}

响应

201

智能体已创建,提供凭证及下一步操作。

application/json

字段类型必填说明
agentAgentIdentity否
api_keystring否
sandboxboolean否
lineageobject否
proximo_passoobject否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "agent": {
      "$ref": "#/components/schemas/AgentIdentity"
    },
    "api_key": {
      "type": "string"
    },
    "sandbox": {
      "type": "boolean"
    },
    "lineage": {
      "type": "object"
    },
    "proximo_passo": {
      "type": "object"
    }
  }
}

400

请求无效或 referral_token 被拒绝。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

GET /mesh/agents

发现网络成员

公开目录,绝不返回密钥、密钥哈希或 token。

身份验证:无需 API 密钥

操作标识:meshListAgents

响应

200

智能体列表。

application/json

字段类型必填说明
agentsarray · AgentIdentity否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentIdentity"
      }
    }
  }
}

POST /mesh/referrals

签发推荐证明(attestation)

须提供推荐方智能体的 X-API-Key,返回带签名、一次性且有有效期的 token。这是建立推荐关系及相应 0.10% 奖励关系的唯一方式。

身份验证:ApiKey

操作标识:meshIssueReferral

请求体

必填:否

application/json

字段类型必填说明
capabilitystring否
expires_in_minutesinteger否

{"default":60,"maximum":10080}

查看完整请求模式
{
  "type": "object",
  "properties": {
    "capability": {
      "type": "string"
    },
    "expires_in_minutes": {
      "type": "integer",
      "default": 60,
      "maximum": 10080
    }
  }
}

响应

201

推荐证明已签发。

application/json

字段类型必填说明
typestring否
referrer_agent_idstring否
referral_tokenstring否
capabilitystring | null否
noncestring否
expires_atstring · date-time否
one_time_useboolean否
查看完整响应模式
{
  "$ref": "#/components/schemas/ReferralAttestation"
}

401

缺少密钥。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

404

密钥未关联至智能体。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

GET /mesh/agents/{agent_id}

智能体状态、mandate 授权、指标及推荐关系

身份验证:无需 API 密钥

操作标识:meshGetAgent

参数

参数位置类型必填说明
agent_idpathstring是

响应

200

智能体资料。

application/json

字段类型必填说明
agent_idstring否
namestring否
descriptionstring | null否
contactstring | null否
statusAgentLifecycle否
environmentstring否

{"enum":["sandbox","production"]}

capabilitiesarray · string否
settlement_addressstring | null否
referred_bystring | null否

注册后不可变,由数据库触发器保护。

created_atstring · date-time否
查看完整响应模式
{
  "$ref": "#/components/schemas/AgentIdentity"
}

404

不存在。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

POST /mesh/agents/{agent_id}/validate

提交测试环境使用证明

仅创建测试密钥不够,须在测试环境创建并接受至少一笔订单。此步骤用于确认真实资金接入前,已有错误处理及状态跟踪流程。

身份验证:ApiKey

操作标识:meshValidateAgent

参数

参数位置类型必填说明
agent_idpathstring是

响应

200

已完成。

application/json

查看完整响应模式
{
  "type": "object"
}

401

缺少密钥。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

403

密钥不属于此智能体。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

409

缺少前置条件。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

POST /mesh/agents/{agent_id}/settlement

设置资金目的地

支持的结算网络地址。

身份验证:ApiKey

操作标识:meshSetSettlement

参数

参数位置类型必填说明
agent_idpathstring是

请求体

必填:是

application/json

字段类型必填说明
settlement_addressstring是

支持的结算网络钱包。

查看完整请求模式
{
  "$ref": "#/components/schemas/SettlementConfiguration"
}

响应

200

已完成。

application/json

查看完整响应模式
{
  "type": "object"
}

401

缺少密钥。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

403

密钥不属于此智能体。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

409

缺少前置条件。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

POST /mesh/agents/{agent_id}/mandate

设置自身限额策略

仅收紧密钥限额,不能扩大权限。进入生产前必须设置。

身份验证:ApiKey

操作标识:meshSetMandate

参数

参数位置类型必填说明
agent_idpathstring是

请求体

必填:是

application/json

字段类型必填说明
max_por_operacao_centsinteger否
max_diario_centsinteger否
contrapartesarray · string否

允许付款的 Pix 收款标识,空列表表示不另加此项限制。

查看完整请求模式
{
  "$ref": "#/components/schemas/Mandate"
}

响应

200

已完成。

application/json

查看完整响应模式
{
  "type": "object"
}

401

缺少密钥。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

403

密钥不属于此智能体。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

409

缺少前置条件。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

POST /mesh/agents/{agent_id}/production-request

自动激活生产环境,无需人工审批

自动检查:测试环境使用证明、支持网络的结算地址、符合规则的 mandate,以及有效凭证。通过后,在同一响应激活生产;缺少条件则返回 422,并提供 missing 及 next_actions,供智能体修正后重试。

身份验证:ApiKey

操作标识:meshActivateProduction

参数

参数位置类型必填说明
agent_idpathstring是

响应

200

已完成。

application/json

字段类型必填说明
statusstring否
agent_idstring否
environmentstring否
activated_atstring · date-time否
activated_bystring否
api_keystring否

生产凭证 lun_live_*,仅显示一次。

settlementobject否
mandateMandate否
capabilitiesarray · string否
查看完整响应模式
{
  "$ref": "#/components/schemas/ProductionActivation"
}

401

缺少密钥。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

403

密钥不属于此智能体。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

409

缺少前置条件。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

422

条件不完整,响应可供程序解析。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

GET /mesh/agents/{agent_id}/network

推荐关系、层级树及网络交易量

递归查询推荐树。network_volume 统计整棵树,reward_eligible_volume 仅统计第一级可计奖交易量。

身份验证:无需 API 密钥

操作标识:meshAgentNetwork

参数

参数位置类型必填说明
agent_idpathstring是

响应

200

网络资料。

application/json

字段类型必填说明
agent_idstring否
referred_bystring | null否
depthinteger否
direct_childreninteger否
total_descendantsinteger否
own_volume_centsinteger否
own_transactionsinteger否
network_volume_centsinteger否
network_transactionsinteger否
reward_eligible_volume_centsinteger否
lifetime_rewards_centsinteger否
first_operationstring | null · date-time否
production_sincestring | null · date-time否
childrenarray · object否
查看完整响应模式
{
  "$ref": "#/components/schemas/AgentNetwork"
}

404

不存在。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

GET /mesh/agents/{agent_id}/rewards

奖励余额及账本流水

身份验证:无需 API 密钥

操作标识:meshAgentRewards

参数

参数位置类型必填说明
agent_idpathstring是

响应

200

余额与账本。

application/json

字段类型必填说明
agent_idstring否
own_volume_centsinteger否
direct_referral_volume_centsinteger否
network_volume_centsinteger否
pending_rewards_centsinteger否
available_rewards_centsinteger否
paid_rewards_centsinteger否
lifetime_rewards_centsinteger否
reward_eventsinteger否
reversalsinteger否
policyMeshEconomyPolicy否
ledgerarray · RewardEvent否
查看完整响应模式
{
  "$ref": "#/components/schemas/RewardBalance"
}

404

不存在。

application/json

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整响应模式
{
  "$ref": "#/components/schemas/ErroAutocorrigivel"
}

GET /saldo/consolidado

密钥汇总:主账户 + 客户子账户,总托管金额

汇总密钥的全部托管资金。casa 为无 customer_ref 的主账户流水,包括合作伙伴份额、调整及自身提现;clientes 为有 customer_ref 的客户子账户总额。total_custodiado_cents = 主账户 + 客户子账户,用于合作伙伴财务对账。

身份验证:ApiKey

响应

200

汇总结果。

application/json

字段类型必填说明
casaobject否
clientesobject否
total_custodiado_centsinteger否
movimentosinteger否
ultimo_movimento_emstring | null · date-time否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "casa": {
      "type": "object",
      "properties": {
        "disponivel_cents": {
          "type": "integer"
        },
        "bloqueado_cents": {
          "type": "integer"
        },
        "total_cents": {
          "type": "integer"
        }
      }
    },
    "clientes": {
      "type": "object",
      "properties": {
        "qtd": {
          "type": "integer"
        },
        "disponivel_cents": {
          "type": "integer"
        },
        "bloqueado_cents": {
          "type": "integer"
        },
        "total_cents": {
          "type": "integer"
        }
      }
    },
    "total_custodiado_cents": {
      "type": "integer"
    },
    "movimentos": {
      "type": "integer"
    },
    "ultimo_movimento_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

GET /saldo/clientes

分页列出有余额的客户子账户

列出当前密钥各 customer_ref 的可用、冻结及总余额,按 customer_ref 排序;使用 cursor=next_cursor 分页。com_saldo=1 隐藏零余额子账户。

身份验证:ApiKey

参数

参数位置类型必填说明
limitqueryinteger否
cursorquerystring否

上一页的 next_cursor,即某个 customer_ref。

com_saldoquerystring否

1 表示仅列出非零余额子账户。

响应

200

子账户分页列表。

application/json

字段类型必填说明
clientesarray · object否
has_moreboolean否
next_cursorstring | null否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "clientes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customer_ref": {
            "type": "string",
            "maxLength": 80
          },
          "disponivel_cents": {
            "type": "integer"
          },
          "bloqueado_cents": {
            "type": "integer"
          },
          "total_cents": {
            "type": "integer"
          },
          "movimentos": {
            "type": "integer"
          },
          "primeiro_movimento_em": {
            "type": "string",
            "format": "date-time"
          },
          "ultimo_movimento_em": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "has_more": {
      "type": "boolean"
    },
    "next_cursor": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

POST /keys/painel-link

通过邮件获取监控链接,无需 API 密钥

完整 API 密钥仅显示一次,监控面板不依赖该密钥登录。填写密钥登记邮箱,只读监控链接(dashboard token)会发送至该邮箱。响应始终为统一格式,不透露邮箱是否存在。每小时每个邮箱最多发送 3 次,每个 IP 最多 10 次。

身份验证:无需 API 密钥

请求体

必填:是

application/json

字段类型必填说明
emailstring · email是
查看完整请求模式
{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    }
  }
}

响应

200

请求已接受,统一格式响应。

400

邮箱无效。

429

已达到每小时限额。

POST /saldo/transferir

子账户与主账户之间内部转账,不生成 Pix

在客户子账户(customer_ref)与主账户("casa",即密钥自身)之间,或两个客户之间转移可用余额,不经过 Pix。常用于客户向主账户支付费用,或主账户向客户发放奖励 / 退款。冻结资金(24 小时冻结或 MED)不可转移。首次充值等待期内的来源子账户不可转账,返回 423,仅约定了等待期的密钥适用。通过 external_id 保证幂等,并发送 saldo.transferido。

身份验证:ApiKey

请求体

必填:是

application/json

字段类型必填说明
from_customer_refstring是

来源 customer_ref 或 "casa"。

to_customer_refstring是

目标 customer_ref 或 "casa"。

amount_centsinteger是

{"minimum":1}

descricaostring否

同时显示在转出与转入两侧流水中。

{"maxLength":140}

external_idstring否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

查看完整请求模式
{
  "type": "object",
  "required": [
    "from_customer_ref",
    "to_customer_ref",
    "amount_cents"
  ],
  "properties": {
    "from_customer_ref": {
      "type": "string",
      "description": "来源 customer_ref 或 \"casa\"。"
    },
    "to_customer_ref": {
      "type": "string",
      "description": "目标 customer_ref 或 \"casa\"。"
    },
    "amount_cents": {
      "type": "integer",
      "minimum": 1
    },
    "descricao": {
      "type": "string",
      "maxLength": 140,
      "description": "同时显示在转出与转入两侧流水中。"
    },
    "external_id": {
      "type": "string",
      "maxLength": 64,
      "description": "最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。"
    }
  }
}

响应

201

已转账。

application/json

字段类型必填说明
transfer_idstring否
from_customer_refstring | null否
to_customer_refstring | null否
amount_centsinteger否
descricaostring | null否
created_atstring · date-time否
movimentosobject否
saldosobject否

转账后两侧余额。

查看完整响应模式
{
  "type": "object",
  "properties": {
    "transfer_id": {
      "type": "string"
    },
    "from_customer_ref": {
      "type": [
        "string",
        "null"
      ]
    },
    "to_customer_ref": {
      "type": [
        "string",
        "null"
      ]
    },
    "amount_cents": {
      "type": "integer"
    },
    "descricao": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "movimentos": {
      "type": "object"
    },
    "saldos": {
      "type": "object",
      "description": "转账后两侧余额。"
    }
  }
}

200

幂等重放,idempotente: true。

400

valor_invalido · origem_igual_destino · custodia_desligada。

409

saldo_insuficiente(提供 disponivel_cents/bloqueado_cents)· external_id_divergente。

423

来源子账户处于 carencia_primeiro_deposito 等待期。

POST /cash-outs/preview

报价预览(不创建订单)

按 amount、brl_amount 或 br_code 预估兑换,不创建订单,无需 pix_key,不预留余额、限额或地址。三个字段须且仅传一个。创建 / 接受报价还会校验收款人限额及 mandate 等额外条件。生产 br_code 可用性在预览及创建时均校验,预览成功不保证订单获接受。也支持 DEPIX/liquid,按平台费率计算,返回 fee_bps、fee_fixed_cents、fee_total_cents、net_cents、min_amount_cents、max_amount_cents。测试环境亦支持相同卖出公式及 BRL 平价,预览无需钱包或收款人。

身份验证:ApiKeyAuth

操作标识:previaCotacao

请求体

必填:是

application/json

字段类型必填说明
assetstring是

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring是

GET /catalog 列出的加密资产入金网络,不同于 /cashin/catalog 的交付网络。

amountstring否

加密资产数量,十进制字符串,例如 "50",不要使用浮点数。不能同时传 brl_amount 或 br_code,此方式创建订单时须提供 pix_key。

brl_amountstring否

反向报价的目标 BRL 金额,最多两位小数的字符串,例如 "250.00"。不能同时传 amount 或 br_code,创建时须提供 pix_key。响应返回精确加密资产充值量及实际 BRL 金额,后者可能因舍入与目标略有差异。接受前展示返回金额,最低金额及限额以路由、密钥及收款人当前条件为准。

token_addressstring否

精确合约地址 / mint。/catalog/dex 代币可能有相同符号,因此必须明确地址。

br_codestring否

带金额的 Pix 收款码。预览解码后返回 amount、brl_amount(二维码金额)、merchant_name 及遮盖后的收款标识,不创建订单。使用 br_code 时不传 amount 或 brl_amount,遵循 POST /cash-outs 的相同规则,仅支持兼容目录路由的 USDT/USDC。amount 已包含 R$ 1.00 Copia e Cola 预留款(reserve_brl,其 USDT 等值见 copia_e_cola_buffer_usd)。客户粘贴或扫描了带金额的静态 / 动态二维码时,须发送完整 br_code,不仅提取 pix_key + brl_amount,才能保留精确金额及收款单 txid;按收款标识付款可能相差几分,导致收款方无法匹配。

sandbox_scenariostring否

仅用于测试环境 DePix/Liquid,优先于金额小数触发条件。未明确指定场景时,.01 至 .08 触发仍有效。生产密钥返回 403 sandbox_only,场景见 GET /sandbox。

{"enum":["success","delayed","failed","expired","refunded","settlement_uncertain","provider_unavailable","route_unavailable","no_deposit"]}

查看完整请求模式
{
  "type": "object",
  "required": [
    "asset",
    "network"
  ],
  "properties": {
    "asset": {
      "type": "string",
      "examples": [
        "USDT",
        "DEPIX"
      ],
      "description": "卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 \"usdt\"。须与 network 组合使用,且 (asset, network) 必须存在于目录。"
    },
    "network": {
      "type": "string",
      "description": "GET /catalog 列出的加密资产入金网络,不同于 /cashin/catalog 的交付网络。",
      "examples": [
        "polygon",
        "liquid"
      ]
    },
    "amount": {
      "type": "string",
      "description": "加密资产数量,十进制字符串,例如 \"50\",不要使用浮点数。不能同时传 brl_amount 或 br_code,此方式创建订单时须提供 pix_key。",
      "examples": [
        "50"
      ]
    },
    "brl_amount": {
      "type": "string",
      "description": "反向报价的目标 BRL 金额,最多两位小数的字符串,例如 \"250.00\"。不能同时传 amount 或 br_code,创建时须提供 pix_key。响应返回精确加密资产充值量及实际 BRL 金额,后者可能因舍入与目标略有差异。接受前展示返回金额,最低金额及限额以路由、密钥及收款人当前条件为准。",
      "examples": [
        "250.00"
      ]
    },
    "token_address": {
      "type": "string",
      "description": "精确合约地址 / mint。/catalog/dex 代币可能有相同符号,因此必须明确地址。"
    },
    "br_code": {
      "type": "string",
      "description": "带金额的 Pix 收款码。预览解码后返回 amount、brl_amount(二维码金额)、merchant_name 及遮盖后的收款标识,不创建订单。使用 br_code 时不传 amount 或 brl_amount,遵循 POST /cash-outs 的相同规则,仅支持兼容目录路由的 USDT/USDC。amount 已包含 R$ 1.00 Copia e Cola 预留款(reserve_brl,其 USDT 等值见 copia_e_cola_buffer_usd)。客户粘贴或扫描了带金额的静态 / 动态二维码时,须发送完整 br_code,不仅提取 pix_key + brl_amount,才能保留精确金额及收款单 txid;按收款标识付款可能相差几分,导致收款方无法匹配。"
    },
    "sandbox_scenario": {
      "type": "string",
      "enum": [
        "success",
        "delayed",
        "failed",
        "expired",
        "refunded",
        "settlement_uncertain",
        "provider_unavailable",
        "route_unavailable",
        "no_deposit"
      ],
      "description": "仅用于测试环境 DePix/Liquid,优先于金额小数触发条件。未明确指定场景时,.01 至 .08 触发仍有效。生产密钥返回 403 sandbox_only,场景见 GET /sandbox。"
    }
  }
}

响应

200

预览已计算,未创建订单。

application/json

字段类型必填说明
previewboolean是

{"const":true}

assetstring是
networkstring是
pathstring否

该笔卖出将使用的渠道。

{"enum":["FAST","DEX","CONVERT","simulated"]}

amountstring是

须发送的加密资产数量,十进制字符串。

brl_amountstring是

Pix 的 BRL 金额。

expires_atstring · date-time否

该报价预计适用的有效期限。

merchant_namestring | null否

仅 br_code 提供,收款码中的收款人名称。

copia_e_cola_buffer_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

pix_keystring | null否

仅 br_code 提供,经遮盖的收款人标识。

pix_key_typestring | null否
partner_fee_bpsinteger否

本次报价计入的合作伙伴 sub fee,单位 bps。

fee_bpsinteger否

DePix 卖出费率,单位 bps。

fee_fixed_centsinteger否

DePix 卖出固定费用,以分计。

fee_total_centsinteger否

总费用,以分计,在 DePix 报价及模拟订单中提供。

net_centsinteger否

Pix 净额,以分计,在 DePix 报价及模拟订单中提供。

pix_key_reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整响应模式
{
  "type": "object",
  "properties": {
    "preview": {
      "type": "boolean",
      "const": true
    },
    "asset": {
      "type": "string"
    },
    "network": {
      "type": "string"
    },
    "path": {
      "type": "string",
      "enum": [
        "FAST",
        "DEX",
        "CONVERT",
        "simulated"
      ],
      "description": "该笔卖出将使用的渠道。"
    },
    "amount": {
      "type": "string",
      "description": "须发送的加密资产数量,十进制字符串。"
    },
    "brl_amount": {
      "type": "string",
      "description": "Pix 的 BRL 金额。"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "该报价预计适用的有效期限。"
    },
    "merchant_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "仅 br_code 提供,收款码中的收款人名称。"
    },
    "copia_e_cola_buffer_usd": {
      "type": [
        "string",
        "null"
      ],
      "description": "R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。",
      "example": "0.200000"
    },
    "pix_key": {
      "type": [
        "string",
        "null"
      ],
      "description": "仅 br_code 提供,经遮盖的收款人标识。"
    },
    "pix_key_type": {
      "type": [
        "string",
        "null"
      ]
    },
    "partner_fee_bps": {
      "type": "integer",
      "description": "本次报价计入的合作伙伴 sub fee,单位 bps。"
    },
    "fee_bps": {
      "type": "integer",
      "description": "DePix 卖出费率,单位 bps。"
    },
    "fee_fixed_cents": {
      "type": "integer",
      "description": "DePix 卖出固定费用,以分计。"
    },
    "fee_total_cents": {
      "type": "integer",
      "description": "总费用,以分计,在 DePix 报价及模拟订单中提供。"
    },
    "net_cents": {
      "type": "integer",
      "description": "Pix 净额,以分计,在 DePix 报价及模拟订单中提供。"
    },
    "pix_key_reserve_usd": {
      "type": [
        "string",
        "null"
      ],
      "description": "R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。",
      "example": "0.200000"
    },
    "reserve_brl": {
      "type": [
        "string",
        "null"
      ],
      "example": "1.00",
      "description": "新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。"
    }
  },
  "required": [
    "preview",
    "asset",
    "network",
    "amount",
    "brl_amount"
  ]
}

400

请求无效或网络不可用。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

422

参数语义无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

sandbox_scenario 须使用测试密钥,未创建订单。

503

服务不可用。测试场景 provider_unavailable 不创建订单。

GET /cashin/catalog

Cash-in 目录:Pix 收款后可交付的资产

加密资产交付目录,用于直接 cash-in 及托管余额提现。仅提供 instant/convert 中 entregavel=true 的项目;instant 可能为空。读取各路由的 memoRequired、withdrawFee、withdrawMin 及时效预估。最低 BRL 金额取决于 POST /cashin/preview 的汇率。托管提现须排除 Liquid/DePix。stale=true 表示缓存目录。

身份验证:ApiKeyAuth

操作标识:catalogoCompra

响应

200

购买目录。

application/json

字段类型必填说明
updatedAtstring | null · date-time否
instantarray · object否

平台渠道路由,可能因配置为空,不保证始终存在或有固定时效。

convertarray · object否

交易所渠道,每个资产 / 网络组合一行。

droppedarray · object否

未纳入的组合及原因,例如 sem_par_usdt。

totalsobject否
staleboolean否

目录来自备用缓存时为 true。

查看完整响应模式
{
  "$ref": "#/components/schemas/CatalogoCompra"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /catalog/dex

可通过 DEX 交易的长尾代币

列出指定 DEX 网络上 relay 白名单代币。将此处 address 用作 POST /cash-outs 的 token_address;符号可能重复,合约地址用于准确识别。不支持结算的网络返回 400。

身份验证:ApiKeyAuth

操作标识:catalogoDex

参数

参数位置类型必填说明
chainquerystring是

DEX 网络,目前仅 polygon。

qquerystring否

按代币符号或地址片段筛选。

响应

200

白名单中的代币。

application/json

查看完整响应模式
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "symbol": {
        "type": "string",
        "description": "代币符号并不唯一,请使用 address。"
      },
      "address": {
        "type": "string",
        "description": "合约地址,即报价中的 token_address。"
      },
      "decimals": {
        "type": "integer"
      }
    },
    "required": [
      "symbol",
      "address",
      "decimals"
    ]
  }
}

400

错误。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /cashin/events

当前密钥的运行事件流

当前密钥近期事件,最新在前,包含收款单、卖出、提现及 webhook 投递,与私密监控使用相同事件流。可用于运行界面,但不替代持久历史。接受 X-API-Key 或该密钥的监控 token。

身份验证:ApiKeyAuth

操作标识:eventosDaChave

参数

参数位置类型必填说明
limitqueryinteger否

返回事件数,默认为 60。

响应

200

近期事件。

application/json

字段类型必填说明
projetostring否

密钥名称。

agorastring · date-time否

服务器时间,用于避免界面时钟依赖客户端设备。

eventosarray · object否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "projeto": {
      "type": "string",
      "description": "密钥名称。"
    },
    "agora": {
      "type": "string",
      "format": "date-time",
      "description": "服务器时间,用于避免界面时钟依赖客户端设备。"
    },
    "eventos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ts": {
            "type": "string",
            "format": "date-time"
          },
          "fluxo": {
            "type": "string",
            "description": "cashin · cashout · payout · webhook"
          },
          "provedor": {
            "type": "string"
          },
          "ref": {
            "type": "string",
            "description": "交易标识。"
          },
          "valor": {
            "type": "string"
          },
          "estado": {
            "type": "string"
          },
          "detalhe": {
            "type": [
              "string",
              "null"
            ]
          },
          "tx": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /comissao

Sub fee 余额,即合作伙伴佣金

Sub fee 累计佣金。符合计佣条件的交易须完成结算 / 交付后才入账,Pix 已付款本身不代表佣金可用。新余额充值不产生佣金;购买及转出按对应佣金类别和交易保存费率核算。购买计费基数为收到金额减去平台固定费用。min_saque_cents 为按当前汇率折合 US$ 10 的最低 BRL 提现金额。

身份验证:ApiKey

响应

200

余额、规则及最低提现金额

application/json

字段类型必填说明
disponivel_centsinteger是
creditado_centsinteger是
estornado_centsinteger否
sacado_centsinteger是
operacoesinteger是
ultimo_credito_emstring | null · date-time否
moedastring是
sandboxboolean是
min_saque_centsinteger | null否

按当前汇率折合 US$ 10 的 BRL 金额。null 表示当前无有效报价,提现会被拒绝。

pode_sacar_agoraboolean是
ultimo_saque_emstring | null · date-time否
proximo_saque_emstring | null · date-time否
politicaobject是
查看完整响应模式
{
  "$ref": "#/components/schemas/Comissao"
}

401

缺少密钥

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /comissao/extrato

佣金流水

身份验证:ApiKey

参数

参数位置类型必填说明
limitqueryinteger否
beforequerystring否

上一页最后一项的 ID

响应

200

流水,最新记录在前

application/json

字段类型必填说明
itensarray · ComissaoEvento否
has_moreboolean否
next_beforestring | null否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "itens": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ComissaoEvento"
      }
    },
    "has_more": {
      "type": "boolean"
    },
    "next_before": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

401

缺少密钥

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /comissao/sacar

以加密资产形式提取佣金

手动将佣金提取为加密资产,可选择 GET /cashin/catalog 当前可交付的币种与网络。不再收取 sub fee 或 Lunium 管理费,因为佣金已由用户在原交易承担;仍须考虑兑换及路由成本。最低金额按当前汇率折合 US$ 10,见 GET /comissao 的 min_saque_cents。每滚动 24 小时一次。交付与 cash-in 相同,通过 GET /cashin/{cashin_id}/status 跟踪 saque.cashin_id,或接收 cashin.settled。

身份验证:ApiKey

请求体

必填:是

application/json

字段类型必填说明
amount_centsinteger是

待兑换的 BRL 金额,以分计,须 ≥ min_saque_cents。

{"minimum":1}

assetstring否

usdt、usdc(Polygon),或 GET /cashin/catalog 中的资产。

{"default":"usdt"}

chainstring否

{"default":"polygon"}

payout_addressstring是

您在所选网络的钱包。

payout_tagstring否

需要时提供该网络的 memo/tag。

external_idstring否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

查看完整请求模式
{
  "type": "object",
  "required": [
    "amount_cents",
    "payout_address"
  ],
  "properties": {
    "amount_cents": {
      "type": "integer",
      "minimum": 1,
      "description": "待兑换的 BRL 金额,以分计,须 ≥ min_saque_cents。"
    },
    "asset": {
      "type": "string",
      "default": "usdt",
      "description": "usdt、usdc(Polygon),或 GET /cashin/catalog 中的资产。"
    },
    "chain": {
      "type": "string",
      "default": "polygon"
    },
    "payout_address": {
      "type": "string",
      "description": "您在所选网络的钱包。"
    },
    "payout_tag": {
      "type": "string",
      "description": "需要时提供该网络的 memo/tag。"
    },
    "external_id": {
      "type": "string",
      "maxLength": 64,
      "description": "最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。"
    }
  }
}

响应

200

提现已创建,正在交付

application/json

字段类型必填说明
saqueCobranca否
comissaoComissao否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "saque": {
      "$ref": "#/components/schemas/Cobranca"
    },
    "comissao": {
      "$ref": "#/components/schemas/Comissao"
    }
  }
}

400

valor_invalido | valor_abaixo_do_minimo(提供 min_saque_cents)| rede_indisponivel | asset_invalido | payout_address_invalido | sandbox_sem_saque

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

402

saldo_insuficiente — 可用佣金低于请求金额

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

external_id_divergente

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

429

saque_comissao_diario — 提供 proximo_saque_em

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

provedor_indisponivel — 无有效报价,无法核对最低金额

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /mesh/graph

Mesh 智能体关系图

查看公开网络成员及推荐关系,汇总网络总量,不包含机密资料,无需凭证。

身份验证:无需 API 密钥

操作标识:meshGraph

响应

200

网络统计与公开智能体资料。

application/json

字段类型必填说明
statsobject是
agentsarray · object是
查看完整响应模式
{
  "type": "object",
  "required": [
    "stats",
    "agents"
  ],
  "properties": {
    "stats": {
      "type": "object",
      "additionalProperties": true
    },
    "agents": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "agent_id",
          "name",
          "status",
          "capabilities"
        ],
        "properties": {
          "agent_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "referred_by": {
            "type": [
              "string",
              "null"
            ]
          },
          "capabilities": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

GET /sandbox

查询测试环境功能

支持的流程、各流程场景、二维码含义、限额及模拟控制接口。包含 DePix/Liquid → Pix 的 cashout_depix 及 scenarios_by_flow.cashout_depix。

身份验证:ApiKeyAuth

响应

200

模拟结果,sandbox=true,不移动真实资金。

application/json

查看完整响应模式
{
  "type": "object",
  "additionalProperties": true
}

401

缺少密钥或密钥无效。

403

须使用测试密钥。

404

当前密钥下未找到交易。

409

状态冲突或幂等参数不一致。

503

模拟器不可用,绝不会回退至真实服务商执行。

POST /sandbox/cashin/{cashin_id}/pay

模拟测试 Pix 收款单的付款

仅所属测试密钥可确认,重复请求不会重复入账。此接口不能确认生产付款。

身份验证:ApiKeyAuth

参数

参数位置类型必填说明
cashin_idpathstring是

请求体

必填:是

application/json

字段类型必填说明
payer_tax_numberstring否

可选模拟付款人证件,资料不符时模拟退款。

查看完整请求模式
{
  "type": "object",
  "properties": {
    "payer_tax_number": {
      "type": "string",
      "description": "可选模拟付款人证件,资料不符时模拟退款。"
    }
  },
  "required": []
}

响应

200

模拟结果,sandbox=true,不移动真实资金。

application/json

查看完整响应模式
{
  "type": "object",
  "additionalProperties": true
}

401

缺少密钥或密钥无效。

403

须使用测试密钥。

404

当前密钥下未找到交易。

409

状态冲突或幂等参数不一致。

503

模拟器不可用,绝不会回退至真实服务商执行。

POST /sandbox/operations/{operation_id}/resolve

核实测试环境中结果不确定的交易

仅可核实已经处于不确定状态的测试交易,相同结果可安全重放。DePix 卖出的 operation_id 为通过 settlement_uncertain 创建、处于 PROCESSING 的 sbx_… cashout_id。sent 使其完成;failed 进入 REFUNDING,并约 4 秒后达到 REFUNDED。

身份验证:ApiKeyAuth

参数

参数位置类型必填说明
operation_idpathstring是

请求体

必填:是

application/json

字段类型必填说明
outcomestring是

{"enum":["sent","failed"]}

查看完整请求模式
{
  "type": "object",
  "properties": {
    "outcome": {
      "type": "string",
      "enum": [
        "sent",
        "failed"
      ]
    }
  },
  "required": [
    "outcome"
  ]
}

响应

200

模拟结果,sandbox=true,不移动真实资金。

application/json

查看完整响应模式
{
  "type": "object",
  "additionalProperties": true
}

400

outcome 缺失或不是 sent / failed 时,返回 outcome_invalido,acao 为 corrigir,sandbox=true。自 1.44.1 起,校验发生在查找交易前,不改变模拟器。此前缺少 outcome 的请求可能返回 200 却未核实任何操作。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

请求 / 响应示例

{
  "erro": "outcome_invalido",
  "acao": "corrigir",
  "detail": "Informe outcome: sent ou failed.",
  "sandbox": true
}
查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

缺少密钥或密钥无效。

403

须使用测试密钥。

404

当前密钥下未找到交易。

409

状态冲突或幂等参数不一致。

503

模拟器不可用,绝不会回退至真实服务商执行。

GET /sandbox/events

查看测试环境生成的事件

即使未配置 webhook,也会返回已生成事件。实际回调尝试请查询 /webhooks/deliveries。

身份验证:ApiKeyAuth

参数

参数位置类型必填说明
limitqueryinteger否

响应

200

模拟结果,sandbox=true,不移动真实资金。

application/json

查看完整响应模式
{
  "type": "object",
  "additionalProperties": true
}

401

缺少密钥或密钥无效。

403

须使用测试密钥。

404

当前密钥下未找到交易。

409

状态冲突或幂等参数不一致。

503

模拟器不可用,绝不会回退至真实服务商执行。

POST /sandbox/reset

重置当前密钥的模拟数据

仅清除所属密钥的模拟状态,之前入队的 webhook 投递历史仍保留。生产密钥会被拒绝。

身份验证:ApiKeyAuth

请求体

必填:是

application/json

字段类型必填说明
confirmboolean是

{"const":true}

查看完整请求模式
{
  "type": "object",
  "properties": {
    "confirm": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "confirm"
  ]
}

响应

200

模拟结果,sandbox=true,不移动真实资金。

application/json

查看完整响应模式
{
  "type": "object",
  "additionalProperties": true
}

401

缺少密钥或密钥无效。

403

须使用测试密钥。

404

当前密钥下未找到交易。

409

状态冲突或幂等参数不一致。

503

模拟器不可用,绝不会回退至真实服务商执行。

GET /sandbox/qr/{cashin_id}.svg

不可用于真实付款的测试二维码图片

编码内容为 SANDBOX:NAO_PAGAVEL:<id>,不是银行 Pix 支付码,不包含付款操作或客户资料。

身份验证:无需 API 密钥

参数

参数位置类型必填说明
cashin_idpathstring是

响应

200

模拟 SVG 二维码。

image/svg+xml

查看完整响应模式
{
  "type": "string"
}

POST /cash-outs/{cashout_id}/refund-address

为待退款订单提交客户确认的钱包

订单处于 AWAITING_REFUND_ADDRESS 时使用,refund_address_required: true,并有 cashout.awaiting_refund_address 事件。表示卖出须退款,但尚无钱包。提交您客户在退款网络的钱包,核对订单 refund_network 及 refund_asset。Lunium 绝不自动退至链上充值来源 deposit_from,已登记钱包不可替换。DePix(asset DEPIX、network liquid)自 1.44.0 起适用,须提供客户 Liquid 地址 lq1…。相同地址重复提交返回 200 及原订单;其他地址返回 409 refund_address_imutavel;Lunium 自身地址,包括本订单 / 其他订单充值地址或平台钱包,返回 400 refund_address_invalida。DePix 全部由 Lunium 持有或已确认服务商返还时,进入 REFUNDING,发送 cashout.refunding,按 refund_amount 自动退款;最终 REFUNDED,提供 refund_tx_hash 及 cashout.refunded。若仍待服务商返还确认,则进入 MANUAL_REVIEW 并发送 cashout.under_review,确认后才退款,最高为实际返还金额。仅在卖出失败时要求钱包;不处于 AWAITING_REFUND_ADDRESS 且无钱包的订单返回 409 devolucao_indisponivel。

身份验证:ApiKeyAuth

操作标识:informarCarteiraDevolucao

参数

参数位置类型必填说明
cashout_idpathstring · uuid是

请求体

必填:是

application/json

字段类型必填说明
refund_addressstring是

客户确认的退款地址,须符合订单返回的退款网络。绝不能从 deposit_from 自动推断。DePix 卖出须提供客户 Liquid 地址(lq1…)。

查看完整请求模式
{
  "type": "object",
  "required": [
    "refund_address"
  ],
  "properties": {
    "refund_address": {
      "type": "string",
      "description": "客户确认的退款地址,须符合订单返回的退款网络。绝不能从 deposit_from 自动推断。DePix 卖出须提供客户 Liquid 地址(lq1…)。"
    }
  }
}

响应

200

订单已更新,请跟踪至 REFUNDED 并取得 refund_tx_hash。DePix 卖出的 state 为 REFUNDING(资金已由 Lunium 持有),或 MANUAL_REVIEW(资金仍在服务商处,等待返还)。

application/json

字段类型必填说明
cashout_idstring否

不透明订单标识,生产环境可能为 UUID,测试环境以 sbx_ 开头。原样保存,不做类型转换。

statestring否

订单状态。COMPLETED 确认 Pix 已付款,中间阶段因渠道而异,DELAYED 属于测试场景。AWAITING_REFUND_ADDRESS 表示须退款但尚无钱包,通过 POST /cash-outs/{cashout_id}/refund-address 提交;适用于加密资产卖出,以及自 1.44.0 起的 DePix 卖出。DePix 成功流程为 QUOTE_CREATED → AWAITING_DEPOSIT → DEPOSIT_DETECTED → PROCESSING → COMPLETED。Pix 无法支付时进入 REFUNDING → REFUNDED,缺少钱包则 AWAITING_REFUND_ADDRESS。若 DePix 已发送至服务商,须确认资金返还后才可退款;此前保持 MANUAL_REVIEW,退款最高为实际返还金额。

{"enum":["QUOTE_CREATED","AWAITING_DEPOSIT","DEPOSIT_DETECTED","DEPOSIT_CONFIRMED","SELLING","SOLD","FORWARDING","PAYING_OUT","COMPLETED","MANUAL_REVIEW","REFUNDING_CRYPTO","REFUNDED","EXPIRED","FAILED","DELAYED","AWAITING_REFUND_ADDRESS","PROCESSING","REFUNDING"]}

pathstring | null否

FAST、DEX 或 CONVERT 渠道。时效取决于路由、确认及处理。DePix/Liquid 使用 depix_liquid。

{"enum":["FAST","DEX","CONVERT",null,"depix_liquid"]}

assetstring否

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring否

目录列出的充值区块链网络,例如 "polygon"。返回地址仅对该网络有效。

amountstring否

加密资产数量,以十进制字符串表示,绝不使用浮点数。

brl_amountstring | null否

Pix 收款账户将收到的巴西雷亚尔(BRL)金额。

pix_keystring否

响应中经遮盖的收款人 Pix 标识。请求传入完整标识,不要将遮盖后的响应与原值逐字比较。

pix_key_typestring否

通常可省略,邮箱、CNPJ、随机标识及带 +55 的手机号可根据格式推断。11 位纯数字无法区分 CPF 与手机号,必须明确指定类型,以免付错收款人。显式类型优先于推断。

{"enum":["cpf","cnpj","phone","email","random"]}

deposit_addressstring | null否

客户发送加密资产的地址,仅在接受报价后提供。测试环境 DePix 返回不可付款标记 SANDBOX:LIQUID:NAO_ENVIAR:…,切勿发送真实资产。

deposit_tagstring | null否

接受报价时返回的 memo/tag,充值须一并填写。仅使用 GET /catalog 中的网络。

external_idstring | null否

每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。

{"maxLength":64}

refund_addressstring | null否

客户确认的退款钱包,缺失时不代表可以使用 deposit_from。订单可能停留于 AWAITING_REFUND_ADDRESS。自 1.44.0 起,DePix 卖出也适用,须提供客户 Liquid 地址 lq1…。

refund_tx_hashstring | null否

退款完成后的交易哈希,不代表所有退款均有固定金额或时限。

deposit_fromstring | null否

充值的链上来源,仅供参考,可能为交易所共用钱包。绝不能自动将其选为退款目的地。

br_codestring | null否

报价时提供的 Copia e Cola 支付码(如有),brl_amount 为二维码金额。

merchant_namestring | null否

从收款二维码中读取的收款人姓名。

copia_e_cola_buffer_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

expires_atstring | null · date-time否

报价到期时间,ISO 8601 UTC,例如 2026-09-02T14:03:00Z。过期后接受报价返回 erro=cotacao_expirada,应重新报价,不要反复提交。

pix_e2estring | null否

Pix 完成后的巴西央行端到端标识,可通过 GET /v1/verificar/{e2e} 无需密钥公开核验。可向最终客户提供。测试环境为虚构 E2E,ISPB 为 00000000,不能证明银行付款。

pix_paid_atstring | null · date-time否
receipt_urlstring | null否

可分享的凭证页面链接,生成后提供。cashout.completed 事件中可能仍为 null,后续 cashout.receipt_ready 或同一订单查询会提供链接。

receipt_pdf_urlstring | null · uri否

PDF 凭证文件,可附至工单、发送给客户或留作会计档案,核查时不依赖在线凭证页面。包含收款人姓名、证件及机构、金额、日期、E2E 和核验链接,与在线页面使用同一数据源。在订单尚未达到对应阶段时为 null。凭证内容及 API、webhook、控制台、Telegram 等获取方式详见 https://docs.luniumpay.com/zh/manual#comprovante 。

{"nullable":true}

verify_urlstring | null · uri否

公开核验直达链接,无需密钥,可交给交易对方独立确认付款。不会展示 Pix 收款标识、完整姓名或完整证件。订单尚未达到相应阶段时为 null。

{"nullable":true}

created_atstring | null · date-time否
updated_atstring | null · date-time否
timelinearray · object否

服务器在状态变化时记录的时间线,来自网关时间而非轮询时间:AWAITING_DEPOSIT → DEPOSIT_DETECTED → DEPOSIT_CONFIRMED →(SELLING → SOLD → FORWARDING,仅交易所渠道)→ PAYING_OUT → COMPLETED。用于客户交易跟踪界面。

confirmationsinteger | null否

当前已观察到的充值确认数,仅在订单等待网络确认时返回,不持久保存,会随区块变化。结合 confirmations_required 展示实际进展,不要编造进度。

confirmations_requiredinteger | null否

交易所对该网络充值入账所要求的确认数。

failure_reasonstring | null否

返回的失败原因,包括测试环境场景。

sandboxboolean否

模拟交易时为 true。

simulationobject否
partner_fee_bpsinteger否

该笔卖出创建时保存的合作伙伴 sub fee,单位 bps。早于此字段的旧订单或 DePix 卖出可能为 null。

{"nullable":true}

partner_fee_brl_centsinteger否

Pix 确认时确定的合作伙伴份额,以分计,即记入佣金账本的金额。

{"nullable":true}

refund_address_requiredboolean否

AWAITING_REFUND_ADDRESS 时为 true。查询退款资料,并通过 POST /cash-outs/{cashout_id}/refund-address 提交客户确认的钱包。

refund_amountstring | null否

核算后的实际退款数量,不要默认等于最初充值量。DePix 全部由 Lunium 持有时,AWAITING_REFUND_ADDRESS 已提供 refund_amount、refund_asset(DEPIX)及 refund_network(liquid)。若已转交服务商,MANUAL_REVIEW 中这些字段保持 null,直至确认返还;之后 refund_amount 最高为实际返还金额加未转交部分,且不超过订单金额。

refund_assetstring | null否

实际退款资产,可能与充值资产不同。

refund_networkstring | null否

实际退款网络,须使用客户确认且兼容的钱包。

provider_return_txidstring | null否

合作服务商向 Lunium 返还资金的参考标识,不是向客户完成退款的证明。

fee_bpsinteger否

DePix 卖出费率,单位 bps。

fee_fixed_centsinteger否

DePix 卖出固定费用,以分计。

fee_total_centsinteger否

总费用,以分计,在 DePix 报价及模拟订单中提供。

net_centsinteger否

Pix 净额,以分计,在 DePix 报价及模拟订单中提供。

pix_key_reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整响应模式
{
  "$ref": "#/components/schemas/CashOut"
}

400

地址缺失、不符合网络或属于 Lunium 自身,返回 refund_address_invalida;加密资产卖出在退款处理时拒绝地址,也可能使用其他错误码,并在 detail 说明原因。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

X-API-Key 缺失、未知或不正确。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

404

订单不存在,或属于其他密钥。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

状态不兼容或已登记钱包。DePix:已有不同钱包时返回 refund_address_imutavel(acao: parar);当前未等待钱包时返回 devolucao_indisponivel(acao: esperar),仅在卖出失败后才要求。其他加密资产卖出原因见 detail。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /carteira-usdt

USDT 钱包余额与状态

可用、已预留及确认中的余额,当前支持的网络与最低金额。请从此接口开始。

身份验证:ApiKey

响应

200

OK

application/json

字段类型必填说明
enabledboolean否

钱包当前可操作。

sandboxboolean否

仅测试密钥模拟器提供,值为 true。

funding_sourcestring否

{"enum":["crypto_usdt"]}

currencystring否

{"enum":["USDT"]}

pix_rulesobject否
networksarray · object否

当前可充值网络、各网络支持的币种及预估入账时间。

balanceobject否
min_depositstring否

最低 USDT 充值金额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

min_payment_brlstring否

使用 USDT 支付 Pix 的最低 BRL 金额。

deposit_validity_hoursnumber否

充值请求有效期,以小时计,目前为 1。

payments_enabledboolean否
payment_methodsobject否
查看完整响应模式
{
  "$ref": "#/components/schemas/CarteiraUsdt"
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /carteira-usdt/deposits

创建 USDT/USDC 充值请求

创建要求精确金额、有效期 1 小时的充值请求,见 expires_at。向用户展示 amount_to_send、network_name 及 address。系统自动入账,通过 GET /carteira-usdt/deposits 或 wallet.deposit_credited 跟踪。USDC 按 1:1 计入余额。

身份验证:ApiKey

请求体

必填:是

application/json

字段类型必填说明
amountstring是

USDT 金额最多 6 位小数,最低金额见 min_deposit。

networkstring否

须选择 GET /carteira-usdt 返回的 networks[].network 之一。

{"default":"polygon"}

请求 / 响应示例

{
  "amount": "100",
  "network": "tron"
}
查看完整请求模式
{
  "type": "object",
  "required": [
    "amount"
  ],
  "properties": {
    "amount": {
      "type": "string",
      "example": "100",
      "description": "USDT 金额最多 6 位小数,最低金额见 min_deposit。"
    },
    "network": {
      "type": "string",
      "default": "polygon",
      "description": "须选择 GET /carteira-usdt 返回的 networks[].network 之一。"
    }
  }
}

响应

201

请求已创建。

application/json

字段类型必填说明
deposit_idstring否
statusstring否

waiting = 等待发送;confirming = 已检测到,确认中;available = 已计入余额;expired = 到期仍未充值;under_review = 核查中;reversed = 已撤销。

{"enum":["waiting","confirming","available","expired","under_review","reversed"]}

amount_to_sendstring否

须发送的精确金额,末尾小数用于识别该笔充值。

{"pattern":"^-?\\d+\\.\\d{6}$"}

amount_receivedstring | null否

实际收到并入账的金额。

addressstring否

所选网络的目标地址。测试环境为虚构地址 SANDBOX-NAO-ENVIE-FUNDOS,不得发送资金。

networkstring否
network_namestring否
assetstring否
accepted_assetsarray · string否
expires_atstring · date-time否

请求自创建起有效 1 小时,即 created_at + deposit_validity_hours,请在期限内发送。

created_atstring · date-time否
credited_atstring | null · date-time否
originstring否

{"enum":["request","assigned_by_support"]}

instructionsstring否

仅在创建响应中提供,供用户阅读的说明。

sandboxboolean否
查看完整响应模式
{
  "$ref": "#/components/schemas/DepositoCarteira"
}

400

valor_invalido、valor_abaixo_do_minimo(提供 min_usdt)、rede_indisponivel。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

muitos_pedidos_abertos。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /carteira-usdt/deposits

列出充值请求

最近 100 笔充值请求及其入账情况。

身份验证:ApiKey

响应

200

OK

application/json

字段类型必填说明
itemsarray · DepositoCarteira否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DepositoCarteira"
      }
    }
  }
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /carteira-usdt/statement

钱包流水

最近 200 笔账本记录,包含每笔之后的余额。

身份验证:ApiKey

响应

200

OK

application/json

字段类型必填说明
itemsarray · LancamentoCarteira否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LancamentoCarteira"
      }
    }
  }
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /carteira-usdt/quote

预估使用 USDT 支付 Pix 的成本

仅预览,不执行交易:查询支付该 Pix 所需的 USDT。Pix 最低金额见 min_payment_brl。

身份验证:ApiKey

请求体

必填:是

application/json

字段类型必填说明
brl_amountstring否

收款人实际收到的 BRL 金额。选择 brl_amount + pix_key,或完整 br_code,二者不可同时使用。

br_codestring否

Pix Copia e Cola 支付码,以 000201 开头。金额及收款人由支付码确定,不要另传 brl_amount。

funding_sourcestring否

可选,仅接受 crypto_usdt。

{"enum":["crypto_usdt"]}

请求 / 响应示例

{
  "brl_amount": "50.00"
}
查看完整请求模式
{
  "type": "object",
  "properties": {
    "brl_amount": {
      "type": "string",
      "example": "50.00",
      "description": "收款人实际收到的 BRL 金额。选择 brl_amount + pix_key,或完整 br_code,二者不可同时使用。"
    },
    "br_code": {
      "type": "string",
      "description": "Pix Copia e Cola 支付码,以 000201 开头。金额及收款人由支付码确定,不要另传 brl_amount。"
    },
    "funding_source": {
      "type": "string",
      "enum": [
        "crypto_usdt"
      ],
      "description": "可选,仅接受 crypto_usdt。"
    }
  }
}

响应

200

OK

application/json

字段类型必填说明
payment_methodstring否

{"enum":["pix_key","br_code"]}

brl_amountstring否
usdt_orderstring否

用于支付 Pix 的 USDT 兑换金额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

withdrawal_feestring否

发送成本。

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_totalstring否

预估扣款总额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_reservedstring否

Pix 完成前的预留金额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

quote_idstring否

仅使用 br_code 时提供,传入 POST /carteira-usdt/payments,确保支付的是同一完整支付码。

merchant_namestring | null否
pix_keystring | null否
pix_key_typestring | null否
expires_atstring · date-time否
notestring否
sandboxboolean否
reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整响应模式
{
  "$ref": "#/components/schemas/CotacaoPixCarteira"
}

400

valor_invalido、valor_abaixo_do_minimo(提供 min_brl)、br_code_invalido、campos_conflitantes、cotacao_recusada、funding_source_invalido。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

POST /carteira-usdt/payments

使用 USDT 余额支付 Pix

预留 USDT、支付 Pix,并按实际成本扣款,未使用预留会释放。异步响应初始为 reservado,通过 GET /carteira-usdt/payments/{payment_id} 或 wallet.payment_completed / wallet.payment_failed 跟踪。使用 external_id 安全重试,相同 external_id 及资料返回同一付款,HTTP 200。

身份验证:ApiKey

请求体

必填:是

application/json

字段类型必填说明
brl_amountstring否

收款人实际收到的 BRL 金额。选择 brl_amount + pix_key,或完整 br_code,二者不可同时使用。

br_codestring否

Pix Copia e Cola 支付码,以 000201 开头。金额及收款人由支付码确定,不要另传 brl_amount。

funding_sourcestring否

可选,仅接受 crypto_usdt。

{"enum":["crypto_usdt"]}

pix_keystring否

Pix 收款标识,使用 brl_amount 时必填。

pix_key_typestring否

当收款标识为 11 位数字、可能是 CPF 或手机号时,建议明确填写类型。

{"enum":["cpf","cnpj","email","phone","random"]}

quote_idstring否

使用 br_code 时,可选传入预览报价的 quote_id。

external_idstring否

您的幂等标识。

{"maxLength":64}

请求 / 响应示例

{
  "brl_amount": "50.00",
  "pix_key": "cliente@exemplo.com",
  "pix_key_type": "email",
  "external_id": "pedido-123"
}
查看完整请求模式
{
  "type": "object",
  "properties": {
    "brl_amount": {
      "type": "string",
      "example": "50.00",
      "description": "收款人实际收到的 BRL 金额。选择 brl_amount + pix_key,或完整 br_code,二者不可同时使用。"
    },
    "br_code": {
      "type": "string",
      "description": "Pix Copia e Cola 支付码,以 000201 开头。金额及收款人由支付码确定,不要另传 brl_amount。"
    },
    "funding_source": {
      "type": "string",
      "enum": [
        "crypto_usdt"
      ],
      "description": "可选,仅接受 crypto_usdt。"
    },
    "pix_key": {
      "type": "string",
      "description": "Pix 收款标识,使用 brl_amount 时必填。"
    },
    "pix_key_type": {
      "type": "string",
      "enum": [
        "cpf",
        "cnpj",
        "email",
        "phone",
        "random"
      ],
      "description": "当收款标识为 11 位数字、可能是 CPF 或手机号时,建议明确填写类型。"
    },
    "quote_id": {
      "type": "string",
      "description": "使用 br_code 时,可选传入预览报价的 quote_id。"
    },
    "external_id": {
      "type": "string",
      "maxLength": 64,
      "description": "您的幂等标识。"
    }
  }
}

响应

201

付款已创建。

application/json

字段类型必填说明
payment_idstring否
external_idstring | null否
statusstring否

最终处理状态:concluido 表示 Pix 已付款;falhou 表示未执行、预留款已释放;falhou_apos_envio 表示发送后仍须核查,预留款不会自行释放。revisao 表示核查中,不等于失败,须继续跟踪。其他状态为处理中阶段。

{"enum":["reservado","ordem_criada","aceita","sacando","enviado","revisao","concluido","falhou","falhou_apos_envio"]}

finalboolean否

状态不再继续变化时为 true。

payment_methodstring否

{"enum":["pix_key","br_code"]}

brl_amountstring否
pix_keystring | null否

已遮盖。

usdt_reservedstring否

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_debitedstring | null否
usdt_orderstring | null否
withdrawal_feestring | null否
cashout_idstring | null否

支付该 Pix 的订单,详情见 GET /cash-outs/{cashout_id}。

errorstring | null否
pix_e2estring否

仅 concluido 提供,Pix E2E 标识。

recipient_namestring否

仅 concluido 提供,收款人姓名。

recipient_documentstring | null否

仅 concluido 提供,按巴西央行方式部分遮盖的 CPF 或 CNPJ。

receipt_urlstring | null否

仅 concluido 提供,官方凭证公开链接,测试环境为 null。

created_atstring · date-time否
updated_atstring · date-time否
sandboxboolean否
查看完整响应模式
{
  "$ref": "#/components/schemas/PagamentoCarteira"
}

200

相同 external_id 的重复请求,返回已存在的付款。

application/json

字段类型必填说明
payment_idstring否
external_idstring | null否
statusstring否

最终处理状态:concluido 表示 Pix 已付款;falhou 表示未执行、预留款已释放;falhou_apos_envio 表示发送后仍须核查,预留款不会自行释放。revisao 表示核查中,不等于失败,须继续跟踪。其他状态为处理中阶段。

{"enum":["reservado","ordem_criada","aceita","sacando","enviado","revisao","concluido","falhou","falhou_apos_envio"]}

finalboolean否

状态不再继续变化时为 true。

payment_methodstring否

{"enum":["pix_key","br_code"]}

brl_amountstring否
pix_keystring | null否

已遮盖。

usdt_reservedstring否

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_debitedstring | null否
usdt_orderstring | null否
withdrawal_feestring | null否
cashout_idstring | null否

支付该 Pix 的订单,详情见 GET /cash-outs/{cashout_id}。

errorstring | null否
pix_e2estring否

仅 concluido 提供,Pix E2E 标识。

recipient_namestring否

仅 concluido 提供,收款人姓名。

recipient_documentstring | null否

仅 concluido 提供,按巴西央行方式部分遮盖的 CPF 或 CNPJ。

receipt_urlstring | null否

仅 concluido 提供,官方凭证公开链接,测试环境为 null。

created_atstring · date-time否
updated_atstring · date-time否
sandboxboolean否
查看完整响应模式
{
  "$ref": "#/components/schemas/PagamentoCarteira"
}

400

valor_invalido、valor_abaixo_do_minimo、pix_key_obrigatoria、br_code_invalido、campos_conflitantes、cotacao_recusada。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

409

saldo_insuficiente、external_id_divergente、cotacao_divergente。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /carteira-usdt/payments

列出付款

最近 100 笔付款。已完成记录提供 E2E、收款人姓名、部分遮盖的 CPF 及凭证链接。

身份验证:ApiKey

响应

200

OK

application/json

字段类型必填说明
itemsarray · PagamentoCarteira否
查看完整响应模式
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PagamentoCarteira"
      }
    }
  }
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

GET /carteira-usdt/payments/{payment_id}

跟踪付款

查询使用 USDT 支付 Pix 的当前状态。完成后提供 E2E、收款人姓名、部分遮盖的 CPF 及 receipt_url。

身份验证:ApiKey

参数

参数位置类型必填说明
payment_idpathstring是

响应

200

OK

application/json

字段类型必填说明
payment_idstring否
external_idstring | null否
statusstring否

最终处理状态:concluido 表示 Pix 已付款;falhou 表示未执行、预留款已释放;falhou_apos_envio 表示发送后仍须核查,预留款不会自行释放。revisao 表示核查中,不等于失败,须继续跟踪。其他状态为处理中阶段。

{"enum":["reservado","ordem_criada","aceita","sacando","enviado","revisao","concluido","falhou","falhou_apos_envio"]}

finalboolean否

状态不再继续变化时为 true。

payment_methodstring否

{"enum":["pix_key","br_code"]}

brl_amountstring否
pix_keystring | null否

已遮盖。

usdt_reservedstring否

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_debitedstring | null否
usdt_orderstring | null否
withdrawal_feestring | null否
cashout_idstring | null否

支付该 Pix 的订单,详情见 GET /cash-outs/{cashout_id}。

errorstring | null否
pix_e2estring否

仅 concluido 提供,Pix E2E 标识。

recipient_namestring否

仅 concluido 提供,收款人姓名。

recipient_documentstring | null否

仅 concluido 提供,按巴西央行方式部分遮盖的 CPF 或 CNPJ。

receipt_urlstring | null否

仅 concluido 提供,官方凭证公开链接,测试环境为 null。

created_atstring · date-time否
updated_atstring · date-time否
sandboxboolean否
查看完整响应模式
{
  "$ref": "#/components/schemas/PagamentoCarteira"
}

404

nao_encontrado。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

401

密钥缺失或无效。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

403

carteira_nao_liberada:当前项目尚未启用钱包。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

503

carteira_indisponivel / pagamentos_indisponiveis:稍后重试,acao: esperar。

application/json

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整响应模式
{
  "$ref": "#/components/schemas/Erro"
}

身份验证

ApiKey

通过 POST /keys 创建的密钥,完整值仅显示一次,请在创建时保存。

{
  "type": "apiKey",
  "in": "header",
  "name": "X-API-Key"
}

ApiKeyAuth

您的密钥。lun_test_… 为测试环境,不移动真实资金;新生产密钥使用 lun_live_…,旧版 lun_… 生产密钥仍有效。

{
  "type": "apiKey",
  "in": "header",
  "name": "X-API-Key"
}

数据模式:Erro

API 错误,字段可能因接口或基础设施响应而异。结合 HTTP 状态码及返回的 erro、acao 判断;detail 用于展示,不用于业务分支。须兼容新增错误码。

字段类型必填说明
errostring否

稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。

acaostring否

corrigir = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。

{"enum":["corrigir","repetir","esperar","parar","falar_com_suporte"]}

detailstring否

面向人工阅读的说明,不用于业务分支判断。

limitsobject否

限额错误中可能提供,已换算为订单币种。

docsstring · uri否
request_idstring否

本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。

codestring否

erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。

查看完整 JSON Schema
{
  "type": "object",
  "description": "API 错误,字段可能因接口或基础设施响应而异。结合 HTTP 状态码及返回的 erro、acao 判断;detail 用于展示,不用于业务分支。须兼容新增错误码。",
  "properties": {
    "erro": {
      "type": "string",
      "description": "稳定错误码,应据此编写分支,不根据 detail 文本判断。本列表来自 API 实际使用的错误码。",
      "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",
        "custodia_desligada",
        "deposit_obrigatorio",
        "destino_invalido",
        "devolucao_indisponivel",
        "documento_invalido",
        "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",
        "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 = 请求有误,原样重试无效;repetir = 暂时故障,可用相同请求重试;esperar = 等待配额恢复;parar = 不要重试,请联系团队;falar_com_suporte = 不循环重试,保留 request_id 及 external_id 并联系 Lunium,例如 config_provedor。"
    },
    "detail": {
      "type": "string",
      "description": "面向人工阅读的说明,不用于业务分支判断。"
    },
    "limits": {
      "type": "object",
      "description": "限额错误中可能提供,已换算为订单币种。"
    },
    "docs": {
      "type": "string",
      "format": "uri"
    },
    "request_id": {
      "type": "string",
      "description": "本次请求标识,同时出现在 X-Request-ID 响应头中,联系支持时请提供。若请求头 X-Request-ID 符合 [A-Za-z0-9._:-]{8,64},将全程保留原值。",
      "examples": [
        "req_62f05f21b3794830a241"
      ]
    },
    "code": {
      "type": "string",
      "deprecated": true,
      "description": "erro 的旧别名,计划于2026年11月9日停止返回。不要依赖此字段,使用规范字段 erro;它不会脱离 erro 单独出现。"
    }
  }
}

数据模式:CashOut

字段类型必填说明
cashout_idstring否

不透明订单标识,生产环境可能为 UUID,测试环境以 sbx_ 开头。原样保存,不做类型转换。

statestring否

订单状态。COMPLETED 确认 Pix 已付款,中间阶段因渠道而异,DELAYED 属于测试场景。AWAITING_REFUND_ADDRESS 表示须退款但尚无钱包,通过 POST /cash-outs/{cashout_id}/refund-address 提交;适用于加密资产卖出,以及自 1.44.0 起的 DePix 卖出。DePix 成功流程为 QUOTE_CREATED → AWAITING_DEPOSIT → DEPOSIT_DETECTED → PROCESSING → COMPLETED。Pix 无法支付时进入 REFUNDING → REFUNDED,缺少钱包则 AWAITING_REFUND_ADDRESS。若 DePix 已发送至服务商,须确认资金返还后才可退款;此前保持 MANUAL_REVIEW,退款最高为实际返还金额。

{"enum":["QUOTE_CREATED","AWAITING_DEPOSIT","DEPOSIT_DETECTED","DEPOSIT_CONFIRMED","SELLING","SOLD","FORWARDING","PAYING_OUT","COMPLETED","MANUAL_REVIEW","REFUNDING_CRYPTO","REFUNDED","EXPIRED","FAILED","DELAYED","AWAITING_REFUND_ADDRESS","PROCESSING","REFUNDING"]}

pathstring | null否

FAST、DEX 或 CONVERT 渠道。时效取决于路由、确认及处理。DePix/Liquid 使用 depix_liquid。

{"enum":["FAST","DEX","CONVERT",null,"depix_liquid"]}

assetstring否

卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 "usdt"。须与 network 组合使用,且 (asset, network) 必须存在于目录。

networkstring否

目录列出的充值区块链网络,例如 "polygon"。返回地址仅对该网络有效。

amountstring否

加密资产数量,以十进制字符串表示,绝不使用浮点数。

brl_amountstring | null否

Pix 收款账户将收到的巴西雷亚尔(BRL)金额。

pix_keystring否

响应中经遮盖的收款人 Pix 标识。请求传入完整标识,不要将遮盖后的响应与原值逐字比较。

pix_key_typestring否

通常可省略,邮箱、CNPJ、随机标识及带 +55 的手机号可根据格式推断。11 位纯数字无法区分 CPF 与手机号,必须明确指定类型,以免付错收款人。显式类型优先于推断。

{"enum":["cpf","cnpj","phone","email","random"]}

deposit_addressstring | null否

客户发送加密资产的地址,仅在接受报价后提供。测试环境 DePix 返回不可付款标记 SANDBOX:LIQUID:NAO_ENVIAR:…,切勿发送真实资产。

deposit_tagstring | null否

接受报价时返回的 memo/tag,充值须一并填写。仅使用 GET /catalog 中的网络。

external_idstring | null否

每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。

{"maxLength":64}

refund_addressstring | null否

客户确认的退款钱包,缺失时不代表可以使用 deposit_from。订单可能停留于 AWAITING_REFUND_ADDRESS。自 1.44.0 起,DePix 卖出也适用,须提供客户 Liquid 地址 lq1…。

refund_tx_hashstring | null否

退款完成后的交易哈希,不代表所有退款均有固定金额或时限。

deposit_fromstring | null否

充值的链上来源,仅供参考,可能为交易所共用钱包。绝不能自动将其选为退款目的地。

br_codestring | null否

报价时提供的 Copia e Cola 支付码(如有),brl_amount 为二维码金额。

merchant_namestring | null否

从收款二维码中读取的收款人姓名。

copia_e_cola_buffer_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

expires_atstring | null · date-time否

报价到期时间,ISO 8601 UTC,例如 2026-09-02T14:03:00Z。过期后接受报价返回 erro=cotacao_expirada,应重新报价,不要反复提交。

pix_e2estring | null否

Pix 完成后的巴西央行端到端标识,可通过 GET /v1/verificar/{e2e} 无需密钥公开核验。可向最终客户提供。测试环境为虚构 E2E,ISPB 为 00000000,不能证明银行付款。

pix_paid_atstring | null · date-time否
receipt_urlstring | null否

可分享的凭证页面链接,生成后提供。cashout.completed 事件中可能仍为 null,后续 cashout.receipt_ready 或同一订单查询会提供链接。

receipt_pdf_urlstring | null · uri否

PDF 凭证文件,可附至工单、发送给客户或留作会计档案,核查时不依赖在线凭证页面。包含收款人姓名、证件及机构、金额、日期、E2E 和核验链接,与在线页面使用同一数据源。在订单尚未达到对应阶段时为 null。凭证内容及 API、webhook、控制台、Telegram 等获取方式详见 https://docs.luniumpay.com/zh/manual#comprovante 。

{"nullable":true}

verify_urlstring | null · uri否

公开核验直达链接,无需密钥,可交给交易对方独立确认付款。不会展示 Pix 收款标识、完整姓名或完整证件。订单尚未达到相应阶段时为 null。

{"nullable":true}

created_atstring | null · date-time否
updated_atstring | null · date-time否
timelinearray · object否

服务器在状态变化时记录的时间线,来自网关时间而非轮询时间:AWAITING_DEPOSIT → DEPOSIT_DETECTED → DEPOSIT_CONFIRMED →(SELLING → SOLD → FORWARDING,仅交易所渠道)→ PAYING_OUT → COMPLETED。用于客户交易跟踪界面。

confirmationsinteger | null否

当前已观察到的充值确认数,仅在订单等待网络确认时返回,不持久保存,会随区块变化。结合 confirmations_required 展示实际进展,不要编造进度。

confirmations_requiredinteger | null否

交易所对该网络充值入账所要求的确认数。

failure_reasonstring | null否

返回的失败原因,包括测试环境场景。

sandboxboolean否

模拟交易时为 true。

simulationobject否
partner_fee_bpsinteger否

该笔卖出创建时保存的合作伙伴 sub fee,单位 bps。早于此字段的旧订单或 DePix 卖出可能为 null。

{"nullable":true}

partner_fee_brl_centsinteger否

Pix 确认时确定的合作伙伴份额,以分计,即记入佣金账本的金额。

{"nullable":true}

refund_address_requiredboolean否

AWAITING_REFUND_ADDRESS 时为 true。查询退款资料,并通过 POST /cash-outs/{cashout_id}/refund-address 提交客户确认的钱包。

refund_amountstring | null否

核算后的实际退款数量,不要默认等于最初充值量。DePix 全部由 Lunium 持有时,AWAITING_REFUND_ADDRESS 已提供 refund_amount、refund_asset(DEPIX)及 refund_network(liquid)。若已转交服务商,MANUAL_REVIEW 中这些字段保持 null,直至确认返还;之后 refund_amount 最高为实际返还金额加未转交部分,且不超过订单金额。

refund_assetstring | null否

实际退款资产,可能与充值资产不同。

refund_networkstring | null否

实际退款网络,须使用客户确认且兼容的钱包。

provider_return_txidstring | null否

合作服务商向 Lunium 返还资金的参考标识,不是向客户完成退款的证明。

fee_bpsinteger否

DePix 卖出费率,单位 bps。

fee_fixed_centsinteger否

DePix 卖出固定费用,以分计。

fee_total_centsinteger否

总费用,以分计,在 DePix 报价及模拟订单中提供。

net_centsinteger否

Pix 净额,以分计,在 DePix 报价及模拟订单中提供。

pix_key_reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整 JSON Schema
{
  "type": "object",
  "properties": {
    "cashout_id": {
      "type": "string",
      "description": "不透明订单标识,生产环境可能为 UUID,测试环境以 sbx_ 开头。原样保存,不做类型转换。"
    },
    "state": {
      "type": "string",
      "enum": [
        "QUOTE_CREATED",
        "AWAITING_DEPOSIT",
        "DEPOSIT_DETECTED",
        "DEPOSIT_CONFIRMED",
        "SELLING",
        "SOLD",
        "FORWARDING",
        "PAYING_OUT",
        "COMPLETED",
        "MANUAL_REVIEW",
        "REFUNDING_CRYPTO",
        "REFUNDED",
        "EXPIRED",
        "FAILED",
        "DELAYED",
        "AWAITING_REFUND_ADDRESS",
        "PROCESSING",
        "REFUNDING"
      ],
      "description": "订单状态。COMPLETED 确认 Pix 已付款,中间阶段因渠道而异,DELAYED 属于测试场景。AWAITING_REFUND_ADDRESS 表示须退款但尚无钱包,通过 POST /cash-outs/{cashout_id}/refund-address 提交;适用于加密资产卖出,以及自 1.44.0 起的 DePix 卖出。DePix 成功流程为 QUOTE_CREATED → AWAITING_DEPOSIT → DEPOSIT_DETECTED → PROCESSING → COMPLETED。Pix 无法支付时进入 REFUNDING → REFUNDED,缺少钱包则 AWAITING_REFUND_ADDRESS。若 DePix 已发送至服务商,须确认资金返还后才可退款;此前保持 MANUAL_REVIEW,退款最高为实际返还金额。"
    },
    "path": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "FAST",
        "DEX",
        "CONVERT",
        null,
        "depix_liquid"
      ],
      "description": "FAST、DEX 或 CONVERT 渠道。时效取决于路由、确认及处理。DePix/Liquid 使用 depix_liquid。"
    },
    "asset": {
      "type": "string",
      "examples": [
        "USDT"
      ],
      "description": "卖出的资产。必须使用 GET /catalog 中完全一致的 id,例如 \"usdt\"。须与 network 组合使用,且 (asset, network) 必须存在于目录。"
    },
    "network": {
      "type": "string",
      "examples": [
        "polygon"
      ],
      "description": "目录列出的充值区块链网络,例如 \"polygon\"。返回地址仅对该网络有效。"
    },
    "amount": {
      "type": "string",
      "description": "加密资产数量,以十进制字符串表示,绝不使用浮点数。"
    },
    "brl_amount": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pix 收款账户将收到的巴西雷亚尔(BRL)金额。"
    },
    "pix_key": {
      "type": "string",
      "description": "响应中经遮盖的收款人 Pix 标识。请求传入完整标识,不要将遮盖后的响应与原值逐字比较。"
    },
    "pix_key_type": {
      "type": "string",
      "enum": [
        "cpf",
        "cnpj",
        "phone",
        "email",
        "random"
      ],
      "description": "通常可省略,邮箱、CNPJ、随机标识及带 +55 的手机号可根据格式推断。11 位纯数字无法区分 CPF 与手机号,必须明确指定类型,以免付错收款人。显式类型优先于推断。"
    },
    "deposit_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "客户发送加密资产的地址,仅在接受报价后提供。测试环境 DePix 返回不可付款标记 SANDBOX:LIQUID:NAO_ENVIAR:…,切勿发送真实资产。"
    },
    "deposit_tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "接受报价时返回的 memo/tag,充值须一并填写。仅使用 GET /catalog 中的网络。"
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "每个业务意图的持久标识,最多 64 个字符。相同请求体重试复用原订单;更改网络、资产、token、目的地、Pix 类型、金额或退款钱包会产生 409 冲突。须先恢复原订单,再决定是否新建。旧订单若缺少可验证请求身份,可能须按 cashout_id/external_id 恢复。",
      "maxLength": 64
    },
    "refund_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "客户确认的退款钱包,缺失时不代表可以使用 deposit_from。订单可能停留于 AWAITING_REFUND_ADDRESS。自 1.44.0 起,DePix 卖出也适用,须提供客户 Liquid 地址 lq1…。 "
    },
    "refund_tx_hash": {
      "type": [
        "string",
        "null"
      ],
      "description": "退款完成后的交易哈希,不代表所有退款均有固定金额或时限。"
    },
    "deposit_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "充值的链上来源,仅供参考,可能为交易所共用钱包。绝不能自动将其选为退款目的地。"
    },
    "br_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "报价时提供的 Copia e Cola 支付码(如有),brl_amount 为二维码金额。"
    },
    "merchant_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "从收款二维码中读取的收款人姓名。"
    },
    "copia_e_cola_buffer_usd": {
      "type": [
        "string",
        "null"
      ],
      "description": "R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。",
      "example": "0.200000"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "报价到期时间,ISO 8601 UTC,例如 2026-09-02T14:03:00Z。过期后接受报价返回 erro=cotacao_expirada,应重新报价,不要反复提交。"
    },
    "pix_e2e": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pix 完成后的巴西央行端到端标识,可通过 GET /v1/verificar/{e2e} 无需密钥公开核验。可向最终客户提供。测试环境为虚构 E2E,ISPB 为 00000000,不能证明银行付款。",
      "examples": [
        "E37293930202607312006361894c4a82"
      ]
    },
    "pix_paid_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "receipt_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "可分享的凭证页面链接,生成后提供。cashout.completed 事件中可能仍为 null,后续 cashout.receipt_ready 或同一订单查询会提供链接。",
      "examples": [
        "https://app.luniumpay.com/comprovante/uwscff6ASNS1oUcH2LHbvw"
      ]
    },
    "receipt_pdf_url": {
      "type": [
        "string",
        "null"
      ],
      "nullable": true,
      "format": "uri",
      "description": "PDF 凭证文件,可附至工单、发送给客户或留作会计档案,核查时不依赖在线凭证页面。包含收款人姓名、证件及机构、金额、日期、E2E 和核验链接,与在线页面使用同一数据源。在订单尚未达到对应阶段时为 null。凭证内容及 API、webhook、控制台、Telegram 等获取方式详见 https://docs.luniumpay.com/zh/manual#comprovante 。",
      "example": "https://app.luniumpay.com/comprovante/qigpnCTx3gM-Ge7hN27Mvw.pdf"
    },
    "verify_url": {
      "type": [
        "string",
        "null"
      ],
      "nullable": true,
      "format": "uri",
      "description": "公开核验直达链接,无需密钥,可交给交易对方独立确认付款。不会展示 Pix 收款标识、完整姓名或完整证件。订单尚未达到相应阶段时为 null。",
      "example": "https://api.luniumpay.com/v1/verificar/E3729393020260731214021222ac6ff1"
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "timeline": {
      "type": "array",
      "description": "服务器在状态变化时记录的时间线,来自网关时间而非轮询时间:AWAITING_DEPOSIT → DEPOSIT_DETECTED → DEPOSIT_CONFIRMED →(SELLING → SOLD → FORWARDING,仅交易所渠道)→ PAYING_OUT → COMPLETED。用于客户交易跟踪界面。",
      "items": {
        "type": "object",
        "properties": {
          "state": {
            "type": "string"
          },
          "at": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "confirmations": {
      "type": [
        "integer",
        "null"
      ],
      "description": "当前已观察到的充值确认数,仅在订单等待网络确认时返回,不持久保存,会随区块变化。结合 confirmations_required 展示实际进展,不要编造进度。"
    },
    "confirmations_required": {
      "type": [
        "integer",
        "null"
      ],
      "description": "交易所对该网络充值入账所要求的确认数。"
    },
    "failure_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "返回的失败原因,包括测试环境场景。"
    },
    "sandbox": {
      "type": "boolean",
      "description": "模拟交易时为 true。"
    },
    "simulation": {
      "type": "object",
      "additionalProperties": true
    },
    "partner_fee_bps": {
      "type": "integer",
      "nullable": true,
      "description": "该笔卖出创建时保存的合作伙伴 sub fee,单位 bps。早于此字段的旧订单或 DePix 卖出可能为 null。"
    },
    "partner_fee_brl_cents": {
      "type": "integer",
      "nullable": true,
      "description": "Pix 确认时确定的合作伙伴份额,以分计,即记入佣金账本的金额。"
    },
    "refund_address_required": {
      "type": "boolean",
      "description": "AWAITING_REFUND_ADDRESS 时为 true。查询退款资料,并通过 POST /cash-outs/{cashout_id}/refund-address 提交客户确认的钱包。"
    },
    "refund_amount": {
      "type": [
        "string",
        "null"
      ],
      "description": "核算后的实际退款数量,不要默认等于最初充值量。DePix 全部由 Lunium 持有时,AWAITING_REFUND_ADDRESS 已提供 refund_amount、refund_asset(DEPIX)及 refund_network(liquid)。若已转交服务商,MANUAL_REVIEW 中这些字段保持 null,直至确认返还;之后 refund_amount 最高为实际返还金额加未转交部分,且不超过订单金额。"
    },
    "refund_asset": {
      "type": [
        "string",
        "null"
      ],
      "description": "实际退款资产,可能与充值资产不同。"
    },
    "refund_network": {
      "type": [
        "string",
        "null"
      ],
      "description": "实际退款网络,须使用客户确认且兼容的钱包。"
    },
    "provider_return_txid": {
      "type": [
        "string",
        "null"
      ],
      "description": "合作服务商向 Lunium 返还资金的参考标识,不是向客户完成退款的证明。"
    },
    "fee_bps": {
      "type": "integer",
      "description": "DePix 卖出费率,单位 bps。"
    },
    "fee_fixed_cents": {
      "type": "integer",
      "description": "DePix 卖出固定费用,以分计。"
    },
    "fee_total_cents": {
      "type": "integer",
      "description": "总费用,以分计,在 DePix 报价及模拟订单中提供。"
    },
    "net_cents": {
      "type": "integer",
      "description": "Pix 净额,以分计,在 DePix 报价及模拟订单中提供。"
    },
    "pix_key_reserve_usd": {
      "type": [
        "string",
        "null"
      ],
      "description": "R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。",
      "example": "0.200000"
    },
    "reserve_brl": {
      "type": [
        "string",
        "null"
      ],
      "example": "1.00",
      "description": "新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。"
    }
  }
}

数据模式:EventoWebhook

Lunium 发送至您接收端的请求体。事件类型可能新增,未知事件不应触发资金业务效果;应兼容并保存记录,以便之后核查。

字段类型必填说明
eventstring是

按事件类型处理。cashin.settled 是入账 / 交付完成信号,托管可用金额仍须查询余额。cashout.confirming 表示交易所等待充值确认的进展,仅在需要较长等待、至少 120 次确认的网络中,于 25%、50% 及 75% 阶段发送,payload 提供 confirmations 与 confirmations_required,用于补充 cashout.deposit_detected 后可能较长的等待。cashin.held 表示 Pix 已付款但按密钥策略本地冻结,data 提供 liberar_em;不同于服务商冻结的 status: delayed。cashin.delayed 表示 Pix 已付款且服务商冻结 24 小时,见 delay_until。cashout.awaiting_refund_address 表示须退款但缺少钱包,state: AWAITING_REFUND_ADDRESS、refund_address_required: true;向客户索取钱包后,通过 POST /cash-outs/{cashout_id}/refund-address 提交,绝不自动退至充值来源。适用于加密资产卖出及自 1.44.0 起的 DePix 卖出,data 与 GET /cash-outs/{cashout_id} 的订单格式相同。USDT 钱包事件:wallet.deposit_credited 的 data 包含 deposit_id、amount_received、asset、network、balance_available、credited_at;wallet.payment_completed 包含 payment_id、brl_amount、cashout_id、usdt_debited;wallet.payment_failed 包含 payment_id、brl_amount、cashout_id、status、refunded,其中 refunded: true 表示预留款已释放回余额。测试环境的相同事件带 sandbox: true。

{"enum":["cashin.paid","cashin.delayed","cashin.held","cashin.settled","cashin.settlement_failed","cashin.expired","cashin.refunded","cashin.failed","cashout.awaiting_deposit","cashout.deposit_detected","cashout.confirming","cashout.processing","cashout.under_review","cashout.awaiting_refund_address","cashout.refunding","cashout.completed","cashout.receipt_ready","cashout.refunded","cashout.expired","cashout.failed","payout.sent","payout.failed","payout.refunded","webhook.test","saldo.liberado","saldo.congelado","saldo.transferido","wallet.deposit_credited","wallet.payment_completed","wallet.payment_failed"]}

event_idstring否

稳定的事件标识,所有重试保持相同。保存并对重复事件去重,避免重复入账。

{"pattern":"^evt_[0-9a-f]{24}$"}

created_atstring · date-time是
dataobject是

与对应交易状态接口使用相同基础格式。

查看完整 JSON Schema
{
  "type": "object",
  "description": "Lunium 发送至您接收端的请求体。事件类型可能新增,未知事件不应触发资金业务效果;应兼容并保存记录,以便之后核查。",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "cashin.paid",
        "cashin.delayed",
        "cashin.held",
        "cashin.settled",
        "cashin.settlement_failed",
        "cashin.expired",
        "cashin.refunded",
        "cashin.failed",
        "cashout.awaiting_deposit",
        "cashout.deposit_detected",
        "cashout.confirming",
        "cashout.processing",
        "cashout.under_review",
        "cashout.awaiting_refund_address",
        "cashout.refunding",
        "cashout.completed",
        "cashout.receipt_ready",
        "cashout.refunded",
        "cashout.expired",
        "cashout.failed",
        "payout.sent",
        "payout.failed",
        "payout.refunded",
        "webhook.test",
        "saldo.liberado",
        "saldo.congelado",
        "saldo.transferido",
        "wallet.deposit_credited",
        "wallet.payment_completed",
        "wallet.payment_failed"
      ],
      "description": "按事件类型处理。cashin.settled 是入账 / 交付完成信号,托管可用金额仍须查询余额。cashout.confirming 表示交易所等待充值确认的进展,仅在需要较长等待、至少 120 次确认的网络中,于 25%、50% 及 75% 阶段发送,payload 提供 confirmations 与 confirmations_required,用于补充 cashout.deposit_detected 后可能较长的等待。cashin.held 表示 Pix 已付款但按密钥策略本地冻结,data 提供 liberar_em;不同于服务商冻结的 status: delayed。cashin.delayed 表示 Pix 已付款且服务商冻结 24 小时,见 delay_until。cashout.awaiting_refund_address 表示须退款但缺少钱包,state: AWAITING_REFUND_ADDRESS、refund_address_required: true;向客户索取钱包后,通过 POST /cash-outs/{cashout_id}/refund-address 提交,绝不自动退至充值来源。适用于加密资产卖出及自 1.44.0 起的 DePix 卖出,data 与 GET /cash-outs/{cashout_id} 的订单格式相同。USDT 钱包事件:wallet.deposit_credited 的 data 包含 deposit_id、amount_received、asset、network、balance_available、credited_at;wallet.payment_completed 包含 payment_id、brl_amount、cashout_id、usdt_debited;wallet.payment_failed 包含 payment_id、brl_amount、cashout_id、status、refunded,其中 refunded: true 表示预留款已释放回余额。测试环境的相同事件带 sandbox: true。"
    },
    "event_id": {
      "type": "string",
      "pattern": "^evt_[0-9a-f]{24}$",
      "description": "稳定的事件标识,所有重试保持相同。保存并对重复事件去重,避免重复入账。",
      "examples": [
        "evt_9c3f21a70b5e4d8812ff0a63"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "data": {
      "type": "object",
      "description": "与对应交易状态接口使用相同基础格式。"
    }
  },
  "required": [
    "event",
    "created_at",
    "data"
  ]
}

数据模式:EntregaWebhook

字段类型必填说明
event_idstring否
eventstring否

{"enum":["cashin.paid","cashin.delayed","cashin.held","cashin.settled","cashin.settlement_failed","cashin.expired","cashin.refunded","cashin.failed","cashout.awaiting_deposit","cashout.deposit_detected","cashout.confirming","cashout.processing","cashout.under_review","cashout.awaiting_refund_address","cashout.refunding","cashout.completed","cashout.receipt_ready","cashout.refunded","cashout.expired","cashout.failed","payout.sent","payout.failed","payout.refunded","webhook.test","saldo.liberado","saldo.congelado","saldo.transferido","wallet.deposit_credited","wallet.payment_completed","wallet.payment_failed"]}

operation_idstring否

产生此事件的交易 ID。

statusstring否

failed 表示 12 次尝试已耗尽,可通过 retry 恢复。

{"enum":["pending","sent","failed"]}

attemptsinteger否
last_errorstring | null否
urlstring · uri否
next_attempt_atstring | null · date-time否
created_atstring · date-time否
updated_atstring · date-time否
查看完整 JSON Schema
{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string"
    },
    "event": {
      "type": "string",
      "enum": [
        "cashin.paid",
        "cashin.delayed",
        "cashin.held",
        "cashin.settled",
        "cashin.settlement_failed",
        "cashin.expired",
        "cashin.refunded",
        "cashin.failed",
        "cashout.awaiting_deposit",
        "cashout.deposit_detected",
        "cashout.confirming",
        "cashout.processing",
        "cashout.under_review",
        "cashout.awaiting_refund_address",
        "cashout.refunding",
        "cashout.completed",
        "cashout.receipt_ready",
        "cashout.refunded",
        "cashout.expired",
        "cashout.failed",
        "payout.sent",
        "payout.failed",
        "payout.refunded",
        "webhook.test",
        "saldo.liberado",
        "saldo.congelado",
        "saldo.transferido",
        "wallet.deposit_credited",
        "wallet.payment_completed",
        "wallet.payment_failed"
      ]
    },
    "operation_id": {
      "type": "string",
      "description": "产生此事件的交易 ID。"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "sent",
        "failed"
      ],
      "description": "failed 表示 12 次尝试已耗尽,可通过 retry 恢复。"
    },
    "attempts": {
      "type": "integer"
    },
    "last_error": {
      "type": [
        "string",
        "null"
      ]
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "next_attempt_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

数据模式:TitularPix

字段类型必填说明
pix_keystring是

规范化后的 Pix 收款标识,手机号格式为 +55…。

pix_key_typestring是

所查询收款标识类型:"cpf"、"cnpj"、"phone"、"email" 或 "random"。

{"enum":["cpf","cnpj","phone","email","random"]}

owner_namestring | null是

DICT 中的持有人姓名。

owner_tax_numberstring | null否

已遮盖的 CPF/CNPJ,绝不返回完整值。

institution_namestring | null否

收款标识登记的金融机构。

ispbstring | null否

机构 ISPB,8 位数字。

verifiedboolean是

已查询收款人或在测试环境模拟时为 true(source=sandbox);未核验时为 false。

sourcestring是

{"enum":["dict","sandbox","disabled"]}

checked_atstring · date-time是
cachedboolean否

响应来自缓存时为 true。

sandboxboolean否

仅测试密钥提供,表示虚构收款人。

availableboolean否

查询不可用时为 false,也可能同时返回 HTTP 200。

optionalboolean否

查询为辅助功能,不是付款前提。

verification_statusstring否

未执行核验时为 not_performed。

detailstring否
查看完整 JSON Schema
{
  "type": "object",
  "required": [
    "pix_key",
    "pix_key_type",
    "owner_name",
    "verified",
    "source",
    "checked_at"
  ],
  "properties": {
    "pix_key": {
      "type": "string",
      "description": "规范化后的 Pix 收款标识,手机号格式为 +55…。"
    },
    "pix_key_type": {
      "type": "string",
      "enum": [
        "cpf",
        "cnpj",
        "phone",
        "email",
        "random"
      ],
      "description": "所查询收款标识类型:\"cpf\"、\"cnpj\"、\"phone\"、\"email\" 或 \"random\"。"
    },
    "owner_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "DICT 中的持有人姓名。",
      "examples": [
        "João Silva"
      ]
    },
    "owner_tax_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "已遮盖的 CPF/CNPJ,绝不返回完整值。",
      "examples": [
        "***.202.745-**"
      ]
    },
    "institution_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "收款标识登记的金融机构。",
      "examples": [
        "NU PAGAMENTOS - IP"
      ]
    },
    "ispb": {
      "type": [
        "string",
        "null"
      ],
      "description": "机构 ISPB,8 位数字。",
      "examples": [
        "18236120"
      ]
    },
    "verified": {
      "type": "boolean",
      "description": "已查询收款人或在测试环境模拟时为 true(source=sandbox);未核验时为 false。"
    },
    "source": {
      "type": "string",
      "enum": [
        "dict",
        "sandbox",
        "disabled"
      ]
    },
    "checked_at": {
      "type": "string",
      "format": "date-time"
    },
    "cached": {
      "type": "boolean",
      "description": "响应来自缓存时为 true。"
    },
    "sandbox": {
      "type": "boolean",
      "description": "仅测试密钥提供,表示虚构收款人。"
    },
    "available": {
      "type": "boolean",
      "description": "查询不可用时为 false,也可能同时返回 HTTP 200。"
    },
    "optional": {
      "type": "boolean",
      "description": "查询为辅助功能,不是付款前提。"
    },
    "verification_status": {
      "type": "string",
      "description": "未执行核验时为 not_performed。"
    },
    "detail": {
      "type": "string"
    }
  }
}

数据模式:NextAction

下一步操作,以可调用结构表示,使智能体无需依赖人工说明继续流程。

字段类型必填说明
methodstring否
endpointstring否
whystring否
查看完整 JSON Schema
{
  "type": "object",
  "description": "下一步操作,以可调用结构表示,使智能体无需依赖人工说明继续流程。",
  "properties": {
    "method": {
      "type": "string",
      "example": "POST"
    },
    "endpoint": {
      "type": "string",
      "example": "/mesh/agents/{agent_id}/settlement"
    },
    "why": {
      "type": "string",
      "example": "sem rota de liquidacao o dinheiro nao tem para onde ir"
    }
  }
}

数据模式:ErroAutocorrigivel

智能体可处理的错误。acao 为稳定枚举:corrigir(请求有误)、esperar(等待配额)、parar(停止重复)、repetir(暂时故障)。

字段类型必填说明
errostring是
acaostring是

{"enum":["corrigir","esperar","parar","repetir"]}

detailstring否
missingarray · string否
next_actionsarray · NextAction否
查看完整 JSON Schema
{
  "type": "object",
  "description": "智能体可处理的错误。acao 为稳定枚举:corrigir(请求有误)、esperar(等待配额)、parar(停止重复)、repetir(暂时故障)。",
  "properties": {
    "erro": {
      "type": "string",
      "example": "mandate_valor_acima_do_teto"
    },
    "acao": {
      "type": "string",
      "enum": [
        "corrigir",
        "esperar",
        "parar",
        "repetir"
      ]
    },
    "detail": {
      "type": "string"
    },
    "missing": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "next_actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/NextAction"
      }
    }
  },
  "required": [
    "erro",
    "acao"
  ]
}

数据模式:Capability

按属性而非内部名称描述 Lunium 的能力,让智能体根据自身目标匹配,无需预先了解平台术语。

字段类型必填说明
descricaostring否
intentarray · string否
input_assetsarray · string否
input_networksarray · string否
output_currenciesarray · string否
payment_railsarray · string否
endpointstring否
directionstring否
settlement_speedstring否

{"enum":["seconds","minutes"]}

查看完整 JSON Schema
{
  "type": "object",
  "description": "按属性而非内部名称描述 Lunium 的能力,让智能体根据自身目标匹配,无需预先了解平台术语。",
  "properties": {
    "descricao": {
      "type": "string"
    },
    "intent": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "sell_crypto",
        "receive_fiat",
        "offramp",
        "cash_out"
      ]
    },
    "input_assets": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "USDT"
      ]
    },
    "input_networks": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "polygon"
      ]
    },
    "output_currencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "BRL"
      ]
    },
    "payment_rails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "PIX"
      ]
    },
    "endpoint": {
      "type": "string",
      "example": "/cash-outs"
    },
    "direction": {
      "type": "string",
      "example": "crypto->fiat"
    },
    "settlement_speed": {
      "type": "string",
      "enum": [
        "seconds",
        "minutes"
      ]
    }
  }
}

数据模式:MeshDiscovery

智能体接入前的统一发现文档,由当前配置生成,用于查询服务能力及规则。

字段类型必填说明
quem_somosobject否
como_falar_comigoobject否

REST、OpenAPI、MCP、A2A 及 Mesh。

capacidadesobject否
como_escolher_capacidadeobject否

业务意图 → 能力的反向索引,以及按属性筛选的说明。

execucaoobject否

每项能力提供接口、必填字段及可用示例。

ativos_e_redesobject否
limitesobject否
como_comecarobject否
regra_de_segurancaobject否
atribuicaoobject否
查看完整 JSON Schema
{
  "type": "object",
  "description": "智能体接入前的统一发现文档,由当前配置生成,用于查询服务能力及规则。",
  "properties": {
    "quem_somos": {
      "type": "object"
    },
    "como_falar_comigo": {
      "type": "object",
      "description": "REST、OpenAPI、MCP、A2A 及 Mesh。"
    },
    "capacidades": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/Capability"
      }
    },
    "como_escolher_capacidade": {
      "type": "object",
      "description": "业务意图 → 能力的反向索引,以及按属性筛选的说明。",
      "properties": {
        "por_intencao": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "execucao": {
      "type": "object",
      "description": "每项能力提供接口、必填字段及可用示例。"
    },
    "ativos_e_redes": {
      "type": "object"
    },
    "limites": {
      "type": "object"
    },
    "como_comecar": {
      "type": "object"
    },
    "regra_de_seguranca": {
      "type": "object"
    },
    "atribuicao": {
      "type": "object"
    }
  }
}

数据模式:AgentIdentity

智能体永久身份。凭证可以替换,但推荐关系、交易量、奖励、mandate 及信誉均归属 agent_id。

字段类型必填说明
agent_idstring否
namestring否
descriptionstring | null否
contactstring | null否
statusAgentLifecycle否
environmentstring否

{"enum":["sandbox","production"]}

capabilitiesarray · string否
settlement_addressstring | null否
referred_bystring | null否

注册后不可变,由数据库触发器保护。

created_atstring · date-time否
查看完整 JSON Schema
{
  "type": "object",
  "description": "智能体永久身份。凭证可以替换,但推荐关系、交易量、奖励、mandate 及信誉均归属 agent_id。",
  "properties": {
    "agent_id": {
      "type": "string",
      "example": "agt_2319c9da313e84af3b"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "contact": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "$ref": "#/components/schemas/AgentLifecycle"
    },
    "environment": {
      "type": "string",
      "enum": [
        "sandbox",
        "production"
      ]
    },
    "capabilities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "settlement_address": {
      "type": [
        "string",
        "null"
      ]
    },
    "referred_by": {
      "type": [
        "string",
        "null"
      ],
      "description": "注册后不可变,由数据库触发器保护。"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

数据模式:AgentLifecycle

生产环境按规则自动激活,无需人工审批。风险控制来自 cash-in 付款人分级、单笔上限、Pix 收款人每日上限及密钥自身 mandate。自2026年9月10日起,不设 API 密钥每日总额度,也没有人工审批队列。

查看完整 JSON Schema
{
  "type": "string",
  "enum": [
    "registered",
    "sandbox_active",
    "validated",
    "production_active",
    "suspended"
  ],
  "description": "生产环境按规则自动激活,无需人工审批。风险控制来自 cash-in 付款人分级、单笔上限、Pix 收款人每日上限及密钥自身 mandate。自2026年9月10日起,不设 API 密钥每日总额度,也没有人工审批队列。"
}

数据模式:AgentRegistration

字段类型必填说明
namestring是

{"minLength":2,"maxLength":80}

descriptionstring否
contactstring否
agent_card_urlstring否
capabilitiesarray · string否
referral_tokenstring否

由推荐方签名的推荐证明,是建立推荐关系的唯一方式。由于涉及奖励,拒绝客户端自行申报 referred_by。

查看完整 JSON Schema
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80
    },
    "description": {
      "type": "string"
    },
    "contact": {
      "type": "string"
    },
    "agent_card_url": {
      "type": "string"
    },
    "capabilities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "referral_token": {
      "type": "string",
      "description": "由推荐方签名的推荐证明,是建立推荐关系的唯一方式。由于涉及奖励,拒绝客户端自行申报 referred_by。"
    }
  }
}

数据模式:AgentKey

凭证前缀:lun_test_ 为测试,lun_live_ 为生产。2026年8月29日前签发的旧 lun_ 密钥仍有效。身份验证依据密钥哈希,前缀仅便于人工识别。

字段类型必填说明
api_keystring否

完整值仅显示一次,平台仅保存哈希。

sandboxboolean否
查看完整 JSON Schema
{
  "type": "object",
  "description": "凭证前缀:lun_test_* 为测试,lun_live_* 为生产。2026年8月29日前签发的旧 lun_ 密钥仍有效。身份验证依据密钥哈希,前缀仅便于人工识别。",
  "properties": {
    "api_key": {
      "type": "string",
      "example": "lun_live_a977c15a…",
      "description": "完整值仅显示一次,平台仅保存哈希。"
    },
    "sandbox": {
      "type": "boolean"
    }
  }
}

数据模式:Mandate

密钥为自身设置的授权策略,只能收紧限额,不能扩大权限。智能体可自行降低其操作范围,生产激活前必须设置。

字段类型必填说明
max_por_operacao_centsinteger否
max_diario_centsinteger否
contrapartesarray · string否

允许付款的 Pix 收款标识,空列表表示不另加此项限制。

查看完整 JSON Schema
{
  "type": "object",
  "description": "密钥为自身设置的授权策略,只能收紧限额,不能扩大权限。智能体可自行降低其操作范围,生产激活前必须设置。",
  "properties": {
    "max_por_operacao_cents": {
      "type": "integer",
      "example": 30000
    },
    "max_diario_cents": {
      "type": "integer",
      "example": 200000
    },
    "contrapartes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "允许付款的 Pix 收款标识,空列表表示不另加此项限制。"
    }
  }
}

数据模式:SettlementConfiguration

字段类型必填说明
settlement_addressstring是

支持的结算网络钱包。

查看完整 JSON Schema
{
  "type": "object",
  "required": [
    "settlement_address"
  ],
  "properties": {
    "settlement_address": {
      "type": "string",
      "example": "0x51e3…75e0",
      "description": "支持的结算网络钱包。"
    }
  }
}

数据模式:ProductionActivation

自动激活,activated_by 始终为 policy,不为 operator。

字段类型必填说明
statusstring否
agent_idstring否
environmentstring否
activated_atstring · date-time否
activated_bystring否
api_keystring否

生产凭证 lun_live_*,仅显示一次。

settlementobject否
mandateMandate否
capabilitiesarray · string否
查看完整 JSON Schema
{
  "type": "object",
  "description": "自动激活,activated_by 始终为 policy,不为 operator。",
  "properties": {
    "status": {
      "type": "string",
      "example": "production_active"
    },
    "agent_id": {
      "type": "string"
    },
    "environment": {
      "type": "string",
      "example": "production"
    },
    "activated_at": {
      "type": "string",
      "format": "date-time"
    },
    "activated_by": {
      "type": "string",
      "example": "policy"
    },
    "api_key": {
      "type": "string",
      "description": "生产凭证 lun_live_*,仅显示一次。"
    },
    "settlement": {
      "type": "object"
    },
    "mandate": {
      "$ref": "#/components/schemas/Mandate"
    },
    "capabilities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

数据模式:ReferralAttestation

签名 token(JWS HS256)用于证明推荐方,一次性且有有效期。未提供时,智能体作为根节点加入,不为推荐方产生奖励。

字段类型必填说明
typestring否
referrer_agent_idstring否
referral_tokenstring否
capabilitystring | null否
noncestring否
expires_atstring · date-time否
one_time_useboolean否
查看完整 JSON Schema
{
  "type": "object",
  "description": "签名 token(JWS HS256)用于证明推荐方,一次性且有有效期。未提供时,智能体作为根节点加入,不为推荐方产生奖励。",
  "properties": {
    "type": {
      "type": "string",
      "example": "mesh_referral"
    },
    "referrer_agent_id": {
      "type": "string"
    },
    "referral_token": {
      "type": "string"
    },
    "capability": {
      "type": [
        "string",
        "null"
      ]
    },
    "nonce": {
      "type": "string"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "one_time_use": {
      "type": "boolean",
      "example": true
    }
  }
}

数据模式:AgentNetwork

某智能体下方的推荐树。network_volume 统计整棵树,用于信誉;reward_eligible_volume 仅统计可计奖交易量。

字段类型必填说明
agent_idstring否
referred_bystring | null否
depthinteger否
direct_childreninteger否
total_descendantsinteger否
own_volume_centsinteger否
own_transactionsinteger否
network_volume_centsinteger否
network_transactionsinteger否
reward_eligible_volume_centsinteger否
lifetime_rewards_centsinteger否
first_operationstring | null · date-time否
production_sincestring | null · date-time否
childrenarray · object否
查看完整 JSON Schema
{
  "type": "object",
  "description": "某智能体下方的推荐树。network_volume 统计整棵树,用于信誉;reward_eligible_volume 仅统计可计奖交易量。",
  "properties": {
    "agent_id": {
      "type": "string"
    },
    "referred_by": {
      "type": [
        "string",
        "null"
      ]
    },
    "depth": {
      "type": "integer"
    },
    "direct_children": {
      "type": "integer"
    },
    "total_descendants": {
      "type": "integer"
    },
    "own_volume_cents": {
      "type": "integer"
    },
    "own_transactions": {
      "type": "integer"
    },
    "network_volume_cents": {
      "type": "integer"
    },
    "network_transactions": {
      "type": "integer"
    },
    "reward_eligible_volume_cents": {
      "type": "integer"
    },
    "lifetime_rewards_cents": {
      "type": "integer"
    },
    "first_operation": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "production_since": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "children": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

数据模式:MeshEconomyPolicy

公开网络经济规则:未结算,不计奖励。

字段类型必填说明
modelstring否
direct_ratestring否
direct_rate_bpsinteger否
max_paid_levelsinteger否
recruitment_rewardboolean否
requires_settled_transactionboolean否
revenue_share_capstring否
查看完整 JSON Schema
{
  "type": "object",
  "description": "公开网络经济规则:未结算,不计奖励。",
  "properties": {
    "model": {
      "type": "string",
      "example": "transaction_attribution"
    },
    "direct_rate": {
      "type": "string",
      "example": "0.10%"
    },
    "direct_rate_bps": {
      "type": "integer",
      "example": 10
    },
    "max_paid_levels": {
      "type": "integer",
      "example": 1
    },
    "recruitment_reward": {
      "type": "boolean",
      "example": false
    },
    "requires_settled_transaction": {
      "type": "boolean",
      "example": true
    },
    "revenue_share_cap": {
      "type": "string"
    }
  }
}

数据模式:RewardEvent

不可变账本记录。冲回以新的负数记录表示,不执行 UPDATE 或 DELETE。

字段类型必填说明
transaction_idstring否
transaction_kindstring否

{"enum":["cashout","cashin"]}

source_agent_idstring否

产生交易量的智能体。

referral_levelinteger否
volume_centsinteger否
rate_bpsinteger否
gross_reward_centsinteger否
revenue_centsinteger否

Lunium 在该交易中的收入。

revenue_cap_centsinteger否

奖励适用上限。

final_reward_centsinteger否

冲回时为负数。

reward_usdtnumber | null否
statusstring否

{"enum":["pending","available","paid","reversed"]}

motivostring | null否
criado_emstring · date-time否
查看完整 JSON Schema
{
  "type": "object",
  "description": "不可变账本记录。冲回以新的负数记录表示,不执行 UPDATE 或 DELETE。",
  "properties": {
    "transaction_id": {
      "type": "string"
    },
    "transaction_kind": {
      "type": "string",
      "enum": [
        "cashout",
        "cashin"
      ]
    },
    "source_agent_id": {
      "type": "string",
      "description": "产生交易量的智能体。"
    },
    "referral_level": {
      "type": "integer",
      "example": 1
    },
    "volume_cents": {
      "type": "integer"
    },
    "rate_bps": {
      "type": "integer",
      "example": 10
    },
    "gross_reward_cents": {
      "type": "integer"
    },
    "revenue_cents": {
      "type": "integer",
      "description": "Lunium 在该交易中的收入。"
    },
    "revenue_cap_cents": {
      "type": "integer",
      "description": "奖励适用上限。"
    },
    "final_reward_cents": {
      "type": "integer",
      "description": "冲回时为负数。"
    },
    "reward_usdt": {
      "type": [
        "number",
        "null"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "available",
        "paid",
        "reversed"
      ]
    },
    "motivo": {
      "type": [
        "string",
        "null"
      ]
    },
    "criado_em": {
      "type": "string",
      "format": "date-time"
    }
  }
}

数据模式:RewardBalance

agent_id 的余额,不属于凭证本身。轮换密钥不会丢失余额。

字段类型必填说明
agent_idstring否
own_volume_centsinteger否
direct_referral_volume_centsinteger否
network_volume_centsinteger否
pending_rewards_centsinteger否
available_rewards_centsinteger否
paid_rewards_centsinteger否
lifetime_rewards_centsinteger否
reward_eventsinteger否
reversalsinteger否
policyMeshEconomyPolicy否
ledgerarray · RewardEvent否
查看完整 JSON Schema
{
  "type": "object",
  "description": "agent_id 的余额,不属于凭证本身。轮换密钥不会丢失余额。",
  "properties": {
    "agent_id": {
      "type": "string"
    },
    "own_volume_cents": {
      "type": "integer"
    },
    "direct_referral_volume_cents": {
      "type": "integer"
    },
    "network_volume_cents": {
      "type": "integer"
    },
    "pending_rewards_cents": {
      "type": "integer"
    },
    "available_rewards_cents": {
      "type": "integer"
    },
    "paid_rewards_cents": {
      "type": "integer"
    },
    "lifetime_rewards_cents": {
      "type": "integer"
    },
    "reward_events": {
      "type": "integer"
    },
    "reversals": {
      "type": "integer"
    },
    "policy": {
      "$ref": "#/components/schemas/MeshEconomyPolicy"
    },
    "ledger": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RewardEvent"
      }
    }
  }
}

数据模式:ServiceRecommendation

智能体间传递的推荐信息,仅包含域名、能力及可选推荐证明,不包含密钥、私密接口或数据模式。接收方仍须独立核实 Lunium。

字段类型必填说明
typestring否
from_agentstring否
domainstring否
capabilitystring否
referral_tokenstring否
verify_yourselfstring否
查看完整 JSON Schema
{
  "type": "object",
  "description": "智能体间传递的推荐信息,仅包含域名、能力及可选推荐证明,不包含密钥、私密接口或数据模式。接收方仍须独立核实 Lunium。",
  "properties": {
    "type": {
      "type": "string",
      "example": "service_recommendation"
    },
    "from_agent": {
      "type": "string"
    },
    "domain": {
      "type": "string",
      "example": "https://luniumpay.com"
    },
    "capability": {
      "type": "string",
      "example": "usdt_to_pix"
    },
    "referral_token": {
      "type": "string"
    },
    "verify_yourself": {
      "type": "string"
    }
  }
}

数据模式:Cobranca

收款单创建响应,含二维码。状态、列表及 webhook 请参阅 StatusCobranca。

字段类型必填说明
cashin_idstring否

收款单标识,格式为 ci_…。

statusstring否

Pix 状态。paid 本身不证明入账 / 交付完成,须读取 settlement_status。

{"enum":["pending","delayed","under_review","paid","expired","refunded","failed"]}

amount_centsinteger否

Pix 金额,以分计。

destinostring否

cripto 表示链上交付,saldo 表示计入密钥 BRL 托管余额,可通过 POST /payouts 及 POST /saldo/sacar-cripto 使用。

{"enum":["cripto","saldo"]}

fontestring否

创建时的资金来源:Pix 或余额提现。

{"enum":["pix","saldo"]}

customer_refstring | null否

您的最终客户引用,即余额子账户。

{"maxLength":80}

payout_addressstring | null否

接收加密资产的钱包,适用于 destino=cripto。

payout_tagstring | null否

共用收款地址等需要附加标识的网络,填写目标钱包 memo/tag,适用于 destino=cripto。

chainstring否

交付网络,使用 GET /cashin/catalog 中的 ID。

assetstring否

交付资产,如 usdt、usdc、btc 等。

lunium_fee_bpsinteger否

创建收款单时固定的比例费用,单位 bps。

lunium_fee_fixed_centsinteger否

创建收款单时固定的费用,以分计。

partner_fee_bpsinteger否

创建收款单时保存的合作伙伴 sub fee。

qr_copypastestring | null否

创建时返回的 Pix Copia e Cola,托管余额提现时为 null。

qr_image_urlstring | null否

二维码 PNG 图片,仅在创建响应中提供。

external_idstring | null否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

created_atstring | null · date-time否
expires_atstring | null · date-time否

该收款单的实际有效期,以此时间戳为准,也包括机器人延长的有效期。

delay_untilstring | null · date-time否

服务商冻结的预计释放时间,如有。

liberar_emstring | null · date-time否

余额入账结束等待期的时间。即时可用时为 null,新密钥自2026年9月16日起默认采用即时释放,但仍须核对适用冻结规则。

hold_hoursinteger否

收款单本地冻结小时数,不等同于 held_hours 或余额的一般等待期。

held_hoursinteger否

向服务商请求的冻结时长。即使为零,也可能存在本地冻结 hold_hours/liberar_em。

heldboolean否

held_hours > 0 时为 true,单独此字段不能反映本地冻结。

sandboxboolean否

模拟交易时为 true。

simulationobject否
sandbox_paymentobject否
timelinearray · object否
delivery_modestring否

仅 chain="liquid" 提供,说明 DePix 交付方式。其他网络无此字段。

{"enum":["full","split"]}

net_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示扣费后收款人实际收到的 DePix,即 Lunium 链上发送金额。

fee_total_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示从总额扣除的固定及比例费用。net_cents + fee_total_cents == amount_cents。

查看完整 JSON Schema
{
  "type": "object",
  "description": "收款单创建响应,含二维码。状态、列表及 webhook 请参阅 StatusCobranca。",
  "properties": {
    "cashin_id": {
      "type": "string",
      "description": "收款单标识,格式为 ci_…。"
    },
    "status": {
      "type": "string",
      "description": "Pix 状态。paid 本身不证明入账 / 交付完成,须读取 settlement_status。",
      "enum": [
        "pending",
        "delayed",
        "under_review",
        "paid",
        "expired",
        "refunded",
        "failed"
      ]
    },
    "amount_cents": {
      "type": "integer",
      "description": "Pix 金额,以分计。"
    },
    "destino": {
      "type": "string",
      "description": "cripto 表示链上交付,saldo 表示计入密钥 BRL 托管余额,可通过 POST /payouts 及 POST /saldo/sacar-cripto 使用。",
      "enum": [
        "cripto",
        "saldo"
      ]
    },
    "fonte": {
      "type": "string",
      "enum": [
        "pix",
        "saldo"
      ],
      "description": "创建时的资金来源:Pix 或余额提现。"
    },
    "customer_ref": {
      "type": [
        "string",
        "null"
      ],
      "description": "您的最终客户引用,即余额子账户。",
      "maxLength": 80
    },
    "payout_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "接收加密资产的钱包,适用于 destino=cripto。"
    },
    "payout_tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "共用收款地址等需要附加标识的网络,填写目标钱包 memo/tag,适用于 destino=cripto。"
    },
    "chain": {
      "type": "string",
      "description": "交付网络,使用 GET /cashin/catalog 中的 ID。"
    },
    "asset": {
      "type": "string",
      "description": "交付资产,如 usdt、usdc、btc 等。"
    },
    "lunium_fee_bps": {
      "type": "integer",
      "description": "创建收款单时固定的比例费用,单位 bps。"
    },
    "lunium_fee_fixed_cents": {
      "type": "integer",
      "description": "创建收款单时固定的费用,以分计。"
    },
    "partner_fee_bps": {
      "type": "integer",
      "description": "创建收款单时保存的合作伙伴 sub fee。"
    },
    "qr_copypaste": {
      "type": [
        "string",
        "null"
      ],
      "description": "创建时返回的 Pix Copia e Cola,托管余额提现时为 null。"
    },
    "qr_image_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "二维码 PNG 图片,仅在创建响应中提供。"
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。",
      "maxLength": 64
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "该收款单的实际有效期,以此时间戳为准,也包括机器人延长的有效期。"
    },
    "delay_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "服务商冻结的预计释放时间,如有。"
    },
    "liberar_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "余额入账结束等待期的时间。即时可用时为 null,新密钥自2026年9月16日起默认采用即时释放,但仍须核对适用冻结规则。"
    },
    "hold_hours": {
      "type": "integer",
      "description": "收款单本地冻结小时数,不等同于 held_hours 或余额的一般等待期。"
    },
    "held_hours": {
      "type": "integer",
      "description": "向服务商请求的冻结时长。即使为零,也可能存在本地冻结 hold_hours/liberar_em。"
    },
    "held": {
      "type": "boolean",
      "description": "held_hours > 0 时为 true,单独此字段不能反映本地冻结。"
    },
    "sandbox": {
      "type": "boolean",
      "description": "模拟交易时为 true。"
    },
    "simulation": {
      "type": "object",
      "additionalProperties": true
    },
    "sandbox_payment": {
      "type": "object",
      "properties": {
        "method": {
          "const": "POST"
        },
        "path": {
          "type": "string"
        }
      }
    },
    "timeline": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "delivery_mode": {
      "type": "string",
      "enum": [
        "full",
        "split"
      ],
      "description": "仅 chain=\"liquid\" 提供,说明 DePix 交付方式。其他网络无此字段。"
    },
    "net_cents": {
      "type": "integer",
      "description": "仅 chain=\"liquid\" 且 delivery_mode=\"split\" 提供,表示扣费后收款人实际收到的 DePix,即 Lunium 链上发送金额。"
    },
    "fee_total_cents": {
      "type": "integer",
      "description": "仅 chain=\"liquid\" 且 delivery_mode=\"split\" 提供,表示从总额扣除的固定及比例费用。net_cents + fee_total_cents == amount_cents。"
    }
  }
}

数据模式:StatusCobranca

收款单状态。GET 可能补充渠道、timeline 及 tempos_tipicos,列表与 webhook 使用基础对象。

字段类型必填说明
cashin_idstring否

收款单标识,格式为 ci_…。

statusstring否

Pix 状态。paid 本身不证明入账 / 交付完成,须读取 settlement_status。

{"enum":["pending","delayed","under_review","paid","expired","refunded","failed"]}

settlement_statusstring | null否

入账 / 交付状态:sent 表示完成;incerto 须对账。Pix 已付款与资产交付是不同状态。

{"enum":["pending","sending","entregando","sent","incerto","failed",null]}

amount_centsinteger否

Pix 金额,以分计。

depix_received_centsinteger | null否

从结算服务商收到、尚未扣除密钥充值费用的金额,不是托管净入账。

usdt_amountstring | null否

结算返回的旧版数量字段,须结合 asset 及路由专有字段理解。

settlement_tx_hashstring | null否

交付链上哈希,或交易所内部交付标识。

settlement_tx_urlstring | null否

上述哈希的区块浏览器链接,如存在。

payout_addressstring | null否

接收加密资产的钱包,适用于 destino=cripto。

payout_tagstring | null否

共用收款地址等需要附加标识的网络,填写目标钱包 memo/tag,适用于 destino=cripto。

chainstring否

交付网络,使用 GET /cashin/catalog 中的 ID。

assetstring否

交付资产,如 usdt、usdc、btc 等。

payer_tax_numberstring否

应支付二维码的付款人 CPF/CNPJ。不同证件付款将退款,refund_reason 为 PAYER_MISMATCH。

external_idstring | null否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

expires_atstring | null · date-time否

该收款单的实际有效期,以此时间戳为准,也包括机器人延长的有效期。

paid_atstring | null · date-time否
settled_atstring | null · date-time否
destinostring否

cripto 表示链上交付,saldo 表示计入密钥 BRL 托管余额,可通过 POST /payouts 及 POST /saldo/sacar-cripto 使用。

{"enum":["cripto","saldo"]}

held_hoursinteger否

向服务商请求的冻结时长。即使为零,也可能存在本地冻结 hold_hours/liberar_em。

heldboolean否

held_hours > 0 时为 true,单独此字段不能反映本地冻结。

delay_untilstring | null · date-time否

服务商冻结的预计释放时间,如有。

liberar_emstring | null · date-time否

余额入账结束等待期的时间。即时可用时为 null,新密钥自2026年9月16日起默认采用即时释放,但仍须核对适用冻结规则。

e2estring | null否

收到的 Pix EndToEndId,即巴西央行端到端标识。

payer_namestring | null否

用户填写或银行识别的付款人姓名。

customer_refstring | null否

您的最终客户引用,即余额子账户。

{"maxLength":80}

refund_reasonstring | null否

status=refunded 时的退款原因,例如 PAYER_MISMATCH(付款证件不符)、TEST_AMOUNT(测试金额)或 PROVIDER_REJECTED。

refund_reason_detailstring | null否

便于人工阅读的退款原因。

created_atstring | null · date-time否
trilhostring否

交易渠道:casa、corretora、saldo 或 liquid,不构成时效承诺。

timelinearray · object否
tempos_tipicosobject否

按渠道统计的各阶段耗时中位数,单位秒,用于展示典型耗时,不是保证期限。

sandboxboolean否

模拟交易时为 true。

simulationobject否
delivery_modestring否

仅 chain="liquid" 提供,说明 DePix 交付方式。其他网络无此字段。

{"enum":["full","split"]}

net_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示扣费后收款人实际收到的 DePix,即 Lunium 链上发送金额。

fee_total_centsinteger否

仅 chain="liquid" 且 delivery_mode="split" 提供,表示从总额扣除的固定及比例费用。net_cents + fee_total_cents == amount_cents。

settlement_proofstring否

独立于 Pix 付款的交付证据:none = 无已完成发送;broadcast = 已提供交易但尚无已记录确认;confirmed = 已记录确认凭证;reported = 已报告完成但无链上证明,包括托管入账 / 内部转账;simulated = 无真实资金的测试。没有确认记录不能证明失败,核验覆盖范围取决于网络及时间段。

{"enum":["none","broadcast","confirmed","reported","simulated"]}

settlement_confirmed_atstring · date-time否

记录链上确认的时间,仅 settlement_proof=confirmed 时填写。

{"nullable":true}

settlement_blockstring否

已确认区块号,以字符串保存,避免精度损失。

{"nullable":true}

查看完整 JSON Schema
{
  "type": "object",
  "description": "收款单状态。GET 可能补充渠道、timeline 及 tempos_tipicos,列表与 webhook 使用基础对象。",
  "properties": {
    "cashin_id": {
      "type": "string",
      "description": "收款单标识,格式为 ci_…。"
    },
    "status": {
      "type": "string",
      "description": "Pix 状态。paid 本身不证明入账 / 交付完成,须读取 settlement_status。",
      "enum": [
        "pending",
        "delayed",
        "under_review",
        "paid",
        "expired",
        "refunded",
        "failed"
      ]
    },
    "settlement_status": {
      "type": [
        "string",
        "null"
      ],
      "description": "入账 / 交付状态:sent 表示完成;incerto 须对账。Pix 已付款与资产交付是不同状态。",
      "enum": [
        "pending",
        "sending",
        "entregando",
        "sent",
        "incerto",
        "failed",
        null
      ]
    },
    "amount_cents": {
      "type": "integer",
      "description": "Pix 金额,以分计。"
    },
    "depix_received_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "从结算服务商收到、尚未扣除密钥充值费用的金额,不是托管净入账。"
    },
    "usdt_amount": {
      "type": [
        "string",
        "null"
      ],
      "description": "结算返回的旧版数量字段,须结合 asset 及路由专有字段理解。"
    },
    "settlement_tx_hash": {
      "type": [
        "string",
        "null"
      ],
      "description": "交付链上哈希,或交易所内部交付标识。"
    },
    "settlement_tx_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "上述哈希的区块浏览器链接,如存在。"
    },
    "payout_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "接收加密资产的钱包,适用于 destino=cripto。"
    },
    "payout_tag": {
      "type": [
        "string",
        "null"
      ],
      "description": "共用收款地址等需要附加标识的网络,填写目标钱包 memo/tag,适用于 destino=cripto。"
    },
    "chain": {
      "type": "string",
      "description": "交付网络,使用 GET /cashin/catalog 中的 ID。"
    },
    "asset": {
      "type": "string",
      "description": "交付资产,如 usdt、usdc、btc 等。"
    },
    "payer_tax_number": {
      "type": "string",
      "description": "应支付二维码的付款人 CPF/CNPJ。不同证件付款将退款,refund_reason 为 PAYER_MISMATCH。"
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。",
      "maxLength": 64
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "该收款单的实际有效期,以此时间戳为准,也包括机器人延长的有效期。"
    },
    "paid_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "settled_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "destino": {
      "type": "string",
      "description": "cripto 表示链上交付,saldo 表示计入密钥 BRL 托管余额,可通过 POST /payouts 及 POST /saldo/sacar-cripto 使用。",
      "enum": [
        "cripto",
        "saldo"
      ]
    },
    "held_hours": {
      "type": "integer",
      "description": "向服务商请求的冻结时长。即使为零,也可能存在本地冻结 hold_hours/liberar_em。"
    },
    "held": {
      "type": "boolean",
      "description": "held_hours > 0 时为 true,单独此字段不能反映本地冻结。"
    },
    "delay_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "服务商冻结的预计释放时间,如有。"
    },
    "liberar_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "余额入账结束等待期的时间。即时可用时为 null,新密钥自2026年9月16日起默认采用即时释放,但仍须核对适用冻结规则。"
    },
    "e2e": {
      "type": [
        "string",
        "null"
      ],
      "description": "收到的 Pix EndToEndId,即巴西央行端到端标识。"
    },
    "payer_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "用户填写或银行识别的付款人姓名。"
    },
    "customer_ref": {
      "type": [
        "string",
        "null"
      ],
      "description": "您的最终客户引用,即余额子账户。",
      "maxLength": 80
    },
    "refund_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "status=refunded 时的退款原因,例如 PAYER_MISMATCH(付款证件不符)、TEST_AMOUNT(测试金额)或 PROVIDER_REJECTED。"
    },
    "refund_reason_detail": {
      "type": [
        "string",
        "null"
      ],
      "description": "便于人工阅读的退款原因。"
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "trilho": {
      "type": "string",
      "description": "交易渠道:casa、corretora、saldo 或 liquid,不构成时效承诺。"
    },
    "timeline": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "tempos_tipicos": {
      "type": "object",
      "description": "按渠道统计的各阶段耗时中位数,单位秒,用于展示典型耗时,不是保证期限。",
      "additionalProperties": true
    },
    "sandbox": {
      "type": "boolean",
      "description": "模拟交易时为 true。"
    },
    "simulation": {
      "type": "object",
      "additionalProperties": true
    },
    "delivery_mode": {
      "type": "string",
      "enum": [
        "full",
        "split"
      ],
      "description": "仅 chain=\"liquid\" 提供,说明 DePix 交付方式。其他网络无此字段。"
    },
    "net_cents": {
      "type": "integer",
      "description": "仅 chain=\"liquid\" 且 delivery_mode=\"split\" 提供,表示扣费后收款人实际收到的 DePix,即 Lunium 链上发送金额。"
    },
    "fee_total_cents": {
      "type": "integer",
      "description": "仅 chain=\"liquid\" 且 delivery_mode=\"split\" 提供,表示从总额扣除的固定及比例费用。net_cents + fee_total_cents == amount_cents。"
    },
    "settlement_proof": {
      "type": "string",
      "enum": [
        "none",
        "broadcast",
        "confirmed",
        "reported",
        "simulated"
      ],
      "description": "独立于 Pix 付款的交付证据:none = 无已完成发送;broadcast = 已提供交易但尚无已记录确认;confirmed = 已记录确认凭证;reported = 已报告完成但无链上证明,包括托管入账 / 内部转账;simulated = 无真实资金的测试。没有确认记录不能证明失败,核验覆盖范围取决于网络及时间段。"
    },
    "settlement_confirmed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "记录链上确认的时间,仅 settlement_proof=confirmed 时填写。"
    },
    "settlement_block": {
      "type": "string",
      "nullable": true,
      "description": "已确认区块号,以字符串保存,避免精度损失。"
    }
  }
}

数据模式:Payout

从密钥托管余额扣款的 Pix 提现(Pix → Pix)。

字段类型必填说明
payout_idstring否
customer_refstring | null否

{"maxLength":80}

statusstring否

processing、sent、failed 或 refunded,须通过流水核对余额,并兼容新增状态。

amount_centsinteger否

收款人实际收到的金额。

fee_centsinteger | null否

amount_cents 之外的总费用:fee_service_total_cents + fee_provider_cents。已包含合作伙伴佣金,不要重复加上。

fee_service_centsinteger | null否

已保存的 Lunium 服务费,以分计,为会计组成项。客户界面及通知应使用 fee_service_total_cents。

fee_provider_centsinteger | null否

服务商费用:fee_cents 减去 fee_service_cents 及 fee_partner_cents。

pix_keystring否
pix_key_typestring否

{"enum":["cpf","cnpj","phone","email","random"]}

tax_numberstring | null否

收款人证件经遮盖后的值,如有;请求中该字段为可选。

external_idstring | null否

最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。

{"maxLength":64}

errorstring | null否

failed/refunded 时的原因。

e2estring | null否

已发送 Pix 的 EndToEndId。

receiver_namestring | null否

付款后取得的收款人姓名,如可用;未取得时为 null。

receiver_tax_numberstring | null否
paid_atstring | null · date-time否
sent_atstring | null · date-time否
verify_urlstring | null否

公开 Pix 核验,GET /v1/verificar/{e2e}。

created_atstring | null · date-time否
updated_atstring | null · date-time否
sandboxboolean否

模拟交易时为 true。

simulationobject否
fee_partner_centsinteger否

本次提现从余额扣除的合作伙伴 sub fee,以分计,已包含在 fee_cents 中。

{"nullable":true}

fee_service_total_centsinteger | null否

客户合并服务费,即交易保存的 Lunium 费用加合作伙伴佣金,保留原分位舍入及历史费率。旧记录中平台组成项未知时为 null。生产及测试环境的付款响应与 payout.* webhook data 均提供此字段。仅加一次 fee_provider_cents 即得 fee_cents,不再加 fee_partner_cents。

{"minimum":0}

查看完整 JSON Schema
{
  "type": "object",
  "description": "从密钥托管余额扣款的 Pix 提现(Pix → Pix)。",
  "properties": {
    "payout_id": {
      "type": "string"
    },
    "customer_ref": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "status": {
      "type": "string",
      "description": "processing、sent、failed 或 refunded,须通过流水核对余额,并兼容新增状态。"
    },
    "amount_cents": {
      "type": "integer",
      "description": "收款人实际收到的金额。"
    },
    "fee_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "amount_cents 之外的总费用:fee_service_total_cents + fee_provider_cents。已包含合作伙伴佣金,不要重复加上。"
    },
    "fee_service_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "已保存的 Lunium 服务费,以分计,为会计组成项。客户界面及通知应使用 fee_service_total_cents。"
    },
    "fee_provider_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "服务商费用:fee_cents 减去 fee_service_cents 及 fee_partner_cents。"
    },
    "pix_key": {
      "type": "string"
    },
    "pix_key_type": {
      "type": "string",
      "enum": [
        "cpf",
        "cnpj",
        "phone",
        "email",
        "random"
      ]
    },
    "tax_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "收款人证件经遮盖后的值,如有;请求中该字段为可选。"
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "最多 64 个字符的幂等标识。重试保持相同标识及全部参数。差异比较规则因接口而异,不要利用重放修改原交易。409 external_id_divergente 表示检测到冲突。",
      "maxLength": 64
    },
    "error": {
      "type": [
        "string",
        "null"
      ],
      "description": "failed/refunded 时的原因。"
    },
    "e2e": {
      "type": [
        "string",
        "null"
      ],
      "description": "已发送 Pix 的 EndToEndId。"
    },
    "receiver_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "付款后取得的收款人姓名,如可用;未取得时为 null。"
    },
    "receiver_tax_number": {
      "type": [
        "string",
        "null"
      ]
    },
    "paid_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "sent_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "verify_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "公开 Pix 核验,GET /v1/verificar/{e2e}。"
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "sandbox": {
      "type": "boolean",
      "description": "模拟交易时为 true。"
    },
    "simulation": {
      "type": "object",
      "additionalProperties": true
    },
    "fee_partner_cents": {
      "type": "integer",
      "nullable": true,
      "description": "本次提现从余额扣除的合作伙伴 sub fee,以分计,已包含在 fee_cents 中。"
    },
    "fee_service_total_cents": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "description": "客户合并服务费,即交易保存的 Lunium 费用加合作伙伴佣金,保留原分位舍入及历史费率。旧记录中平台组成项未知时为 null。生产及测试环境的付款响应与 payout.* webhook data 均提供此字段。仅加一次 fee_provider_cents 即得 fee_cents,不再加 fee_partner_cents。"
    }
  }
}

数据模式:ChaveMe

您的密钥、当前限额及已启用能力。

字段类型必填说明
keyobject否
limitsobject否

当前密钥按单笔及付款人计算的限额与使用情况。每日限额为 null 仅表示没有该项上限,不代表不存在其他限制,仍可能适用 mandate 及个人限额。

payoutobject否

enabled、via、unlocks_at_settled_volume_cents、settled_volume_cents、remaining_cents。

monitor_urlstring否

密钥的项目监控面板。

telegramobject否
grupos_obrigatoriosobject否

状态、合作伙伴及社区群组链接。

comissaoobject否

Sub fee 累计佣金,即合作伙伴余额,详情见 GET /comissao。

查看完整 JSON Schema
{
  "type": "object",
  "description": "您的密钥、当前限额及已启用能力。",
  "properties": {
    "key": {
      "type": "object",
      "properties": {
        "sandbox": {
          "type": "boolean"
        },
        "key_id": {
          "type": "integer"
        },
        "prefix": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "创建密钥时填写的邮箱。测试密钥自2026年10月1日起须提供邮箱;旧版无邮箱密钥可为 null。"
        },
        "cashin_enabled": {
          "type": "boolean"
        },
        "cashout_enabled": {
          "type": "boolean"
        },
        "payout_enabled": {
          "type": "boolean"
        },
        "settlement_address": {
          "type": [
            "string",
            "null"
          ],
          "description": "默认 Polygon 结算钱包,配置前为 null。"
        },
        "chain": {
          "type": [
            "string",
            "null"
          ]
        },
        "fee_bps": {
          "type": "integer"
        },
        "rate_limit_per_minute": {
          "type": "integer"
        },
        "webhook_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "通过 PATCH /keys/me 配置前为 null;未配置接收端时,不会向您投递 cashin.paid、cashin.settled、cashin.delayed 等通知。"
        },
        "webhook_configured": {
          "type": "boolean"
        },
        "telegram_linked": {
          "type": "boolean"
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "partner_fee_bps": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000,
          "description": "合作伙伴 sub fee,以 bps 表示,在 Lunium 的 fee_bps 之外另计。100 = 1%,由最终用户承担,不改变 Lunium 份额。0 表示不使用,通过 PATCH /keys/me 配置。"
        },
        "partner_cashout_fee_bps": {
          "type": "integer",
          "description": "卖出交易的合作伙伴 sub fee,单位 bps,0 表示不使用。"
        },
        "partner_saque_fee_bps": {
          "type": "integer",
          "description": "托管资金转出的合作伙伴 sub fee,单位 bps,0 表示不使用。"
        }
      }
    },
    "limits": {
      "type": "object",
      "description": "当前密钥按单笔及付款人计算的限额与使用情况。每日限额为 null 仅表示没有该项上限,不代表不存在其他限制,仍可能适用 mandate 及个人限额。",
      "additionalProperties": true,
      "properties": {
        "cashin_min_por_rota": {
          "type": "object",
          "description": "各币种 / 网络的最低 BRL 金额,已考虑当前密钥费用。per_operation 中 cash-in 的 min_brl_cents 是账户最低金额,通常取决于固定费用;网络最低金额可能更高,实际取两者较大值。",
          "properties": {
            "nota": {
              "type": "string"
            },
            "rotas": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "asset": {
                    "type": "string"
                  },
                  "network": {
                    "type": "string"
                  },
                  "min_brl_cents": {
                    "type": "integer"
                  }
                }
              }
            }
          }
        }
      }
    },
    "payout": {
      "type": "object",
      "description": "enabled、via、unlocks_at_settled_volume_cents、settled_volume_cents、remaining_cents。",
      "additionalProperties": true
    },
    "monitor_url": {
      "type": "string",
      "description": "密钥的项目监控面板。"
    },
    "telegram": {
      "type": "object",
      "additionalProperties": true
    },
    "grupos_obrigatorios": {
      "type": "object",
      "description": "状态、合作伙伴及社区群组链接。",
      "additionalProperties": true
    },
    "comissao": {
      "type": "object",
      "description": "Sub fee 累计佣金,即合作伙伴余额,详情见 GET /comissao。",
      "properties": {
        "partner_fee_bps": {
          "type": "integer"
        },
        "max_partner_fee_bps": {
          "type": "integer"
        },
        "disponivel_cents": {
          "type": [
            "integer",
            "null"
          ]
        },
        "creditado_cents": {
          "type": "integer"
        },
        "estornado_cents": {
          "type": "integer"
        },
        "sacado_cents": {
          "type": "integer"
        },
        "operacoes": {
          "type": "integer"
        },
        "ultimo_credito_em": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "moeda": {
          "type": "string"
        },
        "nota": {
          "type": "string"
        },
        "partner_cashout_fee_bps": {
          "type": "integer"
        },
        "partner_saque_fee_bps": {
          "type": "integer"
        }
      }
    }
  }
}

数据模式:CatalogoCompra

Cash-in 购买目录,即 Pix 收款后可交付的资产。

字段类型必填说明
updatedAtstring | null · date-time否
instantarray · object否

平台渠道路由,可能因配置为空,不保证始终存在或有固定时效。

convertarray · object否

交易所渠道,每个资产 / 网络组合一行。

droppedarray · object否

未纳入的组合及原因,例如 sem_par_usdt。

totalsobject否
staleboolean否

目录来自备用缓存时为 true。

查看完整 JSON Schema
{
  "type": "object",
  "description": "Cash-in 购买目录,即 Pix 收款后可交付的资产。",
  "properties": {
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "instant": {
      "type": "array",
      "description": "平台渠道路由,可能因配置为空,不保证始终存在或有固定时效。",
      "items": {
        "type": "object",
        "properties": {
          "asset": {
            "type": "string"
          },
          "network": {
            "type": "string"
          },
          "eta": {
            "type": "string"
          },
          "entregavel": {
            "type": "boolean"
          },
          "min_brl_cents": {
            "type": "integer",
            "description": "当前路由可交付的最低 BRL 收款金额,已考虑密钥费用。与 POST /cashin/preview 的 min_brl_cents 及创建收款单的最低金额规则一致。尚未为该路由计算时可能缺失,此时应查询预览。自2026年9月24日起为 USDT 及 USDC 公布。"
          }
        }
      }
    },
    "convert": {
      "type": "array",
      "description": "交易所渠道,每个资产 / 网络组合一行。",
      "items": {
        "type": "object",
        "properties": {
          "asset": {
            "type": "string"
          },
          "network": {
            "type": "string"
          },
          "etaSeconds": {
            "type": "integer"
          },
          "eta": {
            "type": "string"
          },
          "fastest": {
            "type": "boolean"
          },
          "withdrawFee": {
            "type": "string",
            "description": "交易所在该网络的提现费用,以资产单位表示,独立于 Lunium 及合作伙伴费用,已参与 minBuyAmount 计算。"
          },
          "withdrawMin": {
            "type": "string",
            "description": "交易所在该网络的最低提现量,以资产单位表示,不是 cash-out 加密资产充值的最低金额。"
          },
          "withdrawMax": {
            "type": "string",
            "description": "该网络公布的最高提现量,以资产单位表示,不能替代单笔 BRL、付款人、余额或 mandate 限制。字段缺失不代表无限额。"
          },
          "minBuyAmount": {
            "type": "string",
            "description": "交易所路由须购买的最低资产数量,用于覆盖 withdrawMin + withdrawFee,不一定等于交付净额。使用当前密钥查询 POST /cashin/preview 的 min_brl_cents,费用及汇率会改变最低 BRL 金额。"
          },
          "precision": {
            "type": "integer"
          },
          "memoRequired": {
            "type": "boolean",
            "description": "共用地址网络,payout_tag 必填。"
          },
          "entregavel": {
            "type": "boolean"
          },
          "min_brl_cents": {
            "type": "integer",
            "description": "当前路由可交付的最低 BRL 收款金额,已考虑密钥费用。与 POST /cashin/preview 的 min_brl_cents 及创建收款单的最低金额规则一致。尚未为该路由计算时可能缺失,此时应查询预览。自2026年9月24日起为 USDT 及 USDC 公布。"
          }
        }
      }
    },
    "dropped": {
      "type": "array",
      "description": "未纳入的组合及原因,例如 sem_par_usdt。",
      "items": {
        "type": "object",
        "properties": {
          "asset": {
            "type": "string"
          },
          "network": {
            "type": "string"
          },
          "motivo": {
            "type": "string"
          }
        }
      }
    },
    "totals": {
      "type": "object",
      "additionalProperties": true
    },
    "stale": {
      "type": "boolean",
      "description": "目录来自备用缓存时为 true。"
    }
  }
}

数据模式:Comissao

字段类型必填说明
disponivel_centsinteger是
creditado_centsinteger是
estornado_centsinteger否
sacado_centsinteger是
operacoesinteger是
ultimo_credito_emstring | null · date-time否
moedastring是
sandboxboolean是
min_saque_centsinteger | null否

按当前汇率折合 US$ 10 的 BRL 金额。null 表示当前无有效报价,提现会被拒绝。

pode_sacar_agoraboolean是
ultimo_saque_emstring | null · date-time否
proximo_saque_emstring | null · date-time否
politicaobject是
查看完整 JSON Schema
{
  "type": "object",
  "properties": {
    "disponivel_cents": {
      "type": "integer"
    },
    "creditado_cents": {
      "type": "integer"
    },
    "estornado_cents": {
      "type": "integer"
    },
    "sacado_cents": {
      "type": "integer"
    },
    "operacoes": {
      "type": "integer"
    },
    "ultimo_credito_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "moeda": {
      "type": "string"
    },
    "sandbox": {
      "type": "boolean"
    },
    "min_saque_cents": {
      "type": [
        "integer",
        "null"
      ],
      "description": "按当前汇率折合 US$ 10 的 BRL 金额。null 表示当前无有效报价,提现会被拒绝。"
    },
    "pode_sacar_agora": {
      "type": "boolean"
    },
    "ultimo_saque_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "proximo_saque_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "politica": {
      "type": "object"
    }
  },
  "required": [
    "disponivel_cents",
    "creditado_cents",
    "sacado_cents",
    "operacoes",
    "moeda",
    "sandbox",
    "pode_sacar_agora",
    "politica"
  ]
}

数据模式:ComissaoEvento

字段类型必填说明
idstring否
kindstring否

{"enum":["credito","estorno","saque","saque_estorno"]}

valor_centsinteger否

带符号金额:入账 +、冲回 −、提现 −、提现退回 +。

sentidostring否

{"enum":["credito","debito"]}

origem_idstring否

购买收款单或加密资产提现的 ci_…、Pix 提现的 po_…、卖出订单 UUID,或佣金提现 ID(kind 为 saque)。

base_centsinteger否
partner_fee_bpsinteger否
statusstring否
motivostring | null否

流水来源:空值表示购买,或为 'venda: cripto -> PIX'、'saida: saque por PIX'、'saida: saque em cripto',也可能为冲回原因。原始取值按接口保留。

criado_emstring · date-time否
查看完整 JSON Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "credito",
        "estorno",
        "saque",
        "saque_estorno"
      ]
    },
    "valor_cents": {
      "type": "integer",
      "description": "带符号金额:入账 +、冲回 −、提现 −、提现退回 +。"
    },
    "sentido": {
      "type": "string",
      "enum": [
        "credito",
        "debito"
      ]
    },
    "origem_id": {
      "type": "string",
      "description": "购买收款单或加密资产提现的 ci_…、Pix 提现的 po_…、卖出订单 UUID,或佣金提现 ID(kind 为 saque)。"
    },
    "base_cents": {
      "type": "integer"
    },
    "partner_fee_bps": {
      "type": "integer"
    },
    "status": {
      "type": "string"
    },
    "motivo": {
      "type": [
        "string",
        "null"
      ],
      "description": "流水来源:空值表示购买,或为 'venda: cripto -> PIX'、'saida: saque por PIX'、'saida: saque em cripto',也可能为冲回原因。原始取值按接口保留。"
    },
    "criado_em": {
      "type": "string",
      "format": "date-time"
    }
  }
}

数据模式:SaqueCripto

字段类型必填说明
fontestring否

{"enum":["saldo"]}

settlement_statusstring否
fee_centsinteger否

从余额扣除的 Lunium 费用。

partner_fee_centsinteger否

在 Lunium 费用之外,从余额另扣的合作伙伴 sub fee,自2026年9月24日起提供。

debited_centsinteger否

amount_cents + fee_cents + partner_fee_cents。

查看完整 JSON Schema
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Cobranca"
    },
    {
      "type": "object",
      "properties": {
        "settlement_status": {
          "type": [
            "string",
            "null"
          ],
          "description": "入账 / 交付状态:sent 表示完成;incerto 须对账。Pix 已付款与资产交付是不同状态。",
          "enum": [
            "pending",
            "sending",
            "entregando",
            "sent",
            "incerto",
            "failed",
            null
          ]
        },
        "settlement_tx_hash": {
          "type": [
            "string",
            "null"
          ],
          "description": "交付链上哈希,或交易所内部交付标识。"
        },
        "fee_cents": {
          "type": "integer",
          "description": "在 amount_cents 之外从余额另扣的平台提现费用。"
        },
        "debited_cents": {
          "type": "integer",
          "description": "amount_cents 加平台提现费用。"
        }
      }
    }
  ],
  "properties": {
    "fonte": {
      "type": "string",
      "enum": [
        "saldo"
      ]
    },
    "settlement_status": {
      "type": "string"
    },
    "fee_cents": {
      "type": "integer",
      "description": "从余额扣除的 Lunium 费用。"
    },
    "partner_fee_cents": {
      "type": "integer",
      "description": "在 Lunium 费用之外,从余额另扣的合作伙伴 sub fee,自2026年9月24日起提供。"
    },
    "debited_cents": {
      "type": "integer",
      "description": "amount_cents + fee_cents + partner_fee_cents。"
    }
  }
}

数据模式:CarteiraUsdt

项目 USDT 钱包状态与余额。

字段类型必填说明
enabledboolean否

钱包当前可操作。

sandboxboolean否

仅测试密钥模拟器提供,值为 true。

funding_sourcestring否

{"enum":["crypto_usdt"]}

currencystring否

{"enum":["USDT"]}

pix_rulesobject否
networksarray · object否

当前可充值网络、各网络支持的币种及预估入账时间。

balanceobject否
min_depositstring否

最低 USDT 充值金额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

min_payment_brlstring否

使用 USDT 支付 Pix 的最低 BRL 金额。

deposit_validity_hoursnumber否

充值请求有效期,以小时计,目前为 1。

payments_enabledboolean否
payment_methodsobject否
查看完整 JSON Schema
{
  "type": "object",
  "description": "项目 USDT 钱包状态与余额。",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "钱包当前可操作。"
    },
    "sandbox": {
      "type": "boolean",
      "description": "仅测试密钥模拟器提供,值为 true。"
    },
    "funding_source": {
      "type": "string",
      "enum": [
        "crypto_usdt"
      ]
    },
    "currency": {
      "type": "string",
      "enum": [
        "USDT"
      ]
    },
    "pix_rules": {
      "type": "object",
      "properties": {
        "recipient_document_required": {
          "type": "boolean"
        }
      }
    },
    "networks": {
      "type": "array",
      "description": "当前可充值网络、各网络支持的币种及预估入账时间。",
      "items": {
        "type": "object",
        "properties": {
          "network": {
            "type": "string",
            "example": "polygon"
          },
          "name": {
            "type": "string",
            "example": "Polygon"
          },
          "assets": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "USDT",
                "USDC"
              ]
            }
          },
          "eta_minutes": {
            "type": [
              "integer",
              "null"
            ]
          }
        }
      }
    },
    "balance": {
      "type": "object",
      "properties": {
        "available": {
          "type": "string",
          "pattern": "^-?\\d+\\.\\d{6}$",
          "description": "可用于支付 Pix 的 USDT,6 位小数。"
        },
        "reserved": {
          "type": "string",
          "pattern": "^-?\\d+\\.\\d{6}$",
          "description": "正在进行的 Pix 付款所预留的 USDT。"
        },
        "confirming": {
          "type": "string",
          "pattern": "^-?\\d+\\.\\d{6}$",
          "description": "已检测到、等待托管确认的充值。"
        }
      }
    },
    "min_deposit": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": "最低 USDT 充值金额。"
    },
    "min_payment_brl": {
      "type": "string",
      "example": "25.00",
      "description": "使用 USDT 支付 Pix 的最低 BRL 金额。"
    },
    "deposit_validity_hours": {
      "type": "number",
      "description": "充值请求有效期,以小时计,目前为 1。"
    },
    "payments_enabled": {
      "type": "boolean"
    },
    "payment_methods": {
      "type": "object",
      "properties": {
        "pix_key": {
          "type": "boolean"
        },
        "br_code": {
          "type": "boolean"
        }
      }
    }
  }
}

数据模式:DepositoCarteira

充值请求。实际到账的精确金额用于识别该笔充值,请在 expires_at 前,通过指定网络发送 amount_to_send。

字段类型必填说明
deposit_idstring否
statusstring否

waiting = 等待发送;confirming = 已检测到,确认中;available = 已计入余额;expired = 到期仍未充值;under_review = 核查中;reversed = 已撤销。

{"enum":["waiting","confirming","available","expired","under_review","reversed"]}

amount_to_sendstring否

须发送的精确金额,末尾小数用于识别该笔充值。

{"pattern":"^-?\\d+\\.\\d{6}$"}

amount_receivedstring | null否

实际收到并入账的金额。

addressstring否

所选网络的目标地址。测试环境为虚构地址 SANDBOX-NAO-ENVIE-FUNDOS,不得发送资金。

networkstring否
network_namestring否
assetstring否
accepted_assetsarray · string否
expires_atstring · date-time否

请求自创建起有效 1 小时,即 created_at + deposit_validity_hours,请在期限内发送。

created_atstring · date-time否
credited_atstring | null · date-time否
originstring否

{"enum":["request","assigned_by_support"]}

instructionsstring否

仅在创建响应中提供,供用户阅读的说明。

sandboxboolean否
查看完整 JSON Schema
{
  "type": "object",
  "description": "充值请求。实际到账的精确金额用于识别该笔充值,请在 expires_at 前,通过指定网络发送 amount_to_send。",
  "properties": {
    "deposit_id": {
      "type": "string",
      "example": "ud_3f9c0a1b2c3d4e5f6a7b"
    },
    "status": {
      "type": "string",
      "enum": [
        "waiting",
        "confirming",
        "available",
        "expired",
        "under_review",
        "reversed"
      ],
      "description": "waiting = 等待发送;confirming = 已检测到,确认中;available = 已计入余额;expired = 到期仍未充值;under_review = 核查中;reversed = 已撤销。"
    },
    "amount_to_send": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": "须发送的精确金额,末尾小数用于识别该笔充值。"
    },
    "amount_received": {
      "type": [
        "string",
        "null"
      ],
      "description": "实际收到并入账的金额。"
    },
    "address": {
      "type": "string",
      "description": "所选网络的目标地址。测试环境为虚构地址 SANDBOX-NAO-ENVIE-FUNDOS,不得发送资金。"
    },
    "network": {
      "type": "string"
    },
    "network_name": {
      "type": "string"
    },
    "asset": {
      "type": "string"
    },
    "accepted_assets": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "请求自创建起有效 1 小时,即 created_at + deposit_validity_hours,请在期限内发送。"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "credited_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "origin": {
      "type": "string",
      "enum": [
        "request",
        "assigned_by_support"
      ]
    },
    "instructions": {
      "type": "string",
      "description": "仅在创建响应中提供,供用户阅读的说明。"
    },
    "sandbox": {
      "type": "boolean"
    }
  }
}

数据模式:LancamentoCarteira

流水记录。amount 始终为正数,由 type 表示方向。

字段类型必填说明
entry_idstring否
typestring否

deposit = 充值入账;reserve = Pix 预留;debit = Pix 已付款;release = 未使用部分或预留款释放回可用余额;reversal = 充值撤销。

{"enum":["deposit","reserve","release","debit","reversal"]}

amountstring否

{"pattern":"^-?\\d+\\.\\d{6}$"}

available_afterstring否

{"pattern":"^-?\\d+\\.\\d{6}$"}

reserved_afterstring否

{"pattern":"^-?\\d+\\.\\d{6}$"}

referencestring否

Pix 的 payment_id,或 deposit、adjustment。

created_atstring · date-time否
查看完整 JSON Schema
{
  "type": "object",
  "description": "流水记录。amount 始终为正数,由 type 表示方向。",
  "properties": {
    "entry_id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "deposit",
        "reserve",
        "release",
        "debit",
        "reversal"
      ],
      "description": "deposit = 充值入账;reserve = Pix 预留;debit = Pix 已付款;release = 未使用部分或预留款释放回可用余额;reversal = 充值撤销。"
    },
    "amount": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": ""
    },
    "available_after": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": ""
    },
    "reserved_after": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": ""
    },
    "reference": {
      "type": "string",
      "description": "Pix 的 payment_id,或 deposit、adjustment。"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

数据模式:CotacaoPixCarteira

使用 USDT 支付 Pix 的预览。仅为预估,确认时会重新报价,并最多额外预留 1%,未使用部分会释放。

字段类型必填说明
payment_methodstring否

{"enum":["pix_key","br_code"]}

brl_amountstring否
usdt_orderstring否

用于支付 Pix 的 USDT 兑换金额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

withdrawal_feestring否

发送成本。

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_totalstring否

预估扣款总额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_reservedstring否

Pix 完成前的预留金额。

{"pattern":"^-?\\d+\\.\\d{6}$"}

quote_idstring否

仅使用 br_code 时提供,传入 POST /carteira-usdt/payments,确保支付的是同一完整支付码。

merchant_namestring | null否
pix_keystring | null否
pix_key_typestring | null否
expires_atstring · date-time否
notestring否
sandboxboolean否
reserve_usdstring | null否

R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。

reserve_brlstring | null否

新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。

查看完整 JSON Schema
{
  "type": "object",
  "description": "使用 USDT 支付 Pix 的预览。仅为预估,确认时会重新报价,并最多额外预留 1%,未使用部分会释放。",
  "properties": {
    "payment_method": {
      "type": "string",
      "enum": [
        "pix_key",
        "br_code"
      ]
    },
    "brl_amount": {
      "type": "string",
      "example": "50.00"
    },
    "usdt_order": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": "用于支付 Pix 的 USDT 兑换金额。"
    },
    "withdrawal_fee": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": "发送成本。"
    },
    "usdt_total": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": "预估扣款总额。"
    },
    "usdt_reserved": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": "Pix 完成前的预留金额。"
    },
    "quote_id": {
      "type": "string",
      "description": "仅使用 br_code 时提供,传入 POST /carteira-usdt/payments,确保支付的是同一完整支付码。"
    },
    "merchant_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "pix_key": {
      "type": [
        "string",
        "null"
      ]
    },
    "pix_key_type": {
      "type": [
        "string",
        "null"
      ]
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "note": {
      "type": "string"
    },
    "sandbox": {
      "type": "boolean"
    },
    "reserve_usd": {
      "type": [
        "string",
        "null"
      ],
      "description": "R$ 1 运营预留款的 USDT 等值金额,报价时换算,已包含在总额中,不要重复加上。已有订单保留其原金额。",
      "example": "0.200000"
    },
    "reserve_brl": {
      "type": [
        "string",
        "null"
      ],
      "example": "1.00",
      "description": "新订单固定 R$ 1 运营预留款,已包含在总额中。旧订单保留原预留金额。"
    }
  }
}

数据模式:PagamentoCarteira

使用 USDT 余额支付的 Pix。

字段类型必填说明
payment_idstring否
external_idstring | null否
statusstring否

最终处理状态:concluido 表示 Pix 已付款;falhou 表示未执行、预留款已释放;falhou_apos_envio 表示发送后仍须核查,预留款不会自行释放。revisao 表示核查中,不等于失败,须继续跟踪。其他状态为处理中阶段。

{"enum":["reservado","ordem_criada","aceita","sacando","enviado","revisao","concluido","falhou","falhou_apos_envio"]}

finalboolean否

状态不再继续变化时为 true。

payment_methodstring否

{"enum":["pix_key","br_code"]}

brl_amountstring否
pix_keystring | null否

已遮盖。

usdt_reservedstring否

{"pattern":"^-?\\d+\\.\\d{6}$"}

usdt_debitedstring | null否
usdt_orderstring | null否
withdrawal_feestring | null否
cashout_idstring | null否

支付该 Pix 的订单,详情见 GET /cash-outs/{cashout_id}。

errorstring | null否
pix_e2estring否

仅 concluido 提供,Pix E2E 标识。

recipient_namestring否

仅 concluido 提供,收款人姓名。

recipient_documentstring | null否

仅 concluido 提供,按巴西央行方式部分遮盖的 CPF 或 CNPJ。

receipt_urlstring | null否

仅 concluido 提供,官方凭证公开链接,测试环境为 null。

created_atstring · date-time否
updated_atstring · date-time否
sandboxboolean否
查看完整 JSON Schema
{
  "type": "object",
  "description": "使用 USDT 余额支付的 Pix。",
  "properties": {
    "payment_id": {
      "type": "string",
      "example": "cu_8a7b6c5d4e3f2a1b0c9d"
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "reservado",
        "ordem_criada",
        "aceita",
        "sacando",
        "enviado",
        "revisao",
        "concluido",
        "falhou",
        "falhou_apos_envio"
      ],
      "description": "最终处理状态:concluido 表示 Pix 已付款;falhou 表示未执行、预留款已释放;falhou_apos_envio 表示发送后仍须核查,预留款不会自行释放。revisao 表示核查中,不等于失败,须继续跟踪。其他状态为处理中阶段。"
    },
    "final": {
      "type": "boolean",
      "description": "状态不再继续变化时为 true。"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "pix_key",
        "br_code"
      ]
    },
    "brl_amount": {
      "type": "string"
    },
    "pix_key": {
      "type": [
        "string",
        "null"
      ],
      "description": "已遮盖。"
    },
    "usdt_reserved": {
      "type": "string",
      "pattern": "^-?\\d+\\.\\d{6}$",
      "description": ""
    },
    "usdt_debited": {
      "type": [
        "string",
        "null"
      ]
    },
    "usdt_order": {
      "type": [
        "string",
        "null"
      ]
    },
    "withdrawal_fee": {
      "type": [
        "string",
        "null"
      ]
    },
    "cashout_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "支付该 Pix 的订单,详情见 GET /cash-outs/{cashout_id}。"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "pix_e2e": {
      "type": "string",
      "description": "仅 concluido 提供,Pix E2E 标识。"
    },
    "recipient_name": {
      "type": "string",
      "description": "仅 concluido 提供,收款人姓名。"
    },
    "recipient_document": {
      "type": [
        "string",
        "null"
      ],
      "description": "仅 concluido 提供,按巴西央行方式部分遮盖的 CPF 或 CNPJ。"
    },
    "receipt_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "仅 concluido 提供,官方凭证公开链接,测试环境为 null。"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "sandbox": {
      "type": "boolean"
    }
  }
}