Skip to content

Qrcode

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",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}
Content-Type: application/json
{
    "idempotencyKey": "qrCodeTest20220722_05",
    "statusCode": 200,
    "errorMsg": "",
    "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
callbackUrl String URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
subMerchantId String The sub merchant ID. Required for PSPs.
riskData JSON The risk data of the payment. MERCHANT_APP_NAME or MERCHANT_WEBSITE must be provided in risk Data. Please see here for further details.

Create A Payment With Risk Data

Please see here for further details.

Response Body Details

Parameter Type Description
idempotencyKey String Unique key to ensure idempotent requests
statusCode Integer 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error
errorMsg String Error message if failed
transferStatus String Transfer status, SETTLED, IN_PROGRESS, FAILED or REJECTED, We should use transferStatus to judge the payment status
transferStatusCode Integer Transfer status code, TransferErrorCode
transferErrorMsg String Transfer error message if failed
Back to top