AI resources

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.

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Cotton t-shirt",
            "description": "Cotton t-shirt",
            "picture_url": "",
            "category_id": "clothing",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "55-inch TV",
            "description": "55-inch TV",
            "picture_url": "",
            "category_id": "electronics",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Concert ticket",
            "description": "Concert ticket",
            "picture_url": "",
            "category_id": "entertainment",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Dining chair",
            "description": "Dining chair",
            "picture_url": "",
            "category_id": "home_and_deco",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Monthly subscription",
            "description": "Monthly subscription",
            "category_id": "software",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Municipal fee",
            "description": "Municipal fee",
            "picture_url": "",
            "category_id": "government",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Supermarket product",
            "description": "Supermarket product",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Flight to tourist city",
            "description": "Flight to tourist city",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Hotel stay",
            "description": "Hotel stay",
            "category_id": "hospitality",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Electricity bill",
            "description": "Electricity bill",
            "category_id": "utilities",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Product kit",
            "description": "Product kit",
            "category_id": "direct_sales",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Vehicle accessory",
            "description": "Vehicle accessory",
            "category_id": "vehicles",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Transit card top-up",
            "description": "Transit card top-up",
            "category_id": "transport",
            "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"
    }
}

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 "Gmail", "Facebook", "Native Web" or "Other".
`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": "Monetary bet",
            "description": "Monetary bet",
            "category_id": "gambling",
            "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"
    }
}

Adobe Commerce

Mercado Pago in your store

Documentation

Starting now?

Resources

Support

Partners

Community

Industry data

Navigation

Resources and Community

Mercado Pago

Country and language