{"idempotencyKey":"1ec983fa-1a37-679b-809b-067861d87ab0","amount":100,"currency":"MXN","country":"MX","paymentMethod":"DEBIT_CARD","paymentFlow":"DIRECT","payer":{"name":"username","email":"username@liquido.com","phone":"+52 1234567890","document":{"documentId":"49033315550","type":"IFE"},"billingAddress":{"zipCode":"03400","state":"CDMX","city":"Álamos","street":"Simón Bolívar","number":"12121"}},"card":{"cardHolderName":"card_holder_name","cardNumber":"4242424242424242","expirationMonth":"06","expirationYear":"2029","cvc":"123"},"orderInfo":{"orderId":"test-order-id","shippingInfo":{"name":"shipping test name","phone":"shipping phone","email":"thiago@example.com","address":{"street":"street name","number":"building number","complement":"unit, apt, etc.","district":"district, neighborhood, etc.","city":"city name","state":"state, state code","zipCode":"zip code, postal code","country":"MX"}}},"description":"this is a test pay","callbackUrl":"https://api.client.com/callback/","subMerchantId":"UUID"}
Response
{"transferStatusCode":200,"transferErrorMsg":null,"idempotencyKey":"1ec983fa-1a37-679b-809b-067861d87ab0","referenceId":"1ec983fa-1a37-679b-809b-067861d87ab0","paymentMethod":"DEBIT_CARD","amount":100,"currency":"MXN","country":"MX","finalAmount":100,"finalCurrency":"MXN","createTime":"2022-03-01 17:53:18 GMT-08:00","scheduledTime":"2022-03-01 17:53:18 GMT-08:00","finalStatusTime":"2022-03-01 17:53:18 GMT-08:00","payer":{"name":"username","email":"username@liquido.com","phone":"+52 1234567890","document":{"documentId":"49033315550","type":"IFE"},"billingAddress":{"zipCode":"03400","state":"CDMX","city":"Álamos","street":"Simón Bolívar","number":"12121"}},"transferDetails":{"card":{"cardInfo":{"cardHolderName":"card_holder_name","expirationMonth":6,"expirationYear":2029,"bin":"424242","last4":"4242","brand":"VISA"}}},"transferStatus":"SETTLED","description":"this is a test pay","callbackUrl":"https://api.client.com/callback/","subMerchantId":"UUID"}
Notification / Callback
Content-Type: application/json
{"eventType":"CHARGE_SUCCEEDED","data":{"chargeDetails":{"transferStatusCode":200,"transferErrorMsg":null,"idempotencyKey":"1ec983fa-1a37-679b-809b-067861d87ab0","referenceId":"1ec983fa-1a37-679b-809b-067861d87ab0","paymentMethod":"DEBIT_CARD","amount":100,"currency":"MXN","country":"MX","finalAmount":100,"finalCurrency":"MXN","createTime":"2022-03-01 17:53:18 GMT-08:00","scheduledTime":"2022-03-01 17:53:18 GMT-08:00","finalStatusTime":null,"payer":{"name":"username","email":"username@liquido.com","phone":"+52 1234567890","document":{"documentId":"49033315550","type":"IFE"},"billingAddress":{"zipCode":"03400","state":"CDMX","city":"Álamos","street":"Simón Bolívar","number":"12121"}},"transferDetails":{"card":{"cardInfo":{"cardHolderName":"card_holder_name","expirationMonth":6,"expirationYear":2029,"bin":"424242","last4":"4242","brand":"VISA"},}},"transferStatus":"SETTLED","description":"this is a test pay","callbackUrl":"https://api.client.com/callback/","subMerchantId":"UUID"}}}
Request Headers Parameters
Key
Value
Authorization
"bearer" + " " + {{access_token}}
x-api-key
{{api_key}}
Request Body Parameters
Parameter
Required
Type
Description
idempotencyKey
String
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=1MXN
country
String
country code
currency
String
The currency code of the transferred fund
paymentMethod
String
payment method, enum value as DEBIT_CARD
paymentFlow
String
payment flow, enum value as DIRECT or REDIRECT
payer
JSON
payer info
card
JSON
debit card info.
orderInfo
JSON
order 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.
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.
Mobile phone number. Should include “+52” as a prefix.
document
JSON
Document info.
billingAddress
JSON
Billing address info.
Document Object Parameters
Parameter
Required
Type
Description
documentId
String
document number.
type
String
document type. enum of IFE,INE or MEXICO_PASSPORT_ID
BillingAddress Object Parameters
Parameter
Required
Type
Description
zipCode
String
zip code.
state
String
state.
city
String
city name.
street
String
street name.
number
String
street number.
OrderInfo Object Parameters
Parameter
Required
Type
Description
orderId
String
order identity number (Required only when object is provided)
shippingInfo
JSON
shipping info
ShippingInfo Object Parameters
Parameter
Required
Type
Description
name
String
shipping name
phone
String
Mobile phone number. Should include “+52” as a prefix.
email
String
email address
address
JSON
the same as billingAddress
Card Object Parameters
Parameter
Required
Type
Description
cardHolderName
String
Cardholder's full name.
cardNumber
String
16 digit number of the card, as a string without any separators.
expirationMonth
String
2 digit numbers representing the card's expiration month.
expirationYear
String
4 digit numbers representing the card's expiration year.
cvc
String
Debit card verification code.
Response Body Parameters
Parameter
Type
Description
transferStatus
String
Transfer status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode
Integer
Transfer status code, 200 transaction SETTLED, IN_PROGRESS, other FAILED
transferErrorMsg
String
Transfer error message if failed
referenceId
String
Unique key to payment ticket, generated by Liquido.
idempotencyKey
String
Unique key to ensure idempotent requests. given by the merchant in their system
amount
Long
The transfer amount
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 method, enum value as DEBIT_CARD
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
subMerchantId
String
The sub merchant ID.
TransferDetails Object Parameters
Parameter
Type
Description
card
JSON
card detail info
Card Object in TransferDetails Parameters
Parameter
Type
Description
cardInfo
JSON
card detail info
CardInfo Object in response Parameters
Parameter
Type
Description
cardHolderName
String
Cardholder's full name.
bin
String
first 6 digit number of the card
last4
String
last 4 digit number of the card
brand
String
Debit card brand. such as Visa, Mastercard
expirationMonth
Integer
1 or 2 digit number(s) representing the card's expiration month.
expirationYear
Integer
4 digit numbers representing the card's expiration year.
Transfer Status
Parameter
Description
IN_PROGRESS
The transaction of this method has started, but no transactions have been processed yet.
SETTLED
The funds of the transaction of this payment have been transferred to the store.
REFUNDING
The transaction of this payment is refunding.
REFUNDED
The transaction of this payment method has been refunded.
CHARGED_BACK
The transaction of this payment has been reported as chargeback.
FAILED
There was an error while processing the transaction of this payment. This status is followed by a message with more details about the error.