Bloquear um portador

Use este endpoint para bloquear um portador.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/portadores/bloqueios' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "idTipoBloqueio": 1, "idTitular": 2001, "idUsuario": 1, "observacao": "Obs" }'

{ "observacao": "Bloqueado", "observacaoDesbloqueio": "Teste", "dataBloqueio": "2024-02-26T17:17:20.478-03:00", "dataVencimentoTransicao": "2024-02-26T17:17:20.478-03:00", "idUsuario": 1, "temBloqueioAtrasoFatura": "N", "tipoBloqueioCliente": { "permitirTransferenciaCredito": "N", "encerrar": "N", "permitirAcessoApi": "N", "permitirVendaLimiteCredito": "N", "sistema": "N", "cancelaCliente": "N", "descricao": "BLOQUEADA", "moduloConvenio": "N", "zerarLimiteAtual": "N", "validarContaInclusaoCredito": "N", "resumo": "Bloqueada", "id": 1, "permitirAlterarLimite": "N", "persisted": true, "bloquearModuloCliente": "N", "transferirParaAdministradora": "N", "permitirAcessoAPP": "S" }, "usuarioDesbloqueio": 1, "idCliente": 13046, "liberado": "N", "vencimentoFatura": "2024-02-26T17:17:20.478-03:00", "statusImpressao": "N", "dataUltimaImpressao": "string", "dataDesbloqueio": "2024-02-26T17:17:20.478-03:00", "persisted": true, "id": 1, "modoBloqueio": "TESTE" }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Parâmetros Bodyapplication/json

opcional

One of

Processadora Cards

Processadora Dock

idTipoBloqueio

integer <int64>

opcional

Identificador do tipo de bloqueio.

Padrão:

Exemplo:

idTitular

integer <int64>

opcional

Identificador do titular.

Exemplo:

2001

idUsuario

integer <int64>

opcional

Identificador do usuário de bloqueio.

Padrão:

Exemplo:

observacao

string

opcional

Observações sobre o bloqueio.

Padrão:

Obs

Exemplo:

Observacao Teste

Examples

Respostas

🟢200OK

application/json

Body

opcional

One of

Processadora Cards

Processadora Dock

Response sobre bloqueio do portador pela processadora Cards.

observacao

string

opcional

Observação do bloqueio.

Exemplo:

Bloqueado

observacaoDesbloqueio

string

opcional

Observações sobre o desbloqueio.

Exemplo:

Teste

dataBloqueio

string

opcional

Data do bloqueio.

Exemplo:

2024-02-26T17:17:20.478-03:00

dataVencimentoTransicao

string

opcional

Data de vencimetno da transição.

Exemplo:

2024-02-26T17:17:20.478-03:00

idUsuario

integer

opcional

Identificador do usuário.

Exemplo:

temBloqueioAtrasoFatura

string

opcional

Indicador de bloqueio por atraso de fatura.

Exemplo:

tipoBloqueioCliente

object

opcional

Informações do tipo do bloqueio.

usuarioDesbloqueio

integer

opcional

Código de desbloqueio do usuário.

Exemplo:

idCliente

integer

opcional

Identificador do portador.

Exemplo:

13046

liberado

string

opcional

Liberado.

Exemplo:

vencimentoFatura

string

opcional

Data de vencimento da fatura.

Exemplo:

2024-02-26T17:17:20.478-03:00

statusImpressao

string

opcional

Status da impressão do cartão.

Exemplo:

dataUltimaImpressao

string

opcional

2024-02-26T17:17:20.478-03:00

dataDesbloqueio

string

opcional

Data de desbloqueio.

Exemplo:

2024-02-26T17:17:20.478-03:00

persisted

boolean

opcional

Persisted.

integer

opcional

Identificador.

Exemplo:

modoBloqueio

string

opcional

Modo de bloqueio do usuário.

Exemplo:

TESTE

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor