Pular para o conteúdo principal
POST
Gerar orçamento de parcelamento
Este endpoint gera uma cotação para um plano de parcelamento.
*Observação Os planos de parcelamento estão disponíveis apenas para pagamentos com cartão de crédito.
Considerações sobre a moeda: A moeda utilizada para o plano de parcelamento pode ser:
  • Moeda local: A moeda do país selecionado. Nesse caso, o cliente será cobrado em sua moeda local.
  • Moeda da conta: A moeda da sua conta Localpayment. Se esta moeda for diferente da moeda local, a Localpayment realizará uma conversão cambial para obter o valor equivalente na moeda local. Essa conversão será refletida no seu extrato bancário.
Observação Para países com várias moedas oficiais, o parâmetro paymentMethod.code é usado para especificar a moeda da transação. Isso garante que o pagamento seja processado na moeda correta para o método de pagamento escolhido.
Expiração do token O token fornecido na resposta é válido por 10 minutos a partir do momento em que é gerado. Após esse período, o token expirará e não poderá mais ser usado para processar planos de parcelamento.

Considerações sobre a moeda:

A moeda utilizada para o plano de parcelamento pode ser:
  • Moeda local: A moeda do país selecionado. Nesse caso, o cliente será cobrado em sua moeda local._
  • Moeda da conta: A moeda da sua conta Localpayment. Se esta moeda for diferente da moeda local, a Localpayment realizará uma conversão cambial para obter o valor equivalente na moeda local. Essa conversão será refletida no seu extrato bancário.
ObservaçãoPara países com várias moedas oficiais, o parâmetro paymentMethod.code é usado para especificar a moeda da transação. Isso garante que o pagamento seja processado na moeda correta para o método de pagamento escolhido.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso.

Corpo

application/json
paymentMethod
object
obrigatório

Especifica o método de pagamento utilizado ou solicitado para a transação.

country
enum<string>
obrigatório

País em que o pagamento será processado. ISO 3166-1 alfa-3.

Opções disponíveis:
ARG,
BOL,
BRA,
CHL,
COL,
CRI,
DOM,
GTM,
HND,
MEX,
PAN,
PRY,
PER
currency
enum<string>
obrigatório

A moeda na qual o valor é expresso.

Opções disponíveis:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
DOP,
USD,
GTQ,
MXN,
PYG,
PEN
amount
number
obrigatório

O valor será dividido em parcelas.

accountNumber
string
obrigatório

Número da conta Localpayment na qual o valor será creditado.

Resposta

OK

installmentsToken
string

Um identificador único para o plano de parcelamento. Este token é usado para referenciar as opções de parcelamento específicas geradas para uma transação.

creationDate
string

A data e a hora em que o plano de parcelamento foi criado. O registro de data e hora segue o formato ISO 8601.

expirationDate
string

A data e hora de expiração do plano de parcelamento. Após esse período, o plano não poderá mais ser utilizado. O registro de data e hora segue o formato ISO 8601.

currency
string

O código da moeda correspondente ao valor da transação.

amount
number

O valor total da transação para a qual o plano de parcelamento foi gerado.

installments
object[]
Última modificação em 10 de novembro de 2026