Cancel Created Payment Links

The Cancel Payment Link feature integrated into Payiano represents a vital functionality for both businesses and individuals engaged in digital transactions, ensuring they maintain control and flexibility over their payment processes. This feature is especially critical when a transaction becomes redundant or if there's an error in the originally sent payment details. By allowing instant invalidation of a payment link, it prevents any potential or unintended financial exchanges.

Additionally, this feature is really helpful for fixing mistakes. For example, if you send a Payment Link with the wrong details, canceling it stops any wrong payments from happening. This tool gives businesses full control over their Payment Links, making sure that only the right transactions go through. It also tells everyone automatically when a Payment Link is canceled. This keeps things clear and helps avoid any mix-ups.

Enhancing the security aspect, this feature is pivotal for withdrawing links that might have been compromised or erroneously shared, thereby safeguarding the transactional integrity. Designed with user-friendliness at its core, the process to cancel a payment link is straightforward and accessible, requiring just a few clicks, making it manageable for users irrespective of their technical expertise. However, it's important to note that the cancellation of a payment link is irreversible; thus, if a subsequent transaction is necessary, a new link must be created. This design principle underscores the commitment to maintaining transactional clarity and integrity, a cornerstone for smooth and secure business operations in the digital age.

PUT/payment_links/{id}/cancel
Sandbox: https://api.payiano.dev/v1/payment_links/{id}/cancel
Live: https://api.payiano.com/v1/payment_links/{id}/cancel
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission payment_links_cancel
Request
Request body schema:
application/json
Path parameters:
id
required
Type: ulid
Length: 26

The unique ID assigned to each payment link which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every payment link. This ULID is automatically created by our system and is used to uniquely identify and track each payment link in our database.

Query parameters:
identify_by
Type: enum|null
Possible values:
[ "id", "reference_id" ]

This attribute specifies which identifier is being used to interact with a resource in the Payiano API. It helps the system understand how to identify resource when processing API requests. By default, the identify_by attribute is set to id, so you only need to specify it if you're using a different identifier.

Response
200
Response schema:
application/json
Response body:
status
Type: boolean

This value indicates whether the payment link cancel was successful or not.

Response sample:
1
{ 2 "status": true 3}