跳转至

查询支付状态

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": "2022030214000008",
    "referenceId": "2022030214000008",
    "paymentMethod": "PIX_DYNAMIC_QR",
    "amount": 300,
    "currency": "BRL",
    "country": "BR",
    "finalAmount": 100,
    "finalCurrency": "BRL",
    "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",
        "document": null,
        "email": "account@example.com",
        "phone": "+55 81987654321",
        "billingAddress": {  
            "zipCode": "04849333",
            "state": "SP",
            "city": "sao paulo",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "15",
            "complement": "casa",
            "country": "BR"
        }
    },
    "transferDetails": {
        "pix": {
            "qrCode": "00020101021226580014BR.GOV.BCB.PIX01366b780a05-2659-4c6c-80d2-a8bd20c8396f520400005303986540530.005802BR5925Liquido Brl Pagamentos Di6014Belo Horizonte61083038040362290525tBxJ2ERi5uYks44S5Lz7SSvuI63044492",
            "qrCodeType": "DYNAMIC",
            "expirationTime": "2023-09-22 11:01:27 UTC"
        },
        "boleto": null
    },
    "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}}

路径参数

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

Response Body 字段说明

参数 类型 描述
idempotencyKey String 幂等目的，交易的唯一标识ID
country String 国家代码
amount Long 汇款金额
currency String 汇款货币代码，BRL
finalAmount Long 用于创建收款订单的最终金额。对于需要转换汇率的收款订单，这个字段的值表示源请求金额被转换后的金额。
finalCurrency String finalAmount的收款货币代码
createTime String 汇款请求时间
scheduledTime String 调用时间
transferDetails JSON 交易其他详细信息
payer 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 名字，全称（入参名字规范：只允许大小写字母，数字和空格的组合。请勿包含西班牙语和葡萄牙语字母，以及其他特殊字符。）
email String 邮箱.
phone String 手机号码.
document JSON 可确认身份的证件，例如巴西居民的CPF.
billingAddress JSON 账单邮寄地址.

document 对象字段说明

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

billingAddress 对象字段说明

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

transferDetails 对象字段说明

参数 类型 描述
pix JSON pix 相关信息
boleto JSON boleto 相关信息

pix 对象字段说明

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

boleto 对象字段说明

参数 类型 描述
barcode String 二维码
digitalLine String 数字线
paymentTerm JSON 支付期限
回到页面顶部