Criar Checkout

post https://sandbox.api.pagseguro.com/checkouts

Este endpoint permite que você crie checkouts personalizados para cada pedido recebedo dos seus clientes. Note que você pode definir opções para receber notificações sobre o status do pagamento, através do parâmetro payment_notification_urls, e do checkout, através do parâmetro notification_urls, de forma independente.

📘
Acesse o guia do serviço de checkout para mais informações sobre seu funcionamento e funcionalidades disponíveis.

Body Params

reference_id

string

Identificador único atribuído para o pedido. Utilizado internamente pelo vendedor em seu sistema (Max 64 caracteres).

expiration_date

date-time

Data de expiração do checkout (ISO-8601). Caso não seja informado, a data de expiração será a data e hora do momento da criação do checkout + 2 horas.

customer

object

Objeto contendo os dados pessoais do comprador. ⚠️ Deve ser informado caso customer_modifiable seja false. Nesse caso todos os parâmetros deste objeto são obrigatórios. ⚠️

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 ⚠️

items

array of objects

Lista de produtos associados ao pedido. ⚠️ Obrigatório ⚠️

items

additional_amount

int32

Valor adicional a ser cobrado definido em centavos (Max 999999900). Esse é um valor complementar ao valor total resultande da soma dos items pertencentes ao pedido.

discount_amount

int32

Valor a ser descontado do valor total da compra (Max 999999900). 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).

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.

payment_methods

array of objects

Define quais meios de pagamento você deseja que sejam aceitos no checkout.

payment_methods

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.

payment_methods_configs

soft_descriptor

string

Texto adicional que será apresentado junto ao nome do estabelecimento na fatura do cartão de crédito do comprador (Max 17 caracteres).

redirect_url

string

URL para redirecionamento do comprador após a finalização do pagamento (Max 255 caracteres).

notification_urls

array of strings

Lista de URLs para as quais o PagBank enviará notificações sobre atualizações do status do checkout (Max 100 caracteres cada).

notification_urls

payment_notification_urls

array of strings

Lista de URLs para as quais o PagBank enviará notificações sobre a atualização do status do pagamento associado ao checkout (Min 5/Max 100 caracteres cada).

payment_notification_urls

Headers

Authorization

string

Defaults to Bearer <token>

Token de autenticação. Deve ser enviado no formato Bearer <token>.

Content-type

string

Defaults to application/json

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox.api.pagseguro.com/checkouts \
3
     --header 'Authorization: Bearer <token>' \
4
     --header 'Content-type: application/json' \
5
     --header 'accept: application/json' \
6
     --header 'x-client-id: <your-client-id>' \
7
     --header 'x-client-secret: <your-client-secret>'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘

200200

400400