Required datafields

Explore the required and recommended information for card and alternative payment methods transactions.

Information

In this section, you will find the required and recommended data for all payments, including card transactions and alternative payment methods. For certain specific industries, additional data may be required.

Additionally, our API is equipped to receive any additional information you deem necessary for your fraud prevention strategy.

IndustryRelated industries
All industriesGeneral mandatory and recommended data for all businesses.
Marketplace, retail, and deliveryAdditional data required beyond the general data.
Wallets and account fundings flowWallet or any industry involving account funding. Additional data required beyond the general data.
​​​SubscriptionsAdditional data required beyond the general data.
PlatformsAny merchant involving two or more submerchants/websites. Additional data required beyond the general data.

All industries

LocationFieldGeneral
payernameRequired
payeremailRequired
payerphoneRecommended
payerdocumentRequired
payerbirth_dateRequired
payeruser_referenceRequired
payeraddressRecommended
payeripRequired
payerdevice_idRequired
additional_risk_data.deviceevent_uuidRequired
cardholder_nameRequired
​additional_risk_data​.payer​account_creation_dateRecommended
​additional_risk_data​.payer​is_positiveRecommended
​additional_risk_data.basket​​unit_priceRecommended
​additional_risk_data.basket​​categoryRecommended
​additional_risk_data.basket​​item_referenceRecommended
​additional_risk_data.basket​​product_nameRecommended
​additional_risk_data.basket​​urlRecommended

Example payment

{
    "amount": 120.00,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
      "name": "Thiago Gabriel",
      "email": "[email protected]",
      "phone": "5512345678901",
      "document": "53033315550",
      "birth_date": "19980925",      
      "user_reference": "12345",
      "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"
    },
    "device": {
      "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
    "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" : {
         	  "account_creation_date": "20210407",
            "is_positive": true
        },       
        "basket": [
            {
                "unit_price": 199.90,
                "category": "Smartphone",
                "item_reference": "SP-562138",
                "product_name": "Pexel 25",
                "quantity": 2,
                "url": "http://merchant.com/product1234"
            }
        ]
  }

Marketplace, retail and delivery

Additional data required beyond the general data for marketplace, retail, and delivery industries.

LocationFieldGeneral
payeraddressRequired
shippingaddressRequired

Example payment

{
    "amount": 120.00,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
      "name": "Thiago Gabriel",
      "email": "[email protected]",
      "phone": "5512345678901",
      "document": "53033315550",
      "birth_date": "19980925",      
      "user_reference": "12345",
      "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"
    },
    "device": {
      "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
    "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" : {
         	  "account_creation_date": "20210407",
            "is_positive": true
        },       
        "basket": [
            {
                "unit_price": 199.90,
                "category": "Smartphone",
                "item_reference": "SP-562138",
                "product_name": "Pexel 25",
                "quantity": 2,
                "url": "http://merchant.com/product1234"
            }
        ],
     		 "shipping" : {
            "address": {
        				"state": "Rio de Janeiro",
        				"city": "Volta",
        				"zip_code": "27273-5945",
        				"street": "Servidao B-21",
        				"number": "1209"
              }
        }
  }

Wallets and Account fundings flow

Wallet or any industry involving account funding. Additional data required beyond the general data.

Example payment

{
    "amount": 120.00,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
      "name": "Thiago Gabriel",
      "email": "[email protected]",
      "phone": "5512345678901",
      "document": "53033315550",
      "birth_date": "19980925",      
      "user_reference": "12345",
      "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"
    },
    "device": {
      "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
    "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" : {
         	  "account_creation_date": "20210407",
            "is_positive": true
        },       
        "basket": [
            {
                "unit_price": 199.90,
                "category": "Coins",
                "item_reference": "SP-562138",
                "product_name": "Coins2",
                "quantity": 2,
                "url": "http://merchant.com/product1234"
            }
        ],
      "beneficiary":{
        	"email":"[email protected]",
        	"phone":"55119846785",
        	"accountID":"384059hji",
        	"name":"gabriel thiago",
        	"document":"54678903",
        	"created_date":"20220704"
      }
  }

Subscriptions

Additional data required beyond the general data.

Example payment

{
    "amount": 120.00,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
      "name": "Thiago Gabriel",
      "email": "[email protected]",
      "phone": "5512345678901",
      "document": "53033315550",
      "birth_date": "19980925",      
      "user_reference": "12345",
      "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"
    },
    "device": {
      "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
    "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" : {
         	  "account_creation_date": "20210407",
            "is_positive": true
        },       
        "basket": [
            {
                "unit_price": 199.90,
                "category": "planA",
                "item_reference": "AA-562138",
                "product_name": "Plan basic",
                "quantity": 1,
                "url": "http://merchant.com/planA",
              	"subscription":{
                  	"id":"adgte1256",
                  	"period":"P1M",
                  	"current_period":3,
                  	"end_date":"20240801"                  
                }
            }
        ]
  }

Platforms

Any merchant involving two or more sub-merchants/websites. Additional data required beyond the general data.

LocationFieldGeneral
additional_risk_data.submerchantmerchant_referenceRequired
additional_risk_data.submerchantnameRecommended
additional_risk_data.submerchantwebsiteRequired
additional_risk_data.submerchantdocumentRequired
additional_risk_data.submerchantemailRequired
additional_risk_data.submerchantphoneRecommended
additional_risk_data.submerchantonboarding_emailRecommended
additional_risk_data.submerchantship_from_addressRecommended

Example payment

{
    "amount": 120.00,
    "currency": "USD",
    "country": "BR",
    "payment_method_id": "CARD",
    "payment_method_flow": "DIRECT",
    "payer":{
      "name": "Thiago Gabriel",
      "email": "[email protected]",
      "phone": "5512345678901",
      "document": "53033315550",
      "birth_date": "19980925",      
      "user_reference": "12345",
      "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"
    },
    "device": {
      "event_uuid": "ab825a72-62c3-4df5-9886-25c75856fac7"
        },
    "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" : {
         	  "account_creation_date": "20210407",
            "is_positive": true
        },       
        "basket": [
            {
                "unit_price": 199.90,
                "category": "planA",
                "item_reference": "AA-562138",
                "product_name": "Plan basic",
                "quantity": 1,
                "url": "http://merchant.com/planA",
            }
        ],
      	"submerchant":{
          	"merchant_reference":"45673",
          	"name":"SubmerchantAAB",
          	"website":"http://submerchantAAB.com",
          	"email":"[email protected]",
          	"phone":"5512345678903",
          	"onboarding_email":"[email protected]",
          	"ship_from_address": {
        			"state": "Rio de Janeiro",
        			"city": "Volta Redonda 2",
        			"zip_code": "27275-545",
        			"street": "Servidao B-31",
        			"number": "11086"
        		}
        }
  }
How can we improve?

Let’s collaborate to create a better experience.

Give feedback