GET
/pix/DEPOSITConsultar cobrança Pix
Requer permissão DEPOSIT no token.
Consulta uma cobrança Pix. Ao menos um dos parâmetros id, clientReference ou endToEndId deve ser informado.
Se a transação tiver sido criada com splits, o campo splits reflete o status final de cada um (EXECUTED ou FAILED) depois que o webhook de confirmação de pagamento processa a transação — ver POST /pix/ para as regras completas de cálculo e comportamento de erro.
Headers
| Authorization | Bearer <seu_token> |
Parâmetros
| Nome | In | Tipo | Descrição |
|---|---|---|---|
| id | query | string | – |
| clientReference | query | string | – |
| endToEndId | query | string | – |
Respostas
Dados da transação
| Campo | Tipo | Descrição |
|---|---|---|
id | string | — |
type | TransactionType | DEPOSITWITHDRAWCOMMISSION |
status | TransactionStatus | PENDINGCOMPLETEDCANCELEDWAITING_FOR_REFUNDREFUNDEDEXPIREDERROR |
amount | number | — |
serviceFeeCharged | number? | — |
clientReference | string? | — |
qrCodeText | string? | — |
qrCodeUrl | string? | — |
qrCodeBase64 | string? | — |
generatedName | string? | — |
generatedDocument | string? | — |
generatedEmail | string? | — |
payerName | string? | — |
payerDocument | string? | — |
payerInstitutionIspb | string? | — |
payerInstitutionName | string? | — |
receiverName | string? | — |
receiverDocument | string? | — |
receiverInstitutionIspb | string? | — |
receiverInstitutionName | string? | — |
withdrawPixKey | string? | Chave PIX usada no saque (preenchido em saque via chave) |
withdrawPixType | PixType? | Tipo da chave PIX (preenchido em saque via chave) cpfcnpjemailphoneevp |
withdrawQrCodeText | string? | Payload EMV Pix Copia e Cola usado no saque (preenchido em saque via QR Code) |
endToEndId | string? | — |
cancellationReason | string? | — |
paidAt | string?date-time | — |
refundEndToEndId | string? | — |
refundAmount | number? | — |
refundStatus | RefundStatus? | PENDINGCOMPLETEDCANCELED |
refundReason | RefundReason? | CUSTOMER_REQUESTDENY_COMPANY_DEPOSITINFRACTION |
refundDescription | string? | — |
refundedAt | string?date-time | — |
createdAt | stringdate-time | — |
updatedAt | stringdate-time | — |
splits | TransactionSplitItem[] | Splits configurados na venda, ecoando exatamente o que foi persistido. Na criação (POST /pix/) todo item vem com status PENDING — a execução real só acontece na confirmação do pagamento. Consulte novamente via GET /pix/ depois do webhook processar para ver EXECUTED ou FAILED. Ausente inteiramente (não aparece nem vazio) quando a transação não foi criada com o campo splits no request. Veja detalhes de cálculo e comportamento de erro em POST /pix/. |
Exemplos
curl "https://api.evopay.cash/v1/pix/?id=exemplo&clientReference=exemplo&endToEndId=exemplo" \ -H "Authorization: Bearer <seu_token>"