Recursos para IA

Dados de indústria

De acordo com o ramo de atividades ou setor de sua loja, é possível incluir informações adicionais no momento da criação da order que ajudam a aumentar as chances de aprovação dos pagamentos.

Veja abaixo alguns dados específicos para estas indústrias e que podem ser adicionados à sua integração.

Vestuário

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`type`	String	Tipo de item.
`description`	String	Descrição do item.
`picture_url`	String	URL da imagem do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Entregas (object shipment)

Campo	Tipo	Descrição
`address`	Object	Dados do endereço da entrega.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: apartamento, andar, bloco, fundos). Está em `address`.

Entregas (object additional_info)

Campo	Tipo	Descrição
`shipment.express`	Boolean	Indica se a entrega é expressa. Caso seja, use `true` e, caso não seja, use `false`.
`shipment.local_pickup`	Boolean	Indica se é possível retirar em uma agência o produto adquirido. Se retira na agência, use `true` e, caso não retira, use `false`.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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": {
        "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"
    }
}

Eletro

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.
`warranty`	Boolean	Produto tem garantia.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Entregas (object shipment)

Campo	Tipo	Descrição
`address`	Object	Dados do endereço da entrega.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: apartamento, andar, bloco, fundos). Está em `address`.

Entregas (object additional_info)

Campo	Tipo	Descrição
`shipment.express`	Boolean	Indica se a entrega é expressa. Caso seja, use `true` e, caso não seja, use `false`.
`shipment.local_pickup`	Boolean	Indica se é possível retirar em uma agência o produto adquirido. Se retira na agência, use `true` e, caso não retira, use `false`.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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,
            "type": "",
            "unit_price": "",
            "warranty": false
        }
    ],
    "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 e entretenimento

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.
`event_date`	Date	Data do evento.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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"
        }
    },
    "items": [
        {
            "external_code": "1",
            "title": "Passagem Para Curitiba",
            "description": "Passagem Para Curitiba",
            "picture_url": "",
            "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"
    }
}

Casa e decoração

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.
`warranty`	Boolean	Produto tem garantia.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Entregas (object shipment)

Campo	Tipo	Descrição
`address`	Object	Dados do endereço da entrega.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: apartamento, andar, bloco, fundos). Está em `address`.

Entregas (object additional_info)

Campo	Tipo	Descrição
`shipment.express`	Boolean	Indica se a entrega é expressa. Caso seja, use `true` e, caso não seja, use `false`.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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,
            "unit_price": "",
            "warranty": false
        }
    ],
    "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"
    }
}

Aplicativos e plataformas online

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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",
            "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"
    }
}

Varejo

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`picture_url`	String	URL da imagem do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Entregas (object shipment)

Campo	Tipo	Descrição
`address`	Object	Dados do endereço da entrega.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: apartamento, andar, bloco, fundos). Está em `address`.

Entregas (object additional_info)

Campo	Tipo	Descrição
`shipment.express`	Boolean	Indica se a entrega é expressa. Caso seja, use `true` e, caso não seja, use `false`.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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"
    }
}

Serviços governamentais e públicos

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades.
`unit_price`	String	Preço unitário do item.
`event_date`	Date	Data do evento.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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,
            "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"
    }
}

Turismo

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Passageiros (additional_info.travel.passengers)

Campo	Tipo	Descrição
`first_name`	String	Nome do passageiro. Está dentro do objeto `passenger`.
`last_name`	String	Sobrenome do passageiro. Está dentro do objeto `passenger`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.

Rotas (additional_info.travel.routes)

Campo	Tipo	Descrição
`departure`	String	Local de partida da rota (ex: código do aeroporto).
`destination`	String	Local de destino da rota (ex: código do aeroporto).
`departure_date_time`	Date	Data e hora de saída da rota.
`arrival_date_time`	Date	Data e hora de chegada da rota.
`company`	String	Companhia responsável pela execução da rota.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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,
            "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",
        "travel.passengers": [
            {
                "first_name": "John",
                "last_name": "Doe",
                "identification": {
                    "type": "CPF",
                    "number": "11111111111"
                }
            }
        ],
        "travel.routes": [
            {
                "departure": "GRU",
                "destination": "CWB",
                "departure_date_time": "2026-12-30T22:00:00",
                "arrival_date_time": "2026-12-30T23:00:00",
                "company": "gol"
            },
            {
                "departure": "GRU",
                "destination": "CWB",
                "departure_date_time": "2027-01-02T22:00:00",
                "arrival_date_time": "2027-01-02T23:00:00",
                "company": "azul"
            }
        ]
    }
}

Hospitalidade

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário.
`event_date`	Date	Data do evento.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Passageiros (additional_info.travel.passengers)

