Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Trade

Consultar carteira de operações

Esta rota serve para consultar a carteira de operações. É obrigatorio o envio das informações do cursor ou do status ou dos tradeIds.

get/trades

Query parameters

status'Aberto' | 'EmAgendamento' | 'Agendado' | 'EmAprovacao' | 'Aprovado' | 'EmAntecipacao' | 'Antecipado' | 'Liquidado' | 'Cancelado' | 'EmAtraso' | 'Indisponivel' | 'Pago' | 'EmCancelamento'

Status do trade

Status do trade

tradeIdsstring
Example:123456,654321,135790

Identificadores de trades. Lista de identificadores separados por virgula.

payerTaxIdstring

CNPJ/CPF

Example:15996430000182

Identificação do sacado

payeeTaxIdstring

CNPJ/CPF

Example:15996430000182

Identificação do fornecedor

cursorstring

Referência do cursor

Example:cGFnZT0yJml0ZW1zUGVyUGFnZT0xMCZ0eXBlPW51bGwmc3RhdHVzPVNFTlQ=

Cursor para navegar entre as paginas

limitinteger

Limite de registros por paginação

Example:1000

Limite de registros por paginação. Permitido de 1 a 10000.

Response

Sucesso

Example response

{
  "trades": [
    {
      "id": "123456",
      "contractNumber": "123-12345",
      "balance": {
        "principal": 123.12,
        "interestArrears": 123.12,
        "penaltyFee": 123.12,
        "latePaymentFee": 123.12
      }
    }
  ],
  "_links": {
    "next": {
      "href": "/v1/scf/trades?cursor=cGFnZT0yJml0ZW1zUGVyUGFnZT0xMCZ0eXBlPW51bGwmc3RhdHVzPVNFTlQ=",
      "method": "GET"
    }
  }
}