# MD for: https://www.mercadopago.com.pe/developers/es/docs/checkout-api-orders/payment-management/improve-payment-approval/industry-data.md

\# Industry data According to your store's line of business or sector, you can include additional information when creating the payment that helps increase approval chances. See below some specific data for these industries that can be added to your integration. :::AccordionComponent{title="Apparel"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`type\` | String | Item type. | | \`description\` | String | Item description. | | \`picture\_url\` | String | Item image URL. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Shipping (\_object\_ \`shipment\`) | Field | Type | Description | |------------------|----------|-------------------------------------------------------------------------------------------------------| | \`address\` | \_Object\_ | Shipping address data. | | \`zip\_code\` | \_String\_ | Buyer's postal code. It is inside the \`address\` object. | | \`street\_name\` | \_String\_ | Street name of the buyer's address. It is inside the \`address\` object. | | \`street\_number\` | \_String\_ | Street number of the buyer's address. It is inside the \`address\` object. | | \`city\` | \_String\_ | City of the buyer's address. It is inside the \`address\` object. | | \`state\` | \_String\_ | State of the buyer's address. It is inside the \`address\` object. | | \`neighborhood\` | \_String\_ | Neighborhood of the buyer's address. It is inside the \`address\` object. | | \`complement\` | \_String\_ | Additional information of the buyer's address (e.g.: apartment, floor, block, back). It is in \`address\`. | - Shipping (\_object\_ \`additional\_info\`) | Field | Type | Description | |---------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------| | \`shipment.express\` | \_Boolean\_ | Indicates whether the shipping is express. If it is, use \`true\`; if not, use \`false\`. | | \`shipment.local\_pickup\` | \_Boolean\_ | Indicates whether it is possible to pick up the purchased product at a pickup point. If pickup is available, use \`true\`; if not, use \`false\`. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Ticket to Curitiba", "description": "Ticket to Curitiba", "picture\_url": "", "category\_id": "travel", "quantity": 1, "type": "", "unit\_price": "" }, "additional\_info": { "shipment.express": true, "shipment.local\_pickup": false, "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Electronics"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | | \`warranty\` | Boolean | Product has warranty. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Shipping (\_object\_ \`shipment\`) | Field | Type | Description | |------------------|----------|-------------------------------------------------------------------------------------------------------| | \`address\` | \_Object\_ | Shipping address data. | | \`zip\_code\` | \_String\_ | Buyer's postal code. It is inside the \`address\` object. | | \`street\_name\` | \_String\_ | Street name of the buyer's address. It is inside the \`address\` object. | | \`street\_number\` | \_String\_ | Street number of the buyer's address. It is inside the \`address\` object. | | \`city\` | \_String\_ | City of the buyer's address. It is inside the \`address\` object. | | \`state\` | \_String\_ | State of the buyer's address. It is inside the \`address\` object. | | \`neighborhood\` | \_String\_ | Neighborhood of the buyer's address. It is inside the \`address\` object. | | \`complement\` | \_String\_ | Additional information of the buyer's address (e.g.: apartment, floor, block, back). It is in \`address\`. | - Shipping (\_object\_ \`additional\_info\`) | Field | Type | Description | |---------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------| | \`shipment.express\` | \_Boolean\_ | Indicates whether the shipping is express. If it is, use \`true\`; if not, use \`false\`. | | \`shipment.local\_pickup\` | \_Boolean\_ | Indicates whether it is possible to pick up the purchased product at a pickup point. If pickup is available, use \`true\`; if not, use \`false\`. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Ticket to Curitiba", "description": "Ticket to Curitiba", "picture\_url": "", "category\_id": "travel", "quantity": 1, "type": "", "unit\_price": "" }, "additional\_info": { "shipment.express": true, "shipment.local\_pickup": false, "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Tickets and entertainment"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | | \`event\_date\` | Date | Event date. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Ticket to Curitiba", "description": "Ticket to Curitiba", "picture\_url": "", "category\_id": "travel", "quantity": 1, "unit\_price": "", "warranty": false, "event\_date": "" }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Home and decoration"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | | \`warranty\` | Boolean | Product has warranty. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Shipping (\_object\_ \`shipment\`) | Field | Type | Description | |------------------|----------|-------------------------------------------------------------------------------------------------------| | \`address\` | \_Object\_ | Shipping address data. | | \`zip\_code\` | \_String\_ | Buyer's postal code. It is inside the \`address\` object. | | \`street\_name\` | \_String\_ | Street name of the buyer's address. It is inside the \`address\` object. | | \`street\_number\` | \_String\_ | Street number of the buyer's address. It is inside the \`address\` object. | | \`city\` | \_String\_ | City of the buyer's address. It is inside the \`address\` object. | | \`state\` | \_String\_ | State of the buyer's address. It is inside the \`address\` object. | | \`neighborhood\` | \_String\_ | Neighborhood of the buyer's address. It is inside the \`address\` object. | | \`complement\` | \_String\_ | Additional information of the buyer's address (e.g.: apartment, floor, block, back). It is in \`address\`. | - Shipping (\_object\_ \`additional\_info\`) | Field | Type | Description | |---------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------| | \`shipment.express\` | \_Boolean\_ | Indicates whether the shipping is express. If it is, use \`true\`; if not, use \`false\`. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Ticket to Curitiba", "description": "Ticket to Curitiba", "picture\_url": "", "category\_id": "travel", "quantity": 1, "type": "", "unit\_price": "" }, "additional\_info": { "shipment.express": true, "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Apps and online platforms"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city\` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Ticket to Curitiba", "description": "Ticket to Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "" }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Government and public services"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|----------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | | \`warranty\` | Boolean | Product has warranty. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city\` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "picture\_url": "", "category\_id": "travel", "quantity": 1, "type": "", "unit\_price": "" }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Retail"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`picture\_url\` | String | Item image URL. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Shipping (\_object\_ \`shipment\`) | Field | Type | Description | |------------------|----------|-------------------------------------------------------------------------------------------------------| | \`address\` | \_Object\_ | Shipping address data. | | \`zip\_code\` | \_String\_ | Buyer's postal code. It is inside the \`address\` object. | | \`street\_name\` | \_String\_ | Street name of the buyer's address. It is inside the \`address\` object. | | \`street\_number\` | \_String\_ | Street number of the buyer's address. It is inside the \`address\` object. | | \`city\` | \_String\_ | City of the buyer's address. It is inside the \`address\` object. | | \`state\` | \_String\_ | State of the buyer's address. It is inside the \`address\` object. | | \`neighborhood\` | \_String\_ | Neighborhood of the buyer's address. It is inside the \`address\` object. | | \`complement\` | \_String\_ | Additional information of the buyer's address (e.g.: apartment, floor, block, back). It is in \`address\`. | - Shipping (\_object\_ \`additional\_info\`) | Field | Type | Description | |---------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------| | \`shipment.express\` | \_Boolean\_ | Indicates whether the shipping is express. If it is, use \`true\`; if not, use \`false\`. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "2", "title": "Passagem Para Guarulhos", "description": "Passagem Para Guarulhos", "picture\_url": "" }, "additional\_info": { "shipment.express": true, "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Tourism"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Passengers (\`additional\_info.travel.passengers\`) | Field | Type | Description | |------------------------|---------|----------------------------| | \`first\_name\` | String | Passenger's first name. Inside the \`passenger\` object. | | \`last\_name\` | String | Passenger's last name. Inside the \`passenger\` object. | | \`identification\` | Object | Passenger's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number \` | String | Identification number. Inside the \`identification\` object. | - Routes (\`additional\_info.travel.routes\`) | Field | Type | Description | |----------------------|---------|----------------------------| | \`departure\`| String | Route departure location (e.g. airport code). | | \`destination\`| String | Route destination location (e.g. airport code). | | \`departure\_date\_time\` | Date | Route departure date and time. | | \`arrival\_date\_time\` | Date | Route arrival date and time. | | \`company\`| String | Company responsible for executing the route. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "" }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Hospitality"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | | \`event\_date\` | Date | Event date. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Passengers (\`additional\_info.travel.passengers\`) | Field | Type | Description | |------------------------|---------|----------------------------| | \`first\_name\` | String | Passenger's first name. Inside the \`passenger\` object. | | \`last\_name\` | String | Passenger's last name. Inside the \`passenger\` object. | | \`identification\` | Object | Passenger's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number \` | String | Identification number. Inside the \`identification\` object. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "" }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Utilities"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "" }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Direct sales"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | external\_code| String | Item identification code. | | title | String | Item name/title. | | type | String | Item type. | | description | String | Item description. | | category\_id | String | Item category. | | quantity | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Shipping (\_object\_ \`shipment\`) | Field | Type | Description | |------------------|----------|-------------------------------------------------------------------------------------------------------| | \`address\` | \_Object\_ | Shipping address data. | | \`zip\_code\` | \_String\_ | Buyer's postal code. It is inside the \`address\` object. | | \`street\_name\` | \_String\_ | Street name of the buyer's address. It is inside the \`address\` object. | | \`street\_number\` | \_String\_ | Street number of the buyer's address. It is inside the \`address\` object. | | \`city\` | \_String\_ | City of the buyer's address. It is inside the \`address\` object. | | \`state\` | \_String\_ | State of the buyer's address. It is inside the \`address\` object. | | \`neighborhood\` | \_String\_ | Neighborhood of the buyer's address. It is inside the \`address\` object. | | \`complement\` | \_String\_ | Additional information of the buyer's address (e.g.: apartment, floor, block, back). It is in \`address\`. | - Shipping (\_object\_ \`additional\_info\`) | Field | Type | Description | |---------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------| | \`shipment.express\` | \_Boolean\_ | Indicates whether the shipping is express. If it is, use \`true\`; if not, use \`false\`. | | \`shipment.local\_pickup\` | \_Boolean\_ | Indicates whether it is possible to pick up the purchased product at a pickup point. If pickup is available, use \`true\`; if not, use \`false\`. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "" }, "additional\_info": { "shipment.local\_pickup": true, "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Automotive and nautical"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city\` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | - Shipping (\_object\_ \`shipment\`) | Field | Type | Description | |------------------|----------|-------------------------------------------------------------------------------------------------------| | \`address\` | \_Object\_ | Shipping address data. | | \`zip\_code\` | \_String\_ | Buyer's postal code. It is inside the \`address\` object. | | \`street\_name\` | \_String\_ | Street name of the buyer's address. It is inside the \`address\` object. | | \`street\_number\` | \_String\_ | Street number of the buyer's address. It is inside the \`address\` object. | | \`city\` | \_String\_ | City of the buyer's address. It is inside the \`address\` object. | | \`state\` | \_String\_ | State of the buyer's address. It is inside the \`address\` object. | | \`neighborhood\` | \_String\_ | Neighborhood of the buyer's address. It is inside the \`address\` object. | | \`complement\` | \_String\_ | Additional information of the buyer's address (e.g.: apartment, floor, block, back). It is in \`address\`. | - Shipping (\_object\_ \`additional\_info\`) | Field | Type | Description | |---------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------| | \`shipment.express\` | \_Boolean\_ | Indicates whether the shipping is express. If it is, use \`true\`; if not, use \`false\`. | | \`shipment.local\_pickup\` | \_Boolean\_ | Indicates whether it is possible to pick up the purchased product at a pickup point. If pickup is available, use \`true\`; if not, use \`false\`. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "" }, "additional\_info": { "shipment.local\_pickup": true, "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Urban transport"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`description\` | String | Item description. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "" }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` ::: :::AccordionComponent{title="Gambling"} Add any extra information you consider necessary about: - Items (array \`items\`) | Field | Type | Description | |--------------|---------|----------------------------------------| | \`external\_code\`| String | Item identification code. | | \`title\` | String | Item name/title. | | \`category\_id\` | String | Item category. | | \`quantity\` | Integer | Item quantity. | | \`unit\_price\` | String | Item unit price. | | \`warranty\` | Boolean | Product has warranty. | - Payer (object \`payer\`) | Field | Type | Description | |--------------------|---------|-------------------------------| | \`payer\`| Object | Payer data. | | \`first\_name\` | String | Payer's first name. Inside the \`payer\` object. | | \`last\_name\` | String | Payer's last name. Inside the \`payer\` object. | | \`identification\` | Object | Payer's identification data (e.g. type and number). | | \`type\` | String | Identification type. Inside the \`identification\` object. | | \`number\` | String | Identification number. Inside the \`identification\` object. | | \`phone\` | Object | Payer's phone. | | \`area\_code\`| String | Payer's area code. Inside the \`phone\` object. | | \`number\` | String | Payer's phone number. Inside the \`phone\` object. | | \`address\` | Object | Payer's address data. | | \`zip\_code\` | String | Payer's postal code. Inside the \`address\` object. | | \`street\_name\` | String | Street name of payer's address. Inside the \`address\` object. | | \`street\_number\` | String | Street number of payer's address. Inside the \`address\` object. | | \`city \` | String | City of payer's address. Inside the \`address\` object. | | \`state\` | String | State of payer's address. Inside the \`address\` object. | | \`neighborhood\` | String | Neighborhood of payer's address. Inside the \`address\` object. | | \`complement\` | String | Address complement (e.g. floor, block, back). Inside the \`address\` object. | - Payer (object \`additional\_info\`) | Field | Type | Description | |--------------|---------|-----------------------------------------| | \`payer.authentication\_type\` | String | Authentication type. Can be "MOBILE" or "WEB". | | \`payer.registration\_date\` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | | \`payer.is\_prime\_user\` | Boolean | Indicates if user is premium. If yes, use \`true\`, if not, use \`false\`. | | \`payer.is\_first\_purchase\_online\` | Boolean | Indicates if it's the customer's first purchase. If yes, use \`true\`, if not, use \`false\`. | | \`payer.last\_purchase\` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | See below an example of how to send the data presented in the tables above: \`\`\`curl { "type": "online", "total\_amount": "1000.00", "external\_reference": "ext\_ref\_1234", "transactions": { "payments": \[ { "amount": "1000.00", "payment\_method": { "id": "master", "type": "credit\_card", "token": "677859ef5f18ea7e3a87c41d02c3fbe3", "installments": 1, "statement\_descriptor": "LOJA X" } } \] }, "payer": { "first\_name": "John", "last\_name": "Doe", "identification": { "type": "CPF", "number": "316432423423" }, "phone": { "area\_code": "11", "number": "43434343" }, "address": { "zip\_code": "11034430", "street\_name": "AV PAULISTA", "street\_number": "100", "city": "SAO PAULO", "state": "SP", "neighborhood": "BELA VISTA", "complement": "101" } }, "items": \[ { "external\_code": "1", "title": "Passagem Para Curitiba", "description": "Passagem Para Curitiba", "category\_id": "travel", "quantity": 1, "unit\_price": "", "warranty": false }, "additional\_info": { "payer.registration\_date": "2014-06-28T16:53:03.176-04:00", "payer.authentication\_type": "MOBILE", "payer.is\_prime\_user": true, "payer.is\_first\_purchase\_online": true, "payer.last\_purchase": "2014-06-28T16:53:03.176-04:00" } } \`\`\` :::