Transactions

Consultar uma transação

Retorna os detalhes de uma transação específica pelo seu UUID.

Você só pode consultar transações do seu próprio merchant.

get/transactions/{uuid}

Request

  • Base URL: https://api.virtualpay.online/v2
  • URL: https://api.virtualpay.online/v2/transactions/{uuid}
  • Auth: API key in header x-client-id

Path parameters

uuidstring uuid required

UUID da transação

Response

Transação encontrada

idstring uuid

UUID único da transação

type'deposit' | 'withdraw' | 'charge'

Tipo da transação: deposit, withdraw ou charge

currencystring

Código da moeda (ISO 4217)

amountnumber double

Valor bruto da transação

taxnumber double

Taxa cobrada pela transação

net_amountnumber double

Valor líquido após descontar as taxas

referencestring nullable

Referência externa fornecida na criação

descriptionstring

Descrição da transação

e2e_idstring nullable

End-to-end ID do PIX (apenas para depósitos e saques)

status'pending' | 'in_process' | 'in_analysis' | 'paid' | 'canceled' | 'refund' | 'denied' | 'expired'

Status atual do processamento.

Ciclo de vida típico:

  • Sucesso: pending -> in_process -> paid
  • Falha/Cancelamento: pending -> canceled, expired ou denied
  • Estorno: paid -> refund
status_labelstring

Label legível do status

namestring

Nome do pagador/beneficiário.

Para depósitos criados sem name, este valor pode iniciar com um dado temporário e ser atualizado para o pagador real após a confirmação do pagamento via webhook do provedor. Para saques, é o nome enviado ou o resolvido via DICT; pode vir vazio.

documentstring

CPF ou CNPJ do pagador/beneficiário.

Para depósitos criados sem document, este valor pode iniciar com um dado temporário e ser atualizado para o documento real do pagador após a confirmação do pagamento via webhook do provedor. Para saques, é o documento enviado ou o resolvido via DICT; pode vir vazio.

emailstring nullable

Email

phonestring nullable

Telefone

copy_pastestring nullable

Código PIX copia e cola (apenas para depósitos)

pix_keystring nullable

Chave PIX utilizada (apenas para saques), no formato do DICT (CPF/CNPJ só dígitos, telefone +55DDDNÚMERO, e-mail minúsculo, EVP minúscula com hífens).

key_type'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'EVP'

Tipo de chave PIX

card_last_fourstring nullable

Últimos 4 dígitos do cartão (apenas para cobranças)

card_brand'visa' | 'mastercard' | 'amex' | 'elo' | 'hipercard' nullable

Bandeira do cartão (apenas para cobranças)

installmentsinteger nullable

Número de parcelas (apenas para cobranças)

metadataobject nullable

Dados adicionais (apenas para cobranças)

created_atstring date-time

Data de criação da transação

updated_atstring date-time

Data da última atualização

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "deposit",
  "currency": "BRL",
  "amount": 100.5,
  "tax": 2.5,
  "net_amount": 98,
  "reference": "ORDER-12345",
  "description": "Pagamento de pedido",
  "e2e_id": "E18236120202104062021A1234567ABCD",
  "status": "pending",
  "status_label": "Pendente",
  "name": "João da Silva",
  "document": "12345678901",
  "email": "joao@example.com",
  "phone": "11987654321",
  "copy_paste": "00020126330014BR.GOV.BCB.PIX...",
  "pix_key": "joao@example.com",
  "key_type": "CPF",
  "card_last_four": "1111",
  "card_brand": "visa",
  "installments": 3,
  "created_at": "2024-01-15 10:30:00",
  "updated_at": "2024-01-15 10:30:00",
  "split": {
    "gross": 100,
    "tax": 2.5,
    "net": 97.5,
    "lines": [
      {
        "recipient": "9f1c2b7e-4a6d-4c2f-8b1a-2e5d7c9f0a13",
        "type": "percentage",
        "value": 30,
        "amount": 29.25,
        "status": "pending",
        "status_label": "Pendente"
      }
    ],
    "split_total": 29.25,
    "merchant_net": 68.25
  }
}

Changes

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