Pause Recurring Transaction

Pause a recurring transaction in ACTIVE status. While paused, no transactions will be created until resumed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type. Use id for Passport-assigned ID or externalId for program manager-assigned ID.

Allowed:
string
required

The unique identifier of the recurring transaction to pause.

Body Params

Reason for pausing the recurring transaction.

string
enum
required

Reason for pausing.

Allowed:
Headers
string
enum
required

Controls response timing. Use NEVER for immediate synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses
204

Recurring transaction paused successfully.

400

Invalid request or transaction cannot be paused.

404

Recurring transaction not found.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!
.readme-logo { display: none !important; }