Skip to main content
GET/transfer-pix/get/{id}

Parâmetros de caminho

idstringrequired

ID da operação. Em consultas de depósito, saque e transferência interna, também pode ser a referência externa.

Autorização

X-API-Keystringrequired

Chave VibeCash com permissão para esta operação.

Resposta

200 application/json
successbooleanrequired

Indica se a operação foi concluída pela API.

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
idstring

Identificador da operação.

statusstring

Situação atual do pagamento ou envio.

amountnumber

Valor bruto ou informado, em reais.

feeAmountnumber

Taxa da operação, em reais.

netAmountnumber

Líquido da entrada ou total debitado de uma saída.

Valor entregue ao destinatário.

Total debitado da carteira.

createdAtstring

Data e hora da criação em formato ISO.

requestIdstring

Identificador da requisição.

netAmount mantém o total debitado da carteira por compatibilidade. Use recipientAmount para o valor recebido pelo destinatário e totalDebit para o custo total.

Erros

As falhas retornam o envelope com success: false. Consulte erros e códigos HTTP para interpretar validação, permissão, conflito e saldo insuficiente.

curl --request GET \
  --url 'https://seu-dominio/v1/transfer-pix/get/SEU_ID' \
  --header 'X-API-Key: tp_live_SUA_CHAVE'
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "id": "out_exemplo",
    "amount": 5,
    "feeAmount": 0.1,
    "netAmount": 5.1,
    "recipientAmount": 5,
    "totalDebit": 5.1,
    "status": "PROCESSING",
    "createdAt": "2026-11-10T15:00:00.000Z"
  },
  "requestId": "req_exemplo"
}

Pesquisar documentação

GET

Consultar envio PIX

Veja os dados de uma transferência PIX.

Authorization