During the life cycle of a Payment Link, there may be cases where you will need to manage its status, such as cancelling of a payment when the order has been cancelled.

This API also allows you to force changes on the Payment Link's status in the sandbox and production mode in order to test the status flows.

Available Payment Link management actions

Action

Description

cancel

Cancel a payment link when it is still in pending state. Status will be changed to 'cancelled'.

receive_payment

[Sandbox Method] Simulates a payment received from the customer for the payment link. Status will be changed to 'paid'.

settle

[Sandbox Method] Simulates funds for a payment being made available for transfer or withdrawal. Status will be changed to 'completed'.

Language
Authentication
Query