查询支付状态

HTTP请求¶

GET /v1/payments/charges/{{idempotencyKey}}

请求响应

Request Headers

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

Content-Type: application/json

{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "e757689a-d162-4127-8fc3-b7277878831f",
    "referenceId": "e757689a-d162-4127-8fc3-b7277878831f",
    "paymentFlow": "DIRECT",
    "paymentMethod": "CREDIT_CARD",
    "amount": 100,
    "currency": "USD",
    "finalAmount": 100,
    "finalCurrency": "USD",
    "country": "PA",
    "createTime": "2025-07-10 15:06:58 UTC",
    "scheduledTime": "2025-07-10 15:06:58 UTC",
    "finalStatusTime": "2025-07-10 15:07:05 UTC",
    "payer": {
        "name": "username",
        "document": {
            "documentId": "812345678",
            "type": "CI"
        },
        "email": "username@liquido.com",
        "phone": "+50781987654321",
        "billingAddress": {
            "street": "Rua 9 de setembro",
            "number": "5940",
            "complement": "casa",
            "district": "Jardim Gaivotas",
            "city": "Buenos Aires",
            "state": "Buenos Aires",
            "zipCode": "1001",
            "country": "PA"
        }
    },
    "transferStatus": "SETTLED",
    "description": "this is a test pay",
    "callbackUrl": "https://api.client.com/callback/",
    "transferDetails": {
        "card": {
            "cardInfo": {
                "cardHolderName": "Captured",
                "expirationMonth": 1,
                "expirationYear": 2028,
                "brand": "MASTERCARD",
                "bin": "510510",
                "last4": "5100"
            }
        }
    },
    "subMerchantId": "UUID"
}

HTTP Headers 字段说明¶

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

路径参数¶

参数	类型	描述
idempotencyKey	String	交易的幂等ID

Response Body 字段说明¶

参数	类型	描述
idempotencyKey	String	取消的支付记录幂等键
referenceId	String	原支付记录幂等键,当前场景referenceId和idempotencyKey相同
amount	Long	收款金额，单位是货币最小粒度。如 1 = 0.01USD
country	String	国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准
currency	String	货币代码
finalAmount	Long	用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency	String	finalAmount的收款货币代码
createTime	String	交易创建时间
scheduledTime	String	执行时间
finalStatusTime	String	交易终态的更新时间
payer	JSON	买家个人信息
transferDetails	JSON	交易其他详细信息
transferStatus	String	支付状态，枚举值，当前场景是CANCELLED
transferStatusCode	Integer	此次请求的状态码, 200表示成功
transferErrorMsg	String	此次请求失败原因
subMerchantId	String	子商户ID。

Payer 对象字段说明¶

参数	类型	描述
name	String	名字，全称（入参名字规范：只允许大小写字母，数字和空格的组合。请勿包含西班牙语和葡萄牙语字母，以及其他特殊字符。）
email	String	邮箱.
phone	String	手机号码.
document	JSON	可确认身份的证件.
billingAddress	JSON	账单邮寄地址.

document 对象字段说明¶

参数	类型	描述
documentId	String	证件号
type	String	证件类型，枚举值：CI

billingAddress 对象字段说明¶

参数	类型	描述
zipCode	String	邮政编码.
state	String	州.
city	String	城市.
district	String	区县.
street	String	街道.
number	String	门牌号.
complement	String	补充信息.
country	String	国家代码.

transferDetails 对象字段说明¶

参数	类型	描述
card	JSON	卡相关信息

card (响应)对象字段说明¶

参数	类型	描述
cardInfo	JSON	卡详细信息

CardInfo (响应)对象字段说明¶

参数	类型	描述
cardHolderName	String	持卡人姓名
bin	String	卡号前6位数字
last4	String	卡号后4位数字
brand	String	信用卡组织. 如 VISA, MASTERCARD
expirationMonth	Integer	1位数或者2位数的信用卡有效期月份。
expirationYear	Integer	信用卡有效期年份，4位数。