PIX

Ler e Decodificar código EMV (Copia e Cola)

Decodifica um código PIX "Copia e Cola" (string EMV) e retorna os dados estruturados da transação, como valor, chave PIX destinatária, TXID e informações do pagador (se disponíveis).

Esta rota é útil para validar códigos PIX antes de iniciar um pagamento ou para extrair informações para exibição em interfaces de checkout.

post/pix/parser

Request

  • Base URL: https://api.virtualpay.online/v2
  • URL: https://api.virtualpay.online/v2/pix/parser
  • Auth: API key in header x-client-id

Request body

emvstring required

Código "Copia e Cola" (EMV) do PIX

Example request

{
  "emv": "00020126330014BR.GOV.BCB.PIX0114+551199999999..."
}

Response

Código EMV decodificado com sucesso

amountstring

Valor da transação (se presente no EMV)

pix_keystring

Chave PIX identificada no EMV

txidstring

ID da transação (TXID)

expiration_secondsinteger

Tempo de expiração em segundos

created_atstring

Timestamp de criação

descriptionstring

Descrição ou solicitação do pagador

statusstring

Status da transação

Example response

{
  "amount": "150.00",
  "pix_key": "12345678901",
  "txid": "ABC123456789",
  "payer": {
    "name": "João da Silva",
    "document": "123.456.789-00"
  },
  "expiration_seconds": 86400,
  "created_at": "2024-01-15 10:30:00",
  "description": "Pagamento referente ao pedido #123",
  "status": "ACSC"
}

Changes

No recorded changes to this operation across all 1 revision of this API.