| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
| id | String | REQUEST: NãoRESPONSE: Sim | Identificador único gerado para o checkout. |
| reference_id | String (64 caracteres) | REQUEST: Opcional RESPONSE: Condicional | Id de referência para o checkout informado pelo vendedor na criação do checkout. |
| expiration_date | ISO-8601 Date time with timezone offset | REQUEST: Opcional RESPONSE: Sim | Data de expiração do checkout. Caso não seja informado, a data de expiração será a data e hora atual + 2 horas. |
| customer | Object | REQUEST: Opcional ou Obrigatório RESPONSE: Condicional | Dados pessoais do comprador. Regras do campo: Campo obrigatório caso o valor informado em customer_modifiable seja false. |
| └──name | String (1 - 120 caracteres) | REQUEST: Opcional ou Obrigatório RESPONSE: Condicional | Nome/Razão Social do cliente informado pelo vendedor. Regras do campo: - Deve conter nome e sobrenome. - Caracteres especiais permitidos, porém removidos: .?:+/|,ºª;@\_$-\*- Apóstrofo e números são aceitos e não são removidos. - Campo obrigatório caso o valor informado em customer_modifiable seja false. |
| String (10 - 60 caracteres) | REQUEST: Opcional ou Obrigatório RESPONSE: Condicional | E-mail do cliente informado pelo vendedor. Regras do campo: - Deve ser um email válido. - Campo obrigatório caso o valor informado em customer_modifiable seja false. | |
| └──tax_id | String (11/14 caracteres) | REQUEST: Opcional ou Obrigatório RESPONSE: Condicional | Número do CPF ou CNPJ do cliente informado pelo vendedor. Regras do campo: -Apenas números - Campo obrigatório caso o valor informado em customer_modifiable seja false. |
| └──phone | Object | REQUEST: Opcional ou ObrigatórioRESPONSE: Condicional | Dados do telefone do cliente. Regras do campo: - Campo obrigatório caso o valor informado em customer_modifiable seja false. |
| └──└──country | String (2 - 3 caracteres) | REQUEST: Opcional RESPONSE: Condicional | Código do País (DDI) do telefone do cliente informado pelo vendedor. Regras do campo: - Caractere especial permitido: +- Somente o código do Brasil (55) é aceito. |
| └──└──area | String (2 caracteres) | REQUEST: Opcional ou Obrigatório RESPONSE: Condicional | Código de Área (DDD) do telefone do cliente informado pelo vendedor. Regras do campo: - Campo obrigatório caso o valor informado em customer_modifiable seja false. |
| └──└──number | String (9 caracteres) | REQUEST: Opcional ou Obrigatório RESPONSE: Condicional | Número do telefone do cliente informado pelo vendedor. Regras do campo: - Deve iniciar com o número 9. - Deve conter 9 números. - Campo obrigatório caso o valor informado em customer_modifiable seja false. |
| customer_modifiable | Boolean | REQUEST: Opcional RESPONSE: Sim | Indicador da imutabilidade dos dados pessoais na criação do checkout, possibilitando pular o step de dados pessoais. Caso não informado, o valor padrão é true. Regras do campo: - O objeto customer torna-se obrigatório caso o valor informado seja false. |
| items | Array of Objects | REQUEST: ObrigatórioRESPONSE: Sim | Lista de produtos informado pelo vendedor. Deve conter, no mínimo, Nome, Quantidade e Valor unitário. |
| └──reference_id | String (100 caracteres) | REQUEST: Opcional RESPONSE: Condicional | Referência do produto informado pelo vendedor. |
| └──name | String (1 - 100 caracteres) | REQUEST: OpcionalRESPONSE: Condicional | Nome do produto informado pelo vendedor. |
| └──description | String (255 caracteres) | REQUEST: OpcionalRESPONSE: Condicional | Descrição do produto informado pelo vendedor. |
| └──quantity | Integer (1 - 999) | REQUEST: Obrigatório RESPONSE: Sim | Quantidade do produto informado pelo vendedor. |
| └──unit_amount | Integer (0 - 999999900) | REQUEST: Obrigatório RESPONSE: Sim | Valor unitário do produto informado pelo vendedor (Em centavos). |
| additional_amount | BigInteger (0 - 999999900) | REQUEST: Opcional RESPONSE: Sim | Valor adicional a ser cobrado (Em centavos). |
| discount_amount | BigInteger (0 - 999999900) | REQUEST: Opcional RESPONSE: Sim | Valor a ser descontado do valor total (Em centavos). Regras do campo: O valor a ser descontado não deve ultrapassar a soma do valor dos itens + valor adicional. |
| shipping | Object | REQUEST: OpcionalRESPONSE: Condicional | Dados de entrega do produto, caso não informado será considerado que não há necessidade de entrega, caso informado, deve indicar se o valor da entrega é Fixo, Grátis ou Calculado. |
| └──type | (ENUM) | REQUEST: Obrigatório RESPONSE: Sim | Tipo de entrega (FIXED, FREE ou CALCULATED). |
| └──service_type | (ENUM) | REQUEST: Opcional RESPONSE: Sim | Tipo de serviço de entrega ('SEDEX', 'PAC') utilizado no frete calculado. Caso não seja informado, o cliente poderá escolher entre as cotações de PAC e SEDEX na tela. |
| └──address_modifiable | Boolean | REQUEST: Opcional RESPONSE: Sim | Indicador de endereço ser alterável na tela de endereço de entrega do checkout. Caso não informado, o valor padrão é true. Regras do campo: O objeto shipping.address torna-se obrigatório caso o valor informado seja false. |
| └──amount | Integer (0 - 2147483647) | REQUEST: Opcional ou Obrigatório RESPONSE: Sim | Valor de custo da entrega (Em centavos). Regras do campo: Campo obrigatório caso o valor informado em shipping.type seja FIXED. |
| └──address | Object | REQUEST: Opcional ou Obrigatório RESPONSE: Condicional | Endereço de entrega. Caso informado, Logradouro, Bairro, Cidade, Estado, País e CEP são obrigatórios. Regras do campo: Campo obrigatório caso o valor informado em shipping.address_modifiable seja false. |
| └──└──street | String (1 - 160 caracteres) | REQUEST: Obrigatório RESPONSE: Sim | Logradouro do endereço de entrega. |
| └──└──number | String (1 - 20 caracteres) | REQUEST: Obrigatório RESPONSE: Condicional | Número do endereço de entrega. |
| └──└──complement | String (1 - 40 caracteres) | REQUEST: Opcional RESPONSE: Condicional | Complemento do endereço de entrega. |
| └──└──locality | String (1 - 60 caracteres) | REQUEST: Obrigatório RESPONSE: Sim | Bairro do endereço de entrega. |
| └──└──city | String (1 - 90 caracteres) | REQUEST: Obrigatório RESPONSE: Sim | Cidade do endereço de entrega. |
| └──└──region_code | String (ISO 3166-1 alfa-3) | REQUEST: Obrigatório ` RESPONSE: Sim | Estado do endereço de entrega. |
| └──└──country | String (ISO 3166-1 alfa-3) | REQUEST: Obrigatório ` RESPONSE: Sim | País do endereço de entrega. |
| └──└──postal_code | String (8 caracteres) | REQUEST: Obrigatório ` RESPONSE: Sim | CEP do endereço de entrega. |
| └──box | Object | REQUEST: Opcional RESPONSE: Sim | Caixa de entrega. Regras do campo: - Campo obrigatório caso o valor informado em shipping.type seja CALCULATE. |
| └──└──dimensions | Object | REQUEST: Obrigatório RESPONSE: Sim | Dimensões da caixa de entrega. Regras do campo: - A soma das dimensões deve ser inferior a 200 centímetros. |
| └──└──└──length | Integer (15 - 100) | REQUEST: ObrigatórioRESPONSE: Sim | Comprimento da caixa em centímetros. |
| └──└──└──width | Integer (10 - 100) | REQUEST: Obrigatório RESPONSE: Sim | Largura da caixa em centímetros. |
| └──└──└──height | Integer (1 - 100) | REQUEST: Obrigatório RESPONSE: Sim | Altura da caixa em centímetros. |
| └──└──weight | Integer (300 - 10000) | REQUEST: Obrigatório RESPONSE: Sim | Peso da caixa (em gramas). |
| payment_methods | Array of Objects | REQUEST: Opcional RESPONSE: Condicional | Meios de pagamento aceitos. |
| └──└──type | ENUM | REQUEST: Obrigatório RESPONSE: Sim | Meio de pagamento escolhido pelo vendedor ('CREDIT_CARD', 'DEBIT_CARD', ‘BOLETO’, ‘PIX’) |
| └──└──brands | Array of ENUM | REQUEST: Opcional RESPONSE: Condicional | Quando o campo payment_methods[].type for ‘CREDIT_CARD’ ou ‘DEBIT_CARD’, pode ser passada um lista com as bandeiras de cartões aceitas pelo vendedor neste campo. Ver lista de bandeiras aceitas. |
| payment_methods_configs | Array of Objects | REQUEST: Opcional RESPONSE: Condicional | Configurações dos meios de pagamento. |
| └──└──type | ENUM | REQUEST: Obrigatório RESPONSE: Sim | Meio de pagamento que receberá algum tipo de configuração ('CREDIT_CARD', ‘DEBIT_CARD’). |
| └──└──brands | Array of ENUM | REQUEST: Opcional RESPONSE: Condicional | Lista com as bandeiras de cartões que receberão algum tipo de configuração. Ver lista de bandeiras aceitas. |
| └──└──config_options | Array of Objects | REQUEST: Obrigatório RESPONSE: Sim | Lista de opções de configuração. |
| └──└──└──└──option | ENUM | REQUEST: Obrigatório RESPONSE: Sim | Opção de configuração dada a um meio de pagamento ('INSTALLMENTS_LIMIT'). |
| └──└──└──└──value | String | REQUEST: Obrigatório RESPONSE: Sim | Valor da configuração dada a um meio de pagamento. |
| redirect_url | String (255 caracteres) | REQUEST: Opcional RESPONSE: Condicional | URL para redirecionamento após pagamento. |
| soft_descriptor | String (17 caracteres | REQUEST: Opcional RESPONSE: Condicional | Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador. |
| return_url | String (255 caracteres) | REQUEST: Opcional RESPONSE: Condicional | URL para retorno a loja. Caso não seja enviado, o Checkout permanecerá em sua tela de conclusão. |
| notification_urls | Array of String (5 - 100 caracteres) | REQUEST: OpcionalRESPONSE: Condicional | Lista de URLs para notificação dos status de Checkout |
| payment_notification_urls | String (5 - 100 caracteres) | REQUEST: OpcionalRESPONSE: Condicional | Lista de URLs para notificação dos status de pagamento. |
| created_at | String (ISO-8601 Date time with timezone offset) | REQUEST: Não RESPONSE: Sim | Data de criação do checkout. |
| status | (ENUM) | REQUEST: Não RESPONSE: Sim | Status do checkout ('ACTIVE', 'INACTIVE', 'EXPIRED'). Por padrão, o checkout é criado com status ACTIVE. |
| links | Array of Objects | REQUEST: NãoRESPONSE: Sim | Objeto contendo as informações de links relacionado ao recurso. |
| └──rel | (ENUM) | REQUEST: Não RESPONSE: Sim | Indica o relacionamento do recurso ('SELF', ‘PAY’, ‘ACTIVATE', 'INACTIVATE’). |
| └──href | String | REQUEST: Não RESPONSE: Sim | Endereço HTTP do recurso. |
| └──method | (ENUM) | REQUEST: Não RESPONSE: Sim | Método HTTP em uso ('POST', ‘GET’). |