跳转至

PIX

PIX汇款

PIX是巴西中央银行创建的，支持即时付款的一种新的支付方式。 通过PIX密钥或者QR code作为识别方式进行跨银行间的转账交易，这意味着可以24/7全天候从一个电子钱包向另一个电子钱包进行转移和付款。请注意，这个功能仅在巴西可用。

HTTP请求

POST /v1/payments/payouts/pix

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "idempotency-key",
    "country": "BR",
    "targetName": "test user a",
    "targetEmail": "testa@liquido.com",
    "targetDocument": "24988496880",
    "targetPixKey": "testa@liquido.com",
    "targetPixKeyType": "email",
    "amountInCents": 100,
    "currency": "BRL",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}
Content-Type: application/json
{
    "idempotencyKey": "idempotency-key",
    "statusCode": 200,
    "errorMsg": "",
    "transferStatus": "IN_PROGRESS",
    "transferStatusCode": 200,
    "transferErrorMsg": ""
}

HTTP Headers 字段说明

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

Request Body 字段说明

参数 是否必填 类型 描述
idempotencyKey String 此参数用于幂等目的，交易的唯一标识ID 长度不大于128个字节。
country String 国家编码，如巴西BR
targetName String 目标账号持有人的全名.如果设置了targetLastName，此处只需要填写First Name
targetLastName String 目标账号持有人Last Name
targetEmail String 目标账户持有人的电子邮箱
targetPhone String 目标账户持有人的电话，格式 +55xxxxxxxxx
targetBirthDate String 目标账户持有人的生日信息，格式 yyyy-MM-dd
targetDocument String 目标账户持有人的证件号，可以是11位数的CPF或者14位数的CNPJ。
targetPixKey String Pix密钥
targetPixKeyType String Pix密钥类型，枚举值为 "document" "email" "phone" "random"
amount String 已弃用。汇款金额，注意： 1 = 1BRL。请使用amountInCents代替，如果和amountInCents同时存在，会优先使用amountInCents
amountInCents Long 汇款金额，注意： 100 = 1BRL/1USD
currency String 汇款货币代码，长度为3个字节，BRL、USD
callbackUrl String 接收交易状态变更通知的地址，接收post请求
subMerchantId String 子商户ID。商户类型为PSP时必填。

Response Body 字段说明

参数 类型 描述
idempotencyKey String 交易的唯一标识ID
statusCode Integer 此次请求API状态代码，200代表API请求成功, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg String 如果API请求失败，返回的错误信息
transferStatus String 此次交易的目前状态, 枚举值，"SETTLED", "IN_PROGRESS", "FAILED" 或者 "REJECTED",交易状态应以transferStatus为准
transferStatusCode Integer 此次交易的状态码, 交易异常码
transferErrorMsg String 此次交易失败原因
回到页面顶部