On This Page

{#jumplink-list}  
[Markdown](/docs/cybs/en-us/paybylink/developer/all/rest/paybylink/paybylink-services/paybylink-update-customer-intro.md)  
Filter  
FILTER BY TAG

Update a Customer-Set Link {#paybylink-update-customer-intro}
=============================================================

Use the information in this section to update customer-set links to modify the information set in the original link, such as the price amount. When sending an update request, include all of the fields from the original request to create the link. If you exclude a field, the information corresponding to that field is removed from the updated payment page.

Deactivate a Payment Link
-------------------------

You can deactivate a payment link to no longer allow your customers to use the link. To do this, include the status field in your update request and set it to `INACTIVE`. If you want to activate the payment link again, you can send your update request with the status field set to `ACTIVE`.

Endpoints
---------

**Production:** `PATCH ``https://api.cybersource.com``/ipl/v2/payment-links/`*{id}*  
**Test:** `PATCH ``https://apitest.cybersource.com``/ipl/v2/payment-links/`*{id}*  
**India Production:** `PATCH ``https://api.in.cybersource.com``/ipl/v2/payment-links/`*{id}*  
Set the *{id}* to the payment number ID contained in the create payment link response.

Required Fields for Updating a Customer-Set Link {#paybylink-update-customer-req-fields}
========================================================================================

[orderInformation.amountDetails.currency](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-currency.md "")
:

orderInformation.amountDetails.minAmount
:

[orderInformation.amountDetails.totalAmount](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.md "")
:

[orderInformation.lineItems\[\].productName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-name.md "")
:

[orderInformation.lineItems\[\].unitPrice](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-unit-price.md "")
:

processingInformation.linkType
:
Set to `DONATION`.

purchaseInformation.purchaseNumber
:
Set to a unique identifier for the customer-set price link.

Optional Fields for Updating a Customer-Set Link {#paybylink-update-customer-opt-fields}
========================================================================================

[clientReferenceInformation.partner.developerId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-partner-developer-id.md "")
:
Set to your developer ID.

[clientReferenceInformation.partner.solutionId](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/client-ref-info-aa/client-ref-info-partner-solution-id.md "")
:
Set to your partner solution ID (PSID).

orderInformation.amountDetails.maxAmount
:

orderInformation.amountDetails.minAmount
:

[orderInformation.lineItems\[\].productDescription](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-description.md "")
:

[orderInformation.lineItems\[\].productSku](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-product-sku.md "")
:

[orderInformation.lineItems\[\].quantity](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-line-items-quantity.md "")
:

processingInformation.requestPhone
:

processingInformation.requestShipping
:

[status](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/status-a.md "")
:
Include this field to activate or deactivate a payment link.
:
Set to one of these values:

    * `ACTIVE`: The payment link is usable to complete a payment.
    * `INACTIVE`: The payment link is not usable to complete a payment.

`REST` Example: Updating a Customer-Set Price Link {#paybylink-update-don-ex-rest}
==================================================================================

Request

```
{
    "processingInformation": {
        "linkType": "DONATION"
    },
    "orderInformation": {
        "amountDetails": {
            "minAmount": "1",
            "currency": "USD",
            "totalAmount": "5"
        },
        "lineItems": [
            {
                "productName": "Fundraiser",
                "unitPrice": "5"
            }
        ]
    }
}
```

Response to a Successful Request

```keyword
{
  "_links": {
    "self": {
      "href": "/ipl/v2/payment-links/78759658968978",
      "method": "GET"
    },
    "update": {
      "href": "/ipl/v2/payment-links/78759658968978",
      "method": "PATCH"
    }
  },
  "id": "78759658968978",
  "submitTimeUtc": "2024-08-15T21:11:46.163224519Z",
  "status": "ACTIVE",
  "processingInformation": {
    "linkType": "DONATION",
    "requestPhone": false,
    "requestShipping": false
  },
  "purchaseInformation": {
    "purchaseNumber": "78759658968978",
    "createdDate": "2024-08-15T21:08:24.593",
    "paymentLink": "https://businesscenter.cybersource.com/payByLink/pay/e1PxwGdhJWtz3MBXCE7DvuXoYlT7G0I2kyb3gRrQY6bLWbH5769guEPlUri2z7Kc"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 5,
      "currency": "USD"
    },
    "lineItems": [
      {
        "productName": "Fundraiser",
        "unitPrice": 5,
        "quantity": 1
      }
    ]
  }
}
```

RELATED TO THIS PAGE

* [Getting Started with REST](https://developer.cybersource.com/docs/cybs/en-us/platform/developer/all/rest/rest-getting-started/restgs-intro.md)
* [Response Codes](https://developer.cybersource.com/api/reference/response-codes.md)
* [API Field Reference Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/rest-api-fields-intro.md)
* [API Reference Sandbox](https://developer.cybersource.com/api-reference-assets/index.md#static-home-section)
* [Business Center Test](https://businesscentertest.cybersource.com/ebc2/)
* [Business Center Production](https://businesscenter.cybersource.com/ebc2/)
* [Customer Support](https://support.visaacceptance.com/)