属性
此对象表示可与客户关联的付款链接。
id 字符串
客户的唯一标识符(最多 64 个;最少 36 个)。
Example: 8546df3a-b83e-4bb5-a4b3-57aa6385924f
account_id 字符串
账户的唯一标识符(最多 64 个;最少 36 个)。
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
description 字符串
付款链接说明(最多 255 个;最少 3 个)。
举例说明:市场付款
country 枚举
必须处理交易的国家(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:查看国家参考信息。
status 枚举
支付链接状态(最大值 255;最小值 3)(CREATED、已使用、已取消、EXPIRED、ERROR)。
例如活动
merchant_order_id 字符串
支付链接的标识(最多 255 个;最少 3 个)。
例如432245
created_at 时戳
创建付款链接的日期和时间。
Example: 2022-05-09T20:46:54.786342Z
updated_at 时戳
付款链接最后一次更新的日期和时间。
Example: 2022-05-09T20:46:54.786342Z
capture 布尔
决定是授权付款还是抓取付款。授权银行卡支付可以在客户的银行账户中预留资金。
客户银行账户中的资金。如果未发送该字段,我们会将其视为 "true"。您随后可以通过 Yuno 的
付款。 应用程序接口方法.
示例:true
amount 反对
指定payment 金额对象,包括金额和货币。
customer_payer 反对
为付款链接指定客户对象。
id 字符串
客户在
Yuno 平台的客户唯一标识符(最多 255 个;最少 3 个)。
Example: faa89e18-5a11-11ed-9b6a-0242ac120002
customer_id 字符串
外部商户中客户的唯一标识符(最多 255 个;最少 3 个)。
例如:23456
first_name 字符串
客户姓名(最多 255 个;最少 3 个)。
举例说明:约翰
last_name 字符串
客户姓氏(最多 255 个;最少 3 个)。
例子无名氏
gender 枚举
客户性别(MAX 2;MIN 1;(M=男性/F=女性/NA=不适用/NK=不知道))。
可能的枚举值: M, F, NA或 NK.
date_of_birth 字符串
客户的出生日期,格式为 YYYY-MM-DD(长度:10)。
例如:1990-02-28
email 字符串
客户的电子邮件(最多 255 个;最少 3 个)。
例如[email protected]
nationality 枚举
客户的国籍(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:查看国家参考信息。
document 反对
指定客户的文档对象,包括编号和类型。
document_number 字符串
客户文件编号(最多 40 个;最少 3 个)。
例如:1093333333
document_type 枚举
客户的文件类型(最多 6 个,最少 2 个)。
可能的枚举值:检查
国家参考。
phone 反对
指定客户的电话对象,包括号码和代码。
number 字符串
客户电话号码(最多 40 个;最少 3 个)。
例如:11992149494
country_code 字符串
客户电话的国家呼叫代码(最多 3 个;最少 1 个)
可能的值:检查
国家参考。
billing_address 反对
指定客户的账单地址对象。
address_line_1 字符串
客户的主要账单地址行(最多 255 个;最少 3 个)。
例如:Calle 34 # 56 - 78Calle 34 # 56 - 78
address_line_2 字符串
客户的二级账单地址行(最多 255 个;最少 3 个)。
例如:Apartamento 502, Torre I:Apartamento 502, Torre I
city 字符串
账单地址考虑的城市(最多 255 个;最少 3 个)。
例如:波哥大波哥大
country 枚举
账单地址考虑的国家(最多 2 个;最少 2 个; ISO
3166-1).
可能的枚举值:查看国家参考信息。
state 字符串
账单地址的状态(最大 255;最小 3)。
实例:昆迪纳马卡省昆迪纳马卡
zip_code 字符串
账单地址的邮编(最多 11 个;最少 4 个)。
例如:111111
shipping_address 反对
指定客户的送货地址对象。
address_line_1 字符串
客户的主要送货地址行(最多 255 个;最少 3 个)。
例如:Calle 34 # 56 - 78Calle 34 # 56 - 78
address_line_2 字符串
客户的二级送货地址行(最多 255 个;最少 3 个)。
例如:Apartamento 502, Torre I:Apartamento 502, Torre I
city 字符串
收货地址考虑的城市(最多 255 个;最少 3 个)。
例如:波哥大波哥大
country 枚举
送货地址考虑的国家(最多 2 个;最少 2 个; ISO
3166-1).
可能的枚举值:查看国家参考信息。
state 字符串
收货地址的状态(最大 255;最小 3)。
实例:昆迪纳马卡省昆迪纳马卡
zip_code 字符串
送货地址的邮编(最多 11 个;最少 4 个)。
例如:111111
additional_data 反对
指定 additional_data 对象。该对象不是强制性的。但是,如果发送此信息
用户的payment 体验将得到提升。
airline 反对
指定航空公司对象。乘客和机票应具有相同的订单信息。
pnr 字符串
乘客姓名记录(最多 10 个;最少 1 个)。
示例:1P-2UUGJW
legs 对象数组
指定对象的脚数组。
arrival_airport 字符串
国际航空运输协会机场代码(最多 3 个;最少 3 个)。参见 http://www.iata.org.
举例说明:AMS
base_fare 浮动
交易金额,不含税费,最小货币单位(0.0001 的倍数)。
0.0001).
例如:23.5676
base_fare_currency 字符串
用于交易金额的货币(MAX 3; MIN 3; ISO 4217).
举例说明:检查国家参考信息。
carrier_code 字符串
IATA 承运商代码(最多 2 个;最少 2 个)。参见 http://www.iata.org.
例如KL
departure_airport 字符串
国际航空运输协会代码(最多 3 个;最少 3 个)。参见 http://www.iata.org.
例如EZE
departure_airport_timezone 字符串
机场时区(MAX 6;MIN 6)。
例如:-03:00
departure_datetime 时戳
出发机场当地时间的出发日期和时间。
Example: 2022-05-09T20:46:54.786342Z
fare_basis_code 字符串
代码基本费率除提供舱位服务外,还提供票价的具体信息,两者都是预订所必需的(MAX 15;MIN 1)。
预订时需要(MAX 15;MIN 1)。
示例:HL7LNRHL7LNR
fare_class_code 字符串
航空公司的舱位代码(最多 1 个;最少 1 个)。数值可以是字母(A-Z),但根据航空公司的定义可能会有所不同。
取决于航空公司的定义。
举例说明:C
flight_number 字符串
航空公司分配的航班号(最多 5 个;最少 1 个)。
例如:842
stopover_code 字符串
中途停留代码(1 个字母的代码,表示是否允许乘客中途停留。
中途停留。
只允许使用两种字符:O:允许中途停留(字母 "O",非零)/ X:中途停留
不
不允许中途停留)。
示例:OO
passengers 对象数组
指定代表与机票关联的乘客的对象数组。
document 反对
指定乘客的文件对象。
document_number 字符串
旅客证件号码(最多 40 个;最少 3 个)。
例如:1093333333
document_type 枚举
乘客的证件类型(最多 6 个,最少 2 个)。
可能的枚举值:检查
国家参考。
country 枚举
文件签发国(最多 2 个;最少 2 个; ISO
3166-1).
可能的枚举值:查看国家参考信息。
date_of_birth 字符串
乘客的出生日期,格式为 YYYY-MM-DD (最大 10;最小 10)。
例如:1990-02-28
email 字符串
乘客的email (最多 255 个;最少 3 个)。
例如[email protected]
first_name 字符串
乘客姓名(最多 255 个;最少 3 个)。
举例说明:约翰
last_name 字符串
乘客姓氏(最多 255 个;最少 3 个)。
例子无名氏
loyalty_number 字符串
乘客忠诚计划数量(最多 20 个,最少 1 个)。
例如:254587547
loyalty_tier 枚举
乘客忠诚度计划的级别(最多 255 级;最少 3 级)。
可能的枚举值:检查
忠诚度层级。
middle_name 字符串
乘客的中间名(最多 255 个;最少 3 个)。
例子查尔斯
nationality 枚举
乘客的国籍(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:查看国家参考信息。
type 枚举
乘客类型(MAX 1;MIN 1)。
可能的枚举值:检查乘客类型列表。
tickets 对象数组
指定与乘客相关的车票数组。
ticket_number 字符串
票号(最多 14 个;最少 1 个)。
例如:7411823255523
e_ticket 布尔
这是电子机票吗?
可能的值: True 或 False
restricted 布尔
表示票据是否可以重新打印。
可能的值: True 或 False
total_fare_amount 浮动
以最小货币单位(0.0001 的倍数)表示的票价总额。
例如:80000
total_tax_amount 浮动
以最小货币单位(0.0001 的倍数)表示的总税额。
例如:14800
total_fee_amount 浮动
以最小货币单位(0.0001 的倍数)表示的费用总额。
例如:25200
issue 反对
指定问题对象。
address 字符串
售票代理地址(最多 255 个;最少 3 个)。
例如:Apartamento 502, Torre I:Apartamento 502, Torre I
carrier_prefix_code 字符串
签发或验证承运人。这是 AWB 前缀(航空运单)IATA 3 位数字代码(MAX
3;最小
3).
例如:044
city 字符串
售票代理的城市名称(最多 255 个;最少 3 个)。
例如:波哥大波哥大
country 枚举
出票地的国家代码(最多 2 个;最少 2 个; ISO
3166-1).
可能的枚举值:检查国家代码
列表。
date 字符串
出票日期。
例如:1979-01-12
travel_agent_code 字符串
出票旅行社的代码。
例如:10655823
travel_agent_name 字符串
销售点在代理列表或特许经营名称中的名称(MAX 32;
最小
1).
举例说明:ACME 代理公司
order 反对
指定订单对象。
fee_amount 浮动
订单的手续费金额(0.0001 的倍数)。
示例:1
shipping_amount 浮动
订单的运费金额(0.0001 的倍数)。
示例:1
items 对象数组
指定项目的对象。
id 字符串
项目的唯一标识符(最多 255 个;最少 3 个)。
例如3214
name 字符串
项目名称(最多 255 个;最少 3 个)。
示例:iPhone 12 Pro Max
quantity int
项目数量(最大 999;最小 1)。
示例:1
unit_amount 浮动
项目的单位金额(0.0001 的倍数)。
例如550
category 字符串
项目类别(最多 255 个;最少 3 个)。
可能的值:检查项目类别列表。
brand 字符串
物品的品牌(最多 255 个;最少 3 个)。
举例说明:苹果公司
sku_code 字符串
物品的库存单位 (SKU)(最多 255 个;最少 3 个)。
示例:A2342A2342
manufacture_part_number 字符串
物品的生产零件编号(最多 255 个;最少 3 个)。
例如345621234
picture_url 字符串
物品的图片(最大 255;最小 3)。
例如:https://www.merchant_url.com/items/:id
seller_details 反对
指定卖方的详细信息对象。
name 字符串
卖方法定姓名(最多 255 个;最少 3 个)。
示例:Jhon Doe无名氏
email 字符串
卖方电子邮件(最多 255 个;最少 3 个)。
例如[email protected]
reference 字符串
卖方识别代码(最多 255 个;最少 3 个)。
举例说明:卖方
website 字符串
卖方网站 URL(最多 255 个;最少 3 个)。
例如:https://www.test.com/1231324
industry 枚举
卖方行业(最多 255 个;最少 3 个)。
可能的枚举值:检查行业类别。
country 枚举
卖方所在国家(最多 255 个;最少 3 个)。
可能的枚举值:检查国家代码列表。
document 反对
指定卖方的文档对象。
document_number 字符串
卖方文件编号(最多 40 个;最少 3 个)。
例如:1093333333
document_type 枚举
卖方文件类型(最多 6 个,最少 2 个)。
可能的枚举值:检查
国家参考。
phone 反对
指定卖方的电话号码对象。
country_code 字符串
卖方电话的国家代码(最多 3 个;最少 1 个)。可能的值:检查
国家参考.
例如57
number 字符串
卖方电话号码,不含国家代码(最多 32 个;最少 1 个)。
例如3132450765
address 反对
指定卖方的地址对象。
address_line_1 字符串
卖方的主地址行(最多 255 个;最少 3 个)。
例如:Calle 34 # 56 - 78Calle 34 # 56 - 78
address_line_2 字符串
卖方的二级账单地址行(最多 255 个;最少 3 个)。
例如:Apartamento 502, Torre I:Apartamento 502, Torre I
city 字符串
卖方地址考虑的城市(最多 255 个;最少 3 个)。
例如:波哥大波哥大
country 枚举
卖方地址考虑的国家(最多 2 个;最少 2 个、ISO
3166-1).
可能的枚举值:检查国家代码
列表。
state 字符串
卖方地址的州名(最多 255 个;最少 3 个)。
实例:昆迪纳马卡省昆迪纳马卡
zip_code 字符串
卖方地址的邮编(最多 11 个;最少 4 个)。
例如:111111
taxes 对象数组
指定订单的税务对象。
type 字符串
税种。
举例说明:增值税
tax_base 浮动
适用所定义税额的基数。
例如:10000
value 浮动
税额。
例如:2100
percentage 浮动
税款的百分比。
例如:21
one_time_use 布尔
单一链接:适用于已定义产品、金额和客户信息的单一集合。
多次链接:可根据需要多次使用和共享,并规定了数量和产品。
选项:false只允许使用一次,true允许多次支付。
availability 反对
指定可用性对象。指支付链接到期日期。
start_at 时戳
付款链接有效期的起始时间。
Example: 2022-05-09T20:46:54.786342Z
finish_at 时戳
付款链接有效期结束。
Example: 2022-05-09T20:46:54.786342Z
callback_url 字符串
付款后重新定向客户的 URL(最大 255;最小 3)。
例如:https://www.your-site.com/
redirect_url 字符串
付款链接 URL(最多 255 个;最少 3 个)。
例如:https://checkout.y.uno/payment_links/id
payment_method_types 枚举数组
客户可以使用的付款方式类型列表。如果没有传递值,Yuno 将显示
仪表板中定义的付款方式。
payment 对象数组
数组 支付对象
metadata 对象数组
指定元数据对象列表。最多可添加 50 个元数据对象。
metadata object 反对
指定元数据关键字和相应的值。
key 字符串
指定一个元数据密钥。
例如:年龄
value 字符串
指定已定义的元数据关键字的值。
例如:28
vault_on_success 布尔
付款成功后注册银行卡的标志。默认为假。
示例:假