Sign in
paymentLinks

Deactivate payment link

Use this method to deactivate a payment link.

To deactivate a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the Create Payment Link method.

Note: If you don't have the paymentLinkId, use our List Payment Links method to search for the payment link.

If your request is successful, our gateway deactivates the payment link. The customer can't use the link to make a payment, and you can't reactivate the payment link.

post/payment-links/{paymentLinkId}/deactivate

Path parameters

paymentLinkIdstring required

Unique identifier that we assigned to the payment link.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. We return a polymorphic object that contains payment link information.

The value of the type parameter determines which variant you should use:

  • multiUse - Create a link that the merchant can use to take multiple payments.
  • singleUse - Create a link that the merchant can use for only one payment.
OR

Changes

No recorded changes to this endpoint across all 1 revision of this API.