Pular para o conteúdo principal
POST
Este endpoint permite simular um pagamento recebido em uma conta virtual. Disponível apenas no ambiente de Stage. Ele foi projetado para que os lojistas testem o fluxo completo de sua integração, incluindo o recebimento de notificações de pagamento e a verificação do status das transações, sem a necessidade de transferências bancárias reais.
Restrição Ambiental Este endpoint está disponível apenas no ambiente de Stage e destina-se exclusivamente a fins de teste.

Identidade do pagador

Utilize os mesmos dados do beneficiário — nome, tipo de documento e ID do documento — fornecidos na criação da conta virtual. Não são necessárias identidades de teste separadas; o endpoint valida os dados do pagador em relação às informações registradas durante a criação da conta.

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. Obtido no endpoint Obter token de acesso.

Corpo

application/json
externalId
string
obrigatório

Um identificador único para a transação de depósito simulada. Este valor funciona como o ID do depósito gerado por esta simulação e deve ser diferente para cada solicitação. Recomendamos o uso do formato UUID4.

paymentMethod
object
obrigatório
country
enum<string>
obrigatório

O país onde a conta virtual está localizada (ISO 3166-1 alpha-3).

Opções disponíveis:
ARG,
BRA,
COL,
MEX,
PER,
CHL
currency
enum<string>
obrigatório

A moeda do pagamento (ISO 4217).

Opções disponíveis:
ARS,
BRL,
COP,
MXN,
PEN,
CLP
amount
number
obrigatório

O valor a ser simulado para o pagamento.

accountNumber
string
obrigatório

O número da conta que a Localpayment associa ao comerciante, sendo único para cada um.

beneficiary
object
obrigatório

Informações sobre a entidade que receberá os fundos.

payer
object
obrigatório

Informações sobre o pagador simulado. Utilize os mesmos dados — nome, tipo de documento e ID do documento — fornecidos para o beneficiário ao criar a conta virtual.

Resposta

Criado - Simulação iniciada com sucesso.

transactionType
string

O tipo de transação (ex.: PayIn).

Exemplo:

"PayIn"

externalId
string

O identificador único (externalId) fornecido pelo comerciante para rastrear a transação.

internalId
string<uuid>

O identificador único (internalId) atribuído pela Localpayment à transação.

paymentMethod
object

O método de pagamento utilizado na transação simulada.

country
string

O país onde a transação ocorreu.

currency
string

A moeda da transação.

amount
number

O valor da transação.

accountNumber
string

O número da conta do comerciante.

status
object

O estado da transação simulada.

Última modificação em 10 de novembro de 2026