Consulta de todos os programas

beta

Este endpoint permite consultar todos os programas de garantia associados à uma companyKey . A resposta da requisição incluirá detalhes como identificação, descrição e status atual de cada programa.

Pré-requisitos

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

Esteja autenticado com um token válido;
Possua uma companyKey válida e com status ativo.

Requisição (Request)

Requisição HTTP

GET https://api.sandbox.bankly.com.br/collateral-programs

GET'https://api.sandbox.bankly.com.br/collateral-programs' \
--header 'Authorization: Bearer {{Token}}' \
--header 'x-company-key: {{CompanyKey}}'

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
?	Concede acesso para consultar programas de garantia.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.
`x-company-key`	Obrigatório. Chave que identifica o parceiro dentro do Bankly.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

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

Resposta (Response)

O status code 200 indica que a solicitação foi aceita com sucesso e trará uma lista com os programas de garantia.

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

[
    {
        "programId": 1537,
        "description": "programa redondo",
        "status": "INACTIVE"
    },
    {
        "programId": 1597,
        "description": "programa Nathalie",
        "status": "ACTIVE"
    },
    {
        "programId": 1635,
        "description": "programa redondo",
        "status": "ACTIVE"
    }
]

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

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
400	X_COMPANY_KEY_IS_REQUIRED	x-company-key header is required for this request.	O envio do campo `x-company-key` é obrigatório.
404	—	—	A `companyKey` informada não foi encontrada na base.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.