Create Recurring Plan
https://api.druo.com/recurring-plans/createCreates a new Recurring Plan object.
This endpoint establishes a Recurring Plan, allowing you to automate payments or transfers based on a predefined schedule and frequency. The plan can use an existing end user or define a new one inline.
Request body
The description of this Recurring Plan.
The processing method for the Recurring Plan.
AUTOMATICSEND_REQUESTThe ID of the merchant associated with this Recurring Plan.
The scheduled start date. If not set, it defaults to the current date.
The scheduled end date. If not set, the plan continues indefinitely.
The total number of cycles for the Recurring Plan.
The frequency of the Recurring Plan cycles.
DAILYWEEKLYMONTHLYSEMI_ANNUALLYYEARLYThe ID of an existing end user. Required if new_end_user_details is not provided.
The details used to create a new end user. Required only if existing_end_user_id is not provided.
The ID of the account used to fund transactions in this plan.
The ID of the account that should receive the funds for transactions in this plan.
The transaction details for the Recurring Plan.
The ID of the tenant that originated the transaction.
The type of currency in ISO 4217 format.
The amount of money, in the smallest denomination of the currency (e.g., cents for USD).
The description that DRUO will report to financial institutions to appear on customer statements.
The primary reference of the transaction. Used to associate transaction records with an external system.
The secondary reference of the transaction. Used to associate transaction records with an external system.
Key-value pairs containing transaction metadata.
The ID of the retry sequence used to determine retry behavior for transactions that fail due to insufficient funds.
The Recurring Plan's primary reference. Can be any value to associate the plan with an entity in an external system.
The Recurring Plan's secondary reference. Can be any value to associate the plan with an entity in an external system.
Key-value pairs containing additional information about the Recurring Plan.
Response
The unique identifier (UUID) of the Recurring Plan.
rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3The description of the created Recurring Plan.
Recurring Plan #1234567 for transaction 123455The scheduled start date of the Recurring Plan.
2023-08-16T23:20:15.645+00:00The scheduled end date of the Recurring Plan.
2023-10-16T23:20:15.645+00:00The details of the end user associated with the Recurring Plan.
The ID of the origin account.
acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340The ID of the destination account.
acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340The Recurring Plan's secondary reference.
bj39fhow39fhqp3f0hfae4344The transaction details associated with the created Recurring Plan.
The UUID of the tenant that originated the transaction.
22637d15-5b37-4fb2-90e5-aa8751970469The amount of the transaction in the smallest currency unit.
10000The descriptor showing on bank statements.
NOVO BILLING* INV12324The primary reference of the transaction.
Transaction primary referenceThe secondary reference of the transaction.
Transaction secondary referenceThe metadata associated with the transaction.
{"id_user": "69440", "transaction_xyz": "JOHN SMITH"}Key-value pairs containing metadata about the Recurring Plan.
{"order_id": "6735"}The creation timestamp of the Recurring Plan in GMT format.
2021-11-15T23:23:38ZThe last update timestamp of the Recurring Plan in GMT format.
2021-11-15T23:23:38Z
