跳转到主要内容
POST
此接口允许您为客户创建新的订阅。创建订阅包括将客户与特定的订阅计划关联,并记录其付款信息。

授权

Authorization
string
header
必填

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

请求头

Authorization
string
必填

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

请求体

application/json
paymentMethod
object
必填
externalId
string
必填

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

country
enum<string>
必填

文件国家。ISO 3166-1 alpha-3。

可用选项:
COL,
MEX,
PER
amount
number
必填

交易金额。

currency
enum<string>
必填
可用选项:
COP,
MXN,
PEN,
USD
accountNumber
string
必填

Localpayment账号。

conceptCode
enum<string>
必填

付款原因代码。

可用选项:
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
payer
object
必填

付款人信息。

card
object
必填

付款人借记卡数据。

type
enum<string>
必填

指定订阅类别。

可用选项:
SOFTWARE,
STREAMING,
CONTENT,
PRODUCTS,
MEMBERSHIP
autoRecurring
object
必填

订阅属性

comment
string

附加信息

exchangeRateToken
string

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

intermediaries
array

参与者对象数组。它代表支付链中的其他参与者,因为最终用户并非您的直接客户。请注意数组顺序:您的客户应为第一个元素,您客户的客户应为第二个元素,依此类推,直到没有其他中间商为止。

device
object
metaData
string

非结构化对象,用于记录对您有意义的任何元数据。

commercialData
object

与所交易商品或服务相关的其他信息。

merchant
object

商家信息。

invoice
string

发票编号。

item
object

已售商品清单。

shipments
object

收货地址列表

beneficiary
object

账户受益人信息。

retry
object

支付重试选项。

discount
object

折扣选项。

响应

OK

subscriptionId
string

订阅的唯一标识符。

status
状态 · object

操作状态。

creationDate
string

订阅创建的日期和时间。时间戳遵循 ISO 8601 格式。

nextPaymentDate
string

订阅下次付款的日期和时间。时间戳采用 ISO 8601 格式。

payments
object[]

表示与订阅相关的付款对象的数组。

最后修改于 2026年11月10日