Skip to main content

Change Payment Agreement Status

POST 

/v1/pay_to/payment_agreement/change_status

Update the status of an existing payment agreement. This endpoint allows merchants to manage the status of payment agreements based on their business requirements. The status options available are:

  • active: Set the agreement to active status, allowing it to process payments as per the agreement terms.
  • cancelled: Cancel the agreement, making it inactive and preventing any further transactions.
  • suspended: Temporarily suspend the agreement, pausing all associated transactions until reactivated.

This feature is useful for controlling and managing payment workflows in response to specific business needs or customer requests.

Request​

Responses​

Status updated successfully.