跳转至

公共服务支付

公共服务支付

发起支付

支付消费者的公共服务账单

HTTP请求

POST /v1/marketplace/sales/utility

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "280a03fc-2255-11eb-adc1-0242ac120002",
    "merchantName":"CFE",
    "referenceNumber":"972101002847",
    "amount":123,
    "countryCode":"MX",
    "currency": "MXN",
    "paymentType":"PAY_WITH_LINK",
    "allowPaymentMethods": [
        "BANK_TRANSFER_MX",
        "CREDIT_CARD"
    ],
    "targetPhoneNumber": "+5511999999999",
    "email": "liquido-test@gmail.com",
    "billingAddress": {
        "zipCode": "04849333",
        "state": "SP",
        "city": "sao paulo",
        "district": "Jardim Gaivotas",
        "street": "Rua 9 de setembro",
        "number": "15",
        "complement": "casa",
        "country": "MX"
    },
    "callbackUrl": "https://your-domain/callback/",
    "redirectUrl": "https://your-domain/checkout-page"
}
Content-Type: application/json
{
    "statusCode": 200,
    "errorMsg": "",
    "idempotencyKey": "7e18e719-0000-0716-a92a-2b4faeb70008",
    "transactionId": "20210715-175206-145-0369-0449",
    "transactionStatus": "IN_PROGRESS",
    "transactionStatusCode": 200,
    "transactionErrorMsg": ""
}

HTTP Headers 字段说明

Key Value
Content-Type application/json
x-api-key {{api_key}}

Request Body 字段说明

参数 是否必填 类型 描述
idempotencyKey String 此参数用于幂等目的，交易的唯一标识ID 长度不大于128个字节
merchantName String 公共服务运营商名称
referenceNumber String 支付账单上的参考编号
amount Integer 支付账单上金额
countryCode String 用户的国际缩写码，遵循ISO 3166-1 alpha-2 code标准, MX
currency String 支付货币代码，例如墨西哥的MXN
paymentType String 支付类型，枚举值：PREPAID、PAY_WITH_LINK，不填默认PREPAID
allowPaymentMethods String 声明支付页面包含哪些支付方式。 不填默认值是CREDIT_CARD.（仅当支付类型为PAY_WITH_LINK可能需要填写）
targetPhoneNumber String 手机号码（仅当支付类型为PAY_WITH_LINK可能需要填写）
email String 邮箱（仅当支付类型为PAY_WITH_LINK可能需要填写）
billingAddress String 账单地址。如果商户在支付流程之前预收集了用户的账单地址，可以在创建payment link时发送给liquido。该信息可用于Boleto支付表单的预填充。（仅当支付类型为PAY_WITH_LINK可能需要填写）
callbackUrl String 当支付状态变化时，liquido会向callbackUrl发送一个post请求。
redirectUrl String 当redirectUrl非空时，payment link支付成功后会重定向到redirectUrl。（仅当支付类型为PAY_WITH_LINK可能需要填写）

AllowPaymentMethods 对象字段说明

支付方式 国家代码 限制
CREDIT_CARD BR, MX, CO
PIX BR
BOLETO BR > 500BRL
BANK_TRANSFER_BR BR
BANK_TRANSFER_MX MX
PAY_CASH MX, CO
PSE CO >1500COP
NEQUI CO >1500COP

BillingAddress 对象字段说明

参数 必填 类型 描述
zipCode String 邮政编码，如巴西的CEP
state String 州，缩写，如圣保罗是SP
city String 城市.
district String 区县.
street String 街道.
number String 门牌号.
complement String 补充信息.
country String 国家代码.

Response Body 字段说明

参数 类型 描述
statusCode Integer 状态代码，200 代表成功, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg String 如果交易失败，返回的错误信息
idempotencyKey String 交易的幂等键
transactionId String 此次交易的ID
transactionStatus String 此次交易的目前状态, 枚举值，SETTLED, IN_PROGRESS 或者 FAILED。
transactionStatusCode Integer 此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
transactionErrorMsg String 此次交易失败原因

公共服务支付查询

通过幂等ID查询公共服务支付状态

请求

GET /v1/marketplace/sales/utility/key/{{idempotencyKey}}

Request Headers
{
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}

响应

Content-Type: application/json
{
    "statusCode": 200,
    "errorMsg": "",
    "idempotencyKey":"280a03fc-2255-11eb-adc1-0242ac120001",
    "transactionId":"09461d96-2252-11eb-adc1-0242ac120002",
    "transactionStatus":"SETTLED",
    "transactionStatusCode": 200,
    "transactionErrorMsg": "",
    "merchantName": "CFE",
    "price": "10",
    "priceInCents": "1000",
    "currency": "MXN",
    "createTime": "2021-07-26T20:41:53",
    "finalStatusTime": "2021-07-26 12:41:53 GMT+00:00",
    "referenceNumber": "972101002847"
}

HTTP Headers 字段说明

Key Value
x-api-key {{api_key}}
Content-Type application/json

路径参数

参数 是否必填 类型 描述
idempotencyKey String 交易的幂等ID

Response Body 字段说明

参数 类型 描述
statusCode Integer 此次请求API状态代码，200代表API请求成功, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg String 如果API请求失败，返回的错误信息
idempotencyKey String 幂等ID，交易的唯一标识ID
transactionId String 交易ID，系统未成功发给运营商充值前，这个值有可能为空
transactionStatus String 此次交易的状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS"
transactionStatusCode Integer 此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败
transactionErrorMsg String 此次交易失败原因
merchantName String 公共服务运营商名称
price String 支付金额
priceInCents Long 礼品卡金额，单位是货币最小粒度。如 1 = 0.01BRL
currency String 支付货币代码，例如墨西哥的MXN
createTime Time 公共服务支付请求时间
finalStatusTime Time 公共服务支付完成时间
referenceNumber String 支付账单上的参考编号

查询运营商

返回当前国家所有可用的运营商

请求

GET /v1/marketplace/sales/utility/{{countryCode}}/merchants

Request Headers
{
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}

响应

Content-Type: application/json
{
    "statusCode":200,
    "errorMsg": "",
    "merchants": [
        {
            "merchantId": "166",
            "merchantName": "CFE",
            "iconUrl": "https://gestopago.portalventas.net/sistema/images/gestopago/servicios/166.png",
            "description": "Pago de Servicios (Energía)"
        },
        {
            "merchantId": "756",
            "merchantName": "ENGIE MAXIGAS",
            "iconUrl": "https://gestopago.portalventas.net/sistema/images/gestopago/servicios/756.png",
            "description": "Pago de Servicios (Energía)"
        }
    ]
}

HTTP Headers 字段说明

Key Value
x-api-key {{api_key}}
Content-Type application/json

路径参数

参数 类型 描述
countryCode String 用户的国家缩写码，遵循ISO 3166-1 alpha-2 code标准, 长度2个字节, 例如 BR, MX

Response Body 字段说明

参数 类型 描述
statusCode Integer 状态代码，200 代表成功, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg String 如果查询失败，返回的错误信息
merchants JSON Array 可用运营商列表
JSON字段 类型 描述
merchantId String 运营商ID
merchantName String 运营商名字
iconUrl String 运营商图标地址
description String 运营商描述
回到页面顶部