GET {folder}/Contratos/{token}/{colecao}?campo={campo}&orderBy={orderBy}&pageSize={pageSize}&pageNumber={pageNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

string

Required
colecao

integer

Default value is 0
campo

integer

Default value is 0
orderBy

integer

Default value is 0
pageSize

integer

Default value is 0
pageNumber

integer

Default value is 0
folder

string

None.

Body Parameters

None.

Response Information

Resource Description

RetornoContratos
NameDescriptionTypeAdditional information
Registros

Collection of Contratos

None.
TotalDeRegistros

integer

None.
ItensPorPagina

integer

None.
PaginaAtual

integer

None.
Totais

Dictionary of string [key] and Object [value]

None.
TotalDePaginas

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Registros": [
    {
      "dsChave": "sample string 1",
      "dtEnvio": "2025-12-06T01:58:19.5957731-03:00",
      "cdBanco": "sample string 2",
      "nmBanco": "sample string 3",
      "nrAgencia": "sample string 4",
      "nrConta": "sample string 5",
      "vlContrato": 6.0,
      "vlExecutado": 7.0,
      "dtVencimento": "2025-12-06T01:58:19.5967751-03:00",
      "flStatus": true,
      "dtUltimaAtualizacao": "2025-12-06T01:58:19.5967751-03:00",
      "dsTipoContrato": "sample string 9",
      "dsMetodoDivisao": "sample string 10",
      "nrCpfCnpjContrato": "sample string 11",
      "nmEmpresaContrato": "sample string 12",
      "listaURs": [
        {
          "nmCredenciadora": "sample string 1",
          "dsBandeira": "sample string 2",
          "vlExecutado": 3.0,
          "dtLiquidacao": "2025-12-06T01:58:19.5967751-03:00",
          "cdPrioridade": 4
        },
        {
          "nmCredenciadora": "sample string 1",
          "dsBandeira": "sample string 2",
          "vlExecutado": 3.0,
          "dtLiquidacao": "2025-12-06T01:58:19.5967751-03:00",
          "cdPrioridade": 4
        }
      ]
    },
    {
      "dsChave": "sample string 1",
      "dtEnvio": "2025-12-06T01:58:19.5957731-03:00",
      "cdBanco": "sample string 2",
      "nmBanco": "sample string 3",
      "nrAgencia": "sample string 4",
      "nrConta": "sample string 5",
      "vlContrato": 6.0,
      "vlExecutado": 7.0,
      "dtVencimento": "2025-12-06T01:58:19.5967751-03:00",
      "flStatus": true,
      "dtUltimaAtualizacao": "2025-12-06T01:58:19.5967751-03:00",
      "dsTipoContrato": "sample string 9",
      "dsMetodoDivisao": "sample string 10",
      "nrCpfCnpjContrato": "sample string 11",
      "nmEmpresaContrato": "sample string 12",
      "listaURs": [
        {
          "nmCredenciadora": "sample string 1",
          "dsBandeira": "sample string 2",
          "vlExecutado": 3.0,
          "dtLiquidacao": "2025-12-06T01:58:19.5967751-03:00",
          "cdPrioridade": 4
        },
        {
          "nmCredenciadora": "sample string 1",
          "dsBandeira": "sample string 2",
          "vlExecutado": 3.0,
          "dtLiquidacao": "2025-12-06T01:58:19.5967751-03:00",
          "cdPrioridade": 4
        }
      ]
    }
  ],
  "TotalDeRegistros": 1,
  "ItensPorPagina": 2,
  "PaginaAtual": 3,
  "Totais": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "TotalDePaginas": 4
}

application/xml, text/xml

