跳转至

查询支付链接详情

请求

GET /v2/cashier/payment-link/{{linkId}}

响应

成功
{
    "code": 0,
    "message": "success",
    "data": {
        "linkId": "egGFE9mdsSa6DM5YwNGY5w",
        "orderId": "2022-12-15T14:07:00-01",
        "amount": 9999,
        "currency": "BRL",
        "country": "BR",
        "paymentStatus": "INITIAL_STATUS",
        "paymentDocumentUrl": "https://liquido-payment-link.s3.ap-southeast-1.amazonaws.com/payment-link/liquido/20240604-002.png",
        "callbackUrl": "https://your-domain/callback/",
        "redirectUrl": "https://your-domain/checkout-page",
        "description": "this is a test payment",
        "finalPaymentMethod": null,
        "finalStatusTimestamp": 0,
        "finalStatusTime": null,
        "refundAmount": null,
        "refundStatus": "INITIAL_STATUS",
        "refundTime": null,
        "refundTimestamp": 0,
        "name": "buyer name",
        "email": "liquido-test@gmail.com",
        "phone": "+5511999999999",
        "documentId": "51234567890",
        "merchant": {
            "name": null,
            "logo": null
        },
        "transferDetails": {
            "pix": null,
            "boleto": null,
            "bankTransfer": null,
            "payCash": null,
            "pse": null
        },
        "allowPaymentMethods": [
            "CREDIT_CARD",
            "PIX",
            "BOLETO",
            "BANK_TRANSFER_BR"
        ],
        "billingAddress": {
            "zipCode": "04849333",
            "state": "SP",
            "city": "sao paulo",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "15",
            "country": "BR",
            "complement": "casa"
        },
        "shippingAddress": {
          "name": "name",
          "countryCode": "BR",
          "province": "province/state",
          "city": "city",
          "postalCode": "04849334",
          "line1": "Address Info",
          "line2": "Address Info"
        },
        "refunded": false,
        "expiredTime": "2023-10-18 09:21:06",
        "createTime": "2023-10-11 09:21:06",
        "updateTime": "2023-10-11 09:21:06",
        "needCollectAddress": true
    }
}
link id 不存在时.
{
    "code": 404,
    "message": "Payment Link not found!",
    "data": {
        "errorMessage": "Payment Link not found!"
    }
}
默认七天后用户无法提交支付.
{
    "code": 410,
    "message": "Payment Link is expired!",
    "data": {
        "errorMessage": "Payment Link is expired!"
    }
}

Response Body 字段说明

参数 类型 描述
code String 请求的状态码。
message String 关于请求状态的信息。
data JSON 本次请求返回的业务数据。

对象字段说明

Data

参数 类型 描述
linkId String payment link在liquido系统的唯一id.
orderId String 商家的唯一的订单id
amount Long 支付金额。 单位分。 例如 100=1BRL
country String 国家代码
currency String 收款货币代码，长度为3个字节，如巴西: BRL
allowPaymentMethods List 声明支付页面包含哪些支付方式。 默认值是CREDIT_CARD. 已支持的支付方式查看这里
paymentStatus String 支付状态，枚举: INITIAL_STATUS, IN_PROGRESS, SETTLED.
paymentDocumentUrl String 支付文件的URL
finalPaymentMethod String 用户完成支付的支付方式.
finalStatusTime String 用户完成支付的时间，时间格式: "yyyy-MM-dd HH:mm:ss", UTC时区
finalStatusTimestamp Long 用户完成支付的时间戳。
refundTime String 退款时间，如果支付没有退款，则为null，时间格式: "yyyy-MM-dd HH:mm:ss", 时区: UTC
refundTimestamp Long 退款完成的时间戳. 如果没有退款，则为0
refunded Boolean 是否已退款
refundAmount Long 退款金额。 单位分。例如100=1BRL。
refundStatus String 退款状态，枚举: INITIAL_STATUS, IN_PROGRESS, SETTLED, FAILED.
name String 用户姓名。
email String 用户邮箱。
phone String 用户手机号。必须包含国际区号，如"+55".
documentId String 居民身份证件号，如巴西的CPF/CNPJ。不含分隔字符。
billingAddress Address Object 账单地址.
shippingAddress JSON 收货地址。
callbackUrl String 商户接收回调通知的url. 如果为空则不发送通知.
redirectUrl String 支付完成后的重定向地址，如果为空则不重定向。
description String 支付描述
transferDetails Object 支付方式的详细信息，结构和 Payin中的"transferDetails"字段一致。当支付完成后，不再展示。
needCollectAddress Boolean 值为true或者false。
expiredTime String Payment link的到期时间。
createTime String Payment link的创建时间。
updateTime String Payment link的更新时间。
metadata JSON 商户预留字段

Data(Error)

参数 类型 描述
errorMessage String 请求错误的相关消息。

BillingAddress

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

ShippingAddress

参数 类型 描述
name String 收货人姓名。
countryCode String 国家编号。
province String 省份或者州。
city String 城市。
postalCode String 邮编。
line1 String 地址详情。
line2 String 地址详情。

TransferDetails 对象字段说明

参数 类型 描述
pix JSON pix 详情
boleto JSON boleto 详情
bankTransfer JSON The bank transfer 详情

Pix

参数 类型 描述
qrCode String 二维码
qrCodeType String 二维码类型枚举，STATIC，DYNAMIC
expirationTime String 支付期限

Boleto

参数 类型 描述
barcode String 条形码
digitalLine String 数字线
paymentTerm JSON 支付期限

PaymentTerm

参数 类型 描述
paymentDeadline Long 支付期限，不能大于当前时间5年，秒级时间戳

BankTransfer

参数 类型 描述
expirationTime String 这个支付的过期时间
bankAccountInfo JSON 银行账号信息

BankAccountInfo

参数 类型 描述
bankCode String 银行代码，3位数字
beneficiaryName String 受益人名称，例如 BRL_LIQUIDO
bankAccountNumber String 受益人账号
bankBranchId String 银行分行Id
bankAccountType String 受益人账号类型，例如 ContaCorrente
ispb String 银行的ISPB, 用途和缩写bankCode一致, 8位数字
document String 可确认身份的证件，CPF或CNPJ
回到页面顶部