Payout 对象

此对象表示在生成交易将资金从您的账户转到另一个账户或收款人后创建的付款。

id 字符串
付款的唯一标识符(最多 64 个;最少 36 个)。
示例: 5404911d-5df9-429e-8488-ad41abea1a4b5404911d-5df9-429e-8488-ad41abea1a4b

account_id 字符串
账户的唯一标识符(最多 64 个;最少 36 个)。
Example: 2404911d-5df9-429e-8488-ad41abea1a4b

status 枚举
支付状态(最大 255;最小 3)。
举例说明:SUCCEEDED

merchant_reference 字符串
客户订单的唯一标识符(最多 255 个;最少 3 个)。
例如4234

description 字符串
赔付说明(最大 255;最小 3)。
示例:市场付款

purpose 枚举
表示支付的目的。
可能的枚举值:检查目的列表

country 枚举
必须处理交易的国家(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:查看国家参考信息

amount 反对

指定支付金额对象,包括数值和货币。

value 编号
赔付金额(0.0001 的倍数)。
例如:10000

currency 枚举
用于支付的货币(MAX 3; MIN 3; ISO 4217).
可能的枚举值:查看国家参考信息

beneficiary 反对

指定受益对象及其标识。

merchant_beneficiary_id 字符串
商家定义的受益人的唯一标识符。
例如AAAA01

national_entity 枚举
受益人的国家实体类型。
可能的枚举值: INDIVIDUALENTITY

first_name 字符串
受益人的姓名(最多 80 个;最少 1 个)。
举例说明:约翰

last_name 字符串
受益人的姓氏(最多 80 个;最少 1 个)。
例子无名氏

legal_name 字符串
受益人姓名(最多 80 个)。只有在以下情况下才需要 national_entityENTITY.
例如:Arcos dorados S.A:Arcos dorados S.A.

email 字符串
受益人的email (最多 255 个;最少 3 个)。
例如[email protected]

country 枚举
受益人所在国家(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:查看国家参考信息

date_of_birth 日期
受益人的出生日期,格式为 YYYY-MM-DD (最大 10;最小 10)。
例如:1990-02-28

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

withdrawal_method 反对

指定受益人的提款方式对象。

type 枚举
提款方式类型。
例如astropay_wallet

provider_id 枚举
处理付款的提供商。
示例:ASTROPAYASTROPAY

vaulted_token 字符串
金库令牌代表一种安全存储的支付方式。主要用于支付中的信用卡/借记卡。
示例:41032411d-5df9-429e-1238-ad41abea1cft

original_transaction_id 字符串
相关支付交易的 ID。仅用于向 CARD 付款。(最大 64;最小 36)。
Example: 9104911d-5df9-429e-8488-ad41abea1a4b

on_hold bool
定义商家是否希望保留付款,并将其设置为稍后使用 "释放付款 "endpoint进行处理。默认为假。
示例:假

detail 反对

指定提款方式的详细信息。

bank_transfer 反对

指定受益人的提款方式对象。

code 字符串
受益人的金融机构代码(最多 3 个;最少 3 个)。
例如:246

branch 字符串
受益人的具体金融机构分支(最多 3 个;最少 3 个)。
例如XXX

branch_digit 字符串
受益人的特定金融机构分支机构编号(最多 3 位;最少 3 位)。
例如:123

account 反对

指定受益人的银行转账账户对象。

number 字符串
受益人的金融机构帐号或金融机构帐户别名,如 Clabe 代表 MX(最多 255 个;最少 3 个)。
例如:1093333333

digit 字符串
受益人的金融机构账户编号(最多 3 位;最少 1 位)。
例如:123

type 枚举
受益人的账户类型(最多 255 个;最少 3 个)。
可能的枚举值: CHECKINGS, SAVINGS, VISTA, PIX_EMAIL, PIX_PHONE, PIX_DOCUMENT_ID, PIX_BANK_ACCOUNT

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

wallet 反对

指定受益人的提款方式对象。

code 字符串
受益人的钱包代码(最多 3 个;最少 3 个)。
例如:246

email 字符串
受益人的特定钱包email (最多 3 个;最少 3 个)。
例如[email protected]

country 枚举
受益人钱包所在国家(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:查看国家参考信息

document 反对

指定受益人的单据对象,包括其编号和类型。

document_number 字符串
受益人的证件号码(最多 40 个;最少 3 个)。
例如:1093333333

document_type 枚举
受益人的文件类型(最多 6 个,最少 2 个)。
可能的枚举值:查看国家参考信息。

phone 反对

指定受益人的电话号码对象。

country_code 字符串
受益人电话的国家代码(最多 3 个;最少 1 个)。可能的值:检查 国家参考.
例如57

number 字符串
受益人的电话号码,不含国家电话区号(最多 32 个;最少 1 个)。
例如3132450765

transactions 对象数组

指定支付对象列表。

id 字符串
付款意图的唯一标识符(最多 64 个;最少 36 个)。
Example: 9104911d-5df9-429e-8488-ad41abea1a4b

type 枚举
赔付意图类型(最大 255;最小 3)。

status 枚举
支付意图状态(最大 255;最小 3)。

response_code 枚举
响应代码表示付款意向请求的状态(最大 255;最小 3)。

merchant_reference 字符串
商户定义的付款交易标识(最大 255;最小 3)。
例如AAB01-432245

amount 反对

指定支付金额对象,包括数值和货币。

value 编号
赔付金额(0.0001 的倍数)。
例如:10000

currency 枚举
用于支付的货币(MAX 3; MIN 3; ISO 4217).
可能的枚举值:查看国家参考信息

purpose 枚举
指定支付目的。

description 字符串
赔付说明(最大 255;最小 3)。
举例说明:工资

provider_data 反对

指定数据提供者。

id 枚举
数据提供者标识。
可能的值: ADDI, MERCADO_PAGO, SPINPAY, WOMPI

transaction_id 字符串
供应商付款的唯一标识符。
例如:12345678

account_id 字符串
商家的支付提供商账户 ID。
例如:9990128

status 字符串
提供商的交易状态(最大 255;最小 3)。
例如:认证

status_detail 字符串
数据提供者的详细交易状态(最大 255;最小 3)。
例如:批准

raw_response 字符串
数据提供者的原始回复。格式取决于提供商的回复。
每个数据提供商的回复都会有所不同。

created_at 时戳
交易创建日期(MAX 27;MIN 27、 国际标准化组织 8601).
Example: 2022-05-09T20:46:54.786342Z

updated_at 时戳
最后交易更新日期(MAX 27;MIN 27、 国际标准化组织 8601).
Example: 2022-05-09T20:46:54.786342Z

metadata 对象数组

指定与支付相关的自定义键值对列表(用于内部引用、对账或工作流标签)。最多可添加50个元数据对象。

metadata object 反对

指定元数据关键字和相应的值。

用于附加商家定义的上下文(例如:"......"): batch_id, payout_reason).避免发送敏感或个人数据。

key 字符串
元数据密钥(最多 48 个;最少 1 个)。
例如:order_id

value 字符串
元数据密钥值(最大 512;最小 1)。
示例:AA001AA001

created_at 时戳
交易创建日期(MAX 27;MIN 27、 ISO 8601).
Example: 2022-05-09T20:46:54.786342Z

updated_at 时戳
最后交易更新日期(MAX 27;MIN 27、 国际标准化组织 8601).
Example: 2022-05-09T20:46:54.786342Z