Unique key to ensure idempotent requests, no longer than 128 bits
targetPhoneNumber
String
Mobile Phone number, must start with country calling codes, such as "+55".
sku
String
The SKU of top up package
currency
String
Monetary unit, 3 bytes in length, such as BRL, MXN
countryCode
String
Country code, 2 bytes in length, such as BR, MX, without default MX
paymentType
String
Payment type, enumeration value: PREPAID, PAY_WITH_LINK, do not fill in the default PREPAID
allowPaymentMethods
String
Declare which payment methods are included in the payment page. The default value is CREDIT_CARD. (Only when the payment type is PAY_WITH_LINK may need to be filled in)
email
String
Email (only if the payment type is PAY_WITH_LINK)
billingAddress
String
Billing address. If the merchant pre-collected the user's billing address before the payment process, it can send it to liquido when creating the payment link. This information can be used to pre-fill the Boleto payment form. (Only when the payment type is PAY_WITH_LINK may need to be filled in)
callbackUrl
String
When the payment status changes, liquido will send a post request to the callbackUrl.
redirectUrl
String
When the redirectUrl is not empty, the payment link will be redirected to the redirectUrl after successful payment. (Only when the payment type is PAY_WITH_LINK may need to be filled in)
AllowPaymentMethods Object Parameters
Payment Method
Country
Limit
CREDIT_CARD
BR, MX, CO
PIX
BR
BOLETO
BR
>= 5BRL
BANK_TRANSFER_BR
BR
BANK_TRANSFER_MX
MX
PAY_CASH
MX, CO
<= 20,000 MXN or <= 3,000,000 COP
PSE
CO
>= 1500COP
NEQUI
CO
>= 1500COP
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
{"statusCode":200,"errorMsg":"","merchants":[{"merchantId":"TA","merchantName":"Telcel","iconUrl":"https://s3.some.url/Telcel.jpeg","description":"Telcel Tiempo Aire"},{"operatorId":"MOV","operatorName":"Movistar","iconUrl":"https://s3.some.url/Movistar.jpeg","description":"Movistar Tiempo Aire"}]}
HTTP Headers Details
Key
Value
x-api-key
{{api_key}}
Content-Type
application/json
PATH Parameters
Parameter
Required
Type
Description
countryCode
String
Country abbreviation, following ISO 3166-1 alpha-2 code standard, 2 bits, eg. BR, MX
Query Parameters
Parameter
Required
Type
Description
phoneNumber
String
Mobile Phone number, required if countryCode is BR. Must start with country calling codes, such as "+55".
{"statusCode":200,"errorMsg":"","skus":[{"name":"UNE020","description":"Unefon Tiempo Aire 015","price":"20","currency":"MXN","merchantId":"Unefon"},{"name":"UNE020","description":"Unefon Tiempo Aire 020","price":"20","currency":"MXN","merchantId":"Unefon"}]}
HTTP Headers Details
Key
Value
x-api-key
{{api_key}}
Content-Type
application/json
PATH Parameters
Parameter
Required
Type
Description
countryCode
String
Country abbreviation, following ISO 3166-1 alpha-2 code standard, 2 bits, eg. BR, MX
Query Parameters
Parameter
Required
Type
Description
phoneNumber
String
Mobile Phone number, required if countryCode is BR. Must start with country calling codes, such as "+55".
{"statusCode":200,"errorMsg":"","skus":[{"name":"UNE050","description":"Unefon Tiempo Aire 050","price":"50","currency":"MXN","merchantId":"Unefon"},{"name":"UNE070","description":"Unefon Tiempo Aire 070","price":"70","currency":"MXN","merchantId":"Unefon"}]}
HTTP Headers Details
Key
Value
x-api-key
{{api_key}}
Content-Type
application/json
PATH Parameters
Parameter
Required
Type
Description
countryCode
String
Country abbreviation, following ISO 3166-1 alpha-2 code standard, 2 bits, eg. BR, MX
merchantId
String
recharge mobile carrier ID
Query Parameters
Parameter
Required
Type
Description
phoneNumber
String
Mobile Phone number, required if countryCode is BR. Must start with country calling codes, such as "+55".