Sign in

v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Criar Checkout

post/checkouts

Headers

Authorizationstring

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

Content-typestring

Request body

reference_idstring

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

expiration_datestring 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_modifiableboolean

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

additional_amountinteger

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_amountinteger

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).

soft_descriptorstring

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

redirect_urlstring

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

redirect_waiting_timeinteger

Define, em segundos, o tempo de espera antes do redirecionamento automático do comprador para a URL de retorno configurada (Máximo 120).

notification_urlsstring[]

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

payment_notification_urlsstring[]

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).

return_urlstring

URL para redirecionamento do comprador após concluir ou cancelar o pagamento no Checkout PagBank. Essa URL deve apontar para a sua loja, permitindo que o cliente retorne facilmente após a finalização da transação (Max 255 caracteres).

Response

200

idstring
reference_idstring
expiration_datestring
created_atstring
statusstring
customer_modifiableboolean
additional_amountinteger
discount_amountinteger
soft_descriptorstring
redirect_urlstring
redirect_waiting_timeinteger
return_urlstring
notification_urlsstring[]
payment_notification_urlsstring[]

Example response

{
  "id": "CHEC_XXXX",
  "reference_id": "REFERÊNCIA DO PRODUTO",
  "expiration_date": "2023-08-14T19:09:10-03:00",
  "created_at": "2023-06-14T16:34:30-03:00",
  "status": "ACTIVE",
  "customer": {
    "name": "João Teste",
    "email": "joao@teste.com",
    "tax_id": "00000000000",
    "phone": {
      "country": "+55",
      "area": "27",
      "number": "999999999"
    }
  },
  "customer_modifiable": true,
  "items": [
    {
      "reference_id": "ITEM01",
      "name": "Nome do Produto",
      "quantity": 1,
      "unit_amount": 500,
      "image_url": "https://www.petz.com.br/blog//wp-content/upload/2018/09/tamanho-de-cachorro-pet-1.jpg"
    }
  ],
  "shipping": {
    "type": "FREE",
    "address": {
      "country": "BRA",
      "region_code": "SP",
      "city": "São Paulo",
      "postal_code": "01452002",
      "street": "Faria Lima",
      "number": "1384",
      "locality": "Pinheiros",
      "complement": "5 andar"
    },
    "address_modifiable": true
  },
  "payment_methods": [
    {
      "type": "CREDIT_CARD",
      "brands": [
        "MASTERCARD"
      ]
    }
  ],
  "payment_methods_configs": [
    {
      "type": "CREDIT_CARD",
      "config_options": [
        {
          "option": "INSTALLMENTS_LIMIT",
          "value": "1"
        }
      ]
    }
  ],
  "soft_descriptor": "xxxx",
  "redirect_url": "https://pagseguro.uol.com.br",
  "redirect_waiting_time": 15,
  "return_url": "https://pagseguro.uol.com.br",
  "notification_urls": [
    "https://pagseguro.uol.com.br"
  ],
  "payment_notification_urls": [
    "https://pagseguro.uol.com.br"
  ],
  "links": [
    {
      "rel": "PAY",
      "href": "https://pagamento.pagseguro.uol.com.br/pagamento?code=XXXX",
      "method": "GET"
    }
  ]
}