跳转至

OXXO现金支付

HTTP请求

POST /v1/payments/charges/oxxo

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "e565e381-d9eb-6cc4-4da9-b65506b73eed",
    "amount": 100,
    "currency": "MXN",
    "country": "MX",
    "paymentMethod": "OXXO",
    "paymentFlow": "DIRECT",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "billingAddress": {  
            "zipCode": "zip code, postal code",
            "state": "state, state code",
            "city": "city name",
            "street": "street name",
            "number": "building number"
        }
    },
    "orderInfo": {  
        "orderId": "test-order-id",  
        "shippingInfo": { 
            "name": "shipping test name",   
            "email": "thiago@example.com",
            "document": {
                "documentId": "HRGRJN82050602H900",
                "type": "INE"
            },
            "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.168.0.1"
    },
    "description": "test payment",
    "callbackUrl": "",
    "subMerchantId": "UUID"
}
Content-Type: application/json
{
    "transferStatusCode": 200,
    "idempotencyKey": "e565e381-d9eb-6cc4-4da9-b65506b73eed",
    "referenceId": "e565e381-d9eb-6cc4-4da9-b65506b73eed",
    "paymentFlow": "DIRECT",
    "paymentMethod": "OXXO",
    "amount": 100,
    "currency": "MXN",
    "finalAmount": 100,
    "finalCurrency": "MXN",
    "country": "MX",
    "createTime": "2023-06-05 23:26:51 GMT-07:00",
    "scheduledTime": "2023-06-05 23:26:52 GMT-07:00",
    "finalStatusTime": "2023-06-05 23:26:52 GMT-07:00",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "billingAddress": {
            "street": "street name",
            "number": "building number",
            "city": "city name",
            "state": "state, state code",
            "zipCode": "zip code, postal code"
        }
    },
    "transferStatus": "IN_PROGRESS",
    "description": "test payment",
    "callbackUrl": "",
    "subMerchantId": "UUID",
    "transferDetails": {
        "oxxo": {
            "expiresAt": 1687150740,
            "referenceNumber": "871004272433202306180000001007"
        }
    }
}

通知 / 回调

Content-Type: application/json
{
    "eventType":"CHARGE_SUCCEEDED",
    "data":{
        "chargeDetails":{
            "transferStatusCode": 200,
            "idempotencyKey": "e565e381-d9eb-6cc4-4da9-b65506b73eed",
            "referenceId": "e565e381-d9eb-6cc4-4da9-b65506b73eed",
            "paymentFlow": "DIRECT",
            "paymentMethod": "OXXO",
            "amount": 100,
            "currency": "MXN",
            "finalAmount": 100,
            "finalCurrency": "MXN",
            "country": "MX",
            "createTime": "2023-06-05 23:26:51 GMT-07:00",
            "scheduledTime": "2023-06-05 23:26:52 GMT-07:00",
            "finalStatusTime": "2023-06-05 23:26:52 GMT-07:00",
            "payer": {
                "name": "username",
                "email": "username@liquido.com",
                "billingAddress": {
                    "street": "street name",
                    "number": "building number",
                    "city": "city name",
                    "state": "state, state code",
                    "zipCode": "zip code, postal code"
                }
            },
            "transferStatus": "SETTLED",
            "description": "test payment",
            "callbackUrl": "",
            "subMerchantId": "UUID",
            "transferDetails": {
                "oxxo": {
                    "expiresAt": 1687150740,
                    "referenceNumber": "871004272433202306180000001007"
                }
            }
        }
    }
}

HTTP Headers 字段说明

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

Request Body 字段说明

参数 必填 类型 描述
idempotencyKey String 商户系统创建的唯一ID， 长度不大于128个字节。
amount Long 收款金额，单位是货币最小粒度。 如 100 = 1MXN
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如墨西哥MX
currency String 货币代码，如墨西哥MXN
paymentMethod String 支付方式. 枚举值如OXXO
paymentFlow String 交易流程, 如DIRECT 或 REDIRECT
payer JSON 买家个人信息
orderInfo JSON 订单信息
riskData JSON 风险控制信息
description String 描述
callbackUrl String 接收交易状态变更通知的地址。接收post请求。
subMerchantId String 子商户ID，商户类型为PSP时必填。
Payer 对象字段说明
参数 必填 类型 描述
name String 名字，全称（入参名字规范：只允许大小写字母，数字和空格的组合。请勿包含西班牙语和葡萄牙语字母，以及其他特殊字符。）
email String 邮箱
document JSON 支付人的身份信息
phone String 电话号码，需包含“+52”的前缀。
billingAddress JSON 账单邮寄地址

Document 对象字段说明

参数 必填 类型 描述
documentId String 证件号码
type String 证件类型，如INE、IFE或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一致
RiskData 对象字段说明
参数 必填 类型 描述
ipAddress String 客户请求源IP地址

Response Body 字段说明

参数 类型 描述
transferStatus String 汇款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS"
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 支付方式. 枚举值如OXXO
payer JSON 付款人信息
transferDetails JSON 交易类型的详细信息
description String 描述信息
callbackUrl String 商户接收通知的回调地址. 接收http的post请求
createTime String 创建时间
scheduledTime String 执行时间
finalStatusTime String 最终状态更新时间. 最终状态，包括"SETTLED", "FAILED"
subMerchantId String 子商户ID
TransferDetails 对象字段说明
参数 类型 描述
oxxo JSON OXXO交易的详细信息
OXXO 对象字段说明
参数 类型 描述
referenceNumber String 支付者支付时使用的交易号码，可转为条形码扫描
expiresAt Long 交易过期时间的时间戳

支付状态

参数 描述
IN_PROGRESS 交易处理中
SETTLED 交易完成
EXPIRED 交易过期
CANCELLED 交易取消
FAILED 交易失败，异常

Notification 事件类型

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