客户对象

此对象代表将使用您的服务进行支付的客户。

属性

id 字符串
客户的唯一标识符(最多 64 个;最少 36 个)。
Example: faa89e18-5a11-11ed-9b6a-0242ac120002

merchant_customer_id 字符串
外部商户中客户的唯一标识符(最多 255 个;最少 1 个)。
示例: 50ca6f06-5a12-11ed-9b6a-0242ac12000250ca6f06-5a12-11ed-9b6a-0242ac120002

merchant_customer_created_at 时戳
客户在商家平台上的注册日期(最多 27 天;最少 27 天 ISO 3166-1).
Example: 2022-05-09T20:46:54.786342Z

first_name 字符串
客户姓名(最大 255;最小 1)。
举例说明:约翰

last_name 字符串
客户姓氏(最多 255 个;最少 1 个)。
例子无名氏

gender 枚举
客户性别(最多 2 个;最少 1 个)。
可能的枚举值: M, FNB

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

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

nationality 枚举
客户的国籍(最多 2 个;最少 2 个; ISO 3166-1).
可能的枚举值:查看国家参考信息

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

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 字符串
账单地址所考虑的状态(MAX 255; MIN 3; ISO 3166-2).
实例:昆迪纳马卡省昆迪纳马卡

zip_code 字符串
账单地址的邮编(最多 11 个;最少 4 个)。
例如:111111

neighborhood 字符串
客户地址栏的邻近地区(MAX 255; MIN 2)
例子巴里奥 11

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; ISO 3166-2).
实例:昆迪纳马卡省昆迪纳马卡

zip_code 字符串
送货地址的邮编(最多 10 个;最少 5 个)。
例如:111111

neighborhood 字符串
客户地址栏的邻近地区(MAX 255; MIN 2)
例子巴里奥 11

metadata 对象数组

指定与客户相关联的自定义键值对列表(用于内部引用、细分或工作流标记)。最多可添加 50 个元数据对象。

metadata object 反对

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

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

key 字符串
指定一个元数据密钥。
例如:年龄

value 字符串
指定已定义的元数据关键字的值。
例如:28

created_at 时戳
客户创建日期和时间(MAX 27;MIN 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z

updated_at 时戳
客户最后更新日期和时间(MAX 27;MIN 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z