Chargeback Guarantee requirements

Learn how to start using Chargeback Guarantee Services.

Chargeback Guarantee services

dLocal analyzes 100% of the transactions, deciding which are approved and which are rejected. If we approved a transaction and we received a chargeback, we'll cover 100% of chargebacks related to fraud.

📘

Requirements for Chargeback Guarantee service

  • Device ID integration in checkout is mandatory. It will be required that the data recollection starts at the moment when the webpage is loaded at the checkout process.
  • All the required data fields according to industry must be sent.

What chargebacks does CBK Guarantee cover?


We cover 100% of chargebacks with reason codes related to fraud that dLocal has chosen to accept. For merchants that deliver a physical product, the presence of a proof of delivery is mandatory to make the refund of the chargeback.

What is our set-up time?


Once we have checked that all the requirements are ready, we have a shadow mode of three weeks. This time is necessary for our team to understand the traffic and correctly apply a fraud strategy.

Information types

For some industries, there are some specific data points that are most effective for fraud prevention/identification. We have compiled a list of the required and recommended data points below, using the following criteria:

  • 🟢 Required information. This is mandatory information that needs to be detailed in each transaction. Not sharing this information will severely impact fraud detection capabilities.
  • 🔵 Additional information. This is information that can best enhance the fraud detection capabilities of the industry.

📘

Important

The more information the payment has, the more chargebacks and disputes are reduced and long-term conversion rates are improved.

Industry requirements

The following lists serve as a guideline indicating the required and recommended fields per industry. In some cases some fields may not apply, depending on your business model.

IndustryRelated industries
​Gaming​Gaming
Digital GoodsAdvertising, Social, Dating.
Recurring / subscriptionEducation, Antivirus, Hosting, Education, Streaming, and Healthcare.
​​Retail​Retail
MarketplaceMarketplaces/PSP, Wallet, Money remittance, Investing/Financial services, IT Services, Software/Apps, Payroll, Prepaid cards, Donations, and Others.
​​​TravelFlights, Car rental, Lodging.
DeliveryDelivery
RidesharingRidesharing

Gaming

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data.beneficiary​​email🟢
​additional_risk_data.beneficiary​​name🔵
​additional_risk_data.beneficiary​​phone🔵
​additional_risk_data.beneficiary​​document🔵
​additional_risk_data.basket​​unit_price🟢
​additional_risk_data.basket​​brand🔵
​additional_risk_data.basket​​category🟢
​additional_risk_data.basket​​item_reference🟢
​additional_risk_data.basket​​upc🔵
​additional_risk_data.basket​​manufacturer🔵
​additional_risk_data.basket​​product_name🟢
​additional_risk_data.basket​​quantity🟢
​additional_risk_data.basket​​subcategory🔵
​additional_risk_data.basket​​url🔵
​additional_risk_data.basket​​published_date🔵
​additional_risk_data.basket​​rating🔵
​additional_risk_data.basket​​count_reviews🟢
​additional_risk_data.basket​​image🔵
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🟢
​additional_risk_data​.payer​account_creation_date🟢
​additional_risk_data​.payer​first_purchase_date🔵
​additional_risk_data​.payer​is_positive🔵
​additional_risk_data​.payer​last_order_id🔵
​additional_risk_data​.payer​total_order_count🔵
​additional_risk_data​.payer​total_order_amount🔵
​additional_risk_data​.payer​last_updated_date🔵
additional_risk_data​.payer​.wish_listwish_list🟢
additional_risk_data​.payer​.wish_listitem_reference🔵
additional_risk_data​.payer​.wish_listunit_price🔵
additional_risk_data​.payer​.wish_listcurrency🔵
additional_risk_data​.payer​.wish_listproduct_name🔵
​additional_risk_data​.payer​reputation🟢
additional_risk_data.purchaseis_retry🟢
additional_risk_data.purchasechannel🔵
additional_risk_data.purchasetime_in_session🔵
additional_risk_data.purchasesearch_history🔵
additional_risk_data.purchase.search_historyitem_reference🔵
additional_risk_data.purchase.search_historyunit_price🔵
additional_risk_data.purchase.search_historyproduct_name🔵
additional_risk_data.discount_codesamount🔵
additional_risk_data.discount_codespercentage🔵
additional_risk_data.discount_codescode🔵
additional_risk_data.discount_codesvalid_until🔵
additional_risk_data.discount_codesdescription🟢
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵

