> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pepper.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter checkout

> Obtenha dados e configurações de um checkout específico, criado pela sua conta.



## OpenAPI

````yaml GET /checkout/{hash}
openapi: 3.1.0
info:
  title: Pepper API v1
  description: Documentação da API pública da Pepper.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.cloud.pepperpay.com.br/public/v1/
security:
  - bearerAuth: []
paths:
  /checkout/{hash}:
    get:
      description: >-
        Obtenha dados e configurações de um checkout específico, criado pela sua
        conta.
      parameters:
        - name: hash
          in: path
          description: Hash ID do checkout
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dados do checkout retornados com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  template:
                    type: string
                    description: Template do checkout
                  company:
                    type: object
                    properties:
                      id:
                        type: integer
                      creditcard_acquirer_default_id:
                        type: integer
                      title:
                        type: string
                      logo_url:
                        type: string
                      domain:
                        type: string
                      gtag:
                        type: string
                        nullable: true
                      payment_methods_available:
                        type: string
                      public_key:
                        type: string
                      acquirer_creditcard:
                        type: object
                        properties:
                          id:
                            type: integer
                          acquirer_name:
                            type: string
                          script_url:
                            type: string
                          public_key:
                            type: string
                          acquirer_account_id:
                            type: string
                            nullable: true
                  offer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: integer
                      product_id:
                        type: integer
                      user_id:
                        type: integer
                      hash:
                        type: string
                      type:
                        type: string
                      title:
                        type: string
                      cover:
                        type: string
                        nullable: true
                      payment_methods:
                        type: string
                      payment_method_discounts:
                        type: string
                        nullable: true
                      apply_discounts_to_all_offers:
                        type: integer
                      first_billing:
                        type: string
                      currency:
                        type: string
                      price:
                        type: string
                      interval:
                        type: string
                        nullable: true
                      status:
                        type: integer
                      affiliates_visible:
                        type: integer
                      method_default:
                        type: integer
                      shipping_type:
                        type: string
                        nullable: true
                      fixed_shipping:
                        type: string
                        nullable: true
                      redirect_url:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      deleted_at:
                        type: string
                        nullable: true
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      hash:
                        type: string
                      cover:
                        type: string
                      status:
                        type: integer
                      payment_type:
                        type: integer
                      product_type:
                        type: string
                      guaranted_days:
                        type: string
                      support_name:
                        type: string
                      support_email:
                        type: string
                      support_whatsapp:
                        type: string
                      custom_thankyou_page:
                        type: string
                        nullable: true
                      css_custom:
                        type: string
                        nullable: true
                      weight:
                        type: string
                        nullable: true
                      width:
                        type: string
                        nullable: true
                      height:
                        type: string
                        nullable: true
                      length:
                        type: string
                        nullable: true
                      discount_retry:
                        type: string
                        nullable: true
                      custom_checkout_settings:
                        type: string
                        nullable: true
                      delivery_type:
                        type: integer
                      physical:
                        type: string
                        nullable: true
                      checkout_templates:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            type:
                              type: string
                            primary_color:
                              type: string
                            secondary_color:
                              type: string
                            vsl_enabled:
                              type: integer
                            video_enabled:
                              type: integer
                  orderbumps:
                    type: array
                  pixels:
                    type: array
                  affiliates_config:
                    type: object
                    properties:
                      id:
                        type: integer
                      hash:
                        type: string
                      product_id:
                        type: integer
                      attribuition_model:
                        type: string
                      cookie_duration:
                        type: integer
                  affiliate:
                    type: string
                    nullable: true
                  checkout_custom:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        device:
                          type: string
                        position_layout:
                          type: string
                        order:
                          type: string
                        object_type:
                          type: string
                        object:
                          type: string
                        status:
                          type: string
                  seller:
                    type: object
                    properties:
                      hash:
                        type: string
                      name:
                        type: string
                      email:
                        type: string
                      document:
                        type: string
                      account_id:
                        type: integer
                      acquirer_id:
                        type: integer
                      status:
                        type: integer
                      phone:
                        type: string
                  subscription:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: integer
                      user_id:
                        type: integer
                      product_id:
                        type: integer
                      hash:
                        type: string
                      interval:
                        type: string
                      status:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      deleted_at:
                        type: string
                        nullable: true
                      offer:
                        type: object
                        properties:
                          id:
                            type: integer
                          hash:
                            type: string
                          price:
                            type: string
                          currency:
                            type: string
                  coupons_count:
                    type: integer
                  csrf:
                    type: string
                    nullable: true
                  receive_producer:
                    type: integer
                  receive_affiliate:
                    type: integer
                  acquirer_creditcard:
                    type: object
                    properties:
                      id:
                        type: integer
                      acquirer_name:
                        type: string
                      script_url:
                        type: string
                      public_key:
                        type: string
                      acquirer_account_id:
                        type: string
                        nullable: true
                  configs:
                    type: object
                    properties:
                      interest_type:
                        type: string
                      interest_tax:
                        type: number
                      template:
                        type: string
                  testimonials:
                    type: array
                  purchase_notifications:
                    type: string
                    nullable: true
                  visitor_notifications:
                    type: string
                    nullable: true
              examples:
                success:
                  summary: Exemplo de resposta
                  value:
                    template: modern
                    company:
                      id: 42
                      creditcard_acquirer_default_id: 5
                      title: Acme Corp
                      logo_url: https://via.placeholder.com/400x400.png?text=Acme+Logo
                      domain: acme.example.com
                      gtag: null
                      payment_methods_available: credit_card,billet,pix
                      public_key: Xy9P0lQrTs1UvBn2
                      acquirer_creditcard:
                        id: 5
                        acquirer_name: PagMax
                        script_url: https://cdn.pagmax.com/v1/script.js
                        public_key: cf027e40
                        acquirer_account_id: null
                    offer:
                      id: 101
                      account_id: 12
                      product_id: 77
                      user_id: 55
                      hash: x1y2z3a4b5
                      type: checkout
                      title: Oferta Imperdível
                      cover: null
                      payment_methods: '["credit_card","billet", "pix"]'
                      payment_method_discounts: null
                      apply_discounts_to_all_offers: 0
                      first_billing: '150'
                      currency: BRL
                      price: '499.90'
                      interval: null
                      status: 1
                      affiliates_visible: 1
                      method_default: 1
                      shipping_type: null
                      fixed_shipping: null
                      redirect_url: null
                      created_at: '2025'
                      updated_at: '2025'
                      deleted_at: null
                    product:
                      id: 77
                      title: Curso de Programação Web
                      hash: p7o8i9u0y6
                      cover: https://cdn.example.com/products/cover.png
                      status: 1
                      payment_type: 2
                      product_type: digital
                      guaranted_days: '7'
                      support_name: Suporte Acme
                      support_email: suporte@acme.com
                      support_whatsapp: 11 91234
                      custom_thankyou_page: null
                      css_custom: null
                      weight: null
                      width: null
                      height: null
                      length: null
                      discount_retry: null
                      custom_checkout_settings: null
                      delivery_type: 3
                      physical: null
                      checkout_templates:
                        - {}
                        - id: 501
                          type: master
                          primary_color: '#0057FF'
                          secondary_color: '#FFAA00'
                          vsl_enabled: 0
                          video_enabled: 0
                    orderbumps: []
                    pixels: []
                    affiliates_config:
                      id: 88
                      hash: affx9y7z6
                      product_id: 77
                      attribuition_model: last_click
                      cookie_duration: 7
                    affiliate: null
                    checkout_custom:
                      - {}
                      - id: 9
                        title: Checkout Black Friday
                        device: desktop
                        position_layout: full
                        order: '1'
                        object_type: v2
                        object: '{"primary":"#109b6c","darkMode":true}'
                        status: '1'
                    seller:
                      hash: abcxyz987
                      name: João Silva
                      email: joao@acme.com
                      document: '12345678900'
                      account_id: 12
                      acquirer_id: 5
                      status: 1
                      phone: '11999999999'
                    subscription:
                      id: 303
                      account_id: 12
                      user_id: 55
                      product_id: 77
                      hash: sub9q8w7e6
                      interval: monthly
                      status: active
                      created_at: '2025'
                      updated_at: '2025'
                      deleted_at: null
                      offer:
                        id: 101
                        hash: x1y2z3a4b5
                        price: '499.90'
                        currency: BRL
                    coupons_count: 0
                    csrf: null
                    receive_producer: 1
                    receive_affiliate: 0
                    acquirer_creditcard:
                      id: 5
                      acquirer_name: PagMax
                      script_url: https://cdn.pagmax.com/v1/script.js
                      public_key: cf027e40
                      acquirer_account_id: null
                    configs:
                      interest_type: compound
                      interest_tax: 2.99
                      template: modern
                    testimonials: []
                    purchase_notifications: null
                    visitor_notifications: null
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Use o token da Pepper API no formato: `Bearer {seu_token_aqui}`'

````