This page provides API reference information for Velocity API's Deactivate PBL operation, including sample code and parameter descriptions. For information on how to integrate this operation, see our API integration guide.

Request

Endpoint: /cpl/external/delete-payment-link
Method: POST
Format/Content Type: application/x-www-form-urlencoded

To deactivate a payment link, the user sends a POST request to /cpl/external/delete-payment-link?id={PBL_ID}, where {PBL_ID} is replaced with the link ID. The link ID is the value of id in the Pay By Link (PBL) success response received when creating that link. For example, if the PBL success response contains an id value of 1172, the endpoint for the Delete PBL request is /cpl/external/delete-payment-link?id=1172.

This request does not have a body.

Response

A Deactivate PBL response may confirm success or failure; see the code samples below for response structure.

Sample Success Response

The code below is an example of the success response (HTTP status code = 200):

{
    "status": {
        "id": "1172",
        "message": "Payment link deactivated successfully"
    }
}

Sample Fail Responses: Bad Request

The codes below are examples of bad request responses (HTTP status code = 400):

{
    "status": {
        "code": "1008",
        "message": "Payment has already been completed using this link."
    }
}

{
    "status": {
        "code": "1012",
        "message": "The payment link has already been deactivated."
    }
}

{
    "status": {
        "code": "1012",
        "message": "No payment link configuration found to delete."
    }
}

Response Parameters

All response parameters are inside the status object as children of status.