Example payment

{
    "amount": 120.00,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "additional_risk_data": {
      
     	 "beneficiary": {
            "email": "[email protected]",
        },
      
        "basket": [
            {
                "unit_price": 199.90,
                "category": "Smartphone",
                "item_reference": "SP-562138",
                "product_name": "Pexel 25",
                "quantity": 2,
                "count_reviews": 13
            }
        ],
        "payer" : {
         	  "email_is_valid": true,
            "phone_is_valid": false,
            "wish_list": [
                {
                    "item_reference": "125312435",
                    "unit_price": 1300,
                    "product_name": "Pexel 25 for dummies"
                }
            ],
            "reputation": 5
        },
        "purchase": {
            "is_retry": false,       
        },
        "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
      
        "discount_codes": [
          {
              "description": "20% off Smoogle products"
          }
     }
  }

Digital goods

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data.beneficiary​​email🟢
​additional_risk_data.beneficiary​​name🔵
​additional_risk_data.beneficiary​​phone🔵
​additional_risk_data.beneficiary​​document🔵
​additional_risk_data.basket​​unit_price🟢
​additional_risk_data.basket​​brand🔵
​additional_risk_data.basket​​category🟢
​additional_risk_data.basket​​item_reference🟢
​additional_risk_data.basket​​upc🔵
​additional_risk_data.basket​​manufacturer🔵
​additional_risk_data.basket​​product_name🟢
​additional_risk_data.basket​​quantity🟢
​additional_risk_data.basket​​subcategory🔵
​additional_risk_data.basket​​url🔵
​additional_risk_data.basket​​published_date🔵
​additional_risk_data.basket​​rating🔵
​additional_risk_data.basket​​count_reviews🔵
​additional_risk_data.basket​​image🔵
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🟢
​additional_risk_data​.payer​account_creation_date🟢
​additional_risk_data​.payer​first_purchase_date🔵
​additional_risk_data​.payer​is_positive🔵
​additional_risk_data​.payer​last_order_id🔵
​additional_risk_data​.payer​total_order_count🔵
​additional_risk_data​.payer​total_order_amount🔵
​additional_risk_data​.payer​last_updated_date🔵
additional_risk_data​.payer​.wish_listwish_list🔵
additional_risk_data​.payer​.wish_listitem_reference🔵
additional_risk_data​.payer​.wish_listunit_price🔵
additional_risk_data​.payer​.wish_listcurrency🔵
additional_risk_data​.payer​.wish_listproduct_name🔵
​additional_risk_data​.payer​reputation🔵
additional_risk_data.purchaseis_retry🟢
additional_risk_data.purchasechannel🔵
additional_risk_data.purchasetime_in_session🔵
additional_risk_data.purchasesearch_history🔵
additional_risk_data.purchase.search_historyitem_reference🔵
additional_risk_data.purchase.search_historyunit_price🔵
additional_risk_data.purchase.search_historyproduct_name🔵
additional_risk_data.discount_codesamount🔵
additional_risk_data.discount_codespercentage🔵
additional_risk_data.discount_codescode🔵
additional_risk_data.discount_codesvalid_until🔵
additional_risk_data.discount_codesdescription🔵
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵

Example payment

{
    "amount": 120.00,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "additional_risk_data": {
      
     	 "beneficiary": {
            "email": "[email protected]",
        },
      
        "basket": [
            {
                "unit_price": 199.90,
                "category": "Smartphone",
                "item_reference": "SP-562138",
                "product_name": "Pexel 25",
                "quantity": 2
            }
        ],
        "payer" : {
         	  "email_is_valid": true,
            "phone_is_valid": false,
            "account_creation_date": "20201110"
        },
        "purchase": {
            "is_retry": false
          
        },
        "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
      
     }
  }

Recurring/Subscription

This industry includes merchants who offer a product or service in exchange for a recurring fee charged at scheduled intervals (monthly, quarterly, or yearly).

It also applies to Education, Antivirus, Hosting, Education, Streaming and, Healthcare.

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data.beneficiary​​email🟢
​additional_risk_data.beneficiary​​name🔵
​additional_risk_data.beneficiary​​phone🔵
​additional_risk_data.beneficiary​​document🔵
​additional_risk_data.basket​​unit_price🟢
​additional_risk_data.basket​​brand🔵
​additional_risk_data.basket​​category🟢
​additional_risk_data.basket​​item_reference🟢
​additional_risk_data.basket​​upc🔵
​additional_risk_data.basket​​manufacturer🔵
​additional_risk_data.basket​​product_name🟢
​additional_risk_data.basket​​quantity🟢
​additional_risk_data.basket​​subcategory🔵
​additional_risk_data.basket​​url🔵
​additional_risk_data.basket​​published_date🔵
​additional_risk_data.basket​​rating🔵
​additional_risk_data.basket​​count_reviews🔵
​additional_risk_data.basket​​image🔵
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🟢
​additional_risk_data​.payer​account_creation_date🟢
​additional_risk_data​.payer​first_purchase_date🔵
​additional_risk_data​.payer​is_positive🔵
​additional_risk_data​.payer​last_order_id🟢
​additional_risk_data​.payer​total_order_count🔵
​additional_risk_data​.payer​total_order_amount🔵
​additional_risk_data​.payer​last_updated_date🔵
additional_risk_data​.payer​.wish_listwish_list🟢
additional_risk_data​.payer​.wish_listitem_reference🔵
additional_risk_data​.payer​.wish_listunit_price🔵
additional_risk_data​.payer​.wish_listcurrency🔵
additional_risk_data​.payer​.wish_listproduct_name🔵
​additional_risk_data​.payer​reputation🟢
additional_risk_data.purchaseis_retry🟢
additional_risk_data.purchasechannel🔵
additional_risk_data.purchasetime_in_session🔵
additional_risk_data.purchasesearch_history🔵
additional_risk_data.purchase.search_historyitem_reference🔵
additional_risk_data.purchase.search_historyunit_price🔵
additional_risk_data.purchase.search_historyproduct_name🔵
additional_risk_data.discount_codesamount🟢
additional_risk_data.discount_codespercentage🔵
additional_risk_data.discount_codescode🟢
additional_risk_data.discount_codesvalid_until🔵
additional_risk_data.discount_codesdescription🟢
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵
​additional_risk_data.basket​​.subscriptionid🟢
​additional_risk_data.basket​​.subscriptionperiod🟢
​additional_risk_data.basket​​.subscriptioncurrent_period🟢
​additional_risk_data.basket​​.subscriptionend_date🟢

Example payment

{
    "amount": 399.80,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "additional_risk_data": {
        "beneficiary": {
            "email": "[email protected]",
        },
        "basket": [
            {
                "unit_price": 199.90,
                "category": "Smartphone",
                "item_reference": "SP-562138",
                "product_name": "Pexel 25",
                "quantity": 2
            }
        ],
        "payer" : {
            "email_is_valid": true,
            "phone_is_valid": false,
            "account_creation_date": "20201110",
            "last_order_id": "1525634152634"
        },
        "purchase": {
            "is_retry": false
        },
      
        "discount_codes": 
          {
              "amount": 10,
              "code": "PROMO20OFF",
              "description": "20% off Smoogle products"
          },
      
        "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
         "subscription": {
           "id": "A15-D267125367",
           "period": "P1M",
           "current_period": 3,
           "end_date": "20220101"
      }
      
     }
  }

Retail

This industry includes merchants who sell physical goods to end users.

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data​has_bic_event🔵
​additional_risk_data.shipping​​address🟢
​additional_risk_data.shipping​​cost🟢
​additional_risk_data.shipping​​delivery_company🔵
​additional_risk_data.shipping​​method🟢
​additional_risk_data.shipping​​delivery_date🔵
​additional_risk_data.shipping​​is_physical🟢
​additional_risk_data.shipping​​is_forwarding_address🔵
​additional_risk_data.shipping​​geolocation🔵
​additional_risk_data.basket​​unit_price🟢
​additional_risk_data.basket​​brand🔵
​additional_risk_data.basket​​category🟢
​additional_risk_data.basket​​item_reference🟢
​additional_risk_data.basket​​upc🔵
​additional_risk_data.basket​​manufacturer🔵
​additional_risk_data.basket​​product_name🟢
​additional_risk_data.basket​​quantity🟢
​additional_risk_data.basket​​size🔵
​additional_risk_data.basket​​subcategory🔵
​additional_risk_data.basket​​url🔵
​additional_risk_data.basket​​published_date🔵
​additional_risk_data.basket​​rating🔵
​additional_risk_data.basket​​count_reviews🔵
​additional_risk_data.basket​​image🔵
​additional_risk_data.basket​​stock🔵
​additional_risk_data.basket​​weight🔵
​additional_risk_data.basket​​subscription🔵
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🟢
​additional_risk_data​.payer​account_creation_date🟢
​additional_risk_data​.payer​first_purchase_date🟢
​additional_risk_data​.payer​is_positive🔵
​additional_risk_data​.payer​last_order_id🔵
​additional_risk_data​.payer​total_order_count🔵
​additional_risk_data​.payer​total_order_amount🔵
​additional_risk_data​.payer​last_updated_date🔵
additional_risk_data​.payer​.wish_listwish_list🔵
additional_risk_data​.payer​.wish_listitem_reference🔵
additional_risk_data​.payer​.wish_listunit_price🔵
additional_risk_data​.payer​.wish_listcurrency🔵
additional_risk_data​.payer​.wish_listproduct_name🔵
​additional_risk_data​.payer​reputation🔵
additional_risk_data.discount_codesamount🔵
additional_risk_data.discount_codespercentage🔵
additional_risk_data.discount_codescode🔵
additional_risk_data.discount_codesvalid_until🔵
additional_risk_data.discount_codesdescription🟢
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵
additional_risk_data.shippingavs_response_code🔵

Example payment

{
    "amount": 399.80,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "additional_risk_data": {     
        "shipping": {
            "address": {
                "state": "Montevideo",
                "city": "Montevideo",
                "zip_code": "11300",
                "street": "Avda. Brasil",
                "number": "1234 Ap. 501"
            },
            "cost": 12.34,
            "method": "FREE",
            "is_physical": TRUE
        },

        "basket": [
            {
                "unit_price": 199.90,
                "category": "Smartphone",
                "item_reference": "SP-562138",
                "upc": "1758929364928",
                "product_name": "Pexel 25",
                "quantity": 2
            }
        ],
        "payer" : {
            "email_is_valid": true,
            "phone_is_valid": false,
            "account_creation_date": "20201110",
            "first_purchase_date": "20201110"
        },
       "discount_codes": {
          "description": "20% off Smoogle products"
          },

        "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        }
     }
  }

Marketplace

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data​has_bic_event🟢
​additional_risk_data.submerchant​​merchant_reference🟢
​additional_risk_data.submerchant​​name🟢
​additional_risk_data.submerchant​​website🟢
​additional_risk_data.submerchant​​industry🟢
​additional_risk_data.submerchant​​document🟢
​additional_risk_data.submerchant​​nationality🟢
​additional_risk_data.submerchant​​email🟢
​additional_risk_data.submerchant​​username🟢
​additional_risk_data.submerchant​​phone🟢
​additional_risk_data.submerchant​​created_date🟢
​additional_risk_data.submerchant​​total_order_count🟢
​additional_risk_data.submerchant​​total_order_amount🟢
​additional_risk_data.submerchant​​last_updated_date🟢
​additional_risk_data.submerchant​​onboarding_ip_address🟢
​additional_risk_data.submerchant​​onboarding_email🟢
​additional_risk_data.submerchant​​reputation🟢
​additional_risk_data.submerchant​​ship_from_address🟢
​additional_risk_data.submerchant​​.ship_from_addressstreet🟢
​additional_risk_data.submerchant​​.ship_from_addressnumber🟢
additional_risk_data.submerchant​​.ship_from_addresscity🟢
​additional_risk_data.submerchant​​.ship_from_addresszip_code🟢
​additional_risk_data.submerchant​​.ship_from_addressstate🟢
​additional_risk_data.submerchant​​last_login🟢
​additional_risk_data.submerchant​​device_id🟢
​additional_risk_data.submerchant​​KYC_review🟢
​additional_risk_data.submerchant​​fraud_review🟢
​additional_risk_data.submerchant​​fraud_review_type🟢
​additional_risk_data.submerchant​​fraud_review_description🟢
​additional_risk_data.submerchant​​submerchant_description🟢
​additional_risk_data.submerchant​​checkout_type🟢
​additional_risk_data.submerchant​​checkout_subtype🟢
​additional_risk_data.submerchant​​industry_name🟢
​additional_risk_data.submerchant​​registered_company🟢
additional_risk_data.submerchant​​.bank_accountbeneficiary_name🟢
additional_risk_data.submerchant​​.bank_accountbeneficiary_document🟢
additional_risk_data.submerchant​​.bank_accountaccount🟢
additional_risk_data.submerchant​​.bank_accountbranch🟢
additional_risk_data.submerchant​​.bank_accountbeneficiary_email🟢
additional_risk_data.submerchant​​.bank_accountbeneficiary_phone🟢
​additional_risk_data.shipping​​address🟢
​additional_risk_data.shipping​​cost🟢
​additional_risk_data.shipping​​delivery_company🔵
​additional_risk_data.shipping​​method🟢
​additional_risk_data.shipping​​delivery_date🔵
​additional_risk_data.shipping​​is_physical🟢
​additional_risk_data.shipping​​is_forwarding_address🔵
​additional_risk_data.shipping​​geolocation🔵
​additional_risk_data.basket​​unit_price🟢
​additional_risk_data.basket​​brand🔵
​additional_risk_data.basket​​category🟢
​additional_risk_data.basket​​item_reference🟢
​additional_risk_data.basket​​upc🔵
​additional_risk_data.basket​​manufacturer🔵
​additional_risk_data.basket​​product_name🟢
​additional_risk_data.basket​​quantity🟢
​additional_risk_data.basket​​size🔵
​additional_risk_data.basket​​subcategory🔵
​additional_risk_data.basket​​url🟢
​additional_risk_data.basket​​published_date🔵
​additional_risk_data.basket​​rating🔵
​additional_risk_data.basket​​count_reviews🔵
​additional_risk_data.basket​​image🔵
​additional_risk_data.basket​​stock🔵
​additional_risk_data.basket​​weight🔵
​additional_risk_data.basket​​subscription🔵
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🟢
​additional_risk_data​.payer​account_creation_date🟢
​additional_risk_data​.payer​first_purchase_date🟢
​additional_risk_data​.payer​is_positive🔵
​additional_risk_data​.payer​last_order_id🔵
​additional_risk_data​.payer​total_order_count🔵
​additional_risk_data​.payer​total_order_amount🔵
​additional_risk_data​.payer​last_updated_date🔵
additional_risk_data​.payer​.wish_listwish_list🔵
additional_risk_data​.payer​.wish_listitem_reference🔵
additional_risk_data​.payer​.wish_listunit_price🔵
additional_risk_data​.payer​.wish_listcurrency🔵
additional_risk_data​.payer​.wish_listproduct_name🔵
​additional_risk_data​.payer​reputation🔵
additional_risk_data.discount_codesamount🔵
additional_risk_data.discount_codespercentage🔵
additional_risk_data.discount_codescode🟢
additional_risk_data.discount_codesvalid_until🔵
additional_risk_data.discount_codesdescription🟢
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵
additional_risk_data.shippingavs_response_code🔵

Example payment

{
    "amount": 399.80,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "has_bic_event": true,
    "additional_risk_data": {
        "submerchant": {
            "merchant_reference": "12534",
            "name": "Submerchant name",
            "website": "https://www.submerchant.com",
            "industry": 17,
            "document": "15236713521",
            "nationality": "BR",
            "email": "[email protected]",
            "username": "submerchant_username",
            "phone": "123456712345",
            "created_date": "20210311",
         	  "total_order_count": 35,
            "total_order_amount": 45020,
            "last_updated_date": "20210312",
            "onboarding_ip_address": "123.21.31.124",
            "onboarding_email": "[email protected]",
            "reputation": 4,
            "ship_from_address": {
              "state": "Montevideo",
              "city": "Montevideo",
              "zip_code": "11300",
              "street": "Avda. Brasil",
              "number": "1234 Ap. 401"
              },
						"last_login":"20210312",
						"device_id":"2fg3d4gf234",
						"KYC_review":true,
						"Fraud_review":true,
						"Fraud_review_type":"MULTIPLE_ACCOUNTS",
						"Fraud_review_description":"Passed to fraud review because of blacklist NEW_ACCOUNT_MULTIPLE_ACCOUNTS",
						"submerchant_description":"Business description",
						"Checkout_type":"WEBSITE_REDIRECT",
						"Checkout_subtype":"TOKEN",
						"Registered_Company":true,
            "bank_account": {
                "beneficiary_name": "Account's onwer's nam",
                "beneficiary_document": "15236713521",
                "account": "487445839",
                "branch": "name/number",
                "beneficiary_email": "[email protected]",
                "beneficiary_phone": "5512345678901"
            }, 
        },
        "shipping": {
            "address": {
                "state": "Montevideo",
                "city": "Montevideo",
                "zip_code": "11300",
                "street": "Avda. Brasil",
                "number": "1234 Ap. 501"
            },
            "is_physical": true,
            "cost": 12.34,
            "delivery_company": "FadEx",
            "method": "FREE",
            "delivery_date": "20211020",
            "is_forwarding_address": false,
            "geolocation": "-34.8798853,-56.1867859"
        },

        "basket": [
            {
              "unit_price": 199.90,
              "category": "Smartphone",
              "item_reference": "SP-562138",
              "product_name": "Pexel 25",
              "quantity": 2,
              "url": "https://www.merchant.com/products/SP-562138"
            }
        ],
        "payer" : {
            "email_is_valid": true,
            "phone_is_valid": false,
            "account_creation_date": "20201110",
            "first_purchase_date": "20201110"
        },

        "discount_codes": [
            {
                "code": "PROMO20OFF",
                "description": "20% off Smoogle products"
            }
        ],
        "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        }
     }
  }

Travel

Industry related to providing services associated to travel, such as transport and lodging.

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data.basket​​unit_price🟢
​additional_risk_data.basket​​brand🔵
​additional_risk_data.basket​​category🟢
​additional_risk_data.basket​​item_reference🟢
​additional_risk_data.basket​​upc🔵
​additional_risk_data.basket​​manufacturer🔵
​additional_risk_data.basket​​product_name🟢
​additional_risk_data.basket​​quantity🟢
​additional_risk_data.basket​​size🔵
​additional_risk_data.basket​​subcategory🔵
​additional_risk_data.basket​​url🔵
​additional_risk_data.basket​​published_date🔵
​additional_risk_data.basket​​rating🔵
​additional_risk_data.basket​​count_reviews🔵
​additional_risk_data.basket​​image🔵
​additional_risk_data.basket​​stock🔵
​additional_risk_data.basket​​weight🔵
​additional_risk_data.basket​​subscription🔵
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🔵
​additional_risk_data​.payer​account_creation_date🟢
​additional_risk_data​.payer​first_purchase_date🔵
​additional_risk_data​.payer​is_positive🔵
​additional_risk_data​.payer​last_order_id🔵
​additional_risk_data​.payer​total_order_count🔵
​additional_risk_data​.payer​total_order_amount🔵
​additional_risk_data​.payer​last_updated_date🔵
additional_risk_data​.payer​.wish_listwish_list🔵
additional_risk_data​.payer​.wish_listitem_reference🔵
additional_risk_data​.payer​.wish_listunit_price🔵
additional_risk_data​.payer​.wish_listcurrency🔵
additional_risk_data​.payer​.wish_listproduct_name🔵
​additional_risk_data​.payer​reputation🔵
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵
additional_risk_data.shippingavs_response_code🔵
additional_risk_data.travelcar_rental🟢
additional_risk_data.travel.car_rentalinsurance_charges🔵
additional_risk_data.travel.car_rentalpickup_city🟢
additional_risk_data.travel.car_rentalpickup_country🟢
additional_risk_data.travel.car_rentalpickup_date🟢
additional_risk_data.travel.car_rentalrental_charges🟢
additional_risk_data.travel.car_rentalreturn_city🟢
additional_risk_data.travel.car_rentalreturn_country🟢
additional_risk_data.travel.car_rentalreturn_date🔵
additional_risk_data.travelflight🟢
additional_risk_data.travelitinerary🟢
additional_risk_data.travel.flightlegs🟢
additional_risk_data.travel.flightlegs.amount🟢
additional_risk_data.travel.flightlegs.arrival_time🔵
additional_risk_data.travel.flightlegs.carrier_code🔵
additional_risk_data.travel.flightlegs.class_of_travel🔵
additional_risk_data.travel.flightlegs.departure🟢
additional_risk_data.travel.flightlegs.departure_time🟢
additional_risk_data.travel.flightlegs.destination🟢
additional_risk_data.travel.flightflight.passengers🔵
additional_risk_data.travel.flightdate_of_birth🔵
additional_risk_data.travel.flightffp_ID🔵
additional_risk_data.travel.flightfirst_name🟢
additional_risk_data.travel.flightlast_name🟢
additional_risk_data.travel.flightnationality🔵
additional_risk_data.travellodging🟢
additional_risk_data.travel.logginglodging.amount🟢
additional_risk_data.travel.logginglodging.check_in_date🟢
additional_risk_data.travel.logginglodging.check_out_date🟢
additional_risk_data.travel.logginglodging.city🟢
additional_risk_data.travel.logginglodging.country🟢
additional_risk_data.travel.logginglodging.guests🟢
additional_risk_data.travel.logginglodging.prepaid_expenses🔵
additional_risk_data.travel.logginglodging.rooms🔵

Example payment

{
    "amount": 399.80,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "additional_risk_data": {
       "basket": [
            {
              "unit_price": 199.90,
              "category": "Smartphone",
              "item_reference": "SP-562138",
              "product_name": "Pexel 25",
              "quantity": 2
            }
        ],
        "payer" : {
            "email_is_valid": true,
            "account_creation_date": "20201110"
        },
       
      "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
        "travel": {
            "car_rental": [
                {
                    "pickup_city": "Montevideo",
                    "pickup_country": "UY",
                    "pickup_date": "20210312",
                    "rental_charges": 15.03,
                    "return_city": "Buenos Aires",
                    "return_country": "AR",
                    "return_date": "20210320"
                }
            ],
            "flight": {
                "itinerary": {
                    "flight_code": "AR138",
                    "reservation_code": "6AL3J2",
                    "legs": [
                        {
                            "amount": 800.00,
                            "arrival_time": "2021-04-29 07:16:24",
                            "departure": "EZE",
                            "departure_time": "2021-04-29 04:30:15",
                            "destination": "Montevideo"
                        }
                    ]
                },
                "passengers": [
                    {
                        "date_of_birth": "19890703",
                        "ffp_ID": "ABC3454",
                        "first_name": "John",
                        "last_name": "Doe",
                        "nationality": "BR"
                    }
                ]
            },
            "lodging": [
                {
                    "amount": 123,
                    "check_in_date": "20210314",
                    "check_out_date": "20210318",
                    "city": "Montevideo",
                    "country": "UY",
                    "rooms": 1
                }
            ]
        }
    }

Delivery

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data.submerchant​​merchant_reference🟢
​additional_risk_data.submerchant​​name🟢
​additional_risk_data.shipping​​address🟢
​additional_risk_data.shipping​​cost🟢
​additional_risk_data.shipping​​delivery_company🔵
​additional_risk_data.shipping​​method🟢
​additional_risk_data.shipping​​delivery_date🔵
​additional_risk_data.shipping​​is_physical🔵
​additional_risk_data.shipping​​is_forwarding_address🔵
​additional_risk_data.shipping​​geolocation🔵
​additional_risk_data.basket​​unit_price🟢
​additional_risk_data.basket​​brand🔵
​additional_risk_data.basket​​category🟢
​additional_risk_data.basket​​item_reference🔵
​additional_risk_data.basket​​upc🔵
​additional_risk_data.basket​​manufacturer🔵
​additional_risk_data.basket​​product_name🟢
​additional_risk_data.basket​​quantity🟢
​additional_risk_data.basket​​size🔵
​additional_risk_data.basket​​subcategory🔵
​additional_risk_data.basket​​url🔵
​additional_risk_data.basket​​published_date🔵
​additional_risk_data.basket​​rating🔵
​additional_risk_data.basket​​count_reviews🔵
​additional_risk_data.basket​​image🔵
​additional_risk_data.basket​​stock🔵
​additional_risk_data.basket​​weight🔵
​additional_risk_data.basket​​subscription🔵
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🔵
​additional_risk_data​.payer​account_creation_date🔵
​additional_risk_data​.payer​first_purchase_date🔵
​additional_risk_data​.payer​is_positive🔵
​additional_risk_data​.payer​last_order_id🔵
​additional_risk_data​.payer​total_order_count🔵
​additional_risk_data​.payer​total_order_amount🟢
​additional_risk_data​.payer​last_updated_date🟢
​additional_risk_data​.payer​reputation🟢
additional_risk_data.discount_codesamount🔵
additional_risk_data.discount_codespercentage🔵
additional_risk_data.discount_codescode🟢
additional_risk_data.discount_codesvalid_until🔵
additional_risk_data.discount_codesdescription🟢
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵
additional_risk_data.shippingavs_response_code🔵

Example payment

{
    "amount": 399.80,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "has_bic_event": true,
    "additional_risk_data": {
        "submerchant": {
            "merchant_reference": "12534",
            "name": "Submerchant name"
        },
        "shipping": {
            "address": {
                "state": "Montevideo",
                "city": "Montevideo",
                "zip_code": "11300",
                "street": "Avda. Brasil",
                "number": "1234 Ap. 501"
            },
            "cost": 12.34,
            "method": "FREE",
        },

        "basket": [
            {
              "unit_price": 199.90,
              "category": "Smartphone",
              "item_reference": "SP-562138",
              "product_name": "Pexel 25",
              "quantity": 2
            }
        ],
        "payer" : {
            "email_is_valid": true,
            "account_creation_date": "20201110",
            "total_order_amount": 152.03,
            "last_updated_date": "20201020",
            "reputation": 5          
        },

        "discount_codes": [
            {
                "code": "PROMO20OFF",
                "description": "20% off Smoogle products"
            }
        ],
        "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        }
     }
  }

Ridesharing

LocationFieldGeneral
payername🟢
payeremail🟢
payerphone🟢
payerdocument🟢
payeruser_reference🟢
payeraddress🟢
payerip🟢
payerdevice_id🟢
cardholder_name🟢
​additional_risk_data​.payer​email_is_valid🟢
​additional_risk_data​.payer​phone_is_valid🟢
​additional_risk_data​.payer​account_creation_date🟢
​additional_risk_data​.payer​reputation🟢
additional_risk_data.deviceuser_agent🟢
additional_risk_data.devicegeolocation🟢
additional_risk_data.deviceevent_uuid🟢
additional_risk_data.devicelocale🟢
additional_risk_data.deviceadvertising_id🔵
additional_risk_data.devicevendor_id🔵
additional_risk_data.deviceandroid_id🔵
additional_risk_data.devicemedia_drm_id🔵
additional_risk_data.driveraccount_creation_date🟢
additional_risk_data.driverreputation🟢
additional_risk_data.drivernumber_of_rides🔵
additional_risk_data.drivername🔵
additional_risk_data.driverpickup_date🟢
additional_risk_data.driverphone🔵
additional_risk_data.driverdocument🟢
additional_risk_data.driveruser_reference🔵
additional_risk_data.trippick_up_address🟢
additional_risk_data.trippick_up_geo_loc🟢
additional_risk_data.tripdrop_off_address🟢
additional_risk_data.tripdrop_off_geo_loc🟢
additional_risk_data.tripestimated_time🔵
additional_risk_data.tripdistance🔵
additional_risk_data.tripreputation

Example payment

{
    "amount": 399.80,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
        "name": "Thiago Gabriel",
        "email": "[email protected]",
        "document": "53033315550",
        "user_reference": "12345",
        "phone": "5512345678901",
        "address": {
            "state": "Rio de Janeiro",
            "city": "Volta Redonda",
            "zip_code": "27275-595",
            "street": "Servidao B-1",
            "number": "1106"
        },
        "ip" : "2001:0db8:0000:0000:0000:ff00:0042:8329",
        "device_id" : "2fg3d4gf234"
    },
    "card":{
        "holder_name": "Thiago Gabriel",
        "number": "4111111111111111",
        "cvv": "123",
        "expiration_month": 10,
        "expiration_year": 2040
    },
    "order_id": "657434343",
    "notification_url": "http://merchant.com/notifications",
    "additional_risk_data": {
        
        "payer" : {
            "email_is_valid": true,
            "phone_is_valid": true,
            "account_creation_date": "20201110",
            "reputation": 5          
        },

        "device": {
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36",
            "geolocation" : "-34.8798853,-56.1867859",
            "locale": "en-US",
            "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
         "driver" : {
            "account_creation_date": "20201110",
            "reputation": 5,
            "document": "53033315551"      
        },
         "trip" : {
            "pick_up_address":{
                "state": "Montevideo",
                "city": "Montevideo",
                "zip_code": "11300",
                "street": "Avda. Brasil",
                "number": "1234 Ap. 501"
            },
            "pick_up_geo_loc": "-34.8798853,-56.1867859",
            "drop_off_address":{
                "state": "Montevideo",
                "city": "Montevideo",
                "zip_code": "11300",
                "street": "Avda. Brasil",
                "number": "1234 Ap. 501"
            },
            "drop_off_geo_loc": "-34.8798853,-56.1867859",
            "reputation": 5          
        }
     }
  }