Skip to content

WebPay

Integration Guide

When receiving the 'paymentUrl' in the response, you must redirect your client to this URL to complete the payment.

HTTP Request

POST /v1/payments/charges/webpay

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "1ec983fa-1c37-679b-809b-067861d8700019",
    "amount": 1000,
    "currency": "CLP",
    "country": "CL",
    "paymentMethod": "WEB_PAY",
    "paymentFlow": "DIRECT",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+56 234567890",
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
        }
    },
    "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": "CL"
            }
        }
    },
    "webPay": {
        "redirectUrl": "https://www.liquido.com"
    },
    "description": "this is a test pay",
    "callbackUrl": "http://api.client.com/notifications"
}
Content-Type: application/json
{
    "transferStatusCode": 200,
    "idempotencyKey": "1ec983fa-1c37-679b-809b-067861d8700019",
    "referenceId": "1ec983fa-1c37-679b-809b-067861d8700019",
    "paymentFlow": "DIRECT",
    "paymentMethod": "WEB_PAY",
    "amount": 1000,
    "currency": "CLP",
    "finalAmount": 1000,
    "finalCurrency": "CLP",
    "country": "CL",
    "createTime": "2023-05-30 00:37:41 GMT-07:00",
    "scheduledTime": "2023-05-30 00:37:43 GMT-07:00",
    "finalStatusTime": "2023-05-30 00:37:43 GMT-07:00",
    "payer": {
        "name": "username",
        "email": "username@liquido.com",
        "phone": "+56 234567890",
        "billingAddress": {  
            "zipCode": "03400",
            "state": "CDMX",
            "city": "Álamos",
            "street": "Simón Bolívar",
            "number": "12121"
        }
    },
    "transferStatus": "IN_PROGRESS",
    "description": "this is a test pay",
    "callbackUrl": "http://api.client.com/notifications",
    "transferDetails": {
        "webPay": {
            "paymentUrl": "https://liquido.com/gmf-apm/payments/M-9ae481d9-b47f-4459-9b63-644977fe91ed",
            "redirectUrl": "https://www.liquido.com"
        }
    }
}

Notification / Callback

Content-Type: application/json
{
    "eventType": "CHARGE_SUCCEEDED",
    "data":  {
        "chargeDetails": {
            "transferStatusCode": 200,
            "transferErrorMsg": null,
            "idempotencyKey": "1ec983fa-1c37-679b-809b-067861d8700019",
            "referenceId": "1ec983fa-1c37-679b-809b-067861d8700019",
            "paymentMethod": "WEB_PAY",
            "amount": 1000,
            "currency": "CLP",
            "country": "CL",
            "finalAmount": 1000,
            "finalCurrency": "CLP",
            "createTime": "2023-05-30 00:37:43 GMT-07:00",
            "scheduledTime": "2023-05-30 00:37:43 GMT-07:00",
            "finalStatusTime": null,
            "payer": {
                "name": "username",
                "email": "username@liquido.com",
                "phone": "+56 234567890",
                "billingAddress": {  
                    "zipCode": "03400",
                    "state": "CDMX",
                    "city": "Álamos",
                    "street": "Simón Bolívar",
                    "number": "12121"
                }
            },
            "transferDetails": {
                "webPay": {
                    "paymentUrl": "https://liquido.com/gmf-apm/payments/M-9ae481d9-b47f-4459-9b63-644977fe91ed",
                    "redirectUrl": "https://www.liquido.com"
                }
            },
            "transferStatus": "IN_PROGRESS",
            "description": "this is a test pay",
            "callbackUrl": "http://api.client.com/notifications"
        }
    }
}

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=1CLP
country String country code
currency String The currency code of the transferred fund
paymentMethod String payment method, enum value as WEB_PAY
paymentFlow String payment flow, enum value as DIRECT or REDIRECT
payer JSON payer 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.
webPay JSON webPay 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.

Create A Payment With Risk Data

Please see here for further details.

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. Should include “+56” as a prefix.
billingAddress JSON Billing address info.
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
shippingInfo JSON shipping info
ShippingInfo Object Parameters
Parameter Required Type Description
name String shipping name
phone String Mobile phone number. Should include “+56” as a prefix.
email String email address
address JSON the same as billingAddress
WebPay Object Parameters
Parameter Required Type Description
redirectUrl String URL where Liquido will redirect to after the payment is finished

Response Body Parameters

Parameter Type Description
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
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 WEB_PAY
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
TransferDetails Object Parameters
Parameter Type Description
webPay JSON The webPay details
WebPay Object Parameters
Parameter Type Description
paymentUrl String URL for payment
redirectUrl String URL where Liquido will redirect to after the payment is finished

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.

Notification Event Type

CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;
Back to top