QR Code
QR Code Payment
QR Code Payment allows the user to make instant payments through PIX by scanning the payment QR code, thus enabling transfers and payments from one e-wallet to another in real-time, 24/7.
HTTP Request
POST
/v1/payments/payouts/pix/qrcode
Request Headers
{
"Content-Type": "application/json",
"Authorization": "Bearer {{access_token}}",
"x-api-key": "{{api_key}}"
}
Request Body
{
"idempotencyKey": "qrCodeTest20220722_05",
"qrCode": "18000110088.ojaisdhofa.leimen",
"country": "BR",
"currency": "BRL",
"amountInCents": 0
}
Response
Content-Type: application/json
{
"statusCode": 200,
"errorMsg": "",
"transactionId": "",
"transferStatus": "IN_PROGRESS",
"transferStatusCode": 200,
"transferErrorMsg": ""
}
HTTP Headers Details
Key | Value |
---|---|
Content-Type | application/json |
Authorization | "bearer"+ "" + {{access_token}} |
x-api-key | {{api_key}} |
Request Body Details
Parameter | Required | Type | Description |
---|---|---|---|
idempotencyKey | String | Unique key to ensure idempotent requests | |
country | String | Country code, enum value as BR | |
qrCode | String | The string from PIX QR code | |
currency | String | The currency code of the transferred fund. enum value as BRL, USD | |
amountInCents | Long | The transfer amount. note: 100 = 1BRL/1USD |
Response Body Details
Parameter | Type | Description |
---|---|---|
statusCode | int | 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error |
errorMsg | String | Error message if failed |
transactionId | String | The transaction ID |
transferStatus | String | Transfer status, SETTLED, IN_PROGRESS, FAILED or REJECTED, We should use transferStatus to judge the payment status |
transferStatusCode | int | Transfer status code, TransferErrorCode |
transferErrorMsg | String | Transfer error message if failed |