{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Scheduled Transactions"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"scheduled-transactions","__idx":0},"children":["Scheduled Transactions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Scheduled Transactions API lists future-dated payments and transfers for"," ","the business linked to your API Access Token - money that is committed but has"," ","not gone out yet. The endpoint requires the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactions:read"]}," scope."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Beta"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Scheduled Transactions API is in Beta. Additive changes are normal, and"," ","breaking changes may be made with notice while the resource incorporates"," ","customer feedback. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/versioning"},"children":["Versioning and compatibility"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-scheduled-transactions","__idx":1},"children":["List scheduled transactions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v1/scheduled-transactions"]}," returns a paginated list of scheduled"," ","transactions, one-time and recurring. Search matches the schedule's identifier,"," ","amount, and counterparty name."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://rhoapi.rho.co/api/v1/scheduled-transactions?payment_type=ach&sort_by=next_release_date&order=asc&page_size=20\" \\\n  -H \"Authorization: Bearer $RHO_API_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string[]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by rail: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ach"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["domestic_wire"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["international_wire"]},". Repeat the key to pass several."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["counterparty_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string[]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by the counterparty being paid. Repeat the key to pass several."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["initiating_user_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string[]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by the team member who created the schedule. Repeat the key to pass several."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free-text across the schedule's identifier, amount, and counterparty name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort_by"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next_release_date"]}," (default) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["asc"]}," (default) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["desc"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page_size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1 to 100, defaults to 20."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page_token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Opaque cursor from the previous response."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unlike most list endpoints here, this one defaults to ascending order, so the"," ","soonest release leads the page. Follow the cursor as described in"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/pagination"},"children":["Pagination"]}," until ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next_page_token"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", and keep"," ","filters and sort unchanged while paginating. Page tokens belong to the API"," ","version that created them, so restart pagination when migrating from v0 to v1."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"scheduled_transactions\": [\n    {\n      \"id\": \"3f2b1a44-9c1e-4a8b-bb0e-8b7c2d5e1a90\",\n      \"amount\": {\"amount\": 450000, \"currency\": \"USD\"},\n      \"payment_type\": \"ach\",\n      \"source_account\": {\"id\": \"8b7c2d5e-1a90-4a8b-bb0e-3f2b1a449c1e\"},\n      \"counterparty\": {\n        \"id\": \"bb0e8b7c-2d5e-1a90-4a8b-3f2b1a449c1e\",\n        \"name\": \"Northside Property Co\"\n      },\n      \"initiating_user\": {\"id\": \"9c1e4a8b-bb0e-8b7c-2d5e-1a903f2b1a44\"},\n      \"schedule\": {\n        \"frequency\": \"monthly\",\n        \"next_release_date\": \"2026-09-01\",\n        \"end_condition\": {\n          \"type\": \"never\",\n          \"end_date\": null,\n          \"occurrence_count\": null\n        },\n        \"failed\": false\n      },\n      \"bill\": null\n    },\n    {\n      \"id\": \"1a904a8b-3f2b-4a8b-bb0e-8b7c2d5e1a44\",\n      \"amount\": {\"amount\": 128000, \"currency\": \"USD\"},\n      \"payment_type\": \"domestic_wire\",\n      \"source_account\": {\"id\": \"8b7c2d5e-1a90-4a8b-bb0e-3f2b1a449c1e\"},\n      \"counterparty\": {\n        \"id\": \"2d5e1a90-bb0e-4a8b-8b7c-3f2b1a449c1e\",\n        \"name\": \"Kestrel Legal LLP\"\n      },\n      \"initiating_user\": {\"id\": \"9c1e4a8b-bb0e-8b7c-2d5e-1a903f2b1a44\"},\n      \"schedule\": {\n        \"frequency\": \"one_time\",\n        \"next_release_date\": \"2026-08-15\",\n        \"end_condition\": {\n          \"type\": \"never\",\n          \"end_date\": null,\n          \"occurrence_count\": null\n        },\n        \"failed\": false\n      },\n      \"bill\": {\"id\": \"4a8b3f2b-1a44-9c1e-bb0e-8b7c2d5e1a90\"}\n    }\n  ],\n  \"page\": {\n    \"next_page_token\": null\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Amounts use the currency's smallest unit (cents for USD), so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["450000"]}," is"," ","$4,500.00, and it's the amount of each occurrence rather than the total across"," ","them."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-schedule-object","__idx":2},"children":["The schedule object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["frequency"]}," is one of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one_time"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["daily"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weekly"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["semi_monthly"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["monthly"]},","," ","or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yearly"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["semi_monthly"]}," is anchored to the 1st and 15th; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weekly"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["monthly"]}," ","and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yearly"]}," to the same weekday or calendar day."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["next_release_date"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," once the schedule has permanently stopped"," ","producing occurrences - after its single release for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one_time"]},", or once its end"," ","condition is reached."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," when a recurring schedule has stopped executing, as distinct"," ","from one that completed normally or was canceled. It's always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," for"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one_time"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end_condition.type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["never"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end_date"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["occurrence_count"]},", and only the"," ","matching field is populated. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end_date"]}," is exclusive: the schedule stops before"," ","it, so an occurrence landing exactly on that date doesn't fire, and the last"," ","release is on the preceding scheduled date. The end condition isn't meaningful"," ","for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one_time"]},", which always ends after its single release."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"where-a-schedule-comes-from","__idx":3},"children":["Where a schedule comes from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bill"]}," is set when the schedule pays a bill from Bill Pay and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," for a"," ","plain scheduled transfer. Recurring isn't supported in bill pay yet, so a"," ","schedule with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bill"]}," is always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["one_time"]}," today."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["counterparty.id"]}," is the counterparty identifier returned with the schedule, and"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["initiating_user.id"]}," resolves through ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/v1/users"},"children":["Users"]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bill.id"]}," is the Bill Pay identifier."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"limitations","__idx":4},"children":["Limitations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Canceled schedules aren't returned."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To link an occurrence to the transaction you have to match on amount, date, and counterparty."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference","__idx":5},"children":["Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full endpoint catalogue - paths, parameters, response shapes, and required"," ","scopes - lives in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/v1/openapi/scheduled-transactions"},"children":["API Reference"]},"."]}]},"headings":[{"value":"Scheduled Transactions","id":"scheduled-transactions","depth":1},{"value":"List scheduled transactions","id":"list-scheduled-transactions","depth":2},{"value":"The schedule object","id":"the-schedule-object","depth":2},{"value":"Where a schedule comes from","id":"where-a-schedule-comes-from","depth":2},{"value":"Limitations","id":"limitations","depth":2},{"value":"Reference","id":"reference","depth":2}],"frontmatter":{"seo":{"title":"Scheduled Transactions"}},"lastModified":"2026-10-16T16:44:02.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/v1/scheduled-transactions","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}