Pular para o conteúdo principal
POST
Este endpoint inicia uma transação Payin, permitindo que você receba pagamentos de clientes usando diversos métodos de pagamento. Você pode especificar detalhes como o método de pagamento, o valor, a moeda e as informações do cliente. A resposta incluirá um ID de transação e o status, que podem ser usados para rastrear o pagamento.
Deseja fixar uma taxa de câmbio antes de executar a transação?Use a API de Cotação de Câmbio para gerar uma cotação para o par de moedas. A resposta inclui um exchangeRateToken informe esse valor na sua solicitação de Payin para garantir essa taxa. A taxa cotada é garantida até o expirationDate do token, protegendo você e seu usuário das flutuações do mercado.

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.

x-capture
boolean

Envie "true" para gerar uma autorização.

Corpo

application/json
paymentMethod
object
obrigatório

Detalhes do método de pagamento.

externalId
string
obrigatório

Um identificador único gerado pelo seu sistema para rastrear a transação (alfanumérico e com hífens). Recomendamos o uso do UUID4 para garantir a unicidade.

country
string
obrigatório

País. ISO 3166-1 alfa-3.

currency
enum<string>
obrigatório

Códigos de moeda. A moeda do valor pode ser a moeda local (cobrada diretamente) ou a moeda da conta (acionando uma operação de câmbio), com paymentMethod.code resolvendo ambiguidades em países bimonetários.

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

Valor da transação.

Exemplo:

2500.25

accountNumber
string
obrigatório

O número da conta LocalPayment onde o valor especificado será creditado.

conceptCode
string
obrigatório
Exemplo:

"0001"

merchant
object
obrigatório

Informações sobre o comerciante que iniciou a transação.

payer
object
obrigatório

Informações sobre o pagador que está realizando a transação.

commercialData
object
obrigatório

Contém detalhes comerciais sobre a transação.

card
object
obrigatório

Necessário para os métodos de pagamento com cartão de crédito e débito.

comment
string

Informações adicionais para identificar a transação do seu lado.

intermediaries
object[]

Informações adicionais de outras partes envolvidas no processo de pagamento.

metaData
object

Contém informações adicionais sobre a transação.

transactionType
any

Tipo de transação.

clientCode
string

Código do cliente.

userReference
string

Nome de usuário do seu cliente. Por exemplo, e-mail ou nome de usuário na sua plataforma.

requireAuth
boolean

Indica se a transação requer autenticação.

file
boolean

Indica se a transação envolve o envio de um arquivo.

exchangeRateToken
string

Token fornecido pelo serviço de câmbio para utilizar uma taxa de câmbio previamente acordada.

device
object

Contém informações sobre o dispositivo usado para iniciar a transação.

redirectUrl
object

Defina URLs para cenários de autenticação usando 3DS.

Resposta

OK

transactionType
any

Tipo de transação.

externalId
string

Um identificador único gerado pelo seu sistema para rastrear a transação (alfanumérico e com hífens). Recomendamos o uso do UUID4 para garantir a unicidade.

internalId
string

Identificador de transação da Localpayment.

paymentMethod
object

Métodos de pagamento para Payin.

country
string

País. ISO 3166-1 alfa-3.

currency
enum<string>
Opções disponíveis:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
DOP,
USD,
GTQ,
MXN,
PYG,
PEN,
UYU
amount
number

Valor da transação.

accountNumber
string

Número da conta Localpayment.

confirmed
object

Valor confirmado.

payment
object

Detalhes sobre o pagamento efetuado.

localTaxes
object[]

Informações sobre impostos locais.

withHoldings
object[]

Informações sobre retenções na fonte.

fees
object

Detalhes sobre quaisquer taxas cobradas.

status
status · object

Status da operação.

merchant
object

Informações do comerciante.

payer
object

Informações sobre o pagador que efetuou o pagamento.

intermediaries
object[]

Informações sobre quaisquer intermediários envolvidos na transação.

wireInstructions
object

Dados bancários para transferência eletrônica.

date
object

Datas associadas à transação.

errors
object[]

Lista de erros que ocorreram durante a transação.

redirectUrl
string

Caso necessário, esta propriedade fornece um URL para onde o usuário será redirecionado para concluir o processo de pagamento.

ticket
object | null

Informações sobre um bilhete associado à transação (se aplicável).

qr
object | null

Informações sobre o código QR associado à transação (se aplicável).

card
string | null

Detalhes do cartão.

code
string

Status do redirecionamento.

transactionFlow
string

Fluxo da transação.

createdOn
string

Data e hora em que a transação foi criada, no formato ISO 8601.

createdBy
string

O endereço de e-mail do usuário que criou a transação.

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