Pular para o conteúdo principal
POST
Inicie Payouts contínuos da sua conta Localpayment para qualquer beneficiário com uma única chamada de API. Este endpoint permite transferir fundos para clientes, fornecedores ou parceiros, fornecendo detalhes essenciais, incluindo informações do beneficiário, valor da transferência, conta de origem e código da transação. Você receberá confirmação imediata da criação do Payout ou mensagens de erro detalhadas para solução de problemas, otimizando todo o seu fluxo de trabalho de pagamentos e garantindo transferências precisas e pontuais.
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 de taxa para o par de moedas. A resposta inclui um exchangeRateToken; inclua-o na sua requisição de payout para garantir essa taxa. A taxa cotada é garantida até a expirationDate do token, protegendo você e seu usuário das flutuações do mercado.
Sobre o campo comment Esse valor é transmitido pela rede de pagamentos até a instituição destinatária. A exibição desse valor para o destinatário final depende da instituição destinatária e de como ela apresenta os detalhes da transação.

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
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
enum<string>
obrigatório

País do seu usuário final (ou seja, o país onde o pagamento será processado), no formato ISO.

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

Especifique o código da moeda. Escolha entre: (A) a moeda local do país selecionado ou (B) a moeda da sua conta. Para (A), o cliente é cobrado na moeda local. Para (B), o valor é creditado na sua conta e a Localpayment cuida do câmbio para cobrar o valor equivalente na moeda local.

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

O valor da transação deve ser especificado como um número decimal, utilizando um ponto como separador, exceto para CLP (Peso Chileno), que deve ser fornecido sem casas decimais.

accountNumber
string
obrigatório

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

conceptCode
enum<string>
obrigatório
Opções disponíveis:
0001,
0002,
0003,
0004,
0005,
0006,
0007,
0008,
0009,
0010,
0011,
0012,
0013,
0014,
0015,
0016,
0017,
0018,
0019,
0020,
0021,
0022,
0023,
0024,
0025,
0026,
0027,
0028,
0029,
0030,
0031,
0032,
0033,
0034,
0035,
0036,
0037,
0038,
0039,
0040
paymentMethod
object
obrigatório
sender
object
obrigatório

Informações do remetente.

beneficiary
object
obrigatório

Informações do beneficiário.

merchant
object
obrigatório

Informações do comerciante.

comment
string

Campo de texto livre para informações adicionais de pagamento. Transmitido pela rede de pagamentos para a instituição receptora; a visibilidade para o destinatário final depende do banco. Consulte os detalhes do país nesta página.

requireAuth
boolean

Quando o valor é definido como "True", o endpoint Authorizer deve ser executado pelo ID interno para atualizar o status para recebido.

Resposta

Criado

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
country
string
currency
enum<string>
Opções disponíveis:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
DOP,
USD,
GTQ,
MXN,
PYG,
PEN,
UYU
amount
integer

Valor da transação.

accountNumber
string

Número da conta Localpayment.

clientCode
string

Código do cliente.

clientName
string

Nome do cliente.

status
status · object

Status da operação.

beneficiary
object
merchant
object

Informações do comerciante.

sender
object

Informações do remetente.

comment
string

Campo de texto livre para informações adicionais de pagamento. Transmitido pela rede de pagamentos para a instituição receptora; a visibilidade para o destinatário final depende do banco. Consulte os detalhes do país nesta página.

exchangeRateToken
null

Token de taxa de câmbio.

date
object
errors
object[] | null

Informações sobre o erro.

internalLoteID
string

Identificador interno do lote.

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