Visão Geral
Risk Notification API foi desenvolvida pelo time de Risco da Braspag para os que clientes possam consultar alertas de fraudes, chargebacks, realizar envio de arquivos para contestação de chargebacks e acatar chargebacks.
A API é baseada em arquitetura REST, que trocam dados em formato JSON seguindo fluxos de autorização definidos pelo protocolo OAuth 2, onde todos os padrões são amplamente utilizados pelo mercado e suportado pelas comunidades técnicas.
Para saber mais sobre OAuth 2, consulte https://oauth.net/2/
Objetivo
O objetivo desta documentação é orientar o desenvolvedor sobre como integrar com a Risk Notification API, descrevendo as operações disponíveis com exemplos de requisições e respostas.
Para executar uma operação, combine o endpoint base do ambiente com o endpoint da operação desejada e envie utilizando o VERBO HTTP conforme descrito na operação.
Hosts
BraspagAuth API
Ambiente | URL |
---|---|
Sandbox |
https://authsandbox.braspag.com.br/ |
Produção |
https://auth.braspag.com.br/ |
Risk Notification API
Ambiente | URL |
---|---|
Sandbox |
https://risknotificationsandbox.braspag.com.br/ |
Produção |
https://risknotification.braspag.com.br/ |
Autenticação
Tokens de Acesso
A Risk Notification API utiliza o protocolo padrão de mercado OAuth 2.0 para autorização de acesso a seus recursos específicos por ambientes, que são: Sandbox e Produção.
Esta sessão descreve o fluxo necessário para que aplicações cliente obtenham tokens de acesso válidos para uso na API.
Obtenção do token de acesso
O token de acesso é obtido através do fluxo oauth client_credentials. O diagrama abaixo, ilustra, em ordem cronológica, a comunicação que se dá entre a Aplicação Cliente, a API BraspagAuth e a Risk Notification API.
-
A Aplicação Cliente, informa à API BraspagAuth sua credencial.
-
O BraspagAuth valida a credencial recebida. Se for válida, retorna o token de acesso para a Aplicação Cliente.
-
A Aplicação Cliente informa o token de acesso no cabeçalho das requisições HTTP feitas à Risk Notification API.
-
Se o token de acesso for válido, a requisição é processada e os dados são retornados para a Aplicação Cliente.
Solicite uma credencial abrindo um ticket através da nossa ferramenta de suporte, enviando o(s) IP(s) de saída dos seus servidores de homologação e produção. Suporte Braspag
Como obter o token
Uma vez em posse da credencial, será necessário “codificá-la” em Base64, utilizando a convenção client_id:client_secret, e enviar o resultado no cabeçalho através do campo Authorization.
Exemplo:
- client_id: braspagtestes
- client_secret: 1q2w3e4r5t6y7u8i9o0p0q9w8e7r6t5y4u3i2o1p
- String a ser codificada em Base64: braspagtestes:1q2w3e4r5t6y7u8i9o0p0q9w8e7r6t5y4u3i2o1p
- Resultado após a codificação: YnJhc3BhZ3Rlc3RlczoxcTJ3M2U0cg==
Request
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/x-www-form-urlencoded |
Authorization |
Basic YnJhc3BhZ3Rlc3RlczoxcTJ3M2U0cg== |
Parâmetros no corpo (Body)
Key | Value |
---|---|
scope |
Chargeback |
grant_type |
client_credentials |
Response
{
"access_token": "faSYkjfiod8ddJxFTU3vti_ ... _xD0i0jqcw",
"token_type": "bearer",
"expires_in": 599
}
Parâmetros no corpo (Body)
Parâmetro | Descrição |
---|---|
access_token |
O token de acesso solicitado. O aplicativo pode usar esse token para se autenticar no recurso protegido, no caso a Risk Notification API |
token_type |
Indica o valor do tipo de token |
expires_in |
Expiração do o token de acesso, em segundos O token quando expirar, é necessário obter um novo |
Simulando Chargeback
Através desta opção será possível você criar chargeback para as transações apenas no ambiente de sandbox. Para isso, realizar um POST de acordo com as orientações abaixo.
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
condicional |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
condicional |
{
"ChargebackBrandGroups": [{
"Brand": "Visa",
"Details": [{
"Acquirer": "Cielo",
"AcquirerCaseNumber": "2020052301",
"AcquirerTransactionId": "0523103051968",
"Amount": 100,
"AuthorizationCode": "433946",
"CardHolder": "Teste Holder",
"EstablishmentCode": "TestAffiliation",
"MaskedCardNumber": "402400******2931",
"ReasonCode": "101",
"ReasonMessage": "Responsabilidade EMV - Falsifcação",
"SaleDate": "2020-05-23",
"TransactionAmount": 100,
"ProofOfSale": "3051968"
}]
},
{
"Brand": "Master",
"Details": [{
"Acquirer": "Cielo",
"AcquirerCaseNumber": "2020052302",
"AcquirerTransactionId": "0523103114691",
"Amount": 100,
"AuthorizationCode": "722134",
"CardHolder": "Teste Holder",
"EstablishmentCode": "TestAffiliation",
"MaskedCardNumber": "402400******2931",
"ReasonCode": "101",
"ReasonMessage": "Responsabilidade EMV - Falsifcação",
"SaleDate": "2020-05-23",
"TransactionAmount": 100,
"ProofOfSale": "3114691"
}]
}]
}
Parâmetro | Descrição | Tipo | Obrigatório | Tamanho |
---|---|---|---|---|
ChargebackBrandGroups[n].Brand |
Nome da bandeira Informar o mesmo valor informado no campo Payment.CreditCard.Brand na criação da transação |
string | sim | 32 |
ChargebackBrandGroups[n].Details[n].Acquirer |
Nome da adquirente Enviar fixo Cielo |
string | sim | 16 |
ChargebackBrandGroups[n].Details[n].AcquirerCaseNumber |
Número do caso do chargeback Este valor será usado para realizar as operações de Aceitação e Contestação |
string | sim | 10 |
ChargebackBrandGroups[n].Details[n].AcquirerTransactionId |
Id da transação na adquirente Se transação criada a partir do Pagador Braspag, informar o mesmo valor recebido no campo Payment.AcquirerTransactionId do response Se transação criada a partir da API Cielo 3.0 ou API Split Braspag, informar o mesmo valor recebido no campo Payment.Tid do response |
string | sim | 20 |
ChargebackBrandGroups[n].Details[n].Amount |
Valor do chargeback em centavos Ex: 123456 = r$ 1.234,56 |
long | sim | - |
ChargebackBrandGroups[n].Details[n].AuthorizationCode |
Código de autorização da transação na adquirente Informar o mesmo valor recebido no campo Payment.AuthorizationCode do response da criação da transação |
string | sim | 8 |
ChargebackBrandGroups[n].Details[n].CardHolder |
Nome do portador do cartão Informar o mesmo valor informado no campo Payment.CrediCard.Holder na criação da transação Em produção, este campo pode estar vazio ou contendo outra informação diferente da do nome do portador |
string | não | 100 |
ChargebackBrandGroups[n].Details[n].EstablishmentCode |
Número do estabelecimento ou código de afiliação Informar o mesmo valor informado no campo Payment.Credentials.Code na criação da transação |
string | sim | 10 |
ChargebackBrandGroups[n].Details[n].MaskedCardNumber |
Cartão mascarado Informar o mesmo valor recebido no campo Payment.CreditCard.Number do response da criação da transação |
string | sim | 16 |
ChargebackBrandGroups[n].Details[n].ReasonCode |
Código do motivo do chargeback Informar o código de acordo - Tabela 7 - ReasonCode e ReasonMessage |
string | sim | 5 |
ChargebackBrandGroups[n].Details[n].ReasonMessage |
Mensagem do motivo do chargeback Informar a mensagem de acordo - Tabela 7 - ReasonCode e ReasonMessage |
string | sim | 128 |
ChargebackBrandGroups[n].Details[n].SaleDate |
Data de autorização da transação Formato: YYYY-MM-DD |
date | sim | 10 |
ChargebackBrandGroups[n].Details[n].TransactionAmount |
Valor da transação em centavos Informar o mesmo valor informado no campo Payment.Amount na criação da transação Ex: 123456 = r$ 1.234,56 |
long | sim | - |
ChargebackBrandGroups[n].Details[n].ProofOfSale |
Comprovante de venda ou NSU Informar o mesmo valor recebido no campo Payment.ProofOfSale do response da criação da transação |
string | sim | 20 |
Response
Key | Value |
---|---|
Content-Type |
application/json |
Status |
200 OK |
Aceitação
Aceitando um chargeback
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
condicional |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
condicional |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso relacionado ao chargeback | sim |
Response
{
"CaseNumber": "000001",
"Status": 2,
"StatusDescription": "AcceptedByMerchant"
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
200 OK |
Parâmetros no body (Corpo)
Key | Value |
---|---|
CaseNumber |
Número do caso do chargeback |
Status |
Status do chargeback - Tabela 3 - Chargebacks{n}.Status |
StatusDescription |
Descrição do status do chargeback |
Aceitando um chargeback inexistente
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
condicional |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
condicional |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Response
{
"Code": "ChargebackNotFounded",
"Message": "Chargeback not found"
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
404 Not Found |
Parâmetros no body (Corpo)
Key | Value |
---|---|
Code |
Código que o chargeback não foi encontrado |
Message |
Mensagem que o chargeback não foi encontrado |
Aceitando um chargeback aceito anteriormente
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso relacionado ao chargeback | sim |
Response
{
"Code": "ChargebackAlreadyUpdated",
"Message": "Chargeback already updated"
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
400 Bad Request |
Parâmetros no body (Corpo)
Key | Value |
---|---|
Code |
Código que o chargeback foi aceito ou contestado anteriomente |
Message |
Mensagem que o chargeback foi aceito ou contestado anteriormente |
Contestação
Contestando um chargeback
{
"Files":
[{
"FileName": "file1.png",
"Content": "asdfghjkle ********** lkjhgfdsa"
},
{
"FileName": "file2.jpg",
"Content": "zxcvbnmasd ********** qwertyuio"
},
{
"FileName": "file3.jpg",
"Content": "qwertyuiop ********** asdfghjkl"
}]
}
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Parâmetros no corpo (Body)
Parâmetro | Descrição | Tipo | Obrigatório | Tamanho |
---|---|---|---|---|
Files[n].FileName |
Nome do arquivo com extensão Obs.: Extensões permitidas: png, jpg ou jpeg Obs2.: A soma de todos arquivos deve ter no máximo 7mb de tamanho Obs3.: O prazo para realizar a contestação são de 7 dias corridos, ou seja, chargeback de 13/02/2019 é possível enviar a realizar a mesma até 19/02/2019 |
string | sim | 100 |
Files[n].Content |
Conteúdo do arquivo em base64 | string | sim | - |
Response
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
200 OK |
Contestando um chargeback inexistente
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Response
{
"Code": "ChargebackNotFounded",
"Message": "Chargeback not found"
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
404 Not Found |
Parâmetros no body (Corpo)
Key | Value |
---|---|
Code |
Código que o chargeback não foi encontrado |
Message |
Mensagem que o chargeback não foi encontrado |
Contestando um chargeback contestado anteriormente
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Response
{
"Code": "ChargebackAlreadyUpdated",
"Message": "Chargeback already updated"
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
400 Bad Request |
Parâmetros no body (Corpo)
Key | Value |
---|---|
Code |
Código que o chargeback foi contestado ou aceito anteriomente |
Message |
Mensagem que o chargeback foi contestado ou aceito anteriormente |
Contestando um chargeback e não enviando o arquivo de contestação
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Response
{
"Message": "The request is invalid.",
"ModelState": {
"contestationRequest.Files[0].FileName": [
"FileName can not be null or empty."
],
"contestationRequest.Files[0].Content": [
"Content can not be null or empty."
]}
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
400 Bad Request |
Parâmetros no body (Corpo)
Parâmetro | Descrição |
---|---|
Message |
Mensagem informando que a requisição é inválida |
Message.ModelState.ContestationRequest.Files[n].FileName |
Mensagem informando que o nome do arquivo não foi enviado |
Message.ModelState.ContestationRequest.Files[n].Content |
Mensagem informando que o conteúdo do arquivo não foi enviado |
Contestando um chargeback enviando o arquivo de contestação com extensão diferente de jpeg, pfg ou png
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Response
{
"Message": "The request is invalid.",
"ModelState": {
"contestationRequest.Files[0].FileName": [
"The file extension must be sent. The accepted extensions are: '.png', '.jpg', '.jpeg'"
]}
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
400 Bad Request |
Parâmetros no body (Corpo)
Parâmetro | Descrição |
---|---|
Message |
Mensagem informando que a requisição é inválida |
Message.ModelState.ContestationRequest.Files[n].FileName |
Mensagem informando que o arquivo foi enviado com a extensão inválida |
Contestando um chargeback enviando arquivo(s) para contestação com tamanho maior que 7mb
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Response
{
"Message": "File(s) file1.png, file2.png has length bigger than the size limit of 7MB."
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
400 Bad Request |
Parâmetros no body (Corpo)
Parâmetro | Descrição |
---|---|
Message |
Mensagem informando qual(is) arquivo(s) possuem tamanho superior a 7mb |
Contestando um chargeback enviando arquivos e a soma do tamanho de todos é maior que 7mb
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
EstablishmentCode |
xxxxxxxxxx | Número do estabelecimento ou afiliação na adquirente Obs.: Caso esta Key não seja enviada, obrigatoriamente a MerchantId deverá ser enviada |
sim |
MerchantId |
mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm | Id da loja na Braspag Obs.: Caso esta Key não seja enviada, obrigatoriamente a EstablishmentCode deverá ser enviada |
sim |
Parâmetros na rota
Parâmetro | Descrição | Obrigatório |
---|---|---|
CaseNumber |
Número do caso do chargeback | sim |
Response
{
"Message": "Files has length bigger than the size limit of 7MB.",
}
Parâmetros no cabeçalho (Header)
Key | Value |
---|---|
Content-Type |
application/json |
Status |
400 Bad Request |
Parâmetros no body (Corpo)
Parâmetro | Descrição |
---|---|
Message |
Mensagem informando que todos os arquivos enviados somando seus tamanhos é superior a 7mb |
Consultas
Request
Parâmetros no cabeçalho (Header)
Key | Value | Descrição | Obrigatório |
---|---|---|---|
Content-Type |
application/json | Tipo do conteúdo da requisição | sim |
Authorization |
Bearer {access_token} | Tipo da autorização | sim |
Parâmetros na querystring
Parâmetro | Descrição | Obrigatório |
---|---|---|
StartDate |
Data início da consulta | sim |
EndDate |
Data fim da consulta | sim |
PageIndex |
Número da página desejada | sim |
PageSize |
Quantidade de itens desejado na página. Máximo 250 itens. | sim |
MerchantIds |
Id(s) da(s) loja(s) a ser utilizado na consulta Obs.: Caso não seja enviado, a consulta será realizada levando em consideração o(s) MerchantId(s) associado(s) ao ClientId |
não |
EstablishmentCodes |
Número(s) do(s) estabelecimento(s) ou afiliação(ões) na adquirente a ser utilizado na consulta Obs.: Caso não seja enviado, a consulta será realizada levando em consideração o(s) número(s) do(s) estabelecimento(s) ou afiliação(ões) na adquirente associado(s) ao ClientId |
não |
CaseNumber |
Número do caso do chargeback | não |
AcquirerTransactionId |
Identificador da transação na adquirente (TID) | não |
BraspagTransactionId |
Id da transação na plataforma Pagador Braspag ou Cielo 3.0 (PaymentId) | não |
Response
{
"PageIndex": 1,
"PageSize": 250,
"Total": 500,
"Chargebacks":
[
{
"Id": "fd14e3fb-cf2a-4228-b690-1338660afc54",
"CreatedDate": "2018-09-01 09:51:25",
"Date": "2018-08-30",
"CaseNumber": "000001",
"Amount": 10000,
"ReasonCode": "28",
"ReasonMessage": "Consumidor nao reconhece a compra",
"Status": "Received",
"Comment": "Cliente enviou documentos inválidos",
"IsFraud": true,
"Transaction":
{
"AcquirerType": "Cielo",
"EstablishmentCode": "1234567890",
"MerchantOrderId": "abc123efg",
"Tid": "1234567890BA2018XPTO",
"Nsu": "258654",
"AuthorizationCode": "T85245",
"SaleDate": "2018-08-15",
"PagadorMerchantId": "a1052460-92b2-49c3-a929-fc985df0ba2f",
"BraspagTransactionId": "bb33b5c5-82fe-4254-9f1d-b9c97297b0d5",
"Amount": 10000,
"RawData": "JOAO D COUVES",
"MaskedCardNumber": "453906******8385",
"Brand": "Visa",
"AntifraudMerchantId": "4b1b017a-a8b5-4e83-ae36-19c69f11845e",
"AntifraudTransactionId": "9f6ec028-b55d-4605-b655-164ce62aeaef",
"AntifraudSourceApplication": "Gateway",
"ProviderTransactionId": "5446494501496896403073",
"NegativeValues": [
"CustomerDocumentNumber",
"ShippingStreet"
],
"ProviderChargebackMarkingEvent": {
"Id": "5446495589216876903021",
"Status": "ACCEPT",
"Code": "100",
}
}
}
]
}
Parâmetro | Descrição | Tipo |
---|---|---|
Id |
Id do chargeback na Chargeback API Braspag | guid |
CreatedDate |
Data de criação do chargeback na Chargeback API Braspag Ex.: 2018-09-01 09:51:25 |
date |
Date |
Data do chargeback Ex.: 2018-08-30 |
date |
CaseNumber |
Número do caso relacionado ao chargeback | string |
Amount |
Valor do chargeback em centavos Ex: 123456 = r$ 1.234,56 |
long |
ReasonCode |
Código do motivo do chargeback - Tabela 7 - ReasonCode e ReasonMessage | string |
ReasonMessage |
Descrição do motivo do chargeback - Tabela 7 - ReasonCode e ReasonMessage | string |
Status |
Status do chargegback na Braspag - Tabela 3 - Chargebacks{n}.Status | string |
Comment |
Comentário que deseja associar ao chargeback e que ficará visível no Backoffice Braspag Se chargeback de transação Cybersource, este comentário ficará visível no backoffice da Cybersource |
string |
IsFraud |
Identifica se o chargeback é de fraude | bool |
Transaction.AcquirerType |
Identificador da adquirentre | string |
Transaction.EstablishmentCode |
Número do estabelecimento ou afiliação na adquirente | string |
Transaction.MerchantOrderId |
Número do pedido da loja | string |
Transaction.Tid |
Id da transação na adquirente | string |
Transaction.Nsu |
Número sequencial único da transação na adquirente | string |
Transaction.AuthorizationCode |
Código de autorização da transação na adquirente | string |
Transaction.SaleDate |
Data da autorização da transação na adquirente Ex.: 2018-08-15 |
date |
Transaction.PagadorMerchantId |
Identificador da loja na plataforma Pagador Braspag ou Cielo 3.0 | guid |
Transaction.BraspagTransactionId |
Id da transação na plataforma Pagador Braspag ou Cielo 3.0 (PaymentId) | guid |
Transaction.Amount |
Valor da transação em centavos Ex: 123456 = r$ 1.234,56 |
long |
Transaction.RawData |
Dado enviado pela adquirente, podendo ser o titular do cartão ou outra mensagem | string |
Transaction.MaskedCardNumber |
Número do cartão de crédito mascarado | string |
Transaction.Brand |
Bandeira do cartão de crédito | string |
Transaction.AntifraudMerchantId |
Identificador da loja na plataforma Antifraude Legado ou Antifraude Gateway | guid |
Transaction.AntifraudTransactionId |
Identificador da transação na plataforma Antifraude Legado ou Antifraude Gateway | guid |
Transaction.AntifraudSourceApplication |
Origem da plataforma de antifraude - Tabela 6 - Chargebacks{n}.Transaction.AntifraudSourceApplication | string |
Transaction.ProviderTransactionId |
Id da transação no provedor de antifraude | |
Transaction.NegativeValues |
Parâmetros que foram incluídos na lista negativa quando transação de antifraude for Cybersource Os parâmetros são concatenados usando o caracter , Ex.: CustomerDocumentNumber, ShippingStreet - Tabela 1 |
string |
Transaction.ProviderChargebackMarkingEvent.Id |
Id do evento de marcação da transação que sofreu o chargeback. Apenas Cybersource | string |
Transaction.ProviderChargebackMarkingEvent.Status |
Status do evento de marcação da transação que chargeback. Apenas Cybersource - Tabela 4 - Chargebacks{n}.Transaction.ProviderChargebackMarkingEvent.Status | string |
Transaction.ProviderChargebackMarkingEvent.Code |
Código de retorno do evento de marcação da transação que sofreu chargeback. Apenas Cybersouce - Tabela 5 - Chargebacks{n}.Transaction.ProviderChargebackMarkingEvent.Code | string |
Tabelas
Tabela 1 - Chargebacks[n].NegativeValues
Possíveis valores a serem inseridos na lista negativa na Cybersource.
Valor | Descrição |
---|---|
CustomerDocumentNumber | Número do documento do comprador, CPF ou CNPJ |
CustomerIpAddress | Endereço de IP do comprador |
CustomerPhone | Número de telefone do comprador |
ShippingStreet | Logradouro do endereço de entrega |
DeviceFingerprintSmartId | Fingerprint do dispositivo do comprador |
Tabela 2 - Result.ProcessingStatus
Possíveis retornos do chargeback enviado.
Valor | Descrição |
---|---|
AlreadyExist | Transação já marcada com chargeback anteriormente |
Remand | Chargeback deverá ser reenviado |
NotFound | Transação na encontrada na base de dados para os valores enviados nos campos do nó Transaction |
Tabela 3 - Chargebacks[n].Status
Possíveis valores do chargeback.
Valor | Descrição |
---|---|
Received | Chargeback recebido da adquirente |
AcceptedByMerchant | Chargeback aceito pela loja. Neste caso a loja entende que sofreu de fato um chargeback e não irá realizar a disputa |
ContestedByMerchant | Chargeback contestado pela loja. Neste caso a loja enviou os documentos necessários para tentar reverter o chargeback |
Tabela 4 - Chargebacks[n].Transaction.ProviderChargebackMarkingEvent.Status
Valor | Descrição | Provider |
---|---|---|
ACCEPT | Marcação de chargeback aceita no provedor | Cybersource |
REJECT | Marcação de chargeback rejeitada no provedor | Cybesource |
Tabela 5 - Chargebacks[n].Transaction.ProviderChargebackMarkingEvent.Code
Valor | Descrição | Provider |
---|---|---|
100 | Operação realizada com sucesso | Cybersource |
150 | Erro interno Possível ação: Aguarde alguns minutos e tente reenviar a marcação de chargeback |
Cybersource |
151 | A marcação de chargeback foi recebida, mas ocorreu time-out no servidor. Este erro não inclui time-out entre o cliente e o servidor Possível ação: Aguarde alguns minutos e tente reenviar |
Cybersource |
152 | A marcação de chargeback foi recebida, mas ocorreu time-out Possível ação: Aguarde alguns minutos e tente reenviar |
Cybersource |
234 | Problema com a configuração da loja na Cybersource Possível ação: Entre em contato com o suporte para corrigir o problema de configuração |
Cybersource |
Tabela 6 - Chargebacks[n].Transaction.AntifraudSourceApplication
Valor | Descrição | Provider |
---|---|---|
Gateway | Antifraude Gateway | |
Legacy | Antifraude Legado |
Tabela 7 - ReasonCode e ReasonMessage
Código | Descrição | Bandeira | Fraude? |
---|---|---|---|
137 | Mercadoria / Serviço Cancelado | Visa | Não |
127 | Dados inválidos | Visa | Não |
113 | Não Autorizada | Visa | Não |
136 | Crédito não processado | Visa | Não |
125 | Valor incorreto | Visa | Não |
132 | Recorrência Cancelada | Visa | Não |
123 | Moeda Incorreta | Visa | Não |
133 | Mercadoria / Serviço defeituoso ou diferente do descrito | Visa | Não |
112 | Autorização Recusada | Visa | Não |
134 | Mercadoria falsificada | Visa | Não |
135 | Venda Enganosa | Visa | Não |
102 | Responsabilidade EMV - Sem Falsificação | Visa | Sim |
101 | Responsabilidade EMV - Falsificação | Visa | Sim |
122 | Código de transação incorreto | Visa | Não |
105 | Programa Visa de Monitoramento de Fraude | Visa | Sim |
126 | Processamento duplicado / pago por outros meios | Visa | Não |
131 | Mercadoria / Serviços não recebidos | Visa | Não |
103 | Outras Fraudes - Cartão Presente | Visa | Sim |
121 | Apresentação Tardia | Visa | Não |
111 | Boletim de recuperação de cartões | Visa | Não |
137 | Transação de crédito original não aceita | Visa | Não |
104 | Outras Fraudes - Cartão Ausente | Visa | Sim |
124 | Número de conta incorreto | Visa | Não |
4846 | Código Correto da Moeda da Transação Não Fornecido | Master | Não |
4857 | Transação Telefônica Ativada por Cartão | Master | Não |
4859 | Serviços Não Prestados | Master | Não |
4812 | Número da Conta Não Consta no Arquivo (inexistente) | Master | Não |
4807 | Arquivo Boletim de Advertência | Master | Não |
4808 | Autorização requerida não Obtida | Master | Não |
4870 | Transferência de Responsabilidade do Chip | Master | Sim |
4853 | Desacordo Comercial | Master | Não |
4847 | Excede o Limite de Piso - Transação Não Autorizada | Master | Não |
4837 | Sem Autorização do Portador do Cartão | Master | Sim |
4871 | Transf. de Responsabilidade do Chip/Senha (Europa) | Master | Sim |
4849 | Estabelecimento Comercial de Atividades Suspeitas | Master | Sim |
4841 | Transação Recorrente Cancelada | Master | Não |
4842 | Apresentação Tardia | Master | Não |
4855 | Mercadoria Não Recebida | Master | Não |
4850 | Portador Não Reconhece | Master | Sim |
4840 | Processamento Fraudulento da Transação | Master | Sim |
4863 | Portador Não Reconhece a Transação Potencial de | Master | Sim |
4831 | Valor da Transação é diferente | Master | Não |
4854 | Contestação do Portador de Cartão (EUA) | Master | Sim |
4860 | Crédito Não Processado | Master | Não |
4834 | Erro de processamento | Master | Não |
4862 | Transação Falsificada por Fraude da Tarja Magnética | Master | Sim |
4835 | Cartão Inválido ou Vencido | Master | Não |
4554 | Bens e Serviços Não Recebidos | Amex | Não |
4515 | Pagamento por outros meios | Amex | Não |
4527 | Ausência de Impressão | Amex | Sim |
4523 | Número de Conta de Associado do Cartão Não Atribuído | Amex | Não |
4517 | Cópia atendida ilegível/incompleta | Amex | Não |
4752 | Erro de Apresentação de Crédito/Débito | Amex | Não |
4530 | Discrepância de Moeda | Amex | Não |
4516 | Cópia não atendida | Amex | Não |
4799 | Trans. de Resp. por Fraude Perda Roubo não rec. | Amex | Sim |
4536 | Apresentação Tardia | Amex | Não |
4750 | Débito de Aluguel de Carro Não Qualificado | Amex | Não |
4755 | Sem Autorização Válida | Amex | Não |
4553 | Mercadoria Defeituosa ou Não Conforme Descrita | Amex | Não |
4754 | Contestação Regulatória/Legal Local | Amex | Não |
4540 | Cartão não presente | Amex | Sim |
4544 | Cancelamento de Bens/Serviços Recorrentes | Amex | Não |
4513 | Crédito não processado | Amex | Não |
4534 | ROCs Múltiplos | Amex | Não |
4763 | Direito de Regresso Integral por Fraude | Amex | Sim |
4507 | Valor da Transação Incorreto ou Número de Conta | Amex | Não |
4798 | Transferência de Responsabilidade por Fraude | Amex | Sim |
4521 | Autorização inválida | Amex | Não |
4512 | Múltiplos processamentos | Amex | Não |
41 | Transação Recorrente Cancelada | Elo | Não |
71 | Autorização Negada | Elo | Não |
74 | Apresentação Tardia | Elo | Não |
75 | Portador não se lembra da transação | Elo | Sim |
62 | Transação falsificada (Transferência de Responsabilidade) | Elo | Sim |
82 | Duplicidade de Processamento | Elo | Não |
53 | Mercadoria com defeito ou em desacordo | Elo | Não |
83 | Fraude em Ambiente de Cartão Não Presente | Elo | Sim |
80 | Valor da Transação ou número de cartão incorreto | Elo | Não |
76 | Moeda inválida | Elo | Não |
30 | Serviço Não Prestado ou Mercadoria Não recebida | Elo | Não |
72 | Sem Autorização | Elo | Não |
85 | Crédito Não Processado | Elo | Não |
73 | Cartão Vencido | Elo | Não |
81 | Fraude em Ambiente de Cartão Presente | Elo | Sim |
70 | Cartão em Boletim | Elo | Não |
86 | Pagamentos por outros Meios | Elo | Não |
4812 | Número da Conta Não Consta no Arquivo (inexistente) | Diners | Não |
4841 | Transação Recorrente Cancelada | Diners | Não |
4850 | Portador Não Reconhece | Diners | Sim |
4846 | Código Correto da Moeda da Transação Não Fornecido | Diners | Não |
4847 | Excede o Limite de Piso - Transação Não Autorizada | Diners | Não |
4859 | Serviços Não Prestados | Diners | Não |
4831 | Valor da Transação é diferente | Diners | Não |
4849 | Estabelecimento Comercial de Atividades Suspeitas | Diners | Sim |
4835 | Cartão Inválido ou Vencido | Diners | Não |
4842 | Apresentação Tardia | Diners | Não |
4807 | Arquivo Boletim de Advertência | Diners | Não |
4871 | Transf. de Responsabilidade do Chip/Senha (Europa) | Diners | Sim |
4855 | Mercadoria Não Recebida | Diners | Não |
4808 | Autorização requerida não Obtida | Diners | Não |
4837 | Sem Autorização do Portador do Cartão | Diners | Sim |
4840 | Processamento Fraudulento da Transação | Diners | Sim |
4853 | Desacordo Comercial | Diners | Não |
4834 | Erro de processamento | Diners | Não |
4808 | Autorização requerida não Obtida | Hipercard | Não |
4834 | Erro de processamento | Hipercard | Não |
4860 | Crédito Não Processado | Hipercard | Não |
4857 | Transação Telefônica Ativada por Cartão | Hipercard | Não |
4850 | Portador Não Reconhece | Hipercard | Sim |
4807 | Arquivo Boletim de Advertência | Hipercard | Não |
4859 | Serviços Não Prestados | Hipercard | Não |
4862 | Transação Falsificada por Fraude da Tarja Magnética | Hipercard | Sim |
4849 | Estabelecimento Comercial de Atividades Suspeitas | Hipercard | Sim |
4853 | Desacordo Comercial | Hipercard | Não |
4837 | Sem Autorização do Portador do Cartão | Hipercard | Sim |
4847 | Excede o Limite de Piso - Transação Não Autorizada | Hipercard | Não |
4871 | Transf. de Responsabilidade do Chip/Senha (Europa) | Hipercard | Sim |
4812 | Número da Conta Não Consta no Arquivo (inexistente | Hipercard | Não |
4831 | Valor da Transação é diferente | Hipercard | Não |
4840 | Processamento Fraudulento da Transação | Hipercard | Sim |
4841 | Transação Recorrente Cancelada | Hipercard | Não |
4870 | Transferência de Responsabilidade do Chip | Hipercard | Sim |
4863 | Portador Não Reconhece a Transação | Hipercard | Sim |
4842 | Apresentação Tardia | Hipercard | Não |
4854 | Contestação do Portador de Cartão (EUA) | Hipercard | Sim |
4855 | Mercadoria Não Recebida | Hipercard | Não |
4835 | Cartão Inválido ou Vencido | Hipercard | Não |
4846 | Código Correto da Moeda da Transação Não Fornecido | Hipercard | Não |
Matriz
Matriz 1 - Documentos
Segmento\Motivo | Documentos Padrão | Portador não Reconhece a Transação | Mercadoria não Recebida | Serviços não Prestados | Mercadoria com Defeito/Não Confere | Crédito Não Processado | Processamento Duplicado/Pagamentos por Outros Meios |
Locadora de Veículos | 1) Cópia do comprovante de venda 2) Cadastro do portador (nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Contrato de locação devidamente assinado constando política de seguro 5) Documento de assinatura em arquivo (autorização débito) |
6) Notificação de infração de trânsito paga (se houver) 7) Termo de responsabilidade (danos futuros) 8) Boletim de ocorrência (se houver) 9) Três orçamentos para reparos em caso de acidentes e danos ao veículo (se houver) 10) Aviso prévio ao portador das cobranças de avarias/multas |
- | 6) Comprovante de checkout | - | 6) Política de cancelamento | 6) Dois ou mais comprovantes comprovando que houve duas ou mais transações, informar o código de autorização das duas transações |
Hotéis | 1)Cópia do comprovante de venda 2) Cadastro do portador (nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota Fiscal 4) Documento de assinatura em arquivo (autorização débito) |
5) Descritivo dos serviços prestados (chekin e checkout) | - | 5) Descritivo dos serviços prestados (chekin e checkout) | - | 5) Política de cancelamento (no show) com a cópia da tela de opção de cancelamento no site pelo portador comprovando a data | 5) Dois ou mais comprovantes comprovando que houve duas ou mais transações, informar o código de autorização das duas transações |
Agência de Turismo | 1) Cópia do comprovante de venda 2) Cadastro do portador (Nome do titular do cartão, Nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Contrato prestação de serviço de viagens (se houver) |
5) Documento oficial que comprove a identidade do portador (frente e verso) 6) Documento de assinatura em arquivo (autorização débito) |
- | 5) Cópia dos bilhetes/voucher’s emitidos | - | 5) Política de cancelamento | 5) Dois ou mais comprovantes comprovando que houve duas ou mais transações, informar o código de autorização das duas transações |
Cias Aéreas | 1) Cópia do comprovante de venda 2) Cadastro do portador (nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Contrato prestação de serviço de viagens (se houver) |
5) Documento oficial que comprove a identidade do portador (frente e verso) 6) Documento de assinatura em arquivo (autorização débito) |
- | 5) Cópia dos bilhetes/voucher’s emitidos 6) Checkin (se houver) |
- | 5) Política de cancelamento | 5) Dois ou mais comprovantes comprovando que houve duas ou mais transações, informar o código de autorização das duas transações |
Serviço de Processamento de Dados Serviços Online |
1) Cópia do comprovante de venda 2) Cadastro do portador (nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Autorização débito 5) Pedido da compra para transações via internet 6) Cópia da tela com os dados do meio de pagamento |
7) Descritivo dos serviços prestados 8) Cadastro do portador (Nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular |
- | 7) Contrato com detalhes da prestação de serviços 8) Protocolo dos serviços prestados |
- | - | - |
Supermercado ou Varejo | 1) Cópia do comprovante de venda 2) Cadastro do portador (ome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Autorização débito 5) Pedido da compra para transações via internet 6) Cópia da tela com os dados do meio de pagamento |
7) Descritivo dos serviços prestados | 7) Comprovação da entrega do produto e/ou protocolo assinado 8) Aceite eletrônico (se houver) |
7) Contrato com detalhes da prestação de serviços 8) Protocolo do serviços prestados |
7) Política de devolução e troca com aceite eletrônico (se houver) | 7) Política de cancelamento | 7) Dois ou mais comprovantes comprovando que houve duas ou mais transações, informar o código de autorização das duas transações |
Ingressos | 1) Cópia do comprovante de venda 2) Cadastro do portador (Nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Autorização débito 5) Pedido da compra para transações via internet 6) Cópia da tela com os dados do meio de pagamento |
- | 7) Comprovação da entrega do produto e/ou protocolo assinado 8) Aceite eletrônico (se houver) |
- | 7) Política de devolução e troca com aceite eletrônico (se houver) | - | - |
Editora ou Livraria | 1) Cópia do comprovante de venda 2) Cadastro do portador (Nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo /celular) 3) Nota fiscal 4) Autorização débito 5) Pedido da compra para transações via internet 6) Cópia da tela com os dados do meio de pagamento |
- | 7) Comprovação da entrega do produto e/ou protocolo assinado 8) Aceite eletrônico (se houver) |
- | 7) Política de devolução e troca com aceite eletrônico (se houver) | - | - |
Cias de Seguros | 1) Cópia do comprovante de venda 2) Cadastro do portador (nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Autorização débito 5) Pedido da compra para transações via internet 6) Cópia da tela com os dados do meio de pagamento |
- | - | 7) Política de devolução e troca com aceite eletrônico (se houver) | - | - | |
Demais Segmentos | 1) Cópia do comprovante de venda 2) Cadastro do portador (nome do titular do cartão, nome cadastrado no site, CPF, e-mail, endereço, telefone fixo/celular) 3) Nota fiscal 4) Autorização débito 5) Pedido da compra para transações via internet 6) Cópia da tela com os dados do meio de pagamento |
7) Comprovação da entrega do produto e/ou protocolo assinado 8) Carta do verdadeiro portador reconhecendo a despesa |
7) Comprovação da entrega do produto e/ou protocolo assinado 8) Aceite eletrônico (se houver) |
7) Contrato com detalhes da prestação de serviços 8) Protocolo dos serviços prestados |
7) Política de devolução e troca com aceite eletrônico (se houver) | 7) Política de cancelamento | 7) Dois ou mais comprovantes comprovando que houve duas ou mais transações, informar o código de autorização das duas transações |