id String
Identificador único do checkout.
Exemplo: CHEC_XXXX
reference_id String (64 caracteres)
Identificador único atribuído para o pedido. Utilizado internamente pelo vendedor em seu sistema.
Exemplo: ex-00001
expiration_date Timestamp (ISO-8601)
Data de expiração do checkout.
Exemplo: 2023-08-14T19:09:10-03:00
customer Object
Objeto contendo os dados pessoais do comprador.
Deve ser informado caso customer_modifiable seja false 
name String (1 - 120 caracteres)
Nome/Razão Social do cliente, devendo conter nome e sobrenome.
Caracteres especiais são permitidos, porém eles serão removidos.
Apóstrofo e números são aceitos e não serão removidos.
Exemplo: Jose Abcd
email String (10 - 60 caracteres)
E-mail do cliente. Esse email será validado e um erro será retornado se o formato não for válido.
Exemplo: [email protected]
tax_id String (11/14 caracteres)
Número do CPF ou CNPJ do cliente. Apenas números são aceitos.
Exemplo: 11111111111
phone Object
Objeto com os dados do telefone do cliente.
country String (2 - 3 caracteres)
Código do país (DDI) do telefone do cliente.
Somente o caracter especias + é aceito.
Somente o código do Brasil (55) é aceito.
Exemplo: +55
area String (2 caracteres)
Código de área (DDD) do telefone do cliente.
Exemplo: 11
number String (9 caracteres)
Número do telefone do cliente contendo 9 caracteres.
Deve sempre iniciar com o número 9.
Exemplo: 911111111
customer_modifiable Boolean
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.
O objeto customer torna-se obrigatório caso o valor informado seja false
Exemplo: false
items Array of Objects
Lista de produtos associados ao pedido.
reference_id String (1-100 caracteres)
Referência do produto no sistema do vendedor.
Exemplo: ITEM01
name String (1-100 caracteres)
Nome do produto.
Exemplo: Nome do Produto
description String (1-255 caracteres)
Descrição do produto informado pelo vendedor.
Exemplo: Descrição do produto
quantity Integer (1-999)
Quantidade de exemplares desse produto associado ao pedido do cliente.
Obrigatório
Exemplo: 2
unit_amount Integer (0-999999900)
Valor unitário do produto definido em centavos. Para o valor de R$ 1, você deve informar o valor de 100.
Obrigatório
Exemplo: 100
image_url String
URL da imagem do produto. Essa imagem será utilizada ao apresentar a lista de items na página do checkout.
Exemplo: https://www.petz.com.br/blog//wp-content/upload/2018/09/tamanho-de-cachorro-pet-1.jpg
additional_amount Integer (0-999999900)
Valor adicional a ser cobrado. Esse é um valor complementar ao valor total resultande da soma dos items
pertencentes ao pedido.
Exemplo: 100
discount_amount Integer (0-999999900)
Valor a ser descontado do valor total da compra. O valor do desconto é informado em centavos.
O valor informado não deve superar a soma do valor total dos itens somado ao valor adicional
(additional_amount).
Exemplo: 100
shipping Object
Dados de entrega do produto. Caso não informado é considerado que não existe a necessidade de realizar a
entrega. Caso seja informado, é necessário definir se o valor da entrega é fixo, grátis ou calculado.
type ENUM
Tipo de entrega:
- FIXED: O associado a entrega é fixo.
- FREE: Não existe custo para realizar a entrega do pedido.
- CALCULATE: O valor da entrega é calculado com base no volume do pacote.
service_type ENUM
Tipo de serviço de entrega utilizado no frete calculado:
- SEDEX
- PAC
Caso não seja informado, o cliente poderá escolher entre as opções na tela do checkout.
address_modifiable Boolean
Indicador se o endereço pode ser alterado na tela de endereço de entrega do checkout. Caso não informado,
o valor padrão é true.
Caso você selecione a opção false, o objeto shipping.address torna-se
obrigatório.
Exemplo: true
amount Integer (0-2147483647)
Valor do custo da entrega em centavos.
Obrigatório caso shipping.type seja FIXED
Exemplo: 10100
address Object
Endereço de entrega.
Obrigatório caso address_modifiable seja false
street String (1-160 caracteres)
Logradouro do endereço de entrega.
Obrigatório
Exemplo: Rua São João
number String (1-20 caracteres)
Número do endereço de entrega.
Obrigatório
Exemplo: 1115
complement String (1-40 caracteres)
Complemento do endereço de entrega.
Exemplo: Casa
locality String (1-60 caracteres)
Bairro do endereço de entrega.
Obrigatório
Exemplo: Centro
city String (1-90 caracteres)
Cidade do endereço de entrega.
Obrigatório
Exemplo: João Pessoa
region_code String (ISO 3166-1 alfa-3)
Estado do endereço de entrega.
Obrigatório
Exemplo: SP
country String (ISO 3166-1 alfa-3)
País do endereço de entrega.
Obrigatório
Exemplo: BRA
country String (8 caracteres)
CEP do endereço de entrega. Somente números.
Obrigatório
Exemplo: 89845000
box Object
Define o tamanho e peso da caixa de entrega.
Obrigatório caso shipping.type seja CALCULATE
weight Integer (300-10000)
Peso da caixa em gramas.
Obrigatório
Exemplo: 400
dimensions Object
Define a dimensão da caixa.
Obrigatório
length Integer (15-100)
Comprimento da caixa em centímetros.
Obrigatório
Exemplo: 400
width Integer (10-100)
Largura da caixa em centímetros.
Obrigatório
Exemplo: 40
height Integer (1-100)
Altura da caixa em centímetros.
Obrigatório
Exemplo: 40
payment_methods Array of Objects
Define quais meios de pagamento você deseja que sejam aceitos no checkout.
type ENUM
Meio de pagamento escolhido pelo vendedor:
- CREDIT_CARD
- DEBIT_CARD
- BOLETO
- PIX
brands Array of ENUM
Quando o campo payment_methods[].type for CREDIT_CARD ou
DEBIT_CARD, você pode definir uma lista com as bandeiras de cartões que você deseja aceitar. Atualmente as seguintes bandeiras são suportadas:
- PERSONALCARD
- UPBRASIL
- BANESECARD
- VISA
- MASTERCARD
- AMEX
- DINERS
- HIPERCARD
- HIPER
- AURA
- CABAL
- AVISTA
- PLENOCARD
- ELO
- GRANDCARD
- CARDBAN
- SOROCRED
- BRASILCARD
- VERDECARD
- JCB
- MAIS
- POLICARD
- VALECARD
- DISCOVER
- FORTBRASIL
payment_methods_configs Array of Objects
Configuração dos meios de pagamento. As configurações são aplicáveis apenas para CREDIT_CARD e DEBIT_CARD.
type ENUM
Meio de pagamento que será configurado:
- CREDIT_CARD
- DEBIT_CARD
config_options Array of Objects
Lista de opções de configuração..
option ENUM
Opção de configuração dada a um meio de pagamento. Atualemte as seguintes opções estão disponíveis:
- INSTALLMENTS_LIMIT: define o número máximo de parcelas para o pagamento.
- INTEREST_FREE_INSTALLMENTS: especifica o número de parcelas cujo juros serão assumidos pelo vendedor.
value String
Valor da configuração dada a um meio de pagamento.
Exemplo: 10
redirect_url String (255 caracteres)
URL para redirecionamento do comprador após a finalização do pagamento.
Exemplo: https://www.google.com/
soft_descriptor String (17 caracteres)
Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador.
Exemplo: Vestuário
return_url String (255 caracteres)
URL para retorno a loja. Na página do Checkout PagBank é disponibilizada a opção do comprador retornar a loja, caso desejar.
Exemplo: https://www.google.com/
notification_urls Array of String (5-100 caracteres)
Lista de URLs para as quais o PagBank enviará notificações sobre atualizações do status do checkout.
Exemplo: ["https://www.google.com/", "https://www.google.com"]
notification_urls Array of String (5-100 caracteres)
Lista de URLs para as quais o PagBank enviará notificações sobre a atualização do status do pagamento associado ao checkout.
Exemplo: ["https://www.google.com/", "https://www.google.com"]
created_at Timestamp (ISO-8601)
Data de criação do checkout.
Exemplo: 2023-08-14T19:09:10-03:00
status ENUM
Status atual do checkout. (ACTIVE, INACTIVE, EXPIRED). Por padrão, o checkout é criado com status ACTIVE.
Exemplo: ACTIVE
links Array of Objects
Links associados a funções e operações relacionadas ao checkout criado.
rel ENUM
Indica o relacionamento do recurso
- SELF
- PAY
- ACTIVATE
- INACTIVATE
href String
Endereço HTTP do recurso. Você pode realizar uma requisição utilizando esse endpoit.
Exemplo: https://pagamento.pagseguro.uol.com.br/pagamento?code=XXXX
method ENUM
Define o tipo de requisição que pode ser executada.
- POST
- GET