find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/btg-pactual:btg-pactual-commercial-strategy-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: SCF - Risco Sacado Commercial strategy API
  description: Esta API tem a finalidade de contratar Antecipações de Recebíveis. Para autenticação é necessário a utilização do fluxo de client credentials para autenticação na documentação da API. `AUTENTICAÇÃO -> Fluxos de Autenticação -> Client Credentials`
  version: 1.4.1
  contact:
    name: Time BTG Empresas
    email: ol-it-btgempresas@btgpactual.com
servers:
- url: https://api.sandbox.empresas.btgpactual.com/v1/scf
  description: SANDBOX URL
- url: https://api.empresas.btgpactual.com/v1/scf
  description: PROD URL
tags:
- name: Commercial strategy
paths:
  /companies/commercial-strategies:
    post:
      tags:
      - Commercial strategy
      description: Associação de lote de empresas a uma estratégia comercial.
      operationId: addCompaniesToCommercialStrategyRequest
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - companies
              - strategyUuid
              properties:
                companies:
                  type: array
                  items:
                    type: object
                    required:
                    - taxId
                    properties:
                      taxId:
                        type: string
                      name:
                        type: string
                    title: CompanyNameTaxIdDto
                strategyUuid:
                  type: string
      responses:
        '200':
          description: Define se houve sucesso ou erro ao executar o fluxo
          content:
            application/json:
              schema:
                type: object
                properties:
                  isValid:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        errorMessage:
                          type: string
                          description: Erro ocorrido
                        errorCode:
                          type: string
                          enum:
                          - CACSQF0001
                          - CACSQF0002
                          - CACSQF0003
                          - CACSQF0004
                          - CACSQF0005
                          - CACSQF0006
                          - CACSQF0007
                          - CACSQF0008
                          - CACSQF0009
                          description: '___

                            Errors:

                            * CACSQF0001 - Commercial strategy UUID must be provided.

                            * CACSQF0002 - Commercial strategy not found.

                            * CACSQF0003 - Incomplete commercial strategy.

                            * CACSQF0004 - At least one company must be provided.

                            * CACSQF0005 - Company TaxId must be provided.

                            * CACSQF0006 - Can''t add company without name.

                            * CACSQF0007 - Company with id {companyId} had error on associate with commercial strategy {strategyUuid}.

                            * CACSQF0008 - Error on creating counterparties.

                            '
                        propertyName:
                          type: string
                          description: Propriedade que houve erro.
                title: ValidationResultSchema
        '400':
          description: Define se houve sucesso ou erro ao executar o fluxo
          content:
            application/json:
              schema:
                type: object
                properties:
                  isValid:
                    type: boolean
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        errorMessage:
                          type: string
                          description: Erro ocorrido
                        errorCode:
                          type: string
                          enum:
                          - CACSQF0001
                          - CACSQF0002
                          - CACSQF0003
                          - CACSQF0004
                          - CACSQF0005
                          - CACSQF0006
                          - CACSQF0007
                          - CACSQF0008
                          - CACSQF0009
                          description: '___

                            Errors:

                            * CACSQF0001 - Commercial strategy UUID must be provided.

                            * CACSQF0002 - Commercial strategy not found.

                            * CACSQF0003 - Incomplete commercial strategy.

                            * CACSQF0004 - At least one company must be provided.

                            * CACSQF0005 - Company TaxId must be provided.

                            * CACSQF0006 - Can''t add company without name.

                            * CACSQF0007 - Company with id {companyId} had error on associate with commercial strategy {strategyUuid}.

                            * CACSQF0008 - Error on creating counterparties.

                            '
                        propertyName:
                          type: string
                          description: Propriedade que houve erro.
                title: ValidationResultSchema
        '401':
          description: Não autorizado
      security:
      - oauth2:
        - empresas.btgpactual.com/scf/companies
      x-docs-url: https://developers.empresas.btgpactual.com/docs/api-specs-target/SCF%20-%20Risco%20Sacado/add-companies-to-commercial-strategy-request
      summary: Add companies to commercial strategy request
      x-summary-source: derived
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://id.sandbox.btgpactual.com/oauth2/token
          scopes:
            empresas.btgpactual.com/scf/borderos: Scope to borderos
            empresas.btgpactual.com/scf/borderos.readonly: Scope to borderos read
            empresas.btgpactual.com/scf/companies: Scope to companies
            empresas.btgpactual.com/scf/companies.readonly: Scope to companies read
            empresas.btgpactual.com/scf/operations: Scope to operations
            empresas.btgpactual.com/scf/operations.readonly: Scope to operations read
            empresas.btgpactual.com/scf/receivables: Scope to receivables
            empresas.btgpactual.com/scf/receivables.readonly: Scope to receivables read
            empresas.btgpactual.com/scf/settlements: Scope to settlements
            empresas.btgpactual.com/scf/settlements.readonly: Scope to settlements read
            empresas.btgpactual.com/scf/trades: Scope to trades
            empresas.btgpactual.com/scf/trades.readonly: Scope to trades read
            empresas.btgpactual.com/payer-onboardings: Scope to financiers-payer
x-reassembled-from:
  source: https://developers.empresas.btgpactual.com/docs/api-specs-target/
  method: Operation objects decoded verbatim from the "api" payload that the provider's Docusaurus OpenAPI docs embed in each reference page chunk (/assets/js/*.js); grouped by info.title; jsonRequestBodyExample and postman keys dropped.
  chunks:
  - https://developers.empresas.btgpactual.com/assets/js/58e6a5f6.d603bf94.js
  - https://developers.empresas.btgpactual.com/assets/js/0e797970.5126fe3c.js
  - https://developers.empresas.btgpactual.com/assets/js/4ac3e447.07b626b1.js
  - https://developers.empresas.btgpactual.com/assets/js/17b7cd34.31efc121.js
  - https://developers.empresas.btgpactual.com/assets/js/69c7c660.61e0039c.js
  - https://developers.empresas.btgpactual.com/assets/js/d83fedfc.69d77805.js
  - https://developers.empresas.btgpactual.com/assets/js/091533f9.2c5d3d51.js
  - https://developers.empresas.btgpactual.com/assets/js/51cd407d.7f26ecb2.js
  - https://developers.empresas.btgpactual.com/assets/js/522d5b94.745f73fc.js
  - https://developers.empresas.btgpactual.com/assets/js/a9f41984.1f49d7c9.js
  - https://developers.empresas.btgpactual.com/assets/js/10287afc.7e9c97f3.js
  - https://developers.empresas.btgpactual.com/assets/js/6687c7ea.dec258dc.js
  - https://developers.empresas.btgpactual.com/assets/js/fb9f95a5.4835ae79.js
  - https://developers.empresas.btgpactual.com/assets/js/0938da15.d9b57531.js