Mastercard

Bem-vindo à documentação da API de Alerta de Chargeback da Mastercard.

Descrição

A API de Alerta de Chargeback da Mastercard envia notificações para que o cliente possa agir sobre transações em risco de se tornarem chargebacks. Após receber o alerta, o cliente tem até 24 horas para resolver ou estornar a transação e, em seguida, comunicar à nossa API o status da ação tomada.

---

Integração do Alerta de Notificação

Para integrar a API de Alerta de Chargeback, você deve criar um endpoint que será capaz de receber as notificações de chargebacks enviadas pela nossa API. Além disso, é possível configurar quais campos serão recebidos no alerta acessando Configurações -> Empresa dentro da plataforma.

Fluxo do Alerta:

1. Recebimento do Alerta: Nossa API enviará uma notificação para o seu endpoint sempre que uma transação estiver em risco de virar chargeback. Os campos recebidos podem ser configurados conforme sua necessidade.

2. Ação Necessária: Após receber o alerta, você tem até 24 horas para tratar ou estornar a transação.

3. Envio do Status: Depois de tomar a ação necessária, você deverá informar o resultado à nossa API, enviando o status da transação.

---

Configurando o Endpoint para Receber Alertas:

Você deve implementar um endpoint com as seguintes especificações para receber os alertas de chargeback da Mastercard:

• Método: POST

• URL: [A URL do seu endpoint deve ser configurada em Configurações -> Empresa dentro da plataforma]

• Headers:

  • Content-Type: application/json

  • ClientId: "ClientId" disponível em Configurações -> Empresa dentro da plataforma

  • ClientKey: "ClientKey" disponível em Configurações -> Empresa dentro da plataforma

Exemplo de Corpo da Requisição que você receberá:

Os campos a seguir são exemplos de dados que podem ser recebidos no alerta. A seleção de quais campos você receberá pode ser feita em Configurações -> Empresa dentro da plataforma:

{ 
     "AlertId": "MFX98K34SKSR34KRJD",
     "Merchant": "SITUSPAY",
     "MerchantDescriptor": "STSPAYELETRONICOS",
     "Source": "MASTERCARD",
     "TransactionType": "customerdispute_alert",
     "Arn": "14375959682088771139583",
     "CardNumber": "123456******1234",
     "ReceivedDate": "2023-09-01",
     "TransactionDate": "2023-08-23",
     "Amount": 46.24,
     "Currency": "BRL",
     "AuthCode": "948980",
     "Issuer": "BANCO DO BRASIL SA",
     "Country": "BRAZIL",
     "Origin": "national"
}

Descrição dos Campos que você receberá:

Nome	Tipo	Descrição	Pode ser vazio?
AlertId	string	Identificação única do alerta	Não
Merchant	string	Nome do merchant	Não
MerchantDescriptor	string	Descrição que aparece na fatura do cartão	Não
Source	string	Origem do alerta (ex: Mastercard)	Não
TransactionType	string	Tipo de transação (ex: customerdispute_alert)	Sim
Arn	string	Número de referência do adquirente	Sim
CardNumber	string	Número do cartão (parcialmente mascarado)	Não
ReceivedDate	string (yyyy-MM-dd)	Data do recebimento do alerta	Não
TransactionDate	string (yyyy-MM-dd)	Data da transação	Não
Amount	number	Valor da transação	Não
Currency	string	Moeda da transação (ex: BRL, EUR, USD, entre outras)	Não
AuthCode	string	Código de autorização	Sim
Issuer	string	Nome do emissor do cartão	Não
Country	string	País do emissor do cartão	Não
Origin	string	Usado para identificar se o alerta é nacional ou internacional (ex: national ou international)	Não

Nota: Esses são exemplos de campos que podem ser recebidos. A personalização dos campos é feita em Configurações -> Empresa dentro da plataforma.

---

Envio do Status da Ação Tomada

Após processar o alerta e tomar a devida ação (tratar ou estornar a transação), você deve informar o status à nossa API usando o endpoint fornecido por nós.

Fluxo do Envio do Status:

1. Tomada de Ação: Resolva ou estorne a transação de acordo com o alerta recebido.

2. Envio do Status: Envie a resposta informando o status da transação para o nosso endpoint.

---

Como enviar o Status da Ação:

• Método: POST

• URL: https://api.rapidchargeback.com/alerts/update-status/master

• Headers:

  • Content-Type: application/json

  • ClientId: "ClientId" disponível em Configurações -> Empresa dentro da plataforma

  • ClientKey: "ClientKey" disponível em Configurações -> Empresa dentro da plataforma

Exemplo de Corpo da Requisição para enviar o Status:

{ 
     "AlertId": "MFX98K34SKSR34KRJD",
     "Status": "ACCOUNT_SUSPENDED"
}

Descrição dos Atributos do Status:

Nome	Tipo	Descrição
AlertId	string	Identificação única do alerta
Status	string	Status informando a ação tomada

Status possíveis:

• ACCOUNT_SUSPENDED: Quando a transação foi resolvida.

• OTHER: Transação identificada, mas ainda não resolvida.

• NOTFOUND: Quando a transação não foi identificada.