跳转到主要内容
POST
此接口用于发起 Payin 交易,允许您使用各种支付方式向客户收款。您可以指定支付方式、金额、币种和客户信息等详细信息。响应将包含交易 ID 和状态,可用于跟踪付款。
想在执行交易前锁定汇率吗?使用 货币兑换报价 API 为该货币对生成汇率报价。响应中包含 exchangeRateToken,请在您的付款请求中传入该令牌以锁定该汇率。报价汇率在令牌的 expirationDate 之前有保证,可保护您和您的用户免受市场波动影响。

授权

Authorization
string
header
必填

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

请求头

Authorization
string
必填

用于身份验证的 Bearer 访问令牌。该令牌可从获取访问令牌或刷新访问令牌endpoint 获取。

x-capture
boolean

发送 true 以生成授权。

请求体

application/json
paymentMethod
object
必填

付款方式详情。

externalId
string
必填

系统生成的唯一标识符,用于跟踪交易(包含字母、数字和连字符)。我们建议使用 UUID4 以确保唯一性。

country
string
必填

国家。ISO 3166-1 alpha-3。

currency
enum<string>
必填

货币代码。金额的币种可以是本地货币(直接扣款)或账户货币(触发外汇交易),双币种国家的歧义由 paymentMethod.code 解决。

可用选项:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
DOP,
USD,
GTQ,
MXN,
PYG,
PEN
amount
number
必填

交易金额。

示例:

2500.25

accountNumber
string
必填

LocalPayment账户号码,指定金额将存入该账户。

conceptCode
string
必填
示例:

"0001"

merchant
object
必填

发起交易的商户信息。

payer
object
必填

交易付款人的信息。

commercialData
object
必填

包含有关交易的商业细节。

card
object
必填

信用卡和借记卡支付方式必填。

comment
string

用于识别您方交易的附加信息。

intermediaries
object[]

来自支付流程中其他参与方的补充信息。

metaData
object

包含有关该交易的更多信息。

transactionType
any

交易类型。

clientCode
string

客户端代码。

userReference
string

客户的用户名。例如,电子邮件地址或您在平台上的用户名。

requireAuth
boolean

指示交易是否需要身份验证。

file
boolean

指示该交易是否涉及文件上传。

exchangeRateToken
string

由外汇服务提供的令牌,用于使用预先约定的汇率。

device
object

包含有关用于发起交易的设备的信息。

redirectUrl
object

使用 3DS 定义身份验证场景的 URL。

响应

OK

transactionType
any

交易类型。

externalId
string

系统生成的唯一标识符,用于跟踪交易(包含字母、数字和连字符)。我们建议使用 UUID4 以确保唯一性。

internalId
string

Localpayment交易标识符。

paymentMethod
object

收款支付方式。

country
string

国家。ISO 3166-1 alpha-3。

currency
enum<string>
可用选项:
ARS,
BOB,
BRL,
CLP,
COP,
CRC,
DOP,
USD,
GTQ,
MXN,
PYG,
PEN,
UYU
amount
number

交易金额。

accountNumber
string

Localpayment账号。

confirmed
object

已确认金额。

payment
object

付款详情。

localTaxes
object[]

地方税收信息。

withHoldings
object[]

预扣税信息。

fees
object

有关所收取费用的详细信息。

status
状态 · object

操作状态。

merchant
object

商家信息。

payer
object

付款人信息。

intermediaries
object[]

有关交易中涉及的任何中介机构的信息。

wireInstructions
object

汇款所需的银行账户信息。

date
object

与交易相关的日期。

errors
object[]

交易过程中发生的错误列表。

redirectUrl
string

如有需要,此属性提供一个 URL,用户将被重定向到该 URL 以完成支付流程。

ticket
object | null

与交易相关的票据信息(如有)。

qr
object | null

有关交易的二维码的信息(如有)。

card
string | null

银行卡信息。

code
string

重定向状态。

transactionFlow
string

交易流程。

createdOn
string

交易创建的日期和时间,采用 ISO 8601 格式。

createdBy
string

创建交易的用户的电子邮件地址。

executionData
object
最后修改于 2026年11月10日