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, PIX_STATIC_QR
paymentFlow
String
payment flow, enum value as DIRECT or REDIRECT
payer
JSON
payer info
expirationInfo
JSON
pix payment expiration info, required when using PIX_DYNAMIC_QR
orderInfo
JSON
order info
riskData
JSON
risk control info, if PSP, please add sub-merchant here, example as "customProperties":{"merchantId":"1527558812935028000","merchantName":"LIQUIDO PTE. LTD."}
description
String
description of payment. NOTE: 1. If PIX_STATIC_QR, the max length accepted is 33 characters. 2. If PIX_DYNAMIC_QR, 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.
Payer Object Parameters
Parameter
Required
Type
Description
name
String
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.
billingAddress
JSON
Billing address info.
document Object Parameters
Parameter
Required
Type
Description
documentId
String
identity number
type
String
enum of CPF or CNPJ
billingAddress Object Parameters
Parameter
Required
Type
Description
zipCode
String
zip code. such as CEP in Brazil
state
String
state. should be abbreviation, such as SP in Brazil
city
String
city name.
district
String
district name.
street
String
street name.
number
String
street number.
complement
String
complement info.
country
String
country code.
orderInfo Object Parameters
Parameter
Required
Type
Description
orderId
String
order identity number
shippingInfo
JSON
shipping info
shippingInfo Object Parameters
Parameter
Required
Type
Description
name
String
shipping name
phone
String
phone number
email
String
email address
address
JSON
the same as billingAddress
RiskData Object Parameters
Parameter
Required
Type
Description
ipAddress
String
Payer's IP address
customProperties
JSON
Key/value pairs used to store additional custom metadata
expirationInfo Object Parameters
Parameter
Required
Type
Description
expiresAt
Long
Dynamic QR code will expire at that time. unix timestamp in seconds. EX: 1651035000. The number of seconds to increment must be between 3600 and 604800.
Response Body Details
Parameter
Required
Type
Description
idempotencyKey
String
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
String
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_STATIC_QR, 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
int
Transfer status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED