收件人对象

此对象代表将收到部分分拆付款的收款人。它代表您市场中的卖方账户。通过分账,您可以将市场中的购物款直接转入卖方账户,而您的佣金则转入您的市场账户。

属性

id 字符串
收件人的唯一标识符(最多 64 个;最少 36 个)。
Example: 9104911d-5df9-429e-8488-ad41abea1a4b.

account_id 字符串
账户的唯一标识符(最多 64 个;最少 36 个)。
例如4323f8a0-7699-4a5b-8293-f4d712312eb3bd.

merchant_recipient_id 字符串
市场所有者收件人的唯一标识符(最多 255 个;最少 3 个)。
例如AAAA01.

national_entity 字符串
受益人的国家实体类别。可以是个人或实体。
示例:INDIVIDUAL.

entity_type 字符串
受益人的国家实体类型。可以是公共实体、政府实体、非营利实体或私营实体。
示例:PRIVATE:私有。

first_name 字符串
收件人的名字(最多 255 个;最少 3 个)。
例如:约翰约翰

last_name 字符串
收件人的姓氏(最多 255 个;最少 3 个)。
举例说明:无名氏

legal_name 字符串
受益人姓名。(最大:80)只有当国家实体为 ENTITY 时才需要(最大 64;最小 36)。
例如:Arcos dorados S.A:Arcos dorados S.A.

email 字符串
收件人的电子邮件(最多 255 个;最少 3 个)。
例如:[email protected]:[email protected]

date_of_birth 字符串
收件人的出生日期,格式为 YYYY-MM-DD (最大 10;最小 10)。
例如:1990-02-28.

country 枚举
收件人的国家(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:检查国家代码列表

website 字符串
收件人的网站 URL(最多 255 个;最少 3 个)。
例如:https://www.my-site.com

industry 字符串
收件人所属行业(最多 235 个;最少 1 个) 欲了解更多信息,请访问行业类别参考页面。
示例:VIRTUAL_GOODS虚拟物品

merchant_category_code 字符串
商户类别代码(最多 235 个;最少 1 个)。
示例:TTR

document 反对

指定收件人的文档对象,包括编号和类型。

document_number 字符串
收件人的文件编号(最多 40;最少 3)。
例如:1093333333。

document_type 枚举
收件人的文件类型(最多 6 个,最少 2 个)。
可能的枚举值:检查 "国家参考"。

phone 反对

指定收件人的电话号码对象。

country_code 字符串
收件人电话的国家代码(最多 3 个;最少 2 个)。
例子57.

number 字符串
收件人电话号码,不含国家代码(最多 32 个;最少 1 个)。
示例:3132450765.

address 反对

指定收件人的账单地址对象。

address_line_1 字符串
收件人的主要账单地址行(最多 255 个;最少 3 个)。
例如Calle 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。

withdrawal_methods 对象数组

取款方式对象列表;每个项目包含一个银行对象

bank 结构

该取款方式的详细银行信息。

code 字符串
银行代码(最多 3 个;最少 3 个)。
例如:246

branch 字符串
银行分行(最多 3 个;最少 3 个)。
例如:123

branch_digit 字符串
银行分行数字(MAX 1; MIN 1)。
例如5

account 字符串
受益人的银行账号(最多 250 个;最少 3 个)。
例如:1093333333

account_digit 字符串
受益人的银行账户编号(最多 1 位;最少 1 位)。
例如:7

account_type 枚举
受益人银行账户类型: CHECKINGSSAVINGS.
举例说明:储蓄

routing 字符串
受益人银行账户的路由号码。
例如:021000021

country 字符串
银行账户所在国家(ISO 3166-1 alpha-2)。
例如二氧化碳

currency 字符串
银行账户货币(ISO 4217)。
示例:COPCOP

documentation 对象数组

商家提供的文档对象数组。

file_name 字符串

发送的文件名称(最多 255 个;最少 3 个)。
示例:receipt.pdf

content_type 枚举

商家发送的文件类型。
例如收据

content_category 字符串

商家发送的单据类别(如 INVOICE、ID_PROOF)。

content 字符串

以 base64 编码的文档内容(最大大小:1MB)。
示例:JVBERi0xLjQKJcfs...

onboardings 对象数组

每个提供商连接的入职记录列表。

id 枚举
登机的唯一标识符。
Example: 9104911d-5df9-429e-8488-ad41abea1a4b

type 枚举
入职类型。是否以前完成或通过 Yuno 完成。
先前入职,入职供应商

workflow 枚举
入职培训的工作流程。
由提供商托管、由尤诺托管、直接托管

status 枚举
与商家签订合同的状态。
PENDING、SUCCEEDED、DECLINED、阻止、取消、REJECTED、ERROR

provider_response_code 字符串
供应商在入驻过程中返回的供应商响应代码。
例如:00

provider_response_message 字符串
与入职响应相关的描述性提供者消息。
示例:已批准

provider_raw_response 字符串
完整原始提供者响应的引用。使用此标识符在需要时检索完整的有效负载。
示例:64b3f8cba12e3c7d9f0a1234

callback_url 字符串
如果需要,可在入职流程结束后重定向客户的 URL。
例如:https://www.google.com

provider 反对

有关支付提供商连接的信息。

id 字符串
提供方标识符。
示例:ADYEN

connection_id 字符串
与该入职流程关联的具体Yuno连接ID。
示例:322d48b6-f423-4438-8ffb-0b9b5059a2e9

recipient_id 字符串
医疗服务提供者收件人的唯一标识符。
Example: 9104911d-5df9-429e-8488-ad41abea1a4b

redirect_url 字符串
完成入职流程后,最终用户将被重定向到的网址。
示例:https://www.example.com/callback

onboarding_url 字符串
用于重定向收件人的 URL,以最终完成登录。
示例:https://www.provider.com/onboarding

legal_entity 字符串
与该提供者关联的法人实体标识符。

recipient_additional_id 字符串
关于收款人的附加信息。通常指法人实体识别码。

balance_account_id 字符串
医疗服务提供者余额账户的唯一标识符。

documentation 对象数组

商家提供的文档对象数组。

file_name 字符串
发送的文件名称(最多 255 个;最少 3 个)。
示例:收据.pdf

content_type 枚举
商家发送的文件类型。
示例:RECEIPT接收

content_category 字符串
商家发送的文件类别。

content 字符串
以 base64 编码的文档内容(最大大小:1MB)。
示例:JVBERi0xLjQKJcfsJVBERi0xLjQKJcfs...

withdrawal_methods 对象数组

提取方法对象的列表,每个对象包含一个 bank 结构

bank 结构

该取款方式的详细银行信息。

code 字符串
银行代码(最多 3 个;最少 3 个)。
例如:246

branch 字符串
银行分行(最多 3 个;最少 3 个)。
例如:123

branch_digit 字符串
银行分行数字(最多 3 个;最少 3 个)。
例如5

account 字符串
受益人的银行账号(最多 250 个;最少 3 个)。
例如:1093333333

account_digit 字符串
受益人的银行账号数字(最多 250 个;最少 1 个)。
例如:7

account_type 枚举
受益人银行账户类型: CHECKINGS, SAVINGS
举例说明:储蓄

created_at 时戳
入职创建日期(ISO 8601)。
Example: 2022-05-09T20:46:54.786342Z

updated_at 时戳
最后入职更新日期(ISO 8601)。
Example: 2022-07-09T20:43:54.786342Z

created_at 时戳
收件人创建日期和时间(最大 27;最小 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.

updated_at 时戳
最后收件人更新日期和时间(最大 27;最小 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.