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 [email protected] to keep the agreement status as created.
• failed: Use PayID [email protected] to trigger a failure status.
• cancelled: Use PayID [email protected] to simulate a cancelled status.
• suspended: Use PayID [email protected] to simulate a suspended status.

Request

Responses

200

Request processed successfully.

400

Bad Request

401

Unauthorized

422

Unprocessable Entity