Skip to main content

Get Payment Agreement Detail

GET 
/v1/pay_to/payment_agreement/detail

Retrieve the details of a specific payment agreement, including its current status. This endpoint provides insight into the lifecycle and status of a payment agreement, which can be one of the following:

  • created: The customer has initiated the creation of the Payment Agreement.
  • active: The Payment Agreement is active and ready to process payments.
  • suspended: The Payment Agreement is temporarily suspended, pausing all associated transactions.
  • cancelled: The Payment Agreement has been cancelled, and no further payments can be processed.
  • failed: The Payment Agreement has failed due to an error.

For testing purposes, specific PayIDs can be used to simulate different statuses:

  • created: Use PayID no-action@example.com to keep the agreement status as created.
  • failed: Use PayID error@example.com to trigger a failure status.
  • cancelled: Use PayID cancel-agreement@example.com to simulate a cancelled status.
  • suspended: Use PayID suspend-agreement@example.com to simulate a suspended status.

Request​

Responses​

Request processed successfully.