Skip to main content
GET
Visualizar configuração de pagamento

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

paymentId
integer
required

ID da forma de pagamento

id
integer
required

ID da configuração de pagamento

Response

Configuração de pagamento visualizada com sucesso

Configuração de um meio de pagamento no checkout da loja.

payment_id
integer
required

ID do meio de pagamento configurado.

affiliation_id
integer
required

ID da afiliação (adquirente/gateway) usada por este meio de pagamento.

active
boolean
required

Indica se o meio de pagamento está ativo no checkout.

default_display
boolean
required

Indica se o meio de pagamento é exibido por padrão no checkout.

id
integer

Identificador único da configuração de pagamento.

spread
boolean

Indica se os juros do parcelamento são diluídos nos preços dos produtos, fazendo o parcelamento aparecer sem juros ao cliente.

ignore_promotions
boolean

Indica se este meio de pagamento ignora as promoções ativas.

accumulate_discount
boolean

Indica se o desconto deste meio de pagamento pode ser acumulado com outros descontos.

percent_discount
number<float>

Percentual de desconto aplicado ao usar este meio de pagamento.

min_installment_value
number<float>

Valor mínimo de cada parcela, em reais, permitido no parcelamento deste meio de pagamento.

max_installments_without_tax
integer

Número máximo de parcelas sem juros neste meio de pagamento.

billet_expire_days
integer

Quantidade de dias até o vencimento do boleto.

days_to_cancel_unpaid_billets
integer

Quantidade de dias até o cancelamento automático de boletos não pagos.

hours_to_cancel_unpaid_pix
integer

Quantidade de horas até o cancelamento automático de pagamentos Pix não pagos.

hours_to_expire_pix_code
number

Quantidade de horas até a expiração do código Pix gerado.

billet_instructions
string

Instruções exibidas no boleto gerado.

installments
object

Condições de parcelamento configuradas para este meio de pagamento.

affiliation
object

Afiliação (adquirente/gateway) vinculada a este meio de pagamento.

payment
object

Meio de pagamento vinculado a esta configuração.

created_at
string<date-time>
read-only

Data e hora de criação da configuração de pagamento.

updated_at
string<date-time>
read-only

Data e hora da última atualização da configuração de pagamento.