bloqueios transacionais

Serviço de Bloqueios Transacionais

Esta ferramenta permite gerenciar diferentes tipos de bloqueios por um período determinado:

  • Comércio: bloqueio por nome exato, ID ou código MCC.
  • País: bloqueio informando o código do país

Para cada tipo de bloqueio, você pode:

  • Bloquear por um mês (padrão) ou personalizar a duração
  • Gerenciar e monitorar os bloqueios ativos

Criar bloqueio

Este endpoint permite bloquear comércios informando o nome exato, ID ou código MCC. Também é possível bloquear países informando o código ISO 3166-1 alfa-3.

Você pode personalizar a duração do bloqueio ou usar o período padrão de um mês.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Header de restrição
Exemplo: Bearer {access_token}
Body Parameters
merchant_idstringrequired
ID do comércio
Exemplo: 123456799999
expiration_datestringrequired
Data de expiração do bloqueio.
Exemplo: 3000-01-01T13:40:23Z
Path Parameters
typestringrequired
Tipo de bloqueio
Enum: merchant_idmerchant_mccmerchantcountry
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/fraud/{type}/block
{
"merchant_id":
"123456799999"
"expiration_date":
"3000-01-01T13:40:23Z"
}
Respostas de amostra
{
"data":{
"message":
"BLOCKLIST applied successfully."
}
}

Atualizar bloqueio

Este endpoint permite modificar a duração de um bloqueio transacional.
Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Header de restrição
Exemplo: `Bearer {access_token}`
Body Parameters
merchant_idstringrequired
ID do comércio
Exemplo: 123456799999
expiration_datestringrequired
Data de expiração do bloqueio.
Exemplo: 3000-01-01T13:40:23Z
Path Parameters
typestringrequired
Tipo de bloqueio
Enum: merchant_idmerchant_mccmerchantcountry
Detalhe de respostas
dataobject

Esta seção foi útil para você?

PUT/fraud/{type}/block
{
"merchant_id":
"123456799999"
"expiration_date":
"3000-01-01T13:40:23Z"
}
Respostas de amostra
{
"data":{
"message":
"BLOCKLIST applied successfully."
}
}

Excluir bloqueio

Este endpoint permite excluir um bloqueio ativo usando seu identificador.
Parâmetros disponíveis
Path Parameters
typestringrequired
Tipo de bloqueio
Enum: merchant_idmerchant_mccmerchantcountry
identifierrequired
Identificador do bloqueio
Exemplo: `'FACEBOOK-MARKET*12345'`
Detalhe de respostas
dataobject

Esta seção foi útil para você?

DELETE/fraud/{type}/block/{identifier}
Respostas de amostra
{
"data":{
"message":
"BLOCKLIST deleted successfully."
}
}

Obtener estado de bloqueo

Este endpoint te permite revisar si existe un bloqueo activo usando su identificador.
Parâmetros disponíveis
Path Parameters
typestringrequired
Tipo de bloqueio
Enum: merchant_idmerchant_mccmerchantcountry
identifierrequired
Identificador do bloqueio
Exemplo: `'FACEBOOK-MARKET*12345'`
Detalhe de respostas
dataobject

Esta seção foi útil para você?

GET/fraud/{type}/block/{identifier}
Respostas de amostra
{
"data":{
"message":
"FACEBOOK*MARKET"
"applied_date":
"2021-01-01T12:00:00Z"
}
}

Obter lista de bloqueios

Este endpoint permite obter uma lista paginada de bloqueios transacionais ativos. O tipo de bloqueio é especificado na URL e pode ser:

  • Comércios: bloqueios por nome, ID ou MCC
  • Países: bloqueios por país

Considerações

Os resultados são exibidos de forma paginada para facilitar a visualização. Você pode controlar a paginação com os seguintes parâmetros:

  • page[number]: {Número da página a exibir (começa em 0)
  • page[size]: Quantidade de itens por página

Filtros disponíveis

Dependendo do tipo de bloqueio selecionado na URL, é possível utilizar os seguintes filtros:

  • Para bloqueios do tipo comércio:

    • filter[type]=id: Lista bloqueios por ID do comércio
    • filter[type]=mcc: Lista bloqueos por código MCC

  • Para bloqueios do tipo país:

    • filter[type]=code: Lista bloqueios por código do país (ISO 3166-1 alfa-3)

Exemplos

Para listar bloqueios de comércio por ID: GET /fraud/search/merchant/block?page[number]=0&page[size]=10&filter[type]=id

Para listar bloqueios por país: GET /fraud/search/country/block?page[number]=0&page[size]=10&filter[type]=code

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Query Parameters
page[size]number
Tamanho de página.
page[number]number
Número de página. O número da primeira página é 0.
Path Parameters
typestringrequired
Tipo de bloqueio
Enum: merchantmerchant_mccmerchant_idcountry
Detalhe de respostas
dataarray

Esta seção foi útil para você?

GET/fraud/search/{type}/block
Respostas de amostra
{
"data":[
0:{
...
}
]
}