Requirements per industry
Find all the required information about your industry and business model.
Information types
To ensure fraudulent transactions are stopped while legitimate transactions are correctly identified and allowed for processing, it is always recommended to share as much information as possible related to the transactions.
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.
| Industry | Related industries |
|---|---|
| Gaming | Gaming |
| Digital Goods | Advertising, Social, Dating. |
| Recurring / subscription | Education, Antivirus, Hosting, Education, Streaming, and Healthcare. |
| Retail | Retail |
| Marketplace | Marketplaces/PSP, Wallet, Money remittance, Investing/Financial services, IT Services, Software/Apps, Payroll, Prepaid cards, Donations, and Others. |
| Travel | Flights, Car rental, Lodging. |
| Delivery | Delivery |
| Ridesharing | Ridesharing |
Gaming
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": {
"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
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": {
"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.
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,
"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.
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": {
"submerchant": {
"website": "https://www.submerchant.com",
},
"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
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.
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
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
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
}
}
}
Updated 6 months ago