Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.noxpay.io/llms.txt

Use this file to discover all available pages before exploring further.

POST /v2/crossramp_checkout
Authorization: Bearer <your-api-key>
Content-Type: application/json

​
Corpo da requisição

CampoTipoObrigatórioDescrição
currency_codestringSimCriptomoeda a receber (ex: USDT, BTC)
amount_fiatnumberNão*Valor fixo em BRL que o cliente paga
amount_cryptonumberNão*Valor fixo em cripto que o cliente recebe
webhookstringNãoURL para receber atualizações de status
return_urlstringNãoURL para redirecionar o cliente após a conclusão
payer_documentstringNãoCPF ou CNPJ do cliente (apenas dígitos). Se fornecido e não cadastrado, um perfil de cliente é criado automaticamente — ignora a etapa de coleta de identidade no fluxo de checkout
payer_namestringNãoNome do cliente (usado ao criar um novo perfil de cliente)
Forneça amount_fiat ou amount_crypto. Se ambos forem omitidos, a página de checkout permite que o cliente insira o valor.

​
Response 200 OK

{
  "link": "https://checkout.noxpay.io/e2e/NOX..."
}
Redirecione o cliente para esta URL ou incorpore-a. O segmento de caminho NOX... é o ID end2end da transação — use-o para consultar ou rastrear a sessão.

​
Exemplo de requisição

{
  "currency_code": "USDT",
  "amount_fiat": 550.00,
  "webhook": "https://yourapp.com/webhooks/nox",
  "return_url": "https://yourapp.com/success",
  "payer_document": "12345678901"
}