Consultar Ordem Crypto-PIX

Obtenha detalhes de um pagamento Crypto-PIX

GET /api/v1/crypto-pix/order/{id}

Consultar Ordem Crypto-PIX

cURL

curl --request GET \
  --url https://api.example.com/api/v1/crypto-pix/order/{id} \
  --header 'id: <id>'

200

{
  "value": 123,
  "cryptoValue": 123,
  "updatedAt": "<string>",
  "status": "<string>",
  "network": "<string>",
  "address": "<string>",
  "receivedValue": 123,
  "originalCryptoValue": 123,
  "partialUpdatedAt": "<string>",
  "partialBrlValue": 123,
  "isPartial": true,
  "remaining": 123,
  "hash": "<string>",
  "btcQuote": 123,
  "satoshis": "<string>"
}

Consultar detalhes do pagamento Crypto-PIX

Este endpoint retorna informações detalhadas sobre um pagamento Crypto-PIX específico usando seu ID.

Parâmetros da URL

id · string · required

O ID codificado em base64 da ordem de pagamento

Exemplo de requisição

curl -X GET "https://server.cryptouse.com.br/api/v1/crypto-pix/order/Y3B0cGl4XzEyMzQ1YWJjZGU=" \
  -H "Authorization: Bearer seu_token_aqui"

Resposta

value · number

O valor em BRL do pagamento

cryptoValue · number

O valor em criptomoeda

updatedAt · string

Timestamp da última atualização

status · string

Status atual do pagamento

Valores possíveis: PENDING, COMPLETED, REFUNDED, PARTIAL_ORDER, FAILED

network · string

Rede blockchain usada para o pagamento

address · string

Endereço da carteira de criptomoeda

receivedValue · number

Valor recebido (se pagamento parcial)

originalCryptoValue · number

Valor original em criptomoeda

partialUpdatedAt · string

Timestamp de quando o pagamento parcial foi recebido

partialBrlValue · number

Valor parcial em BRL

isPartial · boolean

Indica se a ordem foi parcialmente paga

remaining · number

Valor restante a ser pago, se parcial

hash · string

Hash da transação blockchain

btcQuote · number

Cotação do BTC em BRL (apenas para rede Lightning)

satoshis · string

Valor em satoshis (apenas para rede Lightning)

Exemplo de resposta

Sucesso - Pagamento Completo (200)

{
  "hash": "0x1234567890abcdef...",
  "btcQuote": 0,
  "value": 120.50,
  "cryptoValue": 30.25,
  "updatedAt": "2023-04-20T15:30:45Z",
  "status": "COMPLETED",
  "network": "bsc",
  "address": "0x1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t",
  "receivedValue": 30.25,
  "originalCryptoValue": 30.25,
  "partialUpdatedAt": null,
  "partialBrlValue": null,
  "isPartial": false,
  "remaining": 0
}

Status do pagamento

Os status possíveis para um pagamento Crypto-PIX são:

Status	Descrição
PENDING	A ordem foi criada mas ainda não recebeu pagamento
COMPLETED	O pagamento foi recebido, convertido e o PIX foi enviado com sucesso
PARTIAL_ORDER	Foi recebido um pagamento parcial em criptomoeda
REFUNDED	O pagamento foi reembolsado (por falha na conversão ou no envio do PIX)
FAILED	O pagamento falhou por algum motivo

Pagamentos parciais

Quando um pagamento parcial é recebido:

1. O status muda para PARTIAL_ORDER
2. O campo receivedValue é atualizado com o valor recebido
3. O campo partialBrlValue mostra o valor em BRL já pago
4. O campo remaining indica o valor restante a ser pago
5. O campo partialUpdatedAt é atualizado com o timestamp da transação parcial

Processamento do PIX

Após receber o pagamento em criptomoeda:

1. Convertemos o valor para BRL
2. Processamos o pagamento PIX para o destinatário
3. Atualizamos o status da ordem para COMPLETED

Este processo geralmente leva entre 1 e 5 minutos, dependendo da rede blockchain utilizada.

Campos específicos por rede

Lightning Network

• btcQuote: Cotação atual do BTC em BRL
• satoshis: Valor em satoshis (calculado automaticamente)

Outras redes

• btcQuote: Sempre 0
• satoshis: Não incluído na resposta