AI resources

Integration Update

Important
Circular BCB 3978 no. determines that all Payment Facilitators identify the ultimate beneficiaries at the time of the transaction. To comply with this regulation, it becomes mandatory to send the parameters of the sub_merchant property that are detailed in the table below. In case the fields are not sent, the card networks may apply penalties that will be passed on to the Payment Facilitator.

To use the Payment Facilitator integration, it is necessary to update the forward_data.sub_merchant property for sending the fields described below.

{
  "payer": {...},
  "forward_data": {
    "sub_merchant": {
      "sub_merchant_id": 123123,
      "mcc": "5462",
      "country": "BRA",
      "address_door_number": 1,
      "zip": "2222222",
      "document_number": "222222222222222",
      "city": "SÃO PAULO",
      "address_street": "RUA A",
	    "legal_name": "LOJINHA DO ZÉ",
      "region_code_iso": "BR-MG",
      "region_code": "BR",
      "document_type": "CNPJ",
      "phone": "123123123",
      "url": "www.nomedofacilitador.com.br"
    }
  },
  "transaction_amount": 20,
  "description": "...",
  "token": "....",
  "statement_descriptor": "PRUEBA",
  "issuer_id": ...,
  "payment_method_id": "...",
  "amounts": {...},
  "installments": 1,
  "pos_id": "....",
  "external_reference": "..."
}
FieldTypeDescriptionRequiredExample
sub_merchant_idNumberSubmerchant code.Required123123
mccTextSubmerchant MCC according to Abecs decision and/or primary CNAE.Required5462
countryTextCountry where the submerchant is located.RequiredBRA
address_door_numberNumberStreet number where the submerchant is located.Required1
zipTextCEP of the submerchant.Required2222222
document_numberTextIdentification number of the submerchant's document.Required222222222222222
cityTextCity where the submerchant is located.RequiredSÃO PAULO
address_streetTextStreet where the submerchant is located.RequiredRUA A
legal_nameTextLegal name of the submerchant.RequiredLOJINHA DO ZÉ
region_code_isoTextState where the submerchant is located.RequiredBR-MG
region_codeTextState abbreviation identification of the submerchant.RequiredMG
document_typeTextIdentification of the submerchant's document type, which can be: CPF or CNPJ.RequiredCNPJ
phoneTextPhone number of the submerchant.Required123123123
urlTextPayment facilitator URL.Requiredwww.paymentfacilitator.com.br