PApagbank

Criar Checkout

Changed on

Utilize este endpoint para solicitar a criação de um checkout

post/checkouts/old

Request

  • Base URL
    https://sandbox.api.pagseguro.com
  • URL
    https://sandbox.api.pagseguro.com/checkouts/old
  • Auth
    none required

Headers

Content-typestring
Authorizationstring

Bearer TOKEN

Request body

reference_idstring

Id de referência para o checkout informado pelo vendedor na criação do checkout. Limite: 64 caracteres

expiration_datestring

Data de expiração do checkout. Caso não seja informado, a data de expiração será a data e hora atual + 2 horas. Padrão esperado: ISO-8601 Date time with timezone offset

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. Regras do campo: O objeto customer torna-se obrigatório caso o valor informado seja false.

additional_amountinteger

Valor adicional a ser cobrado (Em centavos). BigInteger (0 - 999999900)

discount_amountinteger

Valor a ser descontado do valor total (Em centavos). BigInteger (0 - 999999900)

soft_descriptorstring

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

redirect_urlstring

URL para redirecionamento após pagamento. Limite: 255 caracteres

notification_urlsstring[]

Lista de URLs para notificação de status do checkout. Limite: (5-100 caracteres)

payment_notification_urlsstring[]

Lista de URLs para notificação dos status de pagamento. Limite: (5-100 caracteres)

Response

200

idstring
reference_idstring
expiration_datestring
created_atstring
statusstring
customer_modifiableboolean
additional_amountinteger
discount_amountinteger
soft_descriptorstring
redirect_urlstring
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
    }
  ],
  "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",
      "brands": [
        "MASTERCARD"
      ],
      "config_options": [
        {
          "option": "INSTALLMENTS_LIMIT",
          "value": "1"
        }
      ]
    }
  ],
  "soft_descriptor": "xxxx",
  "redirect_url": "https://pagseguro.uol.com.br",
  "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"
    }
  ]
}

Changes