latestOpenAPI 3.1.02026-07-2440101174.2 KB

e20afa10cd0e

Pagamentos instantâneos

Consulta do status da transação

Realize a consulta do status das transferências e pagamentos realizados via Pix. Para isso, é necessário ter um authenticationCode válido.

get/pix/cash-out/accounts/{accountNumber}/authenticationcode/{authenticationCode}

accountNumberstring nullable required

Número da conta que realizou o pagamento via Pix.

authenticationCodestring nullable required

Código de autenticação da transação, recebido no retorno da requisição de Pix cash-out.

#/paths/~1pix~1claims/get/parameters/0 — unresolved $ref

#/paths/~1pix~1claims/get/parameters/3 — unresolved $ref

#/paths/~1pix~1claims/get/parameters/1 — unresolved $ref

#/paths/~1pix~1claims/get/parameters/2 — unresolved $ref

Consulta retornada com sucesso.

companyKeystring

Chave que identifica o parceiro dentro do Bankly.

authenticationCodestring uuid

Código de autenticação da transação.

endToEndIdstring nullable

Identificador único do Pix.

receiverReconciliationIdstring nullable

ID de conciliação utilizado para conciliação dos pagamentos.

amountnumber double

Valor transacionado.

descriptionstring nullable

Campo que pode ser utilizado pelo usuário para enviar mensagens ao destinatário da transferência com informações sobre a transação.

correlationIdstring nullable

GUID informado em cada requisição realizada no endpoint.

channel'INTERNAL' | 'EXTERNAL'

Indica se a transação é interna ou externa.

Situação da transação de Pix cash-out.

type'CASH_OUT' | 'REFUND'

Tipo de transação.

createdAtstring date-time

Data de criação da transação.

updatedAtstring date-time nullable

Data de atualização da transação.

isPixOpenBankingboolean

Transação iniciada por Open Finance.

requestDateTimestring date-time

Data e hora de recebimento da ordem de pagamento enviada pelo usuário pagador ao PSP pagador.