Campo	Tipo	Descrição
`first_name`	String	Nome do passageiro. Está dentro do objeto `passenger`.
`last_name`	String	Sobrenome do passageiro. Está dentro do objeto `passenger`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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",
            "category_id": "travel",
            "quantity": 1,
            "unit_price": "",
            "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",
        "travel.passengers": [
            {
                "first_name": "John",
                "last_name": "Doe",
                "identification": {
                    "type": "CPF",
                    "number": "11111111111"
                }
            }
        ]
    }
}

Utilitários

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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",
            "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"
    }
}

Venda direta

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
external_code	String	Código de identificação do item.
title	String	Nome/título do item.
type	String	Tipo de item.
description	String	Descrição do item.
category_id	String	Categoria do item.
quantity	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Entregas (object shipment)

Campo	Tipo	Descrição
`address`	Object	Dados do endereço da entrega.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: apartamento, andar, bloco, fundos). Está em `address`.

Entregas (object additional_info)

Campo	Tipo	Descrição
`shipment.express`	Boolean	Indica se a entrega é expressa. Caso seja, use `true` e, caso não seja, use `false`.
`shipment.local_pickup`	Boolean	Indica se é possível retirar em uma agência o produto adquirido. Se retira na agência, use `true` e, caso não retira, use `false`.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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.express": true,
        "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"
    }
}

Automóveis e náutica

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Entregas (object shipment)

Campo	Tipo	Descrição
`address`	Object	Dados do endereço da entrega.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: apartamento, andar, bloco, fundos). Está em `address`.

Entregas (object additional_info)

Campo	Tipo	Descrição
`shipment.express`	Boolean	Indica se a entrega é expressa. Caso seja, use `true` e, caso não seja, use `false`.
`shipment.local_pickup`	Boolean	Indica se é possível retirar em uma agência o produto adquirido. Se retira na agência, use `true` e, caso não retira, use `false`.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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,
            "unit_price": ""
        }
    ],
    "additional_info": {
        "shipment.express": true,
        "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"
    }
}

Transporte urbano

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`description`	String	Descrição do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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"
    }
}

Apostas

Adicione qualquer informação extra que considerar necessária sobre:

Itens (array items)

Campo	Tipo	Descrição
`external_code`	String	Código de identificação do item.
`title`	String	Nome/título do item.
`category_id`	String	Categoria do item.
`quantity`	Integer	Quantidade de unidades do item.
`unit_price`	String	Preço unitário do item.
`warranty`	Boolean	Produto tem garantia.

Comprador (object payer)

Campo	Tipo	Descrição
`payer`	Object	Dados do comprador.
`first_name`	String	Nome do comprador. Está dentro do objeto `payer`.
`last_name`	String	Sobrenome do comprador. Está dentro do objeto `payer`.
`identification`	Object	Dados de identificação do comprador (ex: tipo e número).
`type`	String	Tipo de identificação. Está dentro do objeto `identification`.
`number`	String	Número de identificação. Está dentro do objeto `identification`.
`phone`	Object	Telefone do comprador.
`area_code`	String	Código de área do comprador. Está dentro do objeto `phone`.
`number`	String	Número de telefone do comprador. Está dentro do objeto `phone`.
`address`	Object	Dados do endereço do comprador.
`zip_code`	String	Código postal do comprador. Está dentro do objeto `address`.
`street_name`	String	Nome da rua do endereço do comprador. Está dentro do objeto `address`.
`street_number`	String	Número da rua do endereço do comprador. Está dentro do objeto `address`.
`city`	String	Cidade do endereço do comprador. Está dentro do objeto `address`.
`state`	String	Estado do endereço do comprador. Está dentro do objeto `address`.
`neighborhood`	String	Bairro do endereço do comprador. Está dentro do objeto `address`.
`complement`	String	Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`.

Comprador (object additional_info)

Campo	Tipo	Descrição
`payer.authentication_type`	String	Tipo de autenticação. Pode ser "MOBILE" ou "WEB".
`payer.registration_date`	Date	Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601.
`payer.is_prime_user`	Boolean	Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`.
`payer.is_first_purchase_online`	Boolean	Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`.
`payer.last_purchase`	Date	Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601.

Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima:

curl
{
    "type": "online",
    "total_amount": "50.00",
    "external_reference": "ext_ref_1234",
    "transactions": {
        "payments": [
            {
                "amount": "50.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",
            "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"
    }
}

AnteriorSalvar cartõesSalve os dados do comprador na sua loja para agilizar as próximas compras.

PróximoStatus da transaçãoConsulte os principais status em que pode resultar a criação de uma transação.