Todos clientes de e-commerce que são Facilitadores de Pagamento, por obrigatoriedade das bandeiras e do Banco Central devem enviar campos específicos na mensageria transacional.
O Gateway de Pagamento transmitirá as informações para as bandeiras por meio da mensageria transacional no momento da autorização.
Os campos específicos estão contidos dentro do nó PaymentFacilitator
. Além dos campos deste nó, os facilitadores também precisam enviar obrigatoriamente o campo SoftDescriptor
do nó Payment
. Veja a seguir o exemplo de requisição e resposta.
Atenção
- As bandeiras, ao identificarem inconformidade devido ao não envio dos dados obrigatórios na mensageria transacional, aplicarão multas ao Facilitador responsável pelo envio dos dados transacionais.
- A bandeira Visa, desde 15 de abril de 2023, atualizou as regras para marketplace e todos os merchants que atuam como Facilitadores de Pagamentos e que tenham clientes que operam como Marketplace Estrangeiro precisam, obrigatoriamente, enviar o indicador de varejo estrangeiro para evitar multa pela bandeira. O parâmetro específico é o
Payment.PaymentFacilitator.SubEstablishment.CountryCode
, que indica o código do país.
Requisição
Confira a seguir um exemplo de requisição para facilitadores de pagamento.
Ambiente | Método | Endpoint |
---|---|---|
Sandbox | post | https://apisandbox.braspag.com.br/v2/sales/ |
Produção | post | https://api.braspag.com.br/v2/sales/ |
Não use acentos pois eles são considerados como dois caracteres
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
"MerchantOrderId":"2017051002",
"Customer":{
"Name":"Nome do Comprador",
"Identity":"12345678909",
"IdentityType":"CPF",
"Email":"[email protected]",
"Birthdate":"1991-01-02",
"IpAddress":"127.0.0.1",
"Address":{
"Street":"Alameda Xingu",
"Number":"512",
"Complement":"27 andar",
"ZipCode":"12345987",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
},
"DeliveryAddress":{
"Street":"Alameda Xingu",
"Number":"512",
"Complement":"27 andar",
"ZipCode":"12345987",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
}
},
"Payment":{
"Provider":"Simulado",
"Type":"CreditCard",
"Amount":10000,
"Currency":"BRL",
"Country":"BRA",
"Installments":1,
"Interest":"ByMerchant",
"Capture":true,
"Authenticate":false,
"Recurrent":false,
"SoftDescriptor":"Mensagem",
"DoSplit":false,
"CreditCard":{
"CardNumber":"4551870000000181",
"Holder":"Nome do Portador",
"ExpirationDate":"12/2021",
"SecurityCode":"123",
"Brand":"Visa",
"SaveCard":"false",
"Alias":"",
"CardOnFile":{
"Usage":"Used",
"Reason":"Unscheduled"
}
},
"PaymentFacilitator":{
"EstablishmentCode":"1234",
"SubEstablishment":{
"EstablishmentCode":"1234",
"Identity":"11111111000100",
"Mcc":"1234",
"Address":"Alameda Grajau, 512",
"City":"Barueri",
"State":"SP",
"CountryCode":"076",
"PostalCode":"06455914",
"PhoneNumber":"1155855585"
}
}
}
}
--verbose
Propriedade | Descrição | Tipo | Tamanho | Obrigatório? |
---|---|---|---|---|
Payment.PaymentFacilitator.EstablishmentCode | Código do estabelecimento do facilitador. “Facilitator ID” (cadastro do facilitador com as bandeiras). Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 11 | Sim para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.EstablishmentCode | Código do estabelecimento do sub-merchant. “Sub-Merchant ID” (cadastro do subcredenciado com o facilitador). Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 15 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.Mcc | MCC do sub-merchant. Aplicável para Cielo30, Rede2 e PagSeguro.** | texto* | 4 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.Address | Endereço do sub-merchant. Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 22 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.City | Cidade do sub-merchant. Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 13 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.State | Estado do sub-merchant. Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 2 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.PostalCode | Código postal do sub-merchant. Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 9 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.PhoneNumber | Número de telefone do sub-merchant. Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 13 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.Identity | CNPJ ou CPF do sub-merchant. Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 14 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.CountryCode | Código do país do sub-merchant com base no ISO 3166. Aplicável para Cielo30, Rede2 e PagSeguro. | texto* | 3 | Sim, para facilitadores |
Payment.PaymentFacilitator.SubEstablishment.CompanyName | Razão Social do sub-merchant. | texto* | 60 | Somente para PagSeguro |
Payment.PaymentFacilitator.SubEstablishment.AddressNumber | Número do endereço do sub-merchant. | texto* | 60 | Somente para PagSeguro |
Payment.PaymentFacilitator.SubEstablishment.District | Bairro do sub-merchant. | texto* | 60 | Somente para PagSeguro |
*Evite usar acentos pois eles são considerados como dois caracteres.
Resposta
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
"MerchantOrderId": "2017051002",
"Customer": {
"Name": "Nome do Comprador",
"Identity": "12345678909",
"IdentityType": "CPF",
"Email": "[email protected]",
"Birthdate": "1991-01-02",
"Address": {
"Street": "Alameda Xingu",
"Number": "512",
"Complement": "27 andar",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA",
"District": "Alphaville"
},
"DeliveryAddress": {
"Street": "Alameda Xingu",
"Number": "512",
"Complement": "27 andar",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA",
"District": "Alphaville"
},
"Payment": {
"ServiceTaxAmount": 0,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"Authenticate": false,
"Recurrent": false,
"DoSplit":false,
"CreditCard": {
"CardNumber": "455187******0181",
"Holder": "Nome do Portador",
"ExpirationDate": "12/2021",
"SaveCard": false,
"Brand": "Visa"
"Alias": "",
"CardOnFile":{
"Usage": "Used",
"Reason":"Unscheduled"
}
},
"Credentials": {
"Code": "9999999",
"Key": "D8888888",
"Password": "LOJA9999999",
"Username": "#Braspag2018@NOMEDALOJA#"
},
"ProofOfSale": "20170510053219433",
"AcquirerTransactionId": "0510053219433",
"AuthorizationCode": "936403",
"SoftDescriptor": "Mensagem",
"VelocityAnalysis": {
"Id": "c374099e-c474-4916-9f5c-f2598fec2925",
"ResultMessage": "Accept",
"Score": 0
},
"PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
"Type": "CreditCard",
"Amount": 10000,
"ReceivedDate": "2017-05-10 17:32:19",
"CapturedAmount": 10000,
"CapturedDate": "2017-05-10 17:32:19",
"Currency": "BRL",
"Country": "BRA",
"Provider": "Simulado",
"ExtraDataCollection": [{
"Name": "NomeDoCampo",
"Value": "ValorDoCampo"
}],
"ReasonCode": 0,
"ReasonMessage": "Successful",
"Status": 2,
"ProviderReturnCode": "6",
"ProviderReturnMessage": "Operation Successful",
"Links": [{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
}
]
}
}
Novos campos obrigatórios para facilitadores
A partir de 11 de abril de 2025, todas as transações de facilitadores de pagamentos deverão informar os seguintes dados:
• Razão social do sub-comerciante, no parâmetro Payment.PaymentFacilitator.SubEstablishment.CompanyName
(máximo de 40 caracteres, não é permitido enviar caractere especial)
• CNPJ/CPF do sub-comerciante, no parâmetro Payment.PaymentFacilitator.SubEstablishment.Identity
(campo já existente).
O Banco Central do Brasil (BCB) definiu uma regra obrigatória para os arranjos de meios de pagamentos, visando reforçar medidas preventivas à lavagem de dinheiro no Brasil, conforme disposto na Circular BCB nº 3.978/2020. Com essa nova regra, a Cielo passará a compartilhar os dados de razão social e CNPJ/CPF do sub-comerciante com as áreas de PLD das instituições envolvidas no processo transacional de compra (bancos emissores, bandeiras, credenciadores e BCB). Esses dados serão compartilhados única e exclusivamente com a finalidade de prevenção à lavagem de dinheiro.
Veja a seguir como um exemplo do nó PaymentFacilitator
com todos os campos que devem ser enviados a partir de 11 de abril de 2025:
{
"PaymentFacilitator": {
"EstablishmentCode": "1234",
"SubEstablishment": {
"EstablishmentCode": "1234",
"Identity": "11111111000100",
"Mcc": "1234",
"Address": "Alameda Xingu, 512",
"City": "Barueri",
"State": "SP",
"CountryCode": "076",
"PostalCode": "06455914",
"PhoneNumber": "11987654321",
"CompanyName": "Subseller"
}
}
}