Consulta do status da transação

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O cliente do parceiro tenha realizado uma transação (pagamento ou transferência) via Pix.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/pix/transfer/{{accountNumber}}/{{authenticationCode}}

--request GET 'https://stageapi.meuacessobackoffice.com.br/pix/transfer/{{accountNumber}}/{{authenticationCode}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON
Authorization	Bearer token	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Nome	Tipo	Descrição
accountNumber	path	Obrigatório. Número da conta que realizou o pagamento via Pix. Obs.: O número da conta deve ser o mesmo da conta que está autenticada
authenticationCode	path	Obrigatório. Código de autenticação da transação, recebido no retorno da requisição de Pix cash-out.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
companyKey	string	Chave que identifica o parceiro dentro do Hiperbanco.
authenticationCode	string	Identificador único da transação, no formato GUID v4.
endToEndId	string	Identificador único do Pix.
initializationType	string	Modo pelo qual a transação ocorreu, que pode ser "key" (chave de endereçamento Pix), "staticQrCode" ou "dynamicQrCode" (QR Code) ou “manual”.
ID de conciliação utilizado para conciliação dos pagamentos.	string	ID de conciliação utilizado para conciliação dos pagamentos. Esse campo é retornado em caso de PixQrCode
amount	number	Valor da transferência Pix.
description	string	Campo que pode ser utilizado pelo cliente do parceiro para registrar informações referentes à transação. Essas informações poderão ser visualizadas pelo destinatário da transferência.
correlationId	string	GUID informado em cada requisição realizada no endpoint.
sender	object	Objeto que contém informações sobre o pagador da transação.
sender.documentType	string	Tipo de documento do pagador da transação, que pode ser "CPF" ou "CNPJ".
sender.documentNumber	string	Número do documento.
sender.name	string	Nome de registro do pagador da transação, conforme consta no cadastro da conta.Quando pessoa física, trata-se do nome de registro, e quando pessoa jurídica, trata-se da razão social da empresa.
sender.account	object	Objeto que contém informações sobre a conta do pagador da transação.
sender.account.branch	string	Número da agência.
sender.account.number	string	Número da conta.
sender.account.type	string	Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
sender.bank	object	Objeto que contém informações sobre o banco pagador da transação.
sender.bank.ispb	string	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco pagador da transação.
recipient	object	Objeto que contém informações sobre o recebedor da transação.
recipient.documentType	string	Tipo de documento do recebedor da transação, que pode ser "CPF" ou "CNPJ".
recipient.documentNumber	string	Número do documento.
recipient.name	string	Nome do recebedor da transação. Esse campo retornará o nome do documento de cadastro, e não o nome social.
recipient.account	object	Objeto que contém informações sobre a conta do recebedor da transação.
recipient.account.branch	string	Número da agência.
recipient.account.number	string	Número da conta.
recipient.account.type	string	Tipo de conta, que pode ser "CHECKING" (conta corrente), "SALARY" (conta salário), "SAVINGS" (poupança) e "PAYMENT" (conta de pagamento).
recipient.bank	object	Objeto que contém informações sobre o banco do recebedor da transação.
recipient.bank.ispb	string	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco recebedor da transação.
recipient.bank.compe	string	Código do banco.
recipient.bank.name	string	Nome do banco.
channel	string	Indica se a transação é interna ("INTERNAL") ou externa ("EXTERNAL").
status	string	Possívei estados da transação de Pix cash-out.
type	string	Tipo de transação, que pode ser "CASH_OUT" (pagamento/transferência) ou "REFUND" (devolução).
createdAt	string	Data de criação da transação, no formato ISO 8601 - UTC.
updatedAt	string	Data de atualização da transação, no formato ISO 8601 - UTC.

{
    "companyKey": "BANCOFICTICIO_XYZ123",
    "authenticationCode": "abcd1234-5678-90ef-ghij-klmnopqrstuv",
    "endToEndId": "E99999999202507152326A123456789XY",
    "initializationType": "Key",
    "amount": 123.45,
    "description": "Pagamento teste de integração Pix",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "sender": {
        "documentType": "CNPJ",
        "account": {
            "branch": "1234",
            "number": "9876543210",
            "type": "CHECKING"
        },
        "bank": {
            "ispb": "99999999"
        },
        "documentNumber": "12345678000199",
        "name": "Empresa Fictícia de Testes LTDA"
    },
    "recipient": {
        "documentType": "CPF",
        "account": {
            "branch": "5678",
            "number": "1122334455",
            "type": "PAYMENT"
        },
        "bank": {
            "ispb": "88888888",
            "compe": "999",
            "name": "Banco Digital Fictício"
        },
        "documentNumber": "98765432100",
        "name": "João da Silva Testador"
    },
    "channel": "EXTERNAL",
    "status": "DONE",
    "type": "CASH_OUT",
    "createdAt": "2025-07-15T20:27:15.065-03:00",
    "updatedAt": "2025-07-15T20:27:18.438-03:00"
}

{
    "companyKey": "BANCOFICTICIO_XYZ987",
    "authenticationCode": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "endToEndId": "E999999992025052214178ABCDE123456",
    "initializationType": "Key",
    "amount": 22,
    "description": "Transferência de teste via Pix",
    "correlationId": "abcd1234-5678-90ef-abcd-1234567890ef",
    "sender": {
        "documentType": "CNPJ",
        "account": {
            "branch": "1234",
            "number": "9876543210",
            "type": "CHECKING"
        },
        "bank": {
            "ispb": "99999999"
        },
        "documentNumber": "12345678000100",
        "name": "Empresa de Tecnologia Fictícia LTDA"
    },
    "recipient": {
        "documentType": "CPF",
        "account": {
            "branch": "5678",
            "number": "1122334455",
            "type": "PAYMENT"
        },
        "bank": {
            "ispb": "88888888",
            "compe": "123",
            "name": "Banco de Pagamentos Fictício S.A."
        },
        "documentNumber": "98765432100",
        "name": "Ana Beatriz da Costa Fictícia"
    },
    "channel": "INTERNAL",
    "status": "DONE",
    "type": "CASH_OUT",
    "createdAt": "2025-05-22T11:17:39.685-03:00",
    "updatedAt": "2025-05-22T11:17:42.829-03:00"
}

Status da transação Pix cash-out

Status	Descrição
CREATED	Transação criada, não finalizada.
IN_PROCESS	Transação em processo, não finalizada.
APPROVED	Transação aprovada, não finalizada.
REPROVED	Transação reprovada, não finalizada.
DONE	Transação concluída com sucesso.
UNDONE	Embora a reserva de valor para a transação (hold) tenha ocorrido com sucesso, a transação não pôde ser concluída, devido à reprovação no processo de antifraude transacional. Nesse caso, o valor será devolvido para a conta pagadora.
CANCELED	A transação foi cancelada. O saldo não foi afetado.

⚠️
Importante
A transação só é considerada como concluída quando o status estiver como DONE, UNDONE ou CANCELED.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.