InstitucionalBlogService DeskStatus Page

Consulta de uma transação

stable

Suggest Edits

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

Requisição HTTP

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

curl --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:

ScopeDescrição
pocket.transaction.readConcede acesso para consultar uma transação feita entre a pocket e a conta de pagamento.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. A versão desta API é a 2.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescrição
pocketNumberpathObrigatório. Número da conta pocket.
authenticationCodepathObrigató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:

NomeTipoDescrição
dataobjectObjeto que contém os dados da transação.
data.authenticationCodestringIdentificador da transação.
data.amountobjectObjeto que contém os dados do valor transacionado.
data.amount.valuenumberValor transacionado.
data.amount.currencystringSigla da moeda na qual a transação ocorreu, de acordo com a ISO 4217.
data.pocketobjectObjeto que contém os dados da conta pocket.
data.pocket.numberstringNúmero da conta pocket.
data.pocket.statusstringEstado da conta pocket, o qual pode ser: “ACTIVE”, “DORMANT”, “LOCKED” e “CLOSED”.
data.pocket.balancesobjectObjeto que contém os dados do saldo da pocket.
data.pocket.balances.totalobjectObjeto que contém os dados do valor total do saldo.
data.pocket.balances.total.valuenumberValor total do saldo.
data.pocket.balances.total.currencystringSigla da moeda do saldo, de acordo com a ISO 4217.
data.pocket.accountobjectObjeto que contém informações sobre a conta de pagamento à qual a pocket está atrelada.
data.pocket.account.branchstringNúmero da agência.
data.pocket.account.numberstringNúmero da conta.
data.pocket.account.statusstringSituação da conta de pagamento à qual a pocket está atrelada, que pode ser “ACTIVE” ou “CLOSED”.
data.pocket.account.bankobjectObjeto que contém informações sobre o banco ao qual a conta de pagamento pertence.
data.pocket.account.bank.codestringCódigo do banco.
data.pocket.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
data.pocket.account.bank.namestringNome do banco.
data.pocket.account.balancesobjectObjeto que contém os dados do saldo da conta de pagamento.
data.pocket.account.balances.totalobjectObjeto que contém os dados do valor total do saldo.
data.pocket.account.balances.total.valuenumberValor total do saldo.
data.pocket.account.balances.total.currencystringSigla da moeda do saldo, de acordo com a ISO 4217.
data.pocket.account.holderobjectObjeto que contém os dados do titular da conta de pagamento.
data.pocket.account.holder.documentobjectObjeto que contém os dados do documento do titular da conta de pagamento.
data.pocket.account.holder.document.valuestringNúmero do documento.
data.pocket.account.holder.document.typestringTipo de documento (CPF ou CNPJ).
data.pocket.account.holder.typestringTipo do cadastro do titular da conta de pagamento (“CUSTOMER” ou “BUSINESS”).
data.pocket.account.holder.namestringNome do titular da conta de pagamento.
data.typestringTipo de transação realizada (DEPOSIT ou REDEEM).
data.statusstringSituação da transação, que pode ser: “CREATED” (criada), “IN_PROCESS” (em processamento), “DONE” (concluída), “UNDONE” (desfeita) e “ERROR” (erro).
data.createdAtstringData de criação da transação, no formato ISO 8601 - UTC.
data.updatedAtstringData de atualização da transação, no formato ISO 8601 - UTC.
data.descriptionstringTexto que descreve a transação.
links[]array of objectsLinks de próximos estados válidos da entidade/recurso.
links[].urlstringURLs que podem ser utilizadas em um próximo estado da entidade.
links[].relstringDescrição de como a URL se relaciona com o recurso atual.
links[].methodstringTipo de verbo que deve ser utilizado para acessar a URL.
metadatadictionary<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.

Updated 12 days ago