Card |
---|
| Requisição Section |
---|
Column |
---|
| Exemplo de body da requisição[ { "administradora": "string", "codigoTef": "string", "descricao": "string", "idInquilino": "string", "idProprietario": "string", "idRetaguarda": "string", "loteOrigem": "string", "situacao": 0, "tipoTransacao": 0 } ] |
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
descricao | String | Descrição da operadora de pagamento | Sim | Tamanho máximo: 100 caracteres | administradora | String | Administradora da operadora de pagamento | Sim | Tamanho máximo: 100 caracteres | codigoTef | String | Código Tef da operadora de pagamento | Sim | Tamanho máximo: 30 caracteres | idInquilino | String | Identificador do inquilin | Sim |
| idProprietario | String | Identificador do proprietário | Sim |
| idRetaguarda | String | Identificador da operadora na retaguarda | Sim |
| loteOrigem | String | Identificador do lote em que serão enviados os dados | Sim |
| situacao | Int | Situação da operadora | Não | 0 - Inativo, 1 - Ativo Caso não enviado será cadastrado como 0 | tipoTransacao | Int | Tipo de transação (Descrição abaixo) | Não | Código | Tipo |
---|
0 | Credito | 1 | Debito |
|
|
|
Retorno Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
|
Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
Card |
---|
| Informações |
---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição Section |
---|
Column |
---|
| Exemplo de body da requisição[ { "administradora": "string", "codigoTef": "string", "descricao": "string", "idInquilino": "string", "idProprietario": "string", "idRetaguarda": "string", "loteOrigem": "string", "situacao": 0, "tipoTransacao": 0 } ] |
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
descricao | String | Descrição da operadora de pagamento | Sim | Tamanho máximo: 100 caracteres | situacao | Int | Situação da operadora (0 - Inativo, 1 - Ativo) | Sim | 0 - Inativo, 1 - Ativo | codigoTef | String | Código Tef da operadora de pagamento | Não | Tamanho máximo: 30 caracteres | administradora | String | Administradora da operadora de pagamento | Não | Tamanho máximo: 100 caracteres | tipoTransacao | Int | Tipo de transação
| Sim | Código | Tipo |
---|
0 | Credito | 1 | Debito |
| idInquilino | String | Identificador do inquilin | Sim |
| idRetaguarda | String | Identificador da operadora na retaguarda | Sim | Tamanho máximo: 100 caracteres | idProprietario | String | Identificador do proprietário | Sim |
| loteOrigem | String | Identificador do lote em que serão enviados os dados | Sim |
|
|
|
Retornos Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
|
Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|