Pular para o conteúdo principal
POST
Gerencie com eficiência suas finanças internas transferindo fundos entre suas próprias contas Localpayment, tanto nacional quanto internacionalmente. Use este endpoint para consolidar saldos, alocar fundos de projetos e otimizar a alocação de recursos entre unidades de negócio. Cada transferência é confirmada com um ID de rastreamento exclusivo internalId, garantindo uma gestão financeira segura e simplificada.

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 documento. ISO 3166-1 alfa-3.

Opções disponíveis:
ARG,
BOL,
BRA,
CHL,
COL,
CRI,
DOM,
ECU,
SLV,
GTM,
HND,
MEX,
PAN,
PRY,
PER,
URY
currency
enum<string>
obrigatório
Opções disponíveis:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
DOP,
USD,
GTQ,
MXN,
PYG,
PEN,
UYU
amount
number
obrigatório

Valor da transação.

transactionType
enum<string>
obrigatório

Tipo de transação.

Opções disponíveis:
InternalDomesticTransfer,
InternalForeignTransfer
client
object
obrigatório

Resposta

OK

transactionType
enum<string>

Tipo de transação que está sendo processada (por exemplo, InternalDomesticTransfer).

Opções disponíveis:
InternalDomesticTransfer,
InternalForeignTransfer
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.

country
enum<string>

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

Opções disponíveis:
ARG,
BOL,
BRA,
CHL,
COL,
CRI,
DOM,
ECU,
SLV,
GTM,
HND,
MEX,
PAN,
PRY,
PER,
URY
currency
enum<string>
Opções disponíveis:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
DOP,
USD,
GTQ,
MXN,
PYG,
PEN,
UYU
clientCode
string

Código do cliente.

creationDate
string

Data e hora em que a transação foi criada.

errors
object[]

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

status
status · object

Status da operação.

amount
number

Valor da transação.

client
object
fees
object

Detalhes sobre quaisquer taxas cobradas.

localTaxes
object[]

Informações sobre impostos locais.

confirmed
object
payment
object

Detalhes da transferência realizada.

withHoldings
object[]

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

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