Consulta de programa por id

Este endpoint permite consultar as informações de um programa de garantia específico, por meio do seu identificador (programId).

A requisição processará um único programa por vez, retornando dados completos, incluindo atributos do programa, parâmetros de crédito, regras de execução, tipo de garantia e status atual.

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;
Tenha criado previamente um programa de garantia para seus clientes.

Requisição (Request)

Requisição HTTP

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

GET 'https://api.sandbox.bankly.com.br/collateral-programs/`{programId}`' \
--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)

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

Nome	Tipo	Descrição	Especificação
`programId`	`path`	Obrigatório. Identificador único do programa de garantia.	—

Corpo da requisição (Body)

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

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita e trará um objeto contendo informações sobre o programa de garantia.

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

Nome	Tipo	Descrição	Número máximo de caracteres
`programId`	`integer`	Identificador único do programa de garantia.
`description`	`string`	Descrição do programa de garantia.
`modality`	`string`	Modalidade do programa de garantia, que sempre será “Credit Card” .
`guaranteeParameters`	`object`	Objeto que contém informações sobre os parâmetros definidos para o programa de garantia.	—
`guaranteeParameters.origin`	`string`	Origem da garantia, que pode ser “Partner Account” (conta do parceiro), “Account” (conta do cliente), “Investment” (investimento).	—
`guaranteeParameters.executionDays`	`integer`	Quantidade de dias para a execução da garantia.	—
`guaranteeParameters.executionType`	`string`	Tipo de execução da garantia, que pode ser “WORKING_DAYS” (dias úteis), “RUNNING_DAYS” (dias corridos).	—
`guaranteeParameters.executeOnlyWorkingDays`	`boolean`	Indica se é permitido a execução da garantia apenas em dias úteis (true) ou não (false).	—
`guaranteeParameters.maxPercentLimit`	`integer`	Percentual máximo de uso da garantia para a concessão de crédito.	—
`guaranteeParameters.contractMinValue`	`number`	Valor mínimo de crédito com garantia que pode ser concedido ao cliente.	—
`guaranteeParameters.contractMaxValue`	`number`	Valor máximo de crédito com garantia que pode ser concedido ao cliente.	—
`modalityParameters`	`array of objects`	LIsta de objetos contendo informações sobre os parâmetros do programa por modalidade.	—
`modalityParameters.key`	`string`	Chave de identificação do parâmetro. Exemplo: `programId`, `allowsCreditAnalysis`, `allowsCustomerAnalysis`.	—
`modalityParameters.value`	`object`	Objeto que contém informações sobre o parâmetro.	—
`modalityParameters.value.value`	`string`	Valor do parâmetro.	—
`modalityParameters.value.description`	`string`	Descrição do parâmetro.	—
`status`	`string`	Situação do programa de garantia, que pode ser “ACTIVE” (ativo) ou "INACTIVE" (inativo).
`createdAt`	`string`	Data e hora de criação do programa, no formato ISO 8601 - UTC.	—
`updatedAt`	`string`	Data e hora de atualização do programa, no formato ISO 8601 - UTC.	—
`version`	`integer`	Versão do programa.	—

{
    "programId": 1537,
    "description": "programa redondo",
    "modality": "CREDIT_CARD",
    "guaranteeParameters": {
        "origin": "PARTNER_ACCOUNT",
        "executionDays": 3,
        "executionType": "WORKING_DAYS",
        "executeOnlyWorkingDays": true,
        "maxPercentLimit": 80,
        "contractMinValue": 1000,
        "contractMaxValue": 2000
    },
    "modalityParameters": [
        {
            "key": "programId",
            "value": {
                "value": "95",
                "description": "Descrição do Programa"
            }
        },
        {
            "key": "allowsCreditAnalysis",
            "value": {
                "value": "S",
                "description": "Permite análise de crédito"
            }
        },
        {
            "key": "allowsCustomerAnalysis",
            "value": {
                "value": "S",
                "description": "Permite análise de customer"
            }
        }
    ],
    "status": "INACTIVE",
    "createdAt": "2025-01-17T13:38:29.551Z",
    "updatedAt": "2025-01-17T10:46:06.638-03:00",
    "version": 2
}

👍
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.	`CompanyKey` obrigatório no header.
404	—	—	O programa ou companyKey informado 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.