查询支付状态
HTTP请求
GET
/v1/payments/charges/{{idempotencyKey}}
Response
{
"transferStatusCode": 200,
"transferErrorMsg": null,
"idempotencyKey": "2022030214000008",
"referenceId": "2022030214000008",
"paymentMethod": "CREDIT_CARD",
"amount": 300,
"currency": "MXN",
"country": "MX",
"finalAmount": 100,
"finalCurrency": "MXN",
"createTime": "2022-03-01 21:16:42 GMT-08:00",
"scheduledTime": "2022-03-01 21:16:42 GMT-08:00",
"finalStatusTime": "2022-03-01 21:16:48 GMT-08:00",
"payer": {
"name": "username",
"email": "username@liquido.com",
"document" : "1234567890",
"phone": "+52 1234567890",
"billingAddress": {
"zipCode": "03400",
"state": "CDMX",
"city": "Álamos",
"street": "Simón Bolívar",
"number": "12121"
}
},
"transferDetails": {
"card": {
"cardInfo": {
"cardHolderName": "card_holder_name",
"expirationMonth": 06,
"expirationYear": 2029,
"bin": "424242",
"last4": "4242",
"brand": "VISA"
},
"cardToken": {
"token": "card_8736453a-dad0-4f26-85f0-95e8787d0237",
"type": "CARD"
}
},
"payCash":{
"referenceNumber":"1264207400046",
"expirationDate":"2022-09-30",
"recurring":false,
"paymentTime": "2022-09-06 00:21:20"
}
},
"transferStatus": "SETTLED",
"description": "this is a test pay",
"callbackUrl": "http://api.client.com/callback/",
"subMerchantId": "UUID"
}
HTTP Headers 字段说明
Key | Value |
---|---|
Authorization | "bearer" + " " + {{access_token}} |
x-api-key | {{api_key}} |
PATH and Query 字段说明
参数 | 类型 | 描述 |
---|---|---|
idempotencyKey | String | 交易的幂等ID |
Response Body 字段说明
参数 | 类型 | 描述 |
---|---|---|
idempotencyKey | String | 幂等目的,交易的唯一标识ID |
amount | Long | 汇款金额 |
country | String | 国家代码,MX |
currency | String | 汇款货币代码,MXN |
finalAmount | Long | 用于创建收款订单的最终金额。对于需要转换汇率的收款订单,这个字段的值表示源请求金额被转换后的金额。 |
finalCurrency | String | finalAmount的收款货币代码 |
createTime | String | 汇款请求时间 |
scheduledTime | String | 调用时间 |
payer | JSON | 买家个人信息。 |
transferDetails | JSON | 交易其他详细信息 |
finalStatusTime | String | 汇款操作完成时间. 完成包括下面状态: "SETTLED", "FAILED" 或者 "REFUNDED" |
transferStatus | String | 汇款状态,枚举值,"SETTLED", "FAILED", "IN_PROGRESS", "REFUNDING", "REFUNDED", "CANCELLED" |
transferStatusCode | Integer | 此次交易的状态码, 200表示交易成功或者进行中, 其他代表失败 |
transferErrorMsg | String | 此次交易失败原因 |
subMerchantId | String | 子商户ID。 |
对象字段说明
Payer
参数 | 必填 | 类型 | 描述 |
---|---|---|---|
name | String | 名字,全称(入参名字规范:只允许大小写字母,数字和空格的组合。请勿包含西班牙语和葡萄牙语字母,以及其他特殊字符。) | |
String | 邮箱 | ||
document | String | CURP | |
phone | String | 电话号码,需包含“+52”的前缀。 | |
billingAddress | JSON | 账单邮寄地址 |
BillingAddress
参数 | 必填 | 类型 | 描述 |
---|---|---|---|
zipCode | String | 邮政编码 | |
state | String | 州 | |
city | String | 城市 | |
street | String | 街道 | |
number | String | 门牌号 |
TransferDetails
参数 | 类型 | 描述 |
---|---|---|
card | JSON | 卡相关信息 |
payCash | JSON | payCash支付详细信息 |
Card
参数 | 类型 | 描述 |
---|---|---|
cardInfo | JSON | 卡详细信息 |
cardToken | JSON | card token, 用户可以使用card token代替card info来发起支付请求 |
CardInfo
参数 | 类型 | 描述 |
---|---|---|
cardHolderName | String | 持卡人姓名 |
bin | String | 卡号前6位数字 |
last4 | String | 卡号后4位数字 |
brand | String | 信用卡组织. 如 VISA, MASTERCARD |
expirationMonth | Integer | 1位数或者2位数的信用卡有效期月份。 |
expirationYear | Integer | 信用卡有效期年份,4位数。 |
CardToken
参数 | 类型 | 描述 |
---|---|---|
token | String | token串 |
type | String | token类型, 枚举,当前只有CARD |
payCash
Parameter | Type | Description |
---|---|---|
referenceNum | String | 支付者支付时使用的reference号码 |
expirationDate | String | 过期时间 墨西哥时间(UTC-5) "yyyy-MM-dd" |
recurring | Boolean | 是否可以多次付款 |
paymentTime | String | 实际支付时间 墨西哥时间 "yyyy-MM-dd HH:mm:ss" |