---
title: "Create a Payment Page"
method: POST
path: "/v3/checkouts"
tags: ["Payment Page"]
---

# Create a Payment Page

`POST /v3/checkouts`

Creates a new checkout session for your customer to complete the payment.  PagSeguro will generate a link to the payment page where the customer can finalize the transaction.  You can specify a preferred payment method or allow the customer to choose from available options.

## Request body

- PaymentPageRequest
  - `integration` IntegrationPaymentPage, required — Object containing the integration data referring to the Merchant Store.
    - `reference` string, required — Transaction reference code in the merchant's store.
    - `notification_url` string, url, required — PagSeguro uses the URL to send notifications after the transaction status changes.
    - `project` integer — Integration project identifier.
  - `order` Order, required — Contains the list of products purchased by the customer from the merchant's store along with their respective values.
    - `currency` 'BRL' | 'CLP' | 'COP' | 'MXN' | 'PEN' | 'USD', required — Currency for charging the transaction (ISO 4217). List of currencies available for PagSeguro: | ISO Code | Currency | |----------|-------------------------| | BRL | Brazilian Real (Brazil) | | CLP | Chilean Peso (Chile) | | COP | Colombian Peso (Colombia) | | MXN | Mexican Peso (Mexico) | | PEN | Nuevo Sol (Peru) | | USD | Dollar (USA) |
    - `items` object[], required — List of items purchased by the customer.
      - `quantity` integer, required — Number of items selected by the customer.
      - `description` string, required — Item description. Accepted characters: Uppercase (A-Z), lowercase (a-z), and numbers (0-9).
      - `unit_price` number, float, required — Price per unit. The PagSeguro API supports amounts starting from 0.01. However, the minimum and maximum transaction limits vary by country and payment method. We recommend using the values listed below: | Country | Payment Method | Minimum Total Amount | Maximum Total Amount | ISO Code Currency | Accepted Brands | |----------|------------------------|----------------------|----------------------|-------------------|------------------------------------------------------------| | Brazil | All credit card brands | 1.00 | 40000.00 | BRL | American Express, Diners, MasterCard, Visa, Elo, Hipercard | | Chile | All credit card brands | 0.01 | 1000000.00 | CLP | American Express, Diners, MasterCard, Visa | | Colombia | All credit card brands | 0.01 | 38000000.00 | COP | American Express, Diners, MasterCard, Visa | | Mexico | All credit card brands | 0.01 | 74000.00 | MXN | American Express, Diners, MasterCard, Visa | | Peru | All credit card brands | 0.01 | 34000.00 | PEN | American Express, Diners, MasterCard, Visa |
  - `checkout` Checkout, required — Defines how the PagSeguro Checkout will be displayed to the Customer.
    - `language` 'en_US' | 'es_ES' | 'pt_BR' | 'pt_PT' | 'tr_TR', required — Specifies the language used by the Payment Page interface. Supported languages:
    - `redirect_urls` object, required — Object specifying the URLs used to redirect the user after finishing using the checkout page.
      - `success` string, url, required — URL used to redirect users after finishing the checkout process successfully.
  - `charge` ChargePaymentPage, required — The `charge` object contains the payment details required to generate the transaction. The checkout can present payment methods to the customer in two ways: - By specifying a payment type. - By selecting a specific payment method. The `type` represents a category of payment methods, allowing the checkout to display all associated options. Alternatively, you can specify a particular payment method directly. For example, setting the `type = credit_card` enables the customer to choose from available card brands. However, if you set `credit_card = VISA`, you will directly select that payment method for your client. If the `type` is omitted, the checkout will present all available payment methods to the customer.
    - `country` 'BR' | 'CL' | 'CO' | 'MX' | 'PE' | 'US', required — The country where the transaction originates, represented by a two-letter ISO 3166-1 alpha-2 code.
    - `type` 'CREDIT_CARD' | 'DEBIT_CARD' | 'E_WALLET' | 'EFT' | 'OBT' | 'POSTPAY' | 'PREPAY' — Specifies the payment method type used for the transaction.
    - `credit_card` 'AMEX' | 'ARGENCARD' | 'CABAL' | 'CENCOSUD' | 'CMR' | 'DINERS' | 'EASY' | 'ELO' | 'HIPERCARD' | 'JCB' | 'JUMBO' | 'LIDER' | 'MAGNA' | 'MASTERCARD' | 'NATIVA' | 'OCA' | 'PARIS' | 'RIPLEY' | 'TARJETA_SHOPPING' | 'TROYCARD' | 'UNIONPAY' | 'VISA' — Specifies the credit card used to execute the operation.
    - `debit_card` 'MAESTRO' | 'REDCOMPRA' | 'VISA_ELECTRON' | 'WEBPAY' — Specifies the debit card used to execute the operation. Only used for payments using the Payment Page.
    - `e_wallet` 'GPAY' | 'NIUBIZ_WALLET' | 'PAGSEGURO' | 'PAYVALIDA' — Specifies the e-Wallet used to execute the payment. Only used for payments using the Payment Page.
    - `eft` 'BANBIF' | 'BANCO_DE_OCCIDENTE' | 'BANCO_DO_BRASIL' | 'BANCOLOMBIA' | 'BANRISUL' | 'BBVA' | 'BCP' | 'INTERBANK' | 'ITAU' | 'KHIPU' | 'PIX' | 'SANTANDER' | 'SCOTIABANK' — Specifies the EFT payment method used to execute the payment. Only used for payments using the Payment Page.
    - `obt` 'AKBANK' | 'BANAMEX' | 'BANBIF' | 'BANCENTRO_LAFISE' | 'BANCO_DE_BOGOTA' | 'BANCO_DO_BRASIL' | 'BANCO_ESTADO' | 'BANCO_NACIONAL_CR' | 'BANCOLOMBIA' | 'BANCOMER' | 'BBVA' | 'BCI' | 'BCP' | 'BRADESCO' | 'CAJA_CUSCO' | 'CAJA_ICA' | 'CAJA_PIURA' | 'CAJA_TACNA' | 'CAJA_TRUJILLO' | 'CATHAY' | 'CITI' | 'DAVIVIENDA' | 'DENIZ' | 'ECONOMI' | 'GARANTI' | 'INTERBANK' | 'ISBANK' | 'ITAU' | 'KASNET' | 'KUVET' | 'MACRO' | 'MUCAP' | 'MUTUAL_ALAJUEDA' | 'PSE' | 'PTT' | 'SAFETYPAY' | 'SANTANDER' | 'SCOTIABANK' | 'SEKER' | 'SERVIPAG' | 'SPEI' | 'VAKIFAR' | 'WESTERN' | 'YAPI_KREDI' | 'ZIRAAT' — Specifies the OBT payment method used to execute the payment. Only used for payments using the Payment Page.
    - `postpay` 'ABITAB' | 'BANCENTRO_LAFISE' | 'BANCO_NACIONAL_CR' | 'BANORTE' | 'BOLETO_FLASH' | 'BOLETO' | 'CASH' | 'CATHAY' | 'EFECTY' | 'GANA' | 'LAFISE' | 'MUCAP' | 'MULTIBANCO' | 'MULTICAJA' | 'MUTUAL_ALAJUEDA' | 'OXXO' | 'PAGO_EFECTIVO' | 'PAGO_FACIL' | 'PAYSHOP' | 'RAPIPAGO' | 'REDPAGOS' | 'TELEDOLAR' — Specifies the PostPay payment method used to execute the payment. Only used for payments using the Payment Page.
    - `prepay` 'TODITO' — Specifies the Prepay payment method used to execute the payment. Only used for payments using the Payment Page.
  - `payer` PayerPaymentPage — Contains information about the Customer who made the purchase on the Merchant. This object is optional, but if provided, the parameters `payer.person.phone.country_code` and `payer.person.phone.number` are mandatory.
    - `email` string, email — Payer E-mail used to execute the order.
    - `person` PayerPersonPaymentPage — Payer's personal information.
      - `name` string, required — The payer's full name. Must be between 4 and 50 characters long and contain at least two words. The first word must have at least 2 characters, while middle and last names can have between 1 and 40 characters. Words must be separated by exactly one space. Accepted characters: uppercase and lowercase letters (A-Z, a-z), special characters (àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ð/,.'&-). Leading and trailing spaces are not allowed.
      - `birth_date` string, date — Payer's birth date in YYYY-MM-DD format.
      - `document` object, required — Contains the payer's identification document details for the transaction.
        - `type` string, required — Document type.
        - `number` string, required — Document number.
      - `phone` object, required — Contains the payer's phone information.
        - `country_code` string, required — Phone country code. This information is required when you send the `payer` object.
        - `number` string, required — Phone number. This information is required when you send the `payer` object.

## Response `201`

Successfully created the Payment Page.

- PaymentPageResponse
  - `code` string — Checkout UUID code, used for internal PagSeguro tracking.
  - `url` string, uri — Checkout URL used to redirect the customer.
  - `created_at` string, date-time — Checkout creation date and time in Coordinated Universal Time (UTC).
  - `expires_at` string, date-time — Checkout expiration date and time in Coordinated Universal Time (UTC). Represents the maximum time the checkout URL can be accessed.

---

[API](https://skmtc.net/pagseguro/apis/pagseguro-international-api.md) · [All operations](https://skmtc.net/pagseguro/apis/pagseguro-international-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pagseguro/pagseguro-international-api/versions/032af0550731/schema)