Sample: 
<RetornoContratos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiAtosBank.Models.Object">
  <ItensPorPagina>2</ItensPorPagina>
  <PaginaAtual>3</PaginaAtual>
  <Registros xmlns:d2p1="http://schemas.datacontract.org/2004/07/ApiAtosBank.Models">
    <d2p1:Contratos>
      <d2p1:cdBanco>sample string 2</d2p1:cdBanco>
      <d2p1:dsChave>sample string 1</d2p1:dsChave>
      <d2p1:dsMetodoDivisao>sample string 10</d2p1:dsMetodoDivisao>
      <d2p1:dsTipoContrato>sample string 9</d2p1:dsTipoContrato>
      <d2p1:dtEnvio>2025-12-06T01:58:19.5957731-03:00</d2p1:dtEnvio>
      <d2p1:dtUltimaAtualizacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtUltimaAtualizacao>
      <d2p1:dtVencimento>2025-12-06T01:58:19.5967751-03:00</d2p1:dtVencimento>
      <d2p1:flStatus>true</d2p1:flStatus>
      <d2p1:listaURs>
        <d2p1:UnidadesRecebivel>
          <d2p1:cdPrioridade>4</d2p1:cdPrioridade>
          <d2p1:dsBandeira>sample string 2</d2p1:dsBandeira>
          <d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao>
          <d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora>
          <d2p1:vlExecutado>3</d2p1:vlExecutado>
        </d2p1:UnidadesRecebivel>
        <d2p1:UnidadesRecebivel>
          <d2p1:cdPrioridade>4</d2p1:cdPrioridade>
          <d2p1:dsBandeira>sample string 2</d2p1:dsBandeira>
          <d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao>
          <d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora>
          <d2p1:vlExecutado>3</d2p1:vlExecutado>
        </d2p1:UnidadesRecebivel>
      </d2p1:listaURs>
      <d2p1:nmBanco>sample string 3</d2p1:nmBanco>
      <d2p1:nmEmpresaContrato>sample string 12</d2p1:nmEmpresaContrato>
      <d2p1:nrAgencia>sample string 4</d2p1:nrAgencia>
      <d2p1:nrConta>sample string 5</d2p1:nrConta>
      <d2p1:nrCpfCnpjContrato>sample string 11</d2p1:nrCpfCnpjContrato>
      <d2p1:vlContrato>6</d2p1:vlContrato>
      <d2p1:vlExecutado>7</d2p1:vlExecutado>
    </d2p1:Contratos>
    <d2p1:Contratos>
      <d2p1:cdBanco>sample string 2</d2p1:cdBanco>
      <d2p1:dsChave>sample string 1</d2p1:dsChave>
      <d2p1:dsMetodoDivisao>sample string 10</d2p1:dsMetodoDivisao>
      <d2p1:dsTipoContrato>sample string 9</d2p1:dsTipoContrato>
      <d2p1:dtEnvio>2025-12-06T01:58:19.5957731-03:00</d2p1:dtEnvio>
      <d2p1:dtUltimaAtualizacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtUltimaAtualizacao>
      <d2p1:dtVencimento>2025-12-06T01:58:19.5967751-03:00</d2p1:dtVencimento>
      <d2p1:flStatus>true</d2p1:flStatus>
      <d2p1:listaURs>
        <d2p1:UnidadesRecebivel>
          <d2p1:cdPrioridade>4</d2p1:cdPrioridade>
          <d2p1:dsBandeira>sample string 2</d2p1:dsBandeira>
          <d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao>
          <d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora>
          <d2p1:vlExecutado>3</d2p1:vlExecutado>
        </d2p1:UnidadesRecebivel>
        <d2p1:UnidadesRecebivel>
          <d2p1:cdPrioridade>4</d2p1:cdPrioridade>
          <d2p1:dsBandeira>sample string 2</d2p1:dsBandeira>
          <d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao>
          <d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora>
          <d2p1:vlExecutado>3</d2p1:vlExecutado>
        </d2p1:UnidadesRecebivel>
      </d2p1:listaURs>
      <d2p1:nmBanco>sample string 3</d2p1:nmBanco>
      <d2p1:nmEmpresaContrato>sample string 12</d2p1:nmEmpresaContrato>
      <d2p1:nrAgencia>sample string 4</d2p1:nrAgencia>
      <d2p1:nrConta>sample string 5</d2p1:nrConta>
      <d2p1:nrCpfCnpjContrato>sample string 11</d2p1:nrCpfCnpjContrato>
      <d2p1:vlContrato>6</d2p1:vlContrato>
      <d2p1:vlExecutado>7</d2p1:vlExecutado>
    </d2p1:Contratos>
  </Registros>
  <Totais xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Totais>
  <TotalDePaginas>4</TotalDePaginas>
  <TotalDeRegistros>1</TotalDeRegistros>
</RetornoContratos>

multipart/form-data

Sample: 
<RetornoContratos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiAtosBank.Models.Object"><ItensPorPagina>2</ItensPorPagina><PaginaAtual>3</PaginaAtual><Registros xmlns:d2p1="http://schemas.datacontract.org/2004/07/ApiAtosBank.Models"><d2p1:Contratos><d2p1:cdBanco>sample string 2</d2p1:cdBanco><d2p1:dsChave>sample string 1</d2p1:dsChave><d2p1:dsMetodoDivisao>sample string 10</d2p1:dsMetodoDivisao><d2p1:dsTipoContrato>sample string 9</d2p1:dsTipoContrato><d2p1:dtEnvio>2025-12-06T01:58:19.5957731-03:00</d2p1:dtEnvio><d2p1:dtUltimaAtualizacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtUltimaAtualizacao><d2p1:dtVencimento>2025-12-06T01:58:19.5967751-03:00</d2p1:dtVencimento><d2p1:flStatus>true</d2p1:flStatus><d2p1:listaURs><d2p1:UnidadesRecebivel><d2p1:cdPrioridade>4</d2p1:cdPrioridade><d2p1:dsBandeira>sample string 2</d2p1:dsBandeira><d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao><d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora><d2p1:vlExecutado>3</d2p1:vlExecutado></d2p1:UnidadesRecebivel><d2p1:UnidadesRecebivel><d2p1:cdPrioridade>4</d2p1:cdPrioridade><d2p1:dsBandeira>sample string 2</d2p1:dsBandeira><d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao><d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora><d2p1:vlExecutado>3</d2p1:vlExecutado></d2p1:UnidadesRecebivel></d2p1:listaURs><d2p1:nmBanco>sample string 3</d2p1:nmBanco><d2p1:nmEmpresaContrato>sample string 12</d2p1:nmEmpresaContrato><d2p1:nrAgencia>sample string 4</d2p1:nrAgencia><d2p1:nrConta>sample string 5</d2p1:nrConta><d2p1:nrCpfCnpjContrato>sample string 11</d2p1:nrCpfCnpjContrato><d2p1:vlContrato>6</d2p1:vlContrato><d2p1:vlExecutado>7</d2p1:vlExecutado></d2p1:Contratos><d2p1:Contratos><d2p1:cdBanco>sample string 2</d2p1:cdBanco><d2p1:dsChave>sample string 1</d2p1:dsChave><d2p1:dsMetodoDivisao>sample string 10</d2p1:dsMetodoDivisao><d2p1:dsTipoContrato>sample string 9</d2p1:dsTipoContrato><d2p1:dtEnvio>2025-12-06T01:58:19.5957731-03:00</d2p1:dtEnvio><d2p1:dtUltimaAtualizacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtUltimaAtualizacao><d2p1:dtVencimento>2025-12-06T01:58:19.5967751-03:00</d2p1:dtVencimento><d2p1:flStatus>true</d2p1:flStatus><d2p1:listaURs><d2p1:UnidadesRecebivel><d2p1:cdPrioridade>4</d2p1:cdPrioridade><d2p1:dsBandeira>sample string 2</d2p1:dsBandeira><d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao><d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora><d2p1:vlExecutado>3</d2p1:vlExecutado></d2p1:UnidadesRecebivel><d2p1:UnidadesRecebivel><d2p1:cdPrioridade>4</d2p1:cdPrioridade><d2p1:dsBandeira>sample string 2</d2p1:dsBandeira><d2p1:dtLiquidacao>2025-12-06T01:58:19.5967751-03:00</d2p1:dtLiquidacao><d2p1:nmCredenciadora>sample string 1</d2p1:nmCredenciadora><d2p1:vlExecutado>3</d2p1:vlExecutado></d2p1:UnidadesRecebivel></d2p1:listaURs><d2p1:nmBanco>sample string 3</d2p1:nmBanco><d2p1:nmEmpresaContrato>sample string 12</d2p1:nmEmpresaContrato><d2p1:nrAgencia>sample string 4</d2p1:nrAgencia><d2p1:nrConta>sample string 5</d2p1:nrConta><d2p1:nrCpfCnpjContrato>sample string 11</d2p1:nrCpfCnpjContrato><d2p1:vlContrato>6</d2p1:vlContrato><d2p1:vlExecutado>7</d2p1:vlExecutado></d2p1:Contratos></Registros><Totais xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:KeyValueOfstringanyType><d2p1:Key>sample string 1</d2p1:Key><d2p1:Value /></d2p1:KeyValueOfstringanyType><d2p1:KeyValueOfstringanyType><d2p1:Key>sample string 3</d2p1:Key><d2p1:Value /></d2p1:KeyValueOfstringanyType></Totais><TotalDePaginas>4</TotalDePaginas><TotalDeRegistros>1</TotalDeRegistros></RetornoContratos>