Add documentation for recurring orders#124
Open
joaobaptistanqda wants to merge 1 commit into
Open
Conversation
|
🚀 Preview has been deployed.
|
jackmurdoch
force-pushed
the
enhancement/document-automated-orders
branch
from
29d0078 to
ce40a53
Compare
andregoncalvesdev
requested changes
Jun 15, 2026
| - `ipVersion` (_optional_): Version of IP value used on the hash. | ||
| - `user-agent` (_optional_): User agent used on partner's side that we should validate remains the same. | ||
| - `partnerFee` (_deprecated_): Use `partner.fee` instead. | ||
| - `periodicity` (_optional_): The order periodicity (can be `once` / `weekly` / `monthly`) |
Contributor
There was a problem hiding this comment.
periodicity (optional): The order periodicity (can be once / weekly / monthly). Defaults to once.
|
|
||
| ## Configuration | ||
|
|
||
| A scheduled order can be initiated by setting the `periodicity` property in the [bootstrap token payload](/flows/crypto-onramp.mdx#bootstrap-token-payload). |
Contributor
There was a problem hiding this comment.
A scheduled order can be initiated by setting the periodicity property in the bootstrap token payload as weekly or monthly.
Contributor
There was a problem hiding this comment.
and remove supported values, they're already documented on the link.
|
|
||
| For `weekly`, scheduled orders are created on the same day of the week that the initial automated order was created - if we create an automated order on Monday, automated orders will be created on Mondays. | ||
|
|
||
| For `monthly`, scheduled orders are created on the same day of the month that the initial automated order was created - if we create an automated order on the 16th, automated orders will be created on ther 16th of each month. If a given month does not have the same number of days, the order will be created on the last day of that month. |
Contributor
There was a problem hiding this comment.
enhance last part
Signed-off-by: João Baptista <joao.baptista@changemoney.org>
joaobaptistanqda
force-pushed
the
enhancement/document-automated-orders
branch
from
ce40a53 to
46e1060
Compare
andregoncalvesdev
requested changes
Jun 15, 2026
| sidebar_position: 16 | ||
| --- | ||
|
|
||
| # Automated orders |
Contributor
There was a problem hiding this comment.
Recurring orders and the file name aswell.
joaobaptistanqda
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation for automated orders.
Related issues
https://uphold.atlassian.net/browse/SWY-3958