API Reference
  1. Treasury Solutions
  2. Recurring Transaction

Create Recurring Transaction

post
https://sandbox-api.prioritycommerce.com/v1/passport/v1/transaction/recurring

Create a recurring transaction to automate payments of a fixed amount at specified intervals. Supports frequencies like CALENDAR_DAY, WEEK, MONTH, and YEAR.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details required to create a recurring transaction.

Request body for creating a recurring transaction.

string
required

Name or description of the recurring transaction.

string

Program manager-assigned external identifier.

transactionDetail
object
required

Scheduling details for the recurring transaction.

action
array of objects
required

Actions to perform on each occurrence.

action*
linkedDocument
array of objects

Documents linked to the recurring transaction.

linkedDocument
string

Additional comments.

metaData
object

Custom key-value metadata.

Headers
string
enum
required

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

Allowed:
Responses

400

Invalid request. Check for missing required fields or incorrect data formats.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the server.

Updated 1 day ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

Did this page help you?
.readme-logo { display: none !important; }