Este método é responsável pela criação de novas operadoras
- Endpoint: /api/retaguarda/v2/Operadoras
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de Operadoras para que possam ser enviados vários na mesma requisição
Para que a baixa da Operadora criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 15 = Operadora
Requisição
Exemplo de body da requisição
[
{
"administradora": "string",
"codigoTef": "string",
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"situacao": 0,
"tipoTransacao": 0
}
]
Definições dos campos do body
Campo |
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 |
|
Retorno
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
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 |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
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 |
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
Exemplo de body da requisição
[
{
"administradora": "string",
"codigoTef": "string",
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"situacao": 0,
"tipoTransacao": 0
}
]
Definições dos campos do body
Campo |
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 |
|
||||||
| 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
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
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 |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
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 |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas