Consulta de ordem de compra e venda

Este endpoint possibilita realizar a busca de uma ordem específica de compra ou venda de criptomoedas.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro:

Possua uma conta ativa;
Tenha criado pelo menos uma intenção de compra ou venda de criptomoedas.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/v2/crypto/orders/{authenticationCode}

-- request GET 
--url 'https://api-mtls.sandbox.bankly.com.br/v2/crypto/orders/5493a218-2801-4515-954a-9e75888a1ff4' \
--header 'accept: application/json' \
--header 'bankly-version: 2023-01-30' \
--header 'bankly-correlation-id: 5a88c4ae-99cd-494e-96b7-39b8109c8a77' \
--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
`crypto.order.read`	Concede acesso para consultar uma ordem de compra ou venda de criptomoedas.

Cabeçalhos (Headers)

Nome	Descrição
`bankly-version`	Obrigatório. Versão da API. Atualmente estamos na versão 2023-01-30.
`authorization`	Obrigatório. Token de autorização do tipo Bearer.
`bankly-correlation-id`	Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
`authenticationCode`	`path`	Obrigatório. Identificador da transação retornado no endpoint de Criação de intenção de compra e venda de criptomoedas.

Corpo da requisição (Body)

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

Resposta (Response)

Os status 200 indica que a ordem retornou com sucesso.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`authenticationCode`	`string`	Identificador da transação informado no path desta requisição.
`type`	`string`	Tipo de ordem (compra ou venda), o qual pode ser “PURCHASE” ou “SELL”.
`market`	`string`	Mercado, o qual é constituído da sigla da criptomoeda com a sigla do real. Exemplo: BTC:BRL.
`status`	`string`	Situação da ordem de execução de compra ou venda.
`account`	`object`	Objeto que contém informações sobre a conta principal do usuário. Esse objeto não retorna caso o status da ordem seja CREATED ou EXPIRED.
`account.branch`	`string`	Número da agência bancária.
`account.number`	`string`	Número da conta bancária.
`price`	`object`	Objeto que contém informações sobre o preço da criptomoeda.
`price.value`	`number`	Preço final da criptomoeda.
`price.currency`	`string`	Sigla da criptomoeda.
`amount`	`object`	Objeto que contém informações sobre o valor da compra ou venda das criptomoedas, sem taxa.
`amount.value`	`number`	Valor da compra ou venda sem taxa.
`amount.currency`	`string`	Sigla da moeda com base na ISO-4217.
`fee`	`object`	Objeto que contém informações sobre a taxa aplicada no valor da compra ou venda das criptomoedas.
`data.fee.value`	`number`	Valor da taxa.
`fee.currency`	`string`	Sigla da moeda com base na ISO-4217.
`quota`	`object`	Objeto que contém informações sobre o valor da operação, em criptomoeda.
`quota.value`	`number`	Valor da operação.
`quota.currency`	`string`	Sigla da criptomoeda.
`total`	`object`	Objeto que contém informações sobre o valor total da operação, em reais (`amount`+ `fee`).
`total.value`	`string`	Valor da operação.
`total.currency`	`string`	Sigla da moeda.
`createdAt`	`string`	Data de criação da ordem de compra ou venda, no formato ISO 8601 - UTC.
`updatedAt`	`string`	Data de atualização da ordem de compra ou venda, no formato ISO 8601 - UTC.
`expiresIn`	`string`	Data de expiração da ordem de compra ou venda, no formato ISO 8601 - UTC. Campo retornado apenas para ordens com status CREATED.
`metadata`	`object`	Dicionário de metadados que pode conter informações adicionais da requisição, de acordo com o modelo de negócio do cliente.
`links[]`	`array of objects`	Lista de objetos que contém os links de próximos estados válidos da entidade/recurso.

{
    "data": {
        "authenticationCode": "5bdd7483-471c-4964-ac99-9e17914df451",
        "type": "PURCHASE",
        "status": "CREATED",
        "market": "BTC:BRL",
        "account": {
            "branch": "0001",
            "number": "15164"
        },
        "price": {
            "value": 145972.5,
            "currency": "BRL"
        },
        "amount": {
            "value": 18,
            "currency": "BRL"
        },
        "fee": {
            "value": 2,
            "currency": "BRL"
        },
        "quota": {
            "value": 0.00012331,
            "currency": "BTC"
        },
        "total": {
            "value": 20,
            "currency": "BRL"
        },
        "createdAt": "2023-03-23T14:46:13.725Z",
        "updatedAt": "2023-03-23T14:46:53.725Z"
    },
    "metadata": {
        "exemplo1": "123",
        "exemplo2": 123,
        "exemplo3": {},
        "exemplo4": []
    },
    "links": [
        {
            "url": "/crypto/orders/5bdd7483-471c-4964-ac99-9e17914df451",
            "rel": "execute_order",
            "method": "POST"
        }
    ]
}

Possíveis status da ordem de execução de compra ou venda

Status	Descrição
CREATED	Ordem solicitada.
IN_PROCESS	Ordem em processamento.
DONE	Ordem executada.
EXPIRED	Ordem expirada.

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

Possíveis status da ordem de execução de compra ou venda

Status	Descrição
CREATED	Ordem solicitada.
IN_PROCESS	Ordem em processamento.
DONE	Ordem executada.
EXPIRED	Ordem expirada.