跳转至

查询汇款状态

汇款查询

通过幂等ID查询汇款状态

HTTP请求

GET /v1/payments/payouts/key/{{idempotencyKey}}

Request Headers
{
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Content-Type: application/json
{
    "statusCode": 200,
    "errorMsg": "",
    "idempotencyKey": "TestPixUSDTOBRL-20220822002",
    "targetName": "Joice M Santos Joice Mary Santos",
    "targetDocument": "11012345678",
    "targetPixKey": "11013601513",
    "targetPixKeyType": "document",
    "targetBankCode": "",
    "targetBankAgency": "",
    "targetBankAccountId": "",
    "amount": "1.00",
    "amountInCents": 100,
    "currency": "USD",
    "paidAmount": 314,
    "paidCurrency": "BRL",
    "exchangeRate": 5.067,
    "paidTax": 192,
    "createTime": "2022-08-22 02:02:52 GMT-07:00",
    "finalStatusTime": "2022-08-22 02:02:59 GMT-07:00",
    "transferStatus": "SETTLED",
    "transferStatusCode": 200,
    "transferErrorMsg": "",
    "subMerchantId": "UUID",
    "transactionDetail": {
        "endToEndId": "27359365-7b8a-4fe2-bc16-962074f54f96"
    }
}

HTTP Headers 字段说明

Key Value
Content-Type application/json
Accept application/json
Authorization "bearer"+ "" + {{access_token}}
x-api-key {{api_key}}

路径参数

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

Response Body 字段说明

参数 类型 描述
statusCode Integer 此次请求API状态代码，200代表API请求成功, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg String 如果API请求失败，返回的错误信息
idempotencyKey String 幂等目的，交易的唯一标识ID
targetName String 目标账号的收款人全名
targetDocument String 目标账户持有人的CPF，11位数字
targetPixKey String 目标账号的Pix密钥
targetPixKeyType String 目标账号的Pix密钥类型
targetBankCode String 目标账号的银行代码
targetBankAgency String 目标账号的银行分支码
targetBankAccountId String 目标账号的账号ID
amount String 已弃用。汇款金额，注意： 1 = 1BRL。请使用amountInCents。
amountInCents Long 汇款金额。 注意： 100 = 1BRL/1USD
currency String 汇款货币代码，BRL、USD
paidAmount Long 当入参货币为BRL时返回null，转换货币代码后的支付金额
paidCurrency String 当入参货币为BRL时返回null，转换货币代码后的货币代码，BRL
exchangeRate Double 当入参货币为BRL时返回null，转换货币代码所使用的汇率
paidTax Long 当入参货币为BRL时返回null，转换货币代码的手续费
createTime String 汇款请求时间
finalStatusTime String 汇款操作完成时间. 完成包括下面状态： "SETTLED", "FAILED" 或者 "REJECTED"
transferStatus String 汇款状态，枚举值，"SETTLED", "FAILED", "IN_PROGRESS" 或者 "REJECTED" ，交易状态应以transferStatus为准
transferStatusCode Integer 此次交易的状态码, 交易异常码
transferErrorMsg String 此次交易失败原因
subMerchantId String 子商户ID
transactionDetail JSON 交易凭证信息，交易被拒绝时可能为空值
transactionDetail 字段说明
参数 类型 描述
endToEndId String 交易为Pix时的交易凭证信息，交易被拒绝时可能为空值
回到页面顶部