Consulta de uma transação

Este endpoint possibilita realizar a consulta de uma transação específica, de depósito ou resgate, ocorrida entre a conta de pagamento e a pocket.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/pockets/{pocketNumber}/transactions/{authenticationCode} \

--request GET \
-- url 'https://api-mtls.sandbox.bankly.com.br/pockets/1516482BRL/transactions/127852a5-58f1-41c6-9790-b606a8be3199' \
--header 'api-version: 2' \
--header 'Authorization: Bearer'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`pocket.transaction.read`	Concede acesso para consultar uma transação feita entre a pocket e a conta de pagamento.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. A versão desta API é a 2.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
`pocketNumber`	`path`	Obrigatório. Número da conta pocket.
`authenticationCode`	`path`	Obrigatório. Identificador da transação em formato GUID, retornado no endpoint de depósito ou resgate de valor.

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 busca.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`data`	`object`	Objeto que contém informações sobre a transação.
`data.authenticationCode`	`string`	Identificador da transação.
`data.amount`	`object`	Objeto que contém informações sobre o valor transacionado.
`data.amount.value`	`number`	Valor transacionado.
`data.amount.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`data.pocket`	`object`	Objeto que contém informações sobre a conta pocket.
`data.pocket.number`	`string`	Número da conta pocket.
`data.pocket.status`	`string`	Status da conta pocket, o qual pode ser “ACTIVE”, “DORMANT”, “LOCKED” e “CLOSED”.
`data.pocket.balances`	`object`	Objeto que contém informações sobre o saldo da pocket.
`data.pocket.balances.total`	`object`	Objeto que contém informações sobre o valor total do saldo.
`data.pocket.balances.total.value`	`number`	Valor total do saldo.
`data.pocket.balances.total.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`data.pocket.account`	`object`	Objeto que contém informações sobre a conta de pagamento à qual a pocket está atrelada.
`data.pocket.account.branch`	`string`	Número da agência.
`data.pocket.account.number`	`string`	Número da conta.
`data.pocket.account.status`	`string`	Situação da conta de pagamento à qual a pocket está atrelada, que pode ser “ACTIVE” ou “CLOSED”.
`data.pocket.account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`data.pocket.account.bank.code`	`string`	Código do banco.
`data.pocket.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`data.pocket.account.bank.name`	`string`	Nome do banco.
`data.pocket.account.balances`	`object`	Objeto que contém informações sobre o saldo da conta de pagamento.
`data.pocket.account.balances.total`	`object`	Objeto que contém informações sobre o valor total do saldo.
`data.pocket.account.balances.total.value`	`number`	Valor total do saldo.
`data.pocket.account.balances.total.currency`	`string`	Código da moeda com base na ISO-4217. Exemplo: “BRL”.
`data.pocket.account.holder`	`object`	Objeto que contém informações sobre o titular da conta de pagamento.
`data.pocket.account.holder.document`	`object`	Objeto que contém informações sobre o documento do titular da conta de pagamento.
`data.pocket.account.holder.document.value`	`string`	Número do documento.
`data.pocket.account.holder.document.type`	`string`	Tipo de documento (CPF ou CNPJ).
`data.pocket.account.holder.type`	`string`	Tipo do cadastro do titular da conta de pagamento, que pode ser “CUSTOMER” ou “BUSINESS”.
`data.pocket.account.holder.name`	`string`	Nome do titular da conta de pagamento.
`data.type`	`string`	Tipo de transação realizada, que pode ser "DEPOSIT" ou "REDEEM".
`data.status`	`string`	Situação da transação, que pode ser “CREATED” (criada), “IN_PROCESS” (em processamento), “DONE” (concluída), “UNDONE” (desfeita) e “ERROR” (erro).
`data.createdAt`	`string`	Data de criação da transação, no formato ISO 8601 - UTC.
`data.updatedAt`	`string`	Data de atualização da transação, no formato ISO 8601 - UTC.
`data.description`	`string`	Texto que descreve a transação.
`links[]`	`array of objects`	Links de próximos estados válidos da entidade/recurso.
`links[].url`	`string`	URLs que podem ser utilizadas em um próximo estado da entidade.
`links[].rel`	`string`	Descrição de como a URL se relaciona com o recurso atual.
`links[].method`	`string`	Tipo de verbo que deve ser utilizado para acessar a URL.
`metadata`	`dictionary<string, object>`	Dicionário de metadados que trará dados adicionais da requisição.

{
    "data": {
        "authenticationCode": "127852a5-58f1-41c6-9790-b606a8be3199",
        "amount": {
            "value": 1.0,
            "currency": "BRL"
        },
        "pocket": {
            "number": "1516482BRL",
            "status": "ACTIVE",
            "balances": {
                "total": {
                    "value": 9995.0,
                    "currency": "BRL"
                }
            },
            "account": {
                "number": "15164",
                "branch": "0001",
                "status": "Active",
                "bank": {
                    "ispb": "13140088",
                    "code": "332",
                    "name": "Acesso Soluções De Pagamento S.A."
                },
                "balances": {
                    "total": {
                        "value": 5.0,
                        "currency": "BRL"
                    }
                },
                "holder": {
                    "document": {
                        "value": "47742663023",
                        "type": "CPF"
                    },
                    "type": "CUSTOMES",
                    "name": "Nísia Floresta"
                }
            }
        },
        "type": "REDEEM",
        "status": "DONE",
        "createdAt": "2022-01-01T03:00:00Z",
        "updatedAt": "2022-01-02T03:00:00Z",
        "description": "Resgate para compra de material"
    }
    "links": [],
    "metadata": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
    }
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

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.

Requisição (Request)

Requisição HTTP

Autorização

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Corpo da requisição (Body)

Resposta (Response)

👍Dica

Erros

Eventos

👍
Dica