跳转至

创建一个支付请求

创建一个信用卡支付

当向Liquido发送信用卡交易请求时，您需要提供信用卡的详细信息。您可以通过直接发送卡的详细信息或者cardId进行请求。 如果通过cardId进行请求，您需要先通过创建卡信息将卡信息进行保存从而得到cardId，然后您就可以使用这个cardId发送信用卡交易请求。

HTTP请求

POST /v1/payments/charges/card

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}

使用card info创建一个信用卡支付

Request Body
{
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "amount": 100,
    "currency": "MXN",
    "country": "MX",
    "paymentMethod": "CREDIT_CARD",
    "paymentFlow": "DIRECT",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+52 1234567890",
        "document": {
            "documentId": "49033315550",
            "type": "IFE"
        },
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
        }
    },
    "card": {
        "cardHolderName": "card_holder_name",
        "cardNumber": "4242424242424242",
        "expirationMonth": "06",
        "expirationYear": "2029",
        "cvc": "123"
    },
    "orderInfo": {  
        "orderId": "test-order-id",  
        "shippingInfo": { 
            "name": "shipping test name",  
            "phone": "shipping phone",  
            "email": "thiago@example.com",
            "address": { 
                "street": "street name",
                "number": "building number",
                "complement": "unit, apt, etc.",
                "district": "district, neighborhood, etc.",
                "city": "city name",
                "state": "state, state code",
                "zipCode": "zip code, postal code",
                "country": "MX"
            }
        }
    },
    "riskData": {
        "ipAddress": "192.0.0.130",
        "PAYER_LOGIN_ID": "1234567890",
        "PAYER_DEVICE_ID": "c9380c4c-bfc3-42c9-9120-22d1db2d53af"
    },
    "description": "this is a test pay",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}

使用card id创建一个信用卡支付

Request Body
{
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "amount": 100,
    "currency": "MXN",
    "country": "MX",
    "paymentMethod": "CREDIT_CARD",
    "paymentFlow": "DIRECT",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+52 1234567890",
        "document": {
            "documentId": "49033315550",
            "type": "IFE"
        },
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
        }
    },
    "cardId": "card_8736453a-dad0-4f26-85f0-95e8787d0237",
    "orderInfo": {  
        "orderId": "test-order-id",  
        "shippingInfo": { 
            "name": "shipping test name",  
            "phone": "shipping phone",  
            "email": "thiago@example.com",
            "address": { 
                "street": "street name",
                "number": "building number",
                "complement": "unit, apt, etc.",
                "district": "district, neighborhood, etc.",
                "city": "city name",
                "state": "state, state code",
                "zipCode": "zip code, postal code",
                "country": "MX"
            }
        }
    },
    "riskData": {
        "ipAddress":"192.0.0.130",
        "PAYER_LOGIN_ID": "1234567890",
        "PAYER_DEVICE_ID": "c9380c4c-bfc3-42c9-9120-22d1db2d53af"
    },
    "description": "this is a test pay",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}

Response
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "referenceId": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "paymentMethod": "CREDIT_CARD",
    "amount": 100,
    "currency": "MXN",
    "country": "MX",
    "finalAmount": 100,
    "finalCurrency": "MXN",
    "createTime": "2022-03-01 17:53:18 GMT-08:00",
    "scheduledTime": "2022-03-01 17:53:18 GMT-08:00",
    "finalStatusTime": "2022-03-01 17:53:18 GMT-08:00",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+52 1234567890",
        "document": {
            "documentId": "49033315550",
            "type": "IFE"
        },
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
        }
    },
    "transferDetails": {
        "card": {
            "cardInfo": {
                "cardHolderName": "card_holder_name",
                "expirationMonth": 6,
                "expirationYear": 2029,
                "bin": "424242",
                "last4": "4242",
                "brand": "VISA"
            },
            "cardId": "card_8736453a-dad0-4f26-85f0-95e8787d0237"
        }
    },
    "transferStatus": "SETTLED",
    "description": "this is a test pay",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}

通知 / 回调

Content-Type: application/json
{
    "eventType": "CHARGE_SUCCEEDED",
    "data":  {
        "chargeDetails": {
            "transferStatusCode": 200,
            "transferErrorMsg": null,
            "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
            "referenceId": "1ec983fa-1a37-679b-809b-067861d87ab0",
            "paymentMethod": "CREDIT_CARD",
            "amount": 100,
            "currency": "MXN",
            "country": "MX",
            "finalAmount": 100,
            "finalCurrency": "MXN",
            "createTime": "2022-03-01 17:53:18 GMT-08:00",
            "scheduledTime": "2022-03-01 17:53:18 GMT-08:00",
            "finalStatusTime": null,
            "payer": {
                "name": "username",
                "email": "username@liquido.com",
                "phone": "+52 1234567890",
                "document": {
                    "documentId": "49033315550",
                    "type": "IFE"
                },
                "billingAddress": {  
                    "zipCode": "03400",
                    "state": "CDMX",
                    "city": "Álamos",
                    "street": "Simón Bolívar",
                    "number": "12121"
                }
            },
            "transferDetails": {
                "card": {
                    "cardInfo": {
                        "cardHolderName": "card_holder_name",
                        "expirationMonth": 6,
                        "expirationYear": 2029,
                        "bin": "424242",
                        "last4": "4242",
                        "brand": "VISA"
                    },
                    "cardId": "card_8736453a-dad0-4f26-85f0-95e8787d0237"
                }
            },
            "transferStatus": "SETTLED",
            "description": "this is a test pay",
            "callbackUrl": "https://api.client.com/callback/",
            "subMerchantId": "UUID"
        }
    }
}

HTTP Headers 字段说明

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body 字段说明

参数 必填 类型 描述
idempotencyKey String 商户系统创建的唯一ID， 长度不大于128个字节。
amount Long 收款金额，单位是货币最小粒度。 如 1 = 0.01MXN
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如墨西哥MX
currency String 货币代码，如墨西哥MXN
paymentMethod String 交易方式，枚举值CREDIT_CARD
paymentFlow String 交易流程, 如DIRECT 或 REDIRECT
payer JSON 买家个人信息
card JSON 信用卡信息.如果cardId缺省，则card不能为缺省
cardId String 卡id. 如果card缺省，则cardId不能为缺省
capture Boolean 设置为false以创建一个信用卡预授权
installments Integer 分期付款次数. 不分期的时候请缺省该参数
orderInfo JSON 订单信息
riskData JSON 风险控制信息
description String 描述
callbackUrl String 接收交易状态变更通知的地址，接收post请求
subMerchantId String 子商户ID。商户类型为PSP时必填。

创建一个卡ID付款的信用卡支付

请参考这里 查看更多详情。

创建一个信用卡预授权

请参考这里 查看更多详情。

创建一个3DS验证的信用卡支付

请参考这里 查看更多详情。

创建一个分期付款的信用卡支付

请参考这里查看更多详情。

创建一个重定向的信用卡支付

请参考这里查看更多详情。

Payer 对象字段说明
参数 必填 类型 描述
name String 名字，全称
email String 邮箱
phone String 电话号码，需包含“+52”的前缀。
document JSON 支付人的身份信息
billingAddress JSON 账单邮寄地址
Document 对象字段说明
Parameter Required Type Description
documentId String 证件号码.
type String 证件类型.如IFE、INE或MEXICO_PASSPORT_ID
BillingAddress 对象字段说明
参数 必填 类型 描述
zipCode String 邮政编码
state String 州
city String 城市
street String 街道
number String 门牌号
OrderInfo 对象字段说明
参数 必填 类型 描述
orderId String 订单号
(字段仅当对象有被提供时必填)
shippingInfo JSON 运输信息
ShippingInfo 对象字段说明
参数 必填 类型 描述
name String 名称
phone String 电话号码，需包含“+52”的前缀。
email String 邮箱地址
address JSON 地址信息，结构和billingAddress一致
Card 对象字段说明
参数 必填 类型 描述
cardHolderName String 持卡人全称
cardNumber String 卡号, 16位纯数字字符串,不能有横杠空格等分隔符
expirationMonth String 信用卡有效期月份，2位数。
expirationYear String 信用卡有效期年份，4位数。
cvc String 信用卡安全码
RiskData 对象字段说明
参数 必填 类型 描述
ipAddress String 客户请求源IP地址
PAYER_LOGIN_ID String 客户登录ID
PAYER_DEVICE_ID String 客户设备ID

Response Body 字段说明

参数 类型 描述
transferStatus String 汇款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS", "AUTHORIZED"
transferStatusCode Integer 此次交易的状态码, 200表示交易成功、进行中或预授权成功, 其他代表失败
transferErrorMsg String 此次交易失败原因
referenceId String 此次交易的ID
idempotencyKey String 此参数用于幂等目的，交易的唯一标识ID，长度不大于128个字节。
amount Long 收款金额
country String 国家编码 MX
currency String 收款货币代码，长度为3个字节，MXN
finalAmount Long 用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency String finalAmount的收款货币代码
paymentMethod String 支付方式. 枚举值, CREDIT_CARD
payer JSON 付款人信息
transferDetails JSON 交易类型的详细信息
description String 描述信息
callbackUrl String 商户接收通知的回调地址. 接收http的get请求
createTime String 创建时间
scheduledTime String 执行时间
finalStatusTime String 最终状态更新时间. 最终状态，包括"REFUNDED", "FAILED"
subMerchantId String 子商户ID。
TransferDetails 对象字段说明
参数 类型 描述
card JSON 卡相关信息
Card (响应)对象字段说明
参数 类型 描述
cardInfo JSON 卡详细信息
cardId String 卡ID, 使用卡信息支付时不返回，用卡ID支付时会返回
installments Integer 分期付款次数
CardInfo (响应)对象字段说明
参数 类型 描述
cardHolderName String 持卡人姓名
bin String 卡号前6位数字
last4 String 卡号后4位数字
brand String 信用卡组织. 如 VISA, MASTERCARD
expirationMonth Integer 1位数或者2位数的信用卡有效期月份。
expirationYear Integer 信用卡有效期年份，4位数。

支付状态

参数 描述
IN_PROGRESS 交易处理中
SETTLED 交易完成
REFUNDING 退款中
REFUNDED 已退款
CHARGED_BACK 拒付
FAILED 交易失败，异常

Notification 事件类型

CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;
回到页面顶部