Obtém as movimentações recentes da operação de Renda Fixa Bancária identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).

get https://api-smartkeys.celcoin.prd.fsapps.io/open-keys/data/api/v2/bank-fixed-incomes/v1/investments/{investmentId}/transactions-current

Path Params

investmentId

string

required

length ≤ 100

Identifica de forma única o relacionamento do cliente com o produto, mantendo as regras de imutabilidade dentro da instituição transmissora.

Query Params

page

int32

1 to 2147483647

Defaults to 1

Número da página que está sendo requisitada (o valor da primeira página é 1).

page-size

int32

25 to 1000

Defaults to 25

Quantidade total de registros por páginas. A transmissora deve considerar entrada como 25, caso seja informado algum valor menor pela receptora. Enquanto houver mais que 25 registros a enviar, a transmissora deve considerar o mínimo por página como 25. Somente a última página retornada (ou primeira, no caso de página única) pode conter menos de 25 registros. Mais informações, acesse Especificações de APIs > Padrões > Paginação.

pagination-key

string

length ≤ 2048

Identificador de rechamada, utilizado para evitar a contagem de chamadas ao endpoint durante a paginação.

fromTransactionDate

date

length ≤ 10

Data inicial de filtragem.

[Restrição] Deve obrigatoriamente ser enviado caso o campo toTransactionDate seja informado. Caso não seja informado, deve ser assumido o dia atual.

toTransactionDate

date

length ≤ 10

Data final de filtragem.

[Restrição] Deve obrigatoriamente ser enviado caso o campo fromTransactionDate seja informado. Caso não seja informado, deve ser assumido o dia atual.

Responses

Response body

object

data

array of objects

required

length ≥ 0

data*

object

type

string

required

Tipo de movimentação na visão de investimento

ENTRADA: APLICACAO, CANCELAMENTO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.
SAIDA: RESGATE, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS.

Por exemplo, para movimentação de CANCELAMENTO, tipicamente, será o type contrário ao evento originário. Ou seja, para cancelamento de APLICACAO, considera-se type SAIDA; para cancelamento de RESGATE, considera-se type ENTRADA.

ENTRADA SAIDA

transactionType

string

required

Aplicação, resgate, cancelamento, vencimento, pagamento de juros, amortização, transferência de titularidade, transferência de custódia e outros. Para movimentos de transferência (titularidade ou custódia) deve ser considerado o preço unitário (transactionUnitPrice) da aquisição do título.

APLICACAO RESGATE CANCELAMENTO VENCIMENTO PAGAMENTO_JUROS AMORTIZACAO TRANSFERENCIA_TITULARIDADE TRANSFERENCIA_CUSTODIA OUTROS

transactionTypeAdditionalInfo

string

length ≤ 100

Informação adicional do tipo de movimentação, para preenchimento no caso de movimentações não delimitadas no domínio.

[Restrição] Campo de preenchimento obrigatório pelas participantes quando houver 'Outros' no campo Motivo da movimentação.

transactionDate

date

required

length between 10 and 10

Data da movimentação.

transactionUnitPrice

object

required

Preço unitário bruto negociado na transação.

transactionQuantity

string

required

length ≤ 24

Quantidade de títulos envolvidos na movimentação.

transactionGrossValue

object

required

Valor bruto da transação (Preço unitário da movimentação x Quantidade).

incomeTax

object

Valor do imposto de renda recolhido na transação.

[Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'SAIDA'.

financialTransactionTax

object

Valor do IOF recolhido na transação.

[Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'SAIDA'.

transactionNetValue

object

required

Valor líquido da transação.

remunerationTransactionRate

string

length between 8 and 8

Taxa de remuneração da transação.

[Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'ENTRADA'.

indexerPercentage

string

length between 8 and 8

Percentual máximo do indexador acordado com o cliente na contratação.

[Restrição] Campo de preenchimento obrigatório pelas participantes quando o campo 'type' for preenchido com o valor 'ENTRADA'.

transactionId

string

required

length ≤ 100

Código ou identificador único prestado pela instituição que mantém a representação individual do movimento.

links

object

required

Referências para outros recusos da API requisitada.

self

uri

required

length ≤ 2000

URI completo que gerou a resposta atual.

first

uri

length ≤ 2000

URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta

uri

length ≤ 2000

URI da página anterior dessa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta

uri

length ≤ 2000

URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta

200Dados obtidos com sucesso.

defaultErro inesperado.