POST api/RegistraCliente
Request Information
URI Parameters
None.
Body Parameters
RegistraClienteRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Pessoa | string |
Required Matching regular expression pattern: ^[FJ]$ Max length: 1 |
|
| CPFCNPJ | string |
Required Max length: 19 |
|
| Nome | string |
Required Max length: 255 |
|
| RazaoSocial | string |
Required Max length: 255 |
|
| Titularidade | string |
Required Max length: 255 |
|
| NomeCurto | string |
Required Max length: 50 |
|
| string |
Required Max length: 255 |
||
| Telefone | string |
Required Max length: 32 |
|
| Cep | string |
Required Max length: 8 |
|
| Logradouro | string |
Required Max length: 100 |
|
| Complemento | string |
Max length: 100 |
|
| Numero | string |
Required Max length: 20 |
|
| Bairro | string |
Required Max length: 100 |
|
| Cidade | string |
Required Max length: 100 |
|
| UF | string |
Required Max length: 2 |
|
| ProvedorPagamentoBoleto | string |
None. |
|
| ProvedorPagamentoCartao | string |
None. |
|
| ProvedorPagamentoPix | string |
None. |
|
| Parametros | Collection of ProvedorParametro |
None. |
|
| NomeUsuario | string |
Required Max length: 255 |
|
| LoginUsuario | string |
Required Max length: 32 |
|
| SenhaUsuario | string |
Required Max length: 32 |
|
| EmailUsuario | string |
Required Max length: 255 |
|
| CriarAcessoCobrancas | boolean |
None. |
|
| CriarAcessoPagamentos | boolean |
None. |
|
| ClienteAtivo | boolean |
None. |
|
| UsuarioAtivo | boolean |
None. |
|
| ModalidadeSistemaCobrancas | ModalidadeSistemaCobrancas |
None. |
|
| TipoInterno | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Pessoa": "sample string 1",
"CPFCNPJ": "sample string 2",
"Nome": "sample string 3",
"RazaoSocial": "sample string 4",
"Titularidade": "sample string 5",
"NomeCurto": "sample string 6",
"Email": "sample string 7",
"Telefone": "sample string 8",
"Cep": "sample string 9",
"Logradouro": "sample string 10",
"Complemento": "sample string 11",
"Numero": "sample string 12",
"Bairro": "sample string 13",
"Cidade": "sample string 14",
"UF": "sample string 15",
"ProvedorPagamentoBoleto": "sample string 16",
"ProvedorPagamentoCartao": "sample string 17",
"ProvedorPagamentoPix": "sample string 18",
"Parametros": [
{
"Nome": "sample string 1",
"Valor": "sample string 2"
},
{
"Nome": "sample string 1",
"Valor": "sample string 2"
}
],
"NomeUsuario": "sample string 19",
"LoginUsuario": "sample string 20",
"SenhaUsuario": "sample string 21",
"EmailUsuario": "sample string 22",
"CriarAcessoCobrancas": true,
"CriarAcessoPagamentos": true,
"ClienteAtivo": true,
"UsuarioAtivo": true,
"ModalidadeSistemaCobrancas": "ContaCliente",
"TipoInterno": 27
}
application/xml, text/xml
Sample:
<RegistraClienteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BknBankCobrancasAdminAPI.Controllers">
<Bairro>sample string 13</Bairro>
<CPFCNPJ>sample string 2</CPFCNPJ>
<Cep>sample string 9</Cep>
<Cidade>sample string 14</Cidade>
<ClienteAtivo>true</ClienteAtivo>
<Complemento>sample string 11</Complemento>
<CriarAcessoCobrancas>true</CriarAcessoCobrancas>
<CriarAcessoPagamentos>true</CriarAcessoPagamentos>
<Email>sample string 7</Email>
<EmailUsuario>sample string 22</EmailUsuario>
<LoginUsuario>sample string 20</LoginUsuario>
<Logradouro>sample string 10</Logradouro>
<ModalidadeSistemaCobrancas>ContaCliente</ModalidadeSistemaCobrancas>
<Nome>sample string 3</Nome>
<NomeCurto>sample string 6</NomeCurto>
<NomeUsuario>sample string 19</NomeUsuario>
<Numero>sample string 12</Numero>
<Parametros>
<ProvedorParametro>
<Nome>sample string 1</Nome>
<Valor>sample string 2</Valor>
</ProvedorParametro>
<ProvedorParametro>
<Nome>sample string 1</Nome>
<Valor>sample string 2</Valor>
</ProvedorParametro>
</Parametros>
<Pessoa>sample string 1</Pessoa>
<ProvedorPagamentoBoleto>sample string 16</ProvedorPagamentoBoleto>
<ProvedorPagamentoCartao>sample string 17</ProvedorPagamentoCartao>
<ProvedorPagamentoPix>sample string 18</ProvedorPagamentoPix>
<RazaoSocial>sample string 4</RazaoSocial>
<SenhaUsuario>sample string 21</SenhaUsuario>
<Telefone>sample string 8</Telefone>
<TipoInterno>27</TipoInterno>
<Titularidade>sample string 5</Titularidade>
<UF>sample string 15</UF>
<UsuarioAtivo>true</UsuarioAtivo>
</RegistraClienteRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.