Skip to main content
GET
Grade de parcelas
A grade vem bandeira por bandeira porque a bandeira só é conhecida quando o comprador digita os seis primeiros dígitos. Mostre a chave default antes disso — ela é o pior caso, então o preço nunca sobe depois. Ver Cobrança no cartão.

Authorizations

Authorization
string
header
required

Chave secreta do vendedor, criada no painel em Desenvolvedores.

O valor em claro existe uma única vez, na criação. Guardamos só o hash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto: um dump do nosso banco não permite cobrar em nome de ninguém.

A chave vai no servidor. Colocá-la no navegador do comprador a entrega a qualquer pessoa que abra a página.

Query Parameters

amount
integer
required

O valor a parcelar, em centavos inteiros.

Required range: x >= 1
max_installments
integer

O teto que você quer impor. O limite real é o menor entre ele, a escada por valor e a taxa da sua conta - um número maior aqui não amplia nada.

Required range: 1 <= x <= 12

Response

A grade, ou o motivo de não haver uma.

A grade de parcelamento para um valor, como o SEU SERVIDOR a recebe. Todo campo está sempre presente - message e unavailable_reason vêm null quando há grade, e matrix vem {} quando não há.

object
string
required
Allowed value: "installments"
amount
integer<int64>
required

O valor consultado, de volta, em centavos inteiros.

available
boolean
required
unavailable_reason
enum<string> | null
required

Por que não há grade. Trate por ele, nunca pela message.

As seis primeiras são chaves de configuração, e cada uma tem dono diferente: a plataforma, a conta Pagar.me que atende a sua loja, o interruptor da sua conta, o status do seu cadastro, a credencial do provedor e o seu contrato de taxa. amount_below_minimum é outra coisa - o cartão está de pé, o que não cabe é este valor.

Available options:
platform_disabled,
gateway_account_disabled,
seller_disabled,
seller_cannot_transact,
no_credential,
fee_disabled,
amount_below_minimum,
null
message
string | null
required

A frase em português, para o seu log. Não é contrato.

matrix
object
required

Mapa de bandeira para lista de opções. Objeto vazio, nunca lista vazia, quando não há grade.