> ## Documentation Index
> Fetch the complete documentation index at: https://docs.centralcart.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Gateways
> Lista os métodos de pagamento habilitados na loja.
Cada método exige um conjunto diferente de dados do comprador. Os campos `require_document`, `require_phone` e `require_address` dizem exatamente o que coletar antes de chamar `POST /webstore/checkout`. No PIX, o provider que processa o pedido depende do valor do carrinho. Use `routing_rules` e `provider_requirements` para decidir os campos conforme o total muda.
## OpenAPI
````yaml /openapi/storefront-store.yaml get /webstore/gateway
openapi: 3.1.0
info:
title: CentralCart Storefront API (Loja)
version: 1.0.0
description: >-
Dados públicos de identidade e configuração da loja. Nenhum destes endpoints
exige autenticação. A loja é resolvida pelo header `x-store-domain`.
servers:
- url: https://api.centralcart.io/v1
description: Produção
security: []
paths:
/webstore/gateway:
get:
tags:
- Loja
summary: List Gateways
description: >-
Lista os métodos de pagamento habilitados na loja.
Cada método exige um conjunto diferente de dados do comprador. Os
campos `require_document`, `require_phone` e `require_address` dizem
exatamente o que coletar antes de chamar `POST /webstore/checkout`. No
PIX, o provider que processa o pedido depende do valor do carrinho. Use
`routing_rules` e `provider_requirements` para decidir os campos
conforme o total muda.
operationId: listWebstoreGateways
parameters:
- $ref: '#/components/parameters/StoreDomain'
responses:
'200':
description: Métodos de pagamento habilitados
content:
application/json:
schema:
type: array
items:
type: object
properties:
gateway:
type: string
description: >-
Identificador do método de pagamento. É o valor que você
envia em `gateway` no checkout.
enum:
- PIX
- CREDITCARD
- MERCADOPAGO
- STRIPE
- PAYPAL
- PICPAY
name:
type: string
description: Alias de `gateway`, mantido por compatibilidade.
display:
type: string
description: 'Nome amigável para exibição (ex: `Cartão de crédito`)'
provider:
type: string
nullable: true
description: >-
Provider que processa o pagamento. Detalhe de
implementação, não envie este valor no checkout.
fee:
type: number
nullable: true
description: Taxa adicional cobrada do comprador neste método.
is_percentage_fee:
type: boolean
description: >-
Se `true`, `fee` é um percentual; se `false`, é um valor
fixo.
require_document:
type: boolean
description: >-
Se este método exige `client_document` (CPF) no
checkout.
require_phone:
type: boolean
description: Se este método exige `client_phone` no checkout.
require_address:
type: boolean
description: Se este método exige `client_address` no checkout.
payee_code:
type: string
description: >-
Somente `CREDITCARD`: identificador do recebedor usado
na tokenização client-side.
max_installments:
type: number
description: 'Somente `CREDITCARD`: número máximo de parcelas.'
installment_interest_mode:
type: string
description: >-
Somente `CREDITCARD`: política de juros do parcelamento.
Use para exibir as parcelas exatamente como serão
cobradas.
installment_interest_rate:
type: number
description: >-
Somente `CREDITCARD`: taxa de juros aplicada por
parcela.
installment_free_until:
type: number
description: 'Somente `CREDITCARD`: até qual parcela não há juros.'
default_provider:
type: string
nullable: true
description: >-
Somente `PIX`: provider usado quando nenhuma regra de
roteamento casa.
routing_rules:
type: array
description: >-
Somente `PIX`: faixas de valor que decidem o provider.
Avaliadas contra o total do carrinho.
items:
type: object
properties:
provider:
type: string
min_price:
type: number
max_price:
type: number
nullable: true
provider_requirements:
type: object
description: >-
Somente `PIX`: exigências de cadastro por provider. Como
o provider do PIX depende do valor do carrinho, o
storefront usa este mapa para decidir reativamente quais
campos exibir conforme o total muda.
additionalProperties:
type: object
properties:
document:
type: boolean
phone:
type: boolean
address:
type: boolean
example:
- gateway: PIX
name: PIX
display: PIX
provider: EFIBANK
fee: null
is_percentage_fee: false
require_document: true
require_phone: false
require_address: false
default_provider: EFIBANK
routing_rules:
- provider: EFIBANK
min_price: 0
max_price: 5000
- provider: ASAAS
min_price: 5000
max_price: null
provider_requirements:
EFIBANK:
document: true
phone: false
address: false
ASAAS:
document: true
phone: false
address: false
- gateway: CREDITCARD
name: CREDITCARD
display: Cartão de crédito
provider: ASAAS
fee: 2.5
is_percentage_fee: true
require_document: true
require_phone: true
require_address: true
max_installments: 12
installment_interest_mode: FREE_UNTIL
installment_interest_rate: 2.99
installment_free_until: 3
'404':
$ref: '#/components/responses/StoreNotFound'
security: []
components:
parameters:
StoreDomain:
name: x-store-domain
in: header
required: true
description: 'Domínio da sua loja (ex: sualoja.centralcart.ai)'
schema:
type: string
responses:
StoreNotFound:
description: Loja não encontrada para o `x-store-domain` informado
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
errors:
- message: Store not found.
schemas:
Error:
type: object
properties:
errors:
type: array
items:
type: object
properties:
message:
type: string
code:
type: string
ref:
type: string
````