PIX is a Brazilian payment method, officially launched by the local Central Bank, that enables immediate payment confirmation and 24/7 availability. The user can complete the payment using any Home Banking or Ewallet App, by copying and pasting a Transaction ID or scanning a QR code
Unique key to ensure idempotent requests. given by the merchant in their system.
amount
Long
The transfer amount. The minimum settlement granularity of the current currency, such as 100=1BRL
country
String
country code
currency
String
The currency code of the transferred fund
paymentMethod
String
payment method, enum value as PIX_DYNAMIC_QR
paymentFlow
String
payment flow, enum value as DIRECT or REDIRECT
payer
JSON
payer info
expirationInfo
JSON
pix payment expiration info. The number of seconds to increment must be between 3600 and 604800. If you want to activate a long-term valid PIX QR code, please contact our sales manager
orderInfo
JSON
order info
description
String
description of payment. NOTE: The max length accepted is 43 characters.
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.
merchantRedirectInfo
JSON
The merchant redirect info.
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.
fullname(Input specification: Only a combination of uppercase and lowercase letters, numbers and spaces is allowed. Spanish and Portuguese letters, and other special characters are not allowed).
email
String
email.
phone
String
Mobile Phone number.
document
JSON
Wallet holder identity proof, such as CPF for Brazil.
It is a URL that redirects to merchant page. It should be include when you need Liquido to redirect your customers back to your page after customers finish payments. This URL can only be set when ‘paymentFlow’ is ‘REDIRECT’ in the payment request.
Unique key to ensure idempotent requests. given by the merchant in their system
referenceId
String
Unique key to payment ticket
amount
Long
The transfer amount. The minimum settlement granularity of the current currency, such as 100=1BRL
country
String
country code
currency
String
The currency code of the transferred fund
finalAmount
Long
The final amount that is used for creating the charge order. EX: for charge orders with FX conversion, this field represents the converted amount from the original requested amount.
finalCurrency
String
The currency code of the finalAmount.
paymentMethod
String
payment flow, enum value as PIX_DYNAMIC_QR
payer
JSON
payer info
transferDetails
JSON
transaction details info
description
String
description of payment
callbackUrl
String
URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
createTime
String
Payment ticket created time
scheduledTime
String
Payment ticket scheduled time
finalStatusTime
String
Transfer final status update time, final status include SETTLED, FAILED
transferStatus
String
Transfer status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode
Integer
Transfer status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED
transferErrorMsg
String
Transfer error message if failed
subMerchantId
String
The sub merchant ID.
redirectUrl
String
The URL where you must redirect your customer to complete the payment. It will be included in the response when “paymentFlow” is “REDIRECT” in the request parameters.