Skip to content

Cancel

Cancel an unpaid payment link.

HTTP Request

POST /v2/cashier/payment-link/cancel

Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Body
{
    "linkId": "{{link_id}}"
}
Content-Type: application/json
{
    "code": 0,
    "message": "success",
    "data": {
        "linkId": "ewGHNonFhmO7be8otCt9tA",
        "orderId": "2023-03-31T17:05:00-103",
        "amount": 599,
        "currency": "BRL",
        "country": "BR",
        "paymentStatus": "CANCELLED",
        "redirectUrl": null,
        "callbackUrl": null,
        "finalPaymentMethod": null,
        "finalStatusTimestamp": 1680247253,
        "finalStatusTime": "2023-03-31 15:20:53",
        "refundAmount": null,
        "refundStatus": "INITIAL_STATUS",
        "refundTime": null,
        "refundTimestamp": 0,
        "name": null,
        "email": "liquido-test@gmail.com",
        "phone": "+551234556799",
        "documentId": null,
        "description": "this is a test link",
        "transferDetails": {
            "pix": null,
            "boleto": null,
            "bankTransfer": null,
            "payCash": null,
            "pse": null,
            "nequi": null
        },
        "allowPaymentMethods": [
            "BOLETO",
            "PIX"
        ],
        "billingAddress": {
            "zipCode": "04849333",
            "state": "SP",
            "city": "sao paulo",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "15",
            "country": "BR",
            "complement": "casa"
        },
        "merchant": {
            "name": null,
            "logo": null,
            "needRefundInfo": false
        },
        "createTime": "2023-03-31 15:20:12",
        "updateTime": "2023-03-31 15:20:53",
        "shippingAddress": {
          "name": "name",
          "countryCode": "BR",
          "province": "province/state",
          "city": "city",
          "postalCode": "04849334",
          "line1": "Address Info",
          "line2": "Address Info"
        },
        "refunded": false,
        "expiredTime": "2023-10-18 09:21:06",
        "createTime": "2023-10-11 09:21:06",
        "updateTime": "2023-10-11 09:21:06",
        "needCollectAddress": true
    }
}

{
    "code": 400,
    "message": "Can't cancel the payment link when status is SETTLED.",
    "data": {
        "errorMessage": "Can't cancel the payment link when status is SETTLED."
    }
}

Request Body Parameters

Parameter Required Type Description
linkId String Unique payment link id.

Response Body Parameters

Parameter Type Description
linkId String Unique payment link id in liquido.
orderId String Unique order id in merchant 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
allowPaymentMethods List Declare which payment methods are included in the payment link. Supported Payment Methods see here
paymentStatus String Payment status, enum value as: INITIAL_STATUS, IN_PROGRESS, SETTLED, CANCELLED.
finalPaymentMethod String The payment method for user to complete payment.
finalStatusTime String The datetime for user to complete payment. date format: "yyyy-MM-dd HH:mm:ss", timezone: UTC
finalStatusTimestamp Long The timestamp for user to complete payment.
refundTime String The datetime of complete refund. it is null when "refunded" is false. date format: "yyyy-MM-dd HH:mm:ss", timezone: UTC
refundTimestamp Long The timestamp of complete refund. it is 0 when "refunded" is false.
refunded Boolean If true，meaning the payment has been refunded.
refundAmount Long The refund amount, The minimum settlement granularity of the current currency, such as 100=1BRL
refundStatus String The refund status, enum value as: INITIAL_STATUS, IN_PROGRESS, SETTLED, FAILED.
email String customer's email
phone String Mobile phone number, must start with country calling codes, such as "+55".
billingAddress Address Object Billing address info.
shippingAddress JSON Shipping address info.
callbackUrl String When the payment link status changed. liquido will send a post http request to the callback url.
redirectUrl String When the payment completed. payment link will redirect to redirectUrl if it is not null.
description String Description of payment
needCollectAddress Boolean True or false.
expiredTime String The expiration time of the payment link.
createTime String The creation time of the payment link.
updateTime String The update time of the payment link.

BillingAddress Object Parameters

Parameter 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.

ShippingAddress Object Parameters

Parameter Type Description
name String Shipping name.
countryCode String Country code.
province String Province.
city String City.
postalCode String Postal code.
line1 String Address details.
line2 String Address details.
Back to top