@hyperscale0/hsx 1.0.0-rc.1 → 2.0.0

package/examples/credit_facility/credit_facility.hsx

@@ -1,5 +1,5 @@
 program credit_facility_example "Credit facility example"
-import { credit_facility, scheduled } from "std/settlements"
+import { credit_facility, scheduled } from "std/money_flows"
 party lender: business
 party borrower: business
 party draw_destination: business

package/examples/credit_facility/credit_facility.udl

@@ -294,7 +294,8 @@
         "installment1Amount": {
           "description": "Stored amount for installment 1 of 2 (carries the integer-division remainder)",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment1DelinquentAfter": {
           "description": "Machine-set marker proving installment 1 reached its stored due date while unpaid",
@@ -304,7 +305,8 @@
         "installment2Amount": {
           "description": "Stored amount for installment 2 of 2",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment2DelinquentAfter": {
           "description": "Machine-set marker proving installment 2 reached its stored due date while unpaid",
@@ -325,7 +327,8 @@
         "principal": {
           "description": "The principal in SAR minor units; the stored installment anchors partition it exactly",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "repaymentSourceAccountId": {
           "description": "The repayment source account",
@@ -547,7 +550,7 @@
           "summary": "Refund this one stored installment 1 payment whole"
         },
         "repay": {
-          "agentDescription": "Pay this record's amount toward installment 1. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, only the payer may call it and an evidence reference is required.",
+          "agentDescription": "Pay this record's amount toward installment 1. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, its declared parties may call it and an evidence reference is required.",
           "effects": {
             "moves": [
               {
@@ -643,7 +646,8 @@
         "amount": {
           "description": "Positive payment amount capped with its paid siblings at installment1Amount",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -834,7 +838,7 @@
           "summary": "Refund this one stored installment 2 payment whole"
         },
         "repay": {
-          "agentDescription": "Pay this record's amount toward installment 2. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, only the payer may call it and an evidence reference is required.",
+          "agentDescription": "Pay this record's amount toward installment 2. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, its declared parties may call it and an evidence reference is required.",
           "effects": {
             "moves": [
               {
@@ -930,7 +934,8 @@
         "amount": {
           "description": "Positive payment amount capped with its paid siblings at installment2Amount",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -1104,7 +1109,8 @@
         "facilityLimit": {
           "description": "Facility limit in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "lenderAccountId": {
           "description": "The lender account",
@@ -1290,7 +1296,8 @@
         "amount": {
           "description": "One draw amount",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",

package/examples/held_payment/held_payment.hsx

@@ -1,5 +1,5 @@
 program held_payment_example "Held payment example"
-import { held_payment } from "std/settlements"
+import { held_payment } from "std/money_flows"
 party buyer: person
 party seller: business
 settlement sale = held_payment {

package/examples/held_payment/held_payment.udl

@@ -7,7 +7,9 @@
         "confirm_delivery",
         "release_on_deadline",
         "cancel",
-        "abandon"
+        "abandon",
+        "dispute",
+        "resume"
       ],
       "actions": {
         "abandon": {
@@ -160,6 +162,7 @@
             ]
           },
           "publicAction": "confirmDeliverySale",
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Confirm through confirm_delivery and start the release payout"
         },
@@ -199,6 +202,14 @@
           ],
           "summary": "Create a sale settlement"
         },
+        "dispute": {
+          "agentDescription": "Freeze a funded sale so neither release nor refund can run until the parties settle the disagreement. No money moves and the whole balance stays put. Only a funded sale disputes.",
+          "description": "Freezes funded sale, preserving the entire balance while the parties decide what happens next.",
+          "moves": [],
+          "publicAction": "disputeSale",
+          "steps": [],
+          "summary": "Dispute a sale settlement"
+        },
         "fund_piece_1": {
           "agentDescription": "Move the buyer's money into this settlement's escrow. Call it after create and before any release. It debits the buyer for real, and where the product charges a payer-side fee that fee is taken on top in the same call. Only a later release or unwind moves the money again.",
           "effects": {
@@ -298,6 +309,7 @@
             }
           ],
           "publicAction": "fundPiece1Sale",
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund piece 1 of the held amount into escrow"
         },
@@ -364,6 +376,14 @@
           ],
           "steps": [],
           "summary": "Release to the seller when releaseDueAt arrives undecided"
+        },
+        "resume": {
+          "agentDescription": "Lift the dispute hold and put the sale back where it was, funded and ready to release. No money moves and the balance was never touched. Only a disputed sale resumes. Use this when the parties settled without a refund.",
+          "description": "Ends the dispute hold without moving money and returns the fully funded sale to its first milestone.",
+          "moves": [],
+          "publicAction": "resumeSale",
+          "steps": [],
+          "summary": "Resume a sale settlement"
         }
       },
       "agentDescription": "Reach for sale when the buyer must commit money up front and nobody is paid until confirm_delivery fires. Funding moves price into this settlement's own escrow account, where it stays until a release or an unwind pays it out. A straight-through payment with no custody step is a different shape.",
@@ -415,7 +435,8 @@
         "price": {
           "description": "The held amount in SAR minor units, funded and paid out whole",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "releaseDueAt": {
           "description": "The date an undecided hold releases to the seller on; confirm_delivery and cancellation decide only before it",
@@ -436,7 +457,8 @@
         "serviceFeeAmount": {
           "description": "Machine-owned 1% service fee computed from price; charged on top at funding",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         }
       },
       "id": "sale",
@@ -446,6 +468,7 @@
         "states": [
           "created",
           "funded",
+          "disputed",
           "released",
           "cancelled",
           "abandoned"
@@ -469,6 +492,12 @@
             ],
             "to": "released"
           },
+          "dispute": {
+            "from": [
+              "funded"
+            ],
+            "to": "disputed"
+          },
           "fund_piece_1": {
             "from": [
               "created"
@@ -480,6 +509,12 @@
               "funded"
             ],
             "to": "released"
+          },
+          "resume": {
+            "from": [
+              "disputed"
+            ],
+            "to": "funded"
           }
         }
       },

package/examples/instant_transfer/instant_transfer.hsx

@@ -1,5 +1,5 @@
 program instant_transfer_example "Instant transfer example"
-import { instant_transfer } from "std/settlements"
+import { instant_transfer } from "std/money_flows"
 party customer: person
 party merchant: business
 settlement transfer = instant_transfer {

package/examples/instant_transfer/instant_transfer.udl

@@ -126,6 +126,7 @@
             }
           ],
           "publicAction": "payPiece1Transfer",
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Pay piece 1 of the amount through"
         },
@@ -233,12 +234,14 @@
         "carvedFeeAmount": {
           "description": "The carved platform fee selected from transferAmount",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "checkoutFee": {
           "description": "Immutable exact customer fee in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -261,7 +264,8 @@
         "highValueFee": {
           "description": "Immutable exact merchant fee in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "merchantAccountId": {
           "description": "The merchant account",
@@ -277,7 +281,8 @@
         "netOfCarvedFeeAmount": {
           "description": "The remainder of transferAmount after the carved platform fee",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "platformAccountId": {
           "description": "The product fee collection account",
@@ -295,7 +300,8 @@
         "transferAmount": {
           "description": "The gross amount in SAR minor units; the piece fields below partition it exactly",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         }
       },
       "id": "transfer",

package/examples/metered/metered.hsx

@@ -1,5 +1,5 @@
 program metered_example "Metered example"
-import { metered } from "std/settlements"
+import { metered } from "std/money_flows"
 party customer: business
 party provider: business
 settlement usage = metered {

package/examples/metered/metered.udl

@@ -152,7 +152,8 @@
         "callRate": {
           "description": "Per-unit price of api call in SAR minor units, committed at period open",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -191,7 +192,8 @@
         "storageRate": {
           "description": "Per-unit price of storage gib in SAR minor units, committed at period open",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         }
       },
       "id": "usage",

package/examples/pooled_split/pooled_split.hsx

@@ -1,5 +1,5 @@
 program pooled_split_example "Pooled split example"
-import { pooled_split } from "std/settlements"
+import { pooled_split } from "std/money_flows"
 party payer: business
 party first_recipient: business
 party second_recipient: business

package/examples/pooled_split/pooled_split.udl

@@ -312,7 +312,8 @@
         "firstRecipientShareAmount": {
           "description": "60% of poolAmount (carries the integer-division remainder): the first recipient's share. Computed as floor(poolAmount * 6000 / 10000) in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "payerAccountId": {
           "description": "The payer account",
@@ -333,7 +334,8 @@
         "poolAmount": {
           "description": "The pooled period total in SAR minor units; the share fields below partition it exactly",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "secondRecipientAccountId": {
           "description": "The second recipient account",
@@ -349,7 +351,8 @@
         "secondRecipientShareAmount": {
           "description": "40% of poolAmount: the second recipient's share. Computed as floor(poolAmount * 4000 / 10000) in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         }
       },
       "id": "pool",

package/examples/premium_forward/premium_forward.hsx

@@ -1,5 +1,5 @@
 program premium_forward_example "Premium forward example"
-import { premium_forward } from "std/settlements"
+import { premium_forward } from "std/money_flows"
 party policyholder: person
 party carrier: business
 settlement premium = premium_forward {

package/examples/premium_forward/premium_forward.udl

@@ -95,6 +95,7 @@
             ]
           },
           "publicAction": "bindPolicyPremium",
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Confirm through bind_policy and start the forward payout"
         },
@@ -245,6 +246,7 @@
             }
           ],
           "publicAction": "fundPiece1Premium",
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund piece 1 of the held amount into escrow"
         },
@@ -302,6 +304,7 @@
             }
           ],
           "publicAction": "fundPiece2Premium",
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund piece 2 of the held amount into escrow"
         },
@@ -327,7 +330,7 @@
         "record_endorsement": {
           "agentDescription": "Record one endorsement against a policy that already forwarded, from evidence the caller supplies. The forward must be released first, and only the carrier may call it. It moves no money and it does not change the premium.",
           "captureInput": {
-            "endorsementEvidenceReference": "evidenceReference"
+            "evidenceReference": "evidenceReference"
           },
           "effects": {
             "decides": [
@@ -444,12 +447,14 @@
         "piece1Amount": {
           "description": "98% of premiumAmount (carries the integer-division remainder): released to the carrier. Computed as floor(premiumAmount * 9800 / 10000) in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "piece2Amount": {
           "description": "2% of premiumAmount: released to the platform. Computed as floor(premiumAmount * 200 / 10000) in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "platformAccountId": {
           "description": "The product fee collection account",
@@ -484,7 +489,8 @@
         "premiumAmount": {
           "description": "The gross held amount in SAR minor units; the piece fields below partition it exactly",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "renewalDueAt": {
           "description": "Stored renewal due condition for the forwarded policy",

package/examples/reconciled_payout/reconciled_payout.hsx

@@ -1,5 +1,5 @@
 program reconciled_payout_example "Reconciled payout example"
-import { reconciled_payout } from "std/settlements"
+import { reconciled_payout } from "std/money_flows"
 party treasury: business
 party supplier: business
 settlement supplier_payout = reconciled_payout {

package/examples/reconciled_payout/reconciled_payout.udl

@@ -108,7 +108,8 @@
         "netPayable": {
           "description": "Amount instructed to the supplier in minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "settleBy": {
           "description": "Instant the expectation stops waiting and the unmatched amount becomes a break",
@@ -265,7 +266,8 @@
         "unmatchedAmount": {
           "description": "Difference between the instructed amount and the evidence, in minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         }
       },
       "id": "supplier_payout_break",

package/examples/recurring_collection/recurring_collection.hsx

@@ -1,5 +1,5 @@
 program recurring_collection_example "Recurring collection example"
-import { recurring_collection, scheduled } from "std/settlements"
+import { recurring_collection, scheduled } from "std/money_flows"
 party debtor: person
 party repayment_source: business
 party recipient: business

package/examples/recurring_collection/recurring_collection.udl

@@ -294,7 +294,8 @@
         "installment1Amount": {
           "description": "Stored amount for installment 1 of 2 (carries the integer-division remainder)",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment1DelinquentAfter": {
           "description": "Machine-set marker proving installment 1 reached its stored due date while unpaid",
@@ -304,7 +305,8 @@
         "installment2Amount": {
           "description": "Stored amount for installment 2 of 2",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment2DelinquentAfter": {
           "description": "Machine-set marker proving installment 2 reached its stored due date while unpaid",
@@ -314,7 +316,8 @@
         "principal": {
           "description": "The principal in SAR minor units; the stored installment anchors partition it exactly",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "recipientAccountId": {
           "description": "The recipient account",
@@ -547,7 +550,7 @@
           "summary": "Refund this one stored installment 1 payment whole"
         },
         "repay": {
-          "agentDescription": "Pay this record's amount toward installment 1. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, only the payer may call it and an evidence reference is required.",
+          "agentDescription": "Pay this record's amount toward installment 1. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, its declared parties may call it and an evidence reference is required.",
           "captureInput": {
             "mandateEvidenceReference": "evidenceReference"
           },
@@ -672,7 +675,8 @@
         "amount": {
           "description": "Positive payment amount capped with its paid siblings at installment1Amount",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -863,7 +867,7 @@
           "summary": "Refund this one stored installment 2 payment whole"
         },
         "repay": {
-          "agentDescription": "Pay this record's amount toward installment 2. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, only the payer may call it and an evidence reference is required.",
+          "agentDescription": "Pay this record's amount toward installment 2. The record must be created and its obligation live. Refused when this amount plus the records already paid against that installment would pass the stored amount. This moves the payer's money. Where a mandate applies, its declared parties may call it and an evidence reference is required.",
           "captureInput": {
             "mandateEvidenceReference": "evidenceReference"
           },
@@ -988,7 +992,8 @@
         "amount": {
           "description": "Positive payment amount capped with its paid siblings at installment2Amount",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",

package/examples/rotating_pool/rotating_pool.hsx

@@ -1,5 +1,5 @@
 program rotating_pool_example "Rotating pool example"
-import { rotating_pool } from "std/settlements"
+import { rotating_pool } from "std/money_flows"
 party member_a: person
 party member_b: person
 party member_c: person

package/examples/rotating_pool/rotating_pool.udl

@@ -396,7 +396,8 @@
         "contributionAmount": {
           "description": "Exact contribution in SAR minor units",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -648,6 +649,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund member a's cycle 1 contribution"
         },
@@ -1244,6 +1246,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Pay this member's stored contribution into cycle 1's shared pot recipient"
         },
@@ -1609,7 +1612,8 @@
         "contributionAmount": {
           "description": "Exact contribution amount shared by every cycle",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -1915,6 +1919,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund member b's cycle 1 contribution"
         },
@@ -2511,6 +2516,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Pay this member's stored contribution into cycle 1's shared pot recipient"
         },
@@ -2876,7 +2882,8 @@
         "contributionAmount": {
           "description": "Exact contribution amount shared by every cycle",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",
@@ -3182,6 +3189,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Fund member c's cycle 1 contribution"
         },
@@ -3778,6 +3786,7 @@
               ]
             }
           ],
+          "sandboxFailurePoint": "release",
           "steps": [],
           "summary": "Pay this member's stored contribution into cycle 1's shared pot recipient"
         },
@@ -4143,7 +4152,8 @@
         "contributionAmount": {
           "description": "Exact contribution amount shared by every cycle",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "currency": {
           "description": "ISO 4217 currency code",

package/examples/scheduled/scheduled.hsx

@@ -1,5 +1,5 @@
 program scheduled_example "Scheduled example"
-import { scheduled } from "std/settlements"
+import { scheduled } from "std/money_flows"
 party payer: business
 party payee: business
 settlement installments = scheduled {

package/examples/scheduled/scheduled.udl

@@ -76,6 +76,7 @@
               "operation": "internal_transfer.create"
             }
           ],
+          "sandboxFailurePoint": "funding",
           "steps": [],
           "summary": "Collect installment 1 of 3"
         },
@@ -228,17 +229,20 @@
         "installment1Amount": {
           "description": "Installment 1 of 3 (carries the integer-division remainder): about 33.34% of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment2Amount": {
           "description": "Installment 2 of 3: about 33.33% of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "installment3Amount": {
           "description": "Installment 3 of 3: about 33.33% of totalAmount, collected on its own stored-date anchor",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         },
         "payeeAccountId": {
           "description": "The payee account",
@@ -265,7 +269,8 @@
         "totalAmount": {
           "description": "The total scheduled amount in SAR minor units; the installment fields below partition it exactly",
           "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string"
+          "type": "string",
+          "x-hyperscale-currency": "SAR"
         }
       },
       "id": "installments",