# Examples
Install the generated TypeScript SDK from the Hyperscale Kit minted by the Product's Developers desk before running these source-tree examples. CI can instead authenticate `GET /v1/llms.txt` with a Product API key to discover the latest Build's exact hosted npm package:
```bash
npm install ./sdks/typescript
```
Each example on an SDK-callable operation is a complete runnable TypeScript program using the `createHyperscale` client the Kit's TypeScript package exports (where an example body has no SDK shape, the raw JSON request is shown instead). Provision a key first as shown in the [Quickstart](quickstart.md). Operations that are not SDK-callable sit in their own sections at the end, grouped by the principal that authorizes them; each section states how that principal authenticates. Sample IDs are setup-owned sandbox IDs; replace them with IDs returned by your Hyperscale setup.
Every snippet below imports from `@hyperscale/tenant-sdk-your-capabilities`, which stands in for your own package name: the Kit names its TypeScript package after your Product's capabilities. Your exact name is the `name` field of `sdks/typescript/package.json` in the unpacked Kit, and an authenticated `GET /v1/llms.txt` returns it for the hosted copy of the same package.
## Index
- account.create: customer_balance_account (POST /v1/accounts)
- account.statement.export: monthly-csv (GET /v1/accounts/{accountId}/statements/{period}/export)
- beneficiary.create: create_seller_beneficiary (POST /v1/beneficiaries)
- beneficiary.verify: verify_seller_payout_beneficiary (POST /v1/beneficiary-verifications)
- card.activate: activate_virtual_card (POST /v1/cards/{cardId}/activate)
- card.cancel: cancel_virtual_card (POST /v1/cards/{cardId}/cancel)
- card.create: issue_controlled_virtual_card (POST /v1/cards)
- card.freeze: freeze_virtual_card (POST /v1/cards/{cardId}/freeze)
- card.unfreeze: unfreeze_virtual_card (POST /v1/cards/{cardId}/unfreeze)
- card.update: tighten_virtual_card_controls (PATCH /v1/cards/{cardId})
- card_authorization.approve: approve_authorization_after_jit_decision (POST /v1/card-authorizations/{cardAuthorizationId}/approve)
- card_authorization.capture: capture_completed_purchase (POST /v1/card-authorizations/{cardAuthorizationId}/capture)
- card_authorization.create: request_retail_authorization (POST /v1/card-authorizations)
- card_authorization.decline: decline_rejected_authorization (POST /v1/card-authorizations/{cardAuthorizationId}/decline)
- card_authorization.reverse: reverse_uncaptured_authorization (POST /v1/card-authorizations/{cardAuthorizationId}/reverse)
- card_dispute.create: file_unauthorized_purchase_dispute (POST /v1/card-disputes)
- card_dispute.review: begin_card_dispute_review (POST /v1/card-disputes/{cardDisputeId}/review)
- card_dispute.update: add_card_dispute_evidence (PATCH /v1/card-disputes/{cardDisputeId})
- card_dispute.win: return_won_dispute_amount (POST /v1/card-disputes/{cardDisputeId}/win)
- card_transaction.create: record_captured_card_purchase (POST /v1/card-transactions)
- card_transaction.refund: refund_returned_purchase (POST /v1/card-transactions/{cardTransactionId}/refund)
- cardholder.activate: activate_approved_cardholder (POST /v1/cardholders/{cardholderId}/activate)
- cardholder.close: close_cardholder_relationship (POST /v1/cardholders/{cardholderId}/close)
- cardholder.create: create_customer_cardholder (POST /v1/cardholders)
- cardholder.resume: resume_cardholder_access (POST /v1/cardholders/{cardholderId}/resume)
- cardholder.suspend: suspend_cardholder_access (POST /v1/cardholders/{cardholderId}/suspend)
- cardholder.update: update_cardholder_contact (PATCH /v1/cardholders/{cardholderId})
- circle_membership.create: join_family_circle (POST /v1/circle-memberships)
- circle_membership.create: join_family_circle_second (POST /v1/circle-memberships)
- circle_membership.create: join_family_circle_third (POST /v1/circle-memberships)
- claim.approve: approve_assessed_claim (POST /v1/claims/{claimId}/approve)
- claim.assess: complete_claim_assessment (POST /v1/claims/{claimId}/assess)
- claim.attest: attest_insurer_approval (POST /v1/claims/{claimId}/attest)
- claim.create: file_accidental_damage_claim (POST /v1/claims)
- claim.deny: deny_unapproved_claim (POST /v1/claims/{claimId}/deny)
- claim.pay: pay_approved_claim (POST /v1/claims/{claimId}/pay)
- claim.reverse: reverse_approved_claim (POST /v1/claims/{claimId}/reverse)
- claim.update: add_claim_evidence_summary (PATCH /v1/claims/{claimId})
- collections_case.assign: assign_collections_case (POST /v1/collections-cases/{collectionsCaseId}/assign)
- collections_case.create: open_case_for_overdue_installment (POST /v1/collections-cases)
- collections_case.recall: recall_collections_case (POST /v1/collections-cases/{collectionsCaseId}/recall)
- collections_case.recover: record_lump_sum_recovery (POST /v1/collections-cases/{collectionsCaseId}/recover)
- contact_attempt.create: record_call_with_promise_to_pay (POST /v1/contact-attempts)
- contact_attempt.void: void_contact_attempt (POST /v1/contact-attempts/{contactAttemptId}/void)
- credit_agreement.advance: advance_credit_agreement (POST /v1/credit-agreements/{creditAgreementId}/advance)
- credit_agreement.create: open_credit_agreement (POST /v1/credit-agreements)
- credit_agreement.settle: settle_credit_agreement (POST /v1/credit-agreements/{creditAgreementId}/settle)
- credit_agreement.write_off: write_off_credit_agreement (POST /v1/credit-agreements/{creditAgreementId}/write-off)
- customer.create: customer (POST /v1/customers)
- customer.create: organization_customer (POST /v1/customers)
- customer.login: default (POST /v1/customer-identity/login)
- customer.logout: default (POST /v1/customer-identity/logout)
- customer.session.revoke: default (POST /v1/customer-identity/sessions/{customerSessionId}/revoke)
- customer.signup: default (POST /v1/customer-identity/signup)
- deposit_hold.cancel: cancel_security_deposit (POST /v1/deposit-holds/{depositHoldId}/cancel)
- deposit_hold.claim: claim_security_deposit (POST /v1/deposit-holds/{depositHoldId}/claim)
- deposit_hold.create: create_security_deposit (POST /v1/deposit-holds)
- deposit_hold.fund: fund_security_deposit (POST /v1/deposit-holds/{depositHoldId}/fund)
- escrow_order.cancel: cancel_unfunded_escrow (POST /v1/escrow-orders/{escrowOrderId}/cancel)
- escrow_order.collect_penalty: collect_disputed_refund_penalty (POST /v1/escrow-orders/{escrowOrderId}/collect-penalty)
- escrow_order.create: open_vehicle_escrow (POST /v1/escrow-orders)
- escrow_order.dispute: hold_funds_for_dispute (POST /v1/escrow-orders/{escrowOrderId}/dispute)
- escrow_order.fund: fund_purchase_escrow (POST /v1/escrow-orders/{escrowOrderId}/fund)
- escrow_order.quote: quote_disputed_refund (POST /v1/escrow-orders/{escrowOrderId}/quote)
- escrow_order.refund: confirm_disputed_refund (POST /v1/escrow-orders/{escrowOrderId}/refund)
- escrow_order.release: release_escrow (POST /v1/escrow-orders/{escrowOrderId}/release)
- escrow_order.resume: resume_after_resolution (POST /v1/escrow-orders/{escrowOrderId}/resume)
- escrow_order.update: annotate_unfunded_escrow (PATCH /v1/escrow-orders/{escrowOrderId})
- event.list: sandbox_events (GET /v1/events)
- event.retrieve: sandbox_event (GET /v1/events/{eventId})
- expected_payment.cancel: cancel_expected_payment (POST /v1/expected-payments/{expectedPaymentId}/cancel)
- expected_payment.create: expect_vehicle_payment (POST /v1/expected-payments)
- exposure_arrangement.approve: approve_borrower_exposure (POST /v1/exposure-arrangements/{exposureArrangementId}/approve)
- exposure_arrangement.close: close_borrower_exposure (POST /v1/exposure-arrangements/{exposureArrangementId}/close)
- exposure_arrangement.create: open_borrower_exposure (POST /v1/exposure-arrangements)
- financial_address.create: request_customer_financial_address (POST /v1/financial-addresses)
- financial_address.disable: disable_financial_address (POST /v1/financial-addresses/{financialAddressId}/disable)
- flight_booking.amend_collect: collect_reissued_fare_increase (POST /v1/flight-bookings/{flightBookingId}/amend-collect)
- flight_booking.amend_fee: collect_reissue_fee (POST /v1/flight-bookings/{flightBookingId}/amend-fee)
- flight_booking.amend_refund: refund_reissued_fare_decrease (POST /v1/flight-bookings/{flightBookingId}/amend-refund)
- flight_booking.cancel_confirm: confirm_flight_cancellation (POST /v1/flight-bookings/{flightBookingId}/cancel-confirm)
- flight_booking.cancel_quote: quote_flight_cancellation (POST /v1/flight-bookings/{flightBookingId}/cancel-quote)
- flight_booking.confirm: confirm_flight_booking (POST /v1/flight-bookings/{flightBookingId}/confirm)
- flight_booking.create: hold_flight_booking (POST /v1/flight-bookings)
- flight_booking.release: release_flight_booking (POST /v1/flight-bookings/{flightBookingId}/release)
- funding_commitment.create: pledge_into_round (POST /v1/funding-commitments)
- funding_round.close: settle_collected_round (POST /v1/funding-rounds/{fundingRoundId}/close)
- funding_round.create: open_equipment_round (POST /v1/funding-rounds)
- held_settlement.abandon: abandon_held_settlement (POST /v1/held-settlements/{heldSettlementId}/abandon)
- held_settlement.create: open_held_settlement (POST /v1/held-settlements)
- hotel_stay.amend_collect: collect_extended_stay_increase (POST /v1/hotel-stays/{hotelStayId}/amend-collect)
- hotel_stay.amend_fee: collect_date_change_fee (POST /v1/hotel-stays/{hotelStayId}/amend-fee)
- hotel_stay.amend_refund: refund_shortened_stay_decrease (POST /v1/hotel-stays/{hotelStayId}/amend-refund)
- hotel_stay.cancel_confirm: confirm_weekend_stay_cancel (POST /v1/hotel-stays/{hotelStayId}/cancel-confirm)
- hotel_stay.cancel_quote: quote_weekend_stay_cancel (POST /v1/hotel-stays/{hotelStayId}/cancel-quote)
- hotel_stay.confirm: confirm_weekend_stay (POST /v1/hotel-stays/{hotelStayId}/confirm)
- hotel_stay.create: hold_weekend_stay (POST /v1/hotel-stays)
- hotel_stay.release: release_weekend_stay (POST /v1/hotel-stays/{hotelStayId}/release)
- installment.create: schedule_installment (POST /v1/installments)
- installment.write_off: write_off_overdue_installment (POST /v1/installments/{installmentId}/write-off)
- internal_transfer.create: marketplace_seller_transfer (POST /v1/internal-transfers)
- internal_transfer.post: post_reserved_transfer (POST /v1/internal-transfers/{transferId}/post)
- internal_transfer.reserve: reserve_account_transfer (POST /v1/internal-transfers/reserve)
- internal_transfer.void: void_reserved_transfer (POST /v1/internal-transfers/{transferId}/void)
- lender_distribution.create: claim_lender_distribution (POST /v1/lender-distributions)
- listing.create: draft_vehicle_offer (POST /v1/listings)
- listing.publish: publish_vehicle_offer (POST /v1/listings/{listingId}/publish)
- listing.reopen: reopen_refunded_offer (POST /v1/listings/{listingId}/reopen)
- listing.reserve: reserve_funded_offer (POST /v1/listings/{listingId}/reserve)
- listing.sell: sell_funded_offer (POST /v1/listings/{listingId}/sell)
- listing.update: attach_funded_escrow (PATCH /v1/listings/{listingId})
- listing.withdraw: withdraw_unreserved_offer (POST /v1/listings/{listingId}/withdraw)
- motor_policy.bind: bind_vehicle_cover (POST /v1/motor-policies/{motorPolicyId}/bind)
- motor_policy.cancel: cancel_unbound_vehicle_cover (POST /v1/motor-policies/{motorPolicyId}/cancel)
- motor_policy.create: quote_vehicle_cover (POST /v1/motor-policies)
- order.cancel: cancel_safely_retired_purchase (POST /v1/orders/{orderId}/cancel)
- order.confirm: confirm_funded_purchase (POST /v1/orders/{orderId}/confirm)
- order.create: create_vehicle_purchase_order (POST /v1/orders)
- order.fulfill: fulfill_released_purchase (POST /v1/orders/{orderId}/fulfill)
- order.update: annotate_unconfirmed_order (PATCH /v1/orders/{orderId})
- payout.create: pay_marketplace_seller (POST /v1/payouts)
- payout_run.cancel: cancel_creator_payout (POST /v1/payout-runs/{payoutRunId}/cancel)
- payout_run.create: schedule_creator_payout (POST /v1/payout-runs)
- payout_run.withhold: withhold_creator_payout (POST /v1/payout-runs/{payoutRunId}/withhold)
- policy.bind: bind_carrier_accepted_risk (POST /v1/policies/{policyId}/bind)
- policy.cancel: confirm_pre_activation_cancel (POST /v1/policies/{policyId}/cancel)
- policy.create: quote_asset_protection (POST /v1/policies)
- policy.endorse: endorse_extend_active_cover (POST /v1/policies/{policyId}/endorse)
- policy.preview: preview_pre_activation_cancel (POST /v1/policies/{policyId}/preview)
- policy.update: refine_quoted_cover (PATCH /v1/policies/{policyId})
- policy.withdraw: withdraw_unbound_quote (POST /v1/policies/{policyId}/withdraw)
- product.operation_set.retrieve: default (GET /v1/products/{productId}/operation-set)
- product.retrieve: Sandbox Product summary (GET /v1/products/{productId})
- sale_settlement.abandon: abandon_unfunded_sale (POST /v1/sale-settlements/{saleSettlementId}/abandon)
- sale_settlement.cancel: cancel_funded_settlement (POST /v1/sale-settlements/{saleSettlementId}/cancel)
- sale_settlement.collect_service_fee: collect_service_fee (POST /v1/sale-settlements/{saleSettlementId}/collect-service-fee)
- sale_settlement.confirm_handover: confirm_handover_as_buyer (POST /v1/sale-settlements/{saleSettlementId}/confirm-handover)
- sale_settlement.create: open_car_sale_settlement (POST /v1/sale-settlements)
- sale_settlement.fund_piece_1: fund_first_piece (POST /v1/sale-settlements/{saleSettlementId}/fund-piece-1)
- sale_settlement.fund_piece_2: fund_second_piece (POST /v1/sale-settlements/{saleSettlementId}/fund-piece-2)
- sale_settlement.fund_piece_3: fund_third_piece (POST /v1/sale-settlements/{saleSettlementId}/fund-piece-3)
- sale_settlement.refund_piece_2: refund_second_piece (POST /v1/sale-settlements/{saleSettlementId}/refund-piece-2)
- sale_settlement.refund_piece_3: refund_last_piece (POST /v1/sale-settlements/{saleSettlementId}/refund-piece-3)
- sale_settlement.release_piece_2: release_second_piece (POST /v1/sale-settlements/{saleSettlementId}/release-piece-2)
- sale_settlement.release_piece_3: release_last_piece (POST /v1/sale-settlements/{saleSettlementId}/release-piece-3)
- sandbox.account.fund: fund_customer_balance (POST /v1/sandbox/account-funding)
- sandbox.beneficiary.accept: accept_seller_beneficiary (POST /v1/sandbox/beneficiaries/{beneficiaryId}/accept)
- sandbox.customer.onboard: onboard_verified_customer (POST /v1/sandbox/customer-onboarding)
- sandbox.customer_access.activate: activate_onboarded_customer (POST /v1/sandbox/customer-access/{customerAccessId}/activate)
- savings_circle.close: close_finished_circle (POST /v1/savings-circles/{savingsCircleId}/close)
- savings_circle.create: form_family_circle (POST /v1/savings-circles)
- savings_circle.disband: disband_unfilled_circle (POST /v1/savings-circles/{savingsCircleId}/disband)
- subject.create: create_vehicle_subject (POST /v1/subjects)
- subject.create: create_flight_itinerary_subject (POST /v1/subjects)
- subject.create: create_lodging_stay_subject (POST /v1/subjects)
- subject.create: create_merchandise_subject (POST /v1/subjects)
- subject.create: create_policy_risk_subject (POST /v1/subjects)
- subject.create: create_traveler_party_subject (POST /v1/subjects)
- trade_settlement.abandon: abandon_unfunded_trade (POST /v1/trade-settlements/{tradeSettlementId}/abandon)
- trade_settlement.create: open_two_sided_trade (POST /v1/trade-settlements)
- trade_settlement.fund: fund_two_sided_trade (POST /v1/trade-settlements/{tradeSettlementId}/fund)
- trade_settlement.release: release_two_sided_trade (POST /v1/trade-settlements/{tradeSettlementId}/release)
- travel_package.cancel: cancel_booked_package (POST /v1/travel-packages/{travelPackageId}/cancel)
- travel_package.complete: complete_delivered_package (POST /v1/travel-packages/{travelPackageId}/complete)
- travel_package.confirm: book_confirmed_package (POST /v1/travel-packages/{travelPackageId}/confirm)
- travel_package.create: draft_jeddah_getaway (POST /v1/travel-packages)
- trust_requirement.respond: default (POST /v1/trust-requirements/{trustRequirementId}/respond)
- vehicle_escrow.collect_penalty: collect_vehicle_cancel_penalty (POST /v1/vehicle-escrows/{vehicleEscrowId}/collect-penalty)
- vehicle_escrow.confirm_cancel: confirm_vehicle_deposit_cancel (POST /v1/vehicle-escrows/{vehicleEscrowId}/confirm-cancel)
- vehicle_escrow.create: open_vehicle_deposit (POST /v1/vehicle-escrows)
- vehicle_escrow.fund: fund_vehicle_deposit (POST /v1/vehicle-escrows/{vehicleEscrowId}/fund)
- vehicle_escrow.quote_cancel: quote_vehicle_deposit_cancel (POST /v1/vehicle-escrows/{vehicleEscrowId}/quote-cancel)
- vehicle_escrow.release: release_vehicle_deposit (POST /v1/vehicle-escrows/{vehicleEscrowId}/release)
- vehicle_listing.complete: complete_vehicle_sale (POST /v1/vehicle-listings/{vehicleListingId}/complete)
- vehicle_listing.create: list_vehicle_for_sale (POST /v1/vehicle-listings)
- vehicle_listing.delist: delist_unsold_vehicle (POST /v1/vehicle-listings/{vehicleListingId}/delist)
- vehicle_listing.reserve: reserve_funded_vehicle (POST /v1/vehicle-listings/{vehicleListingId}/reserve)
- wallet.activate: activate_member_wallet (POST /v1/wallets/{walletId}/activate)
- wallet.close: close_empty_member_wallet (POST /v1/wallets/{walletId}/close)
- wallet.create: create_member_wallet (POST /v1/wallets)
- wallet.topup: topup_member_wallet (POST /v1/wallets/{walletId}/topup)
- wallet.withdraw: withdraw_member_wallet (POST /v1/wallets/{walletId}/withdraw)
- wallet.withdraw: withdraw_wallet_remainder (POST /v1/wallets/{walletId}/withdraw)
- wallet_spend.create: record_member_spend (POST /v1/wallet-spends)
- wallet_spend.post: post_member_spend (POST /v1/wallet-spends/{walletSpendId}/post)
- wallet_spend.refund: refund_member_spend (POST /v1/wallet-spends/{walletSpendId}/refund)
- webhook.delivery.list: pending_deliveries (GET /v1/webhook-endpoints/{webhookEndpointId}/deliveries)
- webhook.delivery.resend: default (POST /v1/webhook-endpoints/{webhookEndpointId}/deliveries/{webhookDeliveryId}/resend)
- webhook.endpoint.create: default (POST /v1/webhook-endpoints)
- webhook.endpoint.recover: default (POST /v1/webhook-endpoints/{webhookEndpointId}/recover)
- webhook.endpoint.secret.rotate: default (POST /v1/webhook-endpoints/{webhookEndpointId}/secret/rotate)
- webhook.endpoint.update: default (PATCH /v1/webhook-endpoints/{webhookEndpointId})
- admin.billing.platform_rate.clear: clear_pro_collection_rate (POST /v1/admin/platform-rates/{platformRateOverrideId}/clear)
- admin.billing.platform_rate.set: collection_rate (POST /v1/admin/platform-rates)
- admin.product.retrieve: Operator Product summary (GET /v1/admin/products/{productId})
- attribution_queue.list: first_page (GET /v1/internal/attribution-queue)
- beneficiary.activate: activate_beneficiary (POST /v1/beneficiaries/{beneficiaryId}/activate)
- beneficiary.disable: disable_beneficiary (POST /v1/beneficiaries/{beneficiaryId}/disable)
- billing.platform.revenue.account.provision: sandbox_platform_revenue (POST /v1/billing/platform-revenue-account)
- bureau_report.generate: weekly-facility-batch (POST /v1/reporting/bureau-batches)
- card_authorization.expire: expire_uncaptured_authorization (POST /v1/card-authorizations/{cardAuthorizationId}/expire)
- card_dispute.lose: close_unresolved_dispute_at_deadline (POST /v1/card-disputes/{cardDisputeId}/lose)
- catalog.author: publish_captured_payment_catalog (POST /v1/catalog/author)
- circle_membership.activate: activate_seat (POST /v1/circle-memberships/{circleMembershipId}/activate)
- circle_membership.contribute: contribute_monthly (POST /v1/circle-memberships/{circleMembershipId}/contribute)
- circle_membership.receive_pot: receive_pot_in_turn (POST /v1/circle-memberships/{circleMembershipId}/receive-pot)
- circle_membership.withdraw: withdraw_disbanded_seat (POST /v1/circle-memberships/{circleMembershipId}/withdraw)
- composer.catalog: default (GET /v1/composer/catalog)
- composer.check: default (POST /v1/composer/check)
- composer.plan: default (POST /v1/composer/plan)
- consent.grant: marketplace_customer_provider_consent (POST /v1/consents)
- customer.data.export: default (GET /v1/customers/{customerId}/data-export)
- customer.update: default (PATCH /v1/customers/{customerId})
- default_rate_publication.generate: quarterly-publication (POST /v1/reporting/default-rate-publications)
- deposit.record: record_attributed_deposit (POST /v1/deposits)
- deposit.return: return_deposit (POST /v1/deposits/{depositId}/return)
- entity.kyc.submit: saudi_identity_fields (POST /v1/entities/{entityId}/kyc)
- entity.update: default (PATCH /v1/entities/{entityId})
- escrow_order.expire: expire_unfunded_escrow (POST /v1/escrow-orders/{escrowOrderId}/expire)
- financial_address.activate: activate_financial_address (POST /v1/financial-addresses/{financialAddressId}/activate)
- funding_commitment.collect: collect_activated_pledge (POST /v1/funding-commitments/{fundingCommitmentId}/collect)
- funding_commitment.refund: refund_failed_round_pledge (POST /v1/funding-commitments/{fundingCommitmentId}/refund)
- funding_round.activate: activate_funded_round (POST /v1/funding-rounds/{fundingRoundId}/activate)
- funding_round.fail: fail_short_round (POST /v1/funding-rounds/{fundingRoundId}/fail)
- installment.collect: collect_overdue_installment (POST /v1/installments/{installmentId}/collect)
- installment.mark_overdue: mark_installment_overdue (POST /v1/installments/{installmentId}/mark-overdue)
- lender_distribution.payout: pay_lender_distribution (POST /v1/lender-distributions/{lenderDistributionId}/payout)
- listing.expire: expire_stale_offer (POST /v1/listings/{listingId}/expire)
- order.expire: expire_unconfirmed_purchase (POST /v1/orders/{orderId}/expire)
- payout.complete: complete_payout (POST /v1/payouts/{payoutId}/complete)
- payout.fail: fail_payout (POST /v1/payouts/{payoutId}/fail)
- payout.reject: reject_payout_reservation (POST /v1/payouts/{payoutId}/reject)
- payout.reserve: reserve_payout (POST /v1/payouts/{payoutId}/reserve)
- payout.return: return_payout (POST /v1/payouts/{payoutId}/return)
- payout.submit: submit_payout (POST /v1/payouts/{payoutId}/submit)
- payout_run.execute: execute_creator_payout (POST /v1/payout-runs/{payoutRunId}/execute)
- personal_access_token.login_grant.create: default (POST /v1/personal-access-token-login-grants)
- personal_access_token.login_grant.exchange: default (POST /v1/personal-access-token-login-grants/exchange)
- platform.operator.passkey.enrollment.authorize: bootstrap (POST /v1/platform/operators/passkey-enrollment/authorize)
- platform.operator.passkey.enrollment.begin: default (POST /v1/platform/operator/passkeys/enrollment/begin)
- platform.operator.passkey.enrollment.confirm: denied (POST /v1/platform/operator/passkeys/enrollment/confirm)
- platform.operator.passkey.list: default (GET /v1/platform/operator/passkeys)
- platform.operator.passkey.revoke.begin: default (POST /v1/platform/operator/passkeys/{credentialId}/revoke/begin)
- platform.operator.passkey.revoke.confirm: denied (POST /v1/platform/operator/passkeys/revoke/confirm)
- policy.activate: activate_cover_at_start (POST /v1/policies/{policyId}/activate)
- policy.expire: expire_cover_at_term (POST /v1/policies/{policyId}/expire)
- product.blueprint.compose: default (POST /v1/products/blueprint-compose)
- product.build.kit.download: default (POST /v1/products/{productId}/build/kit/downloads)
- product.build.kit.retrieve: default (GET /v1/products/{productId}/build/kit)
- product.build.retrieve: default (GET /v1/products/{productId}/build)
- product.instruments.compose: default (POST /v1/products/instruments-compose)
- product.primitives.create: default (POST /v1/products/primitives-create)
- product.program.relower: default (POST /v1/internal/product-program-relowerings)
- product.recompose: default (POST /v1/products/recompose)
- product.update: default (PATCH /v1/products/{productId})
- reconciliation_break_repair.execute: close_a_bank_fee_break (POST /v1/internal/reconciliation-break-repairs)
- reconciliation_run.execute: reconcile_day (POST /v1/internal/reconciliation-runs)
- safeguarding_report.generate: funded-reconciliation (POST /v1/reporting/safeguarding-reconciliations)
- savings_circle.activate: activate_full_circle (POST /v1/savings-circles/{savingsCircleId}/activate)
- statement.generate: monthly-statement (POST /v1/reporting/statements)
- statement.ingest: ingest_normalized_credit (POST /v1/internal/statements/ingest)
- str_case.advance: advance_to_drafted (POST /v1/internal/str-cases/advance)
- str_case.open: open_case (POST /v1/internal/str-cases)
- subject_kind.create: register_comic_book_kind (POST /v1/subject-kinds)
- support.booking.cancel: default (POST /v1/support/bookings/{bookingId}/cancel)
- support.booking.request: default (POST /v1/support/bookings)
- support.ticket.close: default (POST /v1/support/tickets/{ticketId}/close)
- support.ticket.message.post: default (POST /v1/support/tickets/{ticketId}/messages)
- support.ticket.open: default (POST /v1/support/tickets)
- system.health: healthy release (GET /v1/health)
- system.user.credential.mint: create (POST /v1/system/users/credentials/mint)
- system.user.credential.mint: rotate (POST /v1/system/users/credentials/mint)
- team.member.invite: default (POST /v1/team/members/invite)
- team.member.invite.revoke: default (POST /v1/team/members/invitations/{invitationId}/revoke)
- team.member.list: default (GET /v1/team/members)
- team.member.mfa.reset: default (POST /v1/team/members/{userId}/mfa/reset)
- team.member.remove: default (POST /v1/team/members/{userId}/remove)
- team.member.role.update: default (POST /v1/team/members/{userId}/role)
- team.role.create: default (POST /v1/team/roles)
- team.role.delete: default (POST /v1/team/roles/{roleId}/delete)
- team.role.list: default (GET /v1/team/roles)
- team.role.update: default (POST /v1/team/roles/{roleId})
- tenant.security.configure: default (POST /v1/tenant/security)
- tenant.update: default (PATCH /v1/tenants/{tenantId})
- trade_settlement.post: post_two_sided_trade (POST /v1/trade-settlements/{tradeSettlementId}/post)
- trust_evidence.attach: default (POST /v1/trust-reviews/{trustReviewId}/evidence)
- trust_evidence.external_confirmation.ingest: default (POST /v1/trust-reviews/{trustReviewId}/external-confirmation)
- trust_evidence.external_confirmation.record: default (POST /v1/trust-review-external-confirmation)
- trust_requirement.record: default (POST /v1/trust-requirements)
- trust_requirement.waive: default (POST /v1/trust-requirements/{trustRequirementId}/waive)
- trust_review.cancel: default (POST /v1/trust-reviews/{trustReviewId}/cancel)
- trust_review.create: default (POST /v1/trust-reviews)
- trust_review.create: entity_kyb_review (POST /v1/trust-reviews)
- trust_review.refresh: default (POST /v1/trust-reviews/{trustReviewId}/refresh)
- trust_review.review: default (POST /v1/trust-reviews/{trustReviewId}/review)
- trust_review.submit: default (POST /v1/trust-reviews/{trustReviewId}/submit)
- trust_review_subject.upsert: default (POST /v1/trust-review-subjects)
- unmatched_deposit.list: first_page (GET /v1/internal/unmatched-deposits)
- user.email.verification.confirm: default (POST /v1/identity/email-verification/confirm)
- user.email.verification.request: default (POST /v1/identity/email-verification/request)
- user.login: default (POST /v1/identity/login)
- user.login: mfa-required (POST /v1/identity/login)
- user.login.mfa.verify: default (POST /v1/identity/login/mfa/verify)
- user.login.mfa.verify: denied (POST /v1/identity/login/mfa/verify)
- user.login.passkey.begin: default (POST /v1/identity/login/passkey/begin)
- user.login.passkey.enrollment.begin: default (POST /v1/identity/login/passkey/enrollment/begin)
- user.login.passkey.enrollment.confirm: default (POST /v1/identity/login/passkey/enrollment/confirm)
- user.login.passkey.enrollment.confirm: denied (POST /v1/identity/login/passkey/enrollment/confirm)
- user.login.passkey.verify: default (POST /v1/identity/login/passkey/verify)
- user.login.passkey.verify: denied (POST /v1/identity/login/passkey/verify)
- user.logout: default (POST /v1/identity/logout)
- user.mfa.recovery_codes.list: default (GET /v1/identity/mfa/recovery-codes)
- user.mfa.recovery_codes.regenerate: default (POST /v1/identity/mfa/recovery-codes/regenerate)
- user.mfa.totp.disable: default (POST /v1/identity/mfa/totp/disable)
- user.mfa.totp.disable: denied (POST /v1/identity/mfa/totp/disable)
- user.mfa.totp.enrollment.begin: default (POST /v1/identity/mfa/totp/enrollment/begin)
- user.mfa.totp.enrollment.confirm: default (POST /v1/identity/mfa/totp/enrollment/confirm)
- user.password.reset.confirm: default (POST /v1/identity/password-reset/confirm)
- user.password.reset.confirm: denied (POST /v1/identity/password-reset/confirm)
- user.password.reset.request: default (POST /v1/identity/password-reset/request)
- user.session.list: default (GET /v1/identity/sessions)
- user.session.revoke: default (POST /v1/identity/sessions/{sessionId}/revoke)
- user.signup: default (POST /v1/identity/signup)
- user.signup: invited (POST /v1/identity/signup)
- wedged_money.scan: scan_tenant (GET /v1/internal/wedged-money)
- wedged_money_repair.execute: release_a_stuck_hold (POST /v1/internal/wedged-money-repairs)
## account.create / customer_balance_account
Operation ID: account_create
Route: POST /v1/accounts
Callability: tenant SDK (`sdk=true`)
### Request (TypeScript SDK)
```ts
import { createHyperscale } from "@hyperscale/tenant-sdk-your-capabilities";
const hyperscale = createHyperscale({
environment: "sandbox",
auth: () => process.env.HYPERSCALE_API_KEY ?? "",
});
// Replace sample IDs with IDs returned by your Hyperscale setup.
const result = await hyperscale.operations.accountCreate({
body: {
owner: {
type: "customer",
id: "cus_sandbox_aisha0001",
},
role: "customer_balance",
currency: "SAR",
},
});
```
Raw JSON request body
```json
{
"owner": {
"type": "customer",
"id": "cus_sandbox_aisha0001"
},
"role": "customer_balance",
"currency": "SAR"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"name": "Sara Al Otaibi",
"accountAddress": "SA8080000000608010167519"
}
```
Raw JSON request body
```json
{
"iban": "SA8080000000608010167519",
"beneficiaryName": "Sara Al Otaibi"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"accountId": "acct_sandbox_cardfund0001",
"cardholderId": "chd_sandbox_customer0001",
"currency": "SAR",
"label": "Primary virtual card",
"productId": "prd_sandbox_cards000001",
"spendControls": {
"allowedCountries": [
"SA"
],
"allowedMerchantCategories": [
"retail",
"travel",
"lodging"
],
"dailyLimit": "100000",
"monthlyLimit": "500000",
"singlePurchaseLimit": "50000"
}
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"label": "Travel card",
"spendControls": {
"allowedCountries": [
"SA",
"AE"
],
"allowedMerchantCategories": [
"travel",
"lodging"
],
"dailyLimit": "50000",
"monthlyLimit": "200000",
"singlePurchaseLimit": "25000"
}
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"amount": "12500",
"cardAccountId": "acct_sandbox_cardfund0001",
"cardId": "card_sandbox_virtual00001",
"currency": "SAR",
"expiresAt": "2026-07-16T12:00:00.000Z",
"merchantCategory": "electronics",
"merchantCountry": "SA",
"merchantName": "Riyadh Camera Store",
"merchantReference": "merchant-order-1042",
"productId": "prd_sandbox_cards000001",
"settlementAccountId": "acct_sandbox_merchant0001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"cardTransactionId": "ctx_sandbox_purchase00001",
"evidence": [
{
"kind": "customer_statement",
"reference": "support-case-2048",
"submittedAt": "2026-07-11T10:15:00.000Z",
"summary": "Customer confirms the purchase was not authorized."
}
],
"productId": "prd_sandbox_cards000001",
"reason": "unauthorized_purchase",
"responseDueAt": "2026-08-10T23:59:59.000Z"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"evidence": [
{
"kind": "customer_statement",
"reference": "support-case-2048",
"submittedAt": "2026-07-11T10:15:00.000Z",
"summary": "Customer confirms the purchase was not authorized."
},
{
"kind": "merchant_correspondence",
"submittedAt": "2026-07-12T09:30:00.000Z",
"summary": "Merchant could not produce proof of delivery."
}
]
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"cardAuthorizationId": "cau_sandbox_purchase00001",
"postedAt": "2026-07-10T12:05:00.000Z",
"productId": "prd_sandbox_cards000001"
}
```
Raw JSON request body
```json
{
"reason": "Merchant accepted the returned item"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"customerId": "cus_sandbox_customer0001",
"displayName": "Noura Al Saud",
"email": "noura@example.test",
"phoneNumber": "+966500000001",
"productId": "prd_sandbox_cards000001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"displayName": "Noura Al Saud",
"email": "noura@example.test"
}
```
Raw JSON request body
```json
{
"joinedAt": "2026-07-25T09:00:00.000Z",
"memberAccountId": "acct_sandbox_member0001",
"payoutAmount": "300000",
"position": 0,
"productId": "prd_sandbox_jamiya00001",
"receiveAt": "2026-08-20T21:00:00.000Z",
"savingsCircleId": "jam_sandbox_alharbi0001"
}
```
Raw JSON request body
```json
{
"joinedAt": "2026-07-25T09:01:00.000Z",
"memberAccountId": "acct_sandbox_member0002",
"payoutAmount": "300000",
"position": 1,
"productId": "prd_sandbox_jamiya00001",
"receiveAt": "2026-09-20T21:00:00.000Z",
"savingsCircleId": "jam_sandbox_alharbi0001"
}
```
Raw JSON request body
```json
{
"joinedAt": "2026-07-25T09:02:00.000Z",
"memberAccountId": "acct_sandbox_member0003",
"payoutAmount": "300000",
"position": 2,
"productId": "prd_sandbox_jamiya00001",
"receiveAt": "2026-10-20T21:00:00.000Z",
"savingsCircleId": "jam_sandbox_alharbi0001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"actorAccountId": "acct_sandbox_insurer0001"
}
```
Raw JSON request body
```json
{
"claimAmount": "75000",
"claimantAccountId": "acct_sandbox_holder00001",
"currency": "SAR",
"evidenceSummary": "Covered equipment was damaged in an accidental fall.",
"insurerAccountId": "acct_sandbox_insurer0001",
"occurredAt": "2026-10-14T11:30:00.000Z",
"peril": "accidental_damage",
"policyId": "pol_sandbox_protection001",
"productId": "prd_sandbox_protection01",
"subject": "sbj_sandbox_protection001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"evidenceSummary": "Damage assessment confirms the covered accidental event."
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"agreementId": "cagr_sandbox_lending0001",
"allowedContactEndHour": 20,
"allowedContactStartHour": 9,
"currency": "SAR",
"debtorAccountId": "acct_sandbox_borrower001",
"maxContactAttemptsPer30Days": 6,
"memo": "Third installment 45 days past due; dunning exhausted.",
"productId": "prd_sandbox_lending00001",
"recoveryAccountId": "acct_sandbox_pool000001",
"referredAmount": "450000",
"triggeringInstallmentId": "inst_sandbox_lending0003"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"recoveredAmount": "180000"
}
```
Raw JSON request body
```json
{
"attemptedAt": "2026-07-19T10:30:00.000Z",
"caseId": "ccase_sandbox_lending001",
"channel": "call",
"note": "Debtor committed to a lump-sum payment within two weeks.",
"outcome": "promise_to_pay",
"productId": "prd_sandbox_lending00001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"borrowerAccountId": "acct_sandbox_borrower001",
"currency": "SAR",
"fundingAccountId": "acct_sandbox_lender00001",
"principal": "500000",
"productId": "prd_sandbox_lending00001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_riyadhresale01",
"entity": {
"kind": "person",
"displayName": "Aisha Al Saud",
"country": "SA"
}
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_riyadhresale01",
"entity": {
"kind": "organization",
"displayName": "Riyadh Creator Studio LLC",
"country": "SA"
}
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_riyadhresale01",
"email": "aisha@example.com",
"password": "correct-horse-battery"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_riyadhresale01",
"email": "aisha@example.com",
"password": "correct-horse-battery",
"displayName": "Aisha Al Saud",
"country": "SA",
"termsAccepted": true
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"actorAccountId": "acct_sandbox_holder00001",
"assessmentNote": "Keep the documented damage amount",
"claimAmount": "20000"
}
```
Raw JSON request body
```json
{
"amount": "50000",
"currency": "SAR",
"expiresAt": "2026-12-31T21:00:00.000Z",
"holderAccountId": "acct_sandbox_holder00001",
"memo": "Equipment security deposit",
"payerAccountId": "acct_sandbox_payer000001",
"productId": "prd_sandbox_deposits0001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"buyerAccountId": "acct_sandbox_buyer000001",
"fundBy": "2026-08-01T21:00:00.000Z",
"listingId": "lst_sandbox_landcruiser1",
"memo": "Release after the vehicle is handed over.",
"productId": "prd_sandbox_marketplace01",
"subject": "sbj_sandbox_landcruiser1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"fundBy": "2026-08-01T21:00:00.000Z",
"memo": "Buyer funds after inspection booking."
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"reason": "The order was canceled."
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_marketplace001",
"accountId": "acct_sandbox_seller0001",
"financialAddressId": "faddr_sandbox_customer0001",
"amountMin": "24000",
"amountMax": "26000",
"currency": "SAR",
"windowStart": "2026-07-09T00:00:00.000Z",
"windowEnd": "2026-07-16T00:00:00.000Z",
"reference": "vehicle-order-0001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"approvedAmountsCapAmount": "1000000",
"borrowerAccountId": "acct_sandbox_borrower001",
"borrowerEntityId": "borrower-entity-001",
"currency": "SAR",
"productId": "prd_sandbox_lending00001"
}
```
Raw JSON request body
```json
{
"accountId": "acct_sandbox_customer0001",
"productId": "prd_sandbox_marketplace001",
"purpose": "Customer payments"
}
```
Raw JSON request body
```json
{
"reason": "This address is no longer used."
}
```
Raw JSON request body
```json
{
"amendmentNote": "Rebooked SV1024 to the evening departure",
"fareDifference": "24000"
}
```
Raw JSON request body
```json
{
"amendmentFee": "5000",
"amendmentNote": "Carrier reissue fee for the date change"
}
```
Raw JSON request body
```json
{
"amendmentNote": "Moved to the lower morning fare",
"fareDifference": "18500"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"bookingNote": "Morning flight hold",
"currency": "SAR",
"departsAt": "2026-12-20T06:00:00.000Z",
"fareAmount": "85000",
"holdExpiresAt": "2026-12-10T21:00:00.000Z",
"operatorAccountId": "acct_sandbox_operator0001",
"productId": "prd_sandbox_travel000001",
"subject": "sbj_sandbox_flight000001",
"travelerAccountId": "acct_sandbox_traveler001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"amount": "250000",
"committedAt": "2026-07-20T09:00:00.000Z",
"fundingRoundId": "fnr_sandbox_equipround1",
"investorAccountId": "acct_sandbox_investor01",
"productId": "prd_sandbox_p2pfinance1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"borrowerAccountId": "acct_sandbox_borrower001",
"closeBy": "2026-08-15T21:00:00.000Z",
"currency": "SAR",
"memo": "Bakery oven line expansion.",
"productId": "prd_sandbox_p2pfinance1",
"targetAmount": "500000"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"currency": "SAR",
"heldAmount": "75000",
"payeeAccountId": "acct_sandbox_payee00001",
"payerAccountId": "acct_sandbox_payer00001",
"platformAccountId": "acct_sandbox_platform0001",
"productId": "prd_sandbox_settlement01",
"reference": "milestone-001",
"releaseDueAt": "2026-12-31T21:00:00.000Z",
"serviceFeeAmount": "1000"
}
```
Raw JSON request body
```json
{
"amendmentNote": "Extended the stay by two nights",
"rateDifference": "32000"
}
```
Raw JSON request body
```json
{
"amendmentFee": "7500",
"amendmentNote": "Property fee for the date change"
}
```
Raw JSON request body
```json
{
"amendmentNote": "Shortened the stay by one night",
"rateDifference": "16000"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"checkInAt": "2026-10-01T12:00:00.000Z",
"checkOutAt": "2026-10-03T12:00:00.000Z",
"currency": "SAR",
"guestAccountId": "acct_sandbox_guest000001",
"holdExpiresAt": "2026-09-20T12:00:00.000Z",
"productId": "prd_sandbox_travel000001",
"propertyAccountId": "acct_sandbox_property001",
"rateAmount": "50000",
"subject": "sbj_sandbox_stay000001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"agreementId": "cagr_sandbox_bakery000001",
"amount": "50000",
"borrowerAccountId": "acct_sandbox_borrower001",
"currency": "SAR",
"dueAt": "2026-10-01T12:00:00.000Z",
"fundingAccountId": "acct_sandbox_lenderpool01",
"productId": "prd_sandbox_p2pfinance1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"sourceAccountId": "acct_sandbox_buyer0001",
"destinationAccountId": "acct_sandbox_seller0001",
"amount": "25000",
"currency": "SAR",
"memo": "Order seller transfer"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"sourceAccountId": "acct_sandbox_source0001",
"destinationAccountId": "acct_sandbox_destination1",
"amount": "25000",
"currency": "SAR",
"memo": "Reserve journey transfer"
}
```
Raw JSON request body
```json
{
"reason": "Cancel the reserved journey transfer"
}
```
Raw JSON request body
```json
{
"claimedAt": "2026-09-01T12:00:00.000Z",
"creditAgreementId": "cagr_sandbox_bakery000001",
"fundingCommitmentId": "fnc_sandbox_pledge00001",
"fundingRoundId": "fnr_sandbox_equipround1",
"productId": "prd_sandbox_p2pfinance1"
}
```
Raw JSON request body
```json
{
"askingPrice": "240000",
"currency": "SAR",
"description": "Single owner, full service history, sold under escrow protection.",
"expiresAt": "2026-08-31T21:00:00.000Z",
"headline": "2021 Toyota Land Cruiser GXR",
"imageUrl": "https://cdn.sandbox.example/listings/landcruiser-2021.jpg",
"productId": "prd_sandbox_marketplace01",
"sellerAccountId": "acct_sandbox_seller0001",
"subject": "sbj_sandbox_landcruiser1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"escrowOrderId": "eord_sandbox_buyerorder01"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"askingPrice": "240000",
"escrowOrderId": "eord_sandbox_buyerorder01"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"coverageAmount": "250000",
"coverageDescription": "Comprehensive vehicle cover",
"currency": "SAR",
"expiresAt": "2027-09-01T00:00:00.000Z",
"insurerAccountId": "acct_sandbox_insurer0001",
"policyholderAccountId": "acct_sandbox_buyer000001",
"premiumAmount": "12500",
"productId": "prd_sandbox_marketplace01",
"subject": "sbj_sandbox_landcruiser1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"confirmBy": "2026-08-01T20:00:00.000Z",
"escrowOrderId": "eord_sandbox_buyerorder01",
"listingId": "lst_sandbox_landcruiser1",
"memo": "Purchase subject to funded escrow.",
"productId": "prd_sandbox_marketplace01",
"subject": "sbj_sandbox_landcruiser1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"confirmBy": "2026-08-01T20:00:00.000Z",
"memo": "Buyer confirms after inspection."
}
```
Raw JSON request body
```json
{
"sourceAccountId": "acct_sandbox_seller0001",
"beneficiaryId": "ben_sandbox_seller000001",
"amount": "25000",
"currency": "SAR",
"speed": "standard"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"currency": "SAR",
"earnerAccountId": "acct_sandbox_creator0001",
"netAmount": "90000",
"payoutFundingAccountId": "acct_sandbox_payout00001",
"productId": "prd_sandbox_creator0001",
"runAt": "2026-10-01T12:00:00.000Z",
"withholdingAccountId": "acct_sandbox_tax0000001",
"withholdingAmount": "10000"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"coverageLimit": "200000",
"currency": "SAR",
"expiresAt": "2027-08-01T00:00:00.000Z",
"insurerAccountId": "acct_sandbox_insurer0001",
"perilSchedule": [
{
"deductibleBps": 500,
"limitAmount": "200000",
"peril": "accidental_damage",
"waitingPeriodDays": 0
},
{
"deductibleBps": 250,
"limitAmount": "200000",
"peril": "theft",
"waitingPeriodDays": 7
}
],
"policyholderAccountId": "acct_sandbox_holder00001",
"premiumAmount": "12500",
"productId": "prd_sandbox_protection01",
"startsAt": "2026-08-01T00:00:00.000Z",
"subject": "sbj_sandbox_protection001",
"termsSummary": "Annual cover for accidental damage and theft."
}
```
Raw JSON request body
```json
{
"expiresAt": "2027-11-01T00:00:00.000Z",
"termsSummary": "Extended cover incl. water damage."
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"perilSchedule": [
{
"deductibleBps": 500,
"limitAmount": "200000",
"peril": "accidental_damage",
"waitingPeriodDays": 0
},
{
"deductibleBps": 250,
"limitAmount": "200000",
"peril": "theft",
"waitingPeriodDays": 7
}
],
"termsSummary": "Covers accidental damage and theft."
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"actorAccountId": "acct_sandbox_buyer000001"
}
```
Raw JSON request body
```json
{
"buyerAccountId": "acct_sandbox_buyer000001",
"currency": "SAR",
"piece1Amount": "245000",
"piece2Amount": "3750",
"piece3Amount": "1250",
"platformAccountId": "acct_sandbox_platfees001",
"price": "250000",
"productId": "prd_sandbox_marketplace01",
"sellerAccountId": "acct_sandbox_seller00001",
"serviceFeeAmount": "2500",
"subject": "sbj_sandbox_landcruiser1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"destinationAccountId": "acct_sandbox_aisha0001",
"amount": "1000000",
"currency": "SAR"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_riyadhresale01",
"displayName": "Aisha Al Saud"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"contributionAmount": "100000",
"currency": "SAR",
"memberCount": 3,
"memo": "Al Harbi family circle, three seats.",
"productId": "prd_sandbox_jamiya00001",
"startAt": "2026-08-01T21:00:00.000Z"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_marketplace001",
"kind": "vehicle",
"kindVersion": 1,
"attributes": {
"vin": "JTMAB3FV0KD123456",
"make": "Toyota",
"model": "Land Cruiser",
"year": "2024",
"mileageKm": 12000
},
"declaredValue": {
"amount": "15000000",
"currency": "SAR"
}
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_travelagency001",
"kind": "flight_itinerary",
"kindVersion": 1,
"attributes": {
"carrierName": "Saudia",
"flightNumber": "SV101",
"origin": "RUH",
"destination": "JED",
"cabin": "economy"
},
"declaredValue": {
"amount": "125000",
"currency": "SAR"
}
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_travelagency001",
"kind": "lodging_stay",
"kindVersion": 1,
"attributes": {
"propertyName": "Al Faisaliah Hotel",
"city": "Riyadh",
"roomType": "King room"
},
"declaredValue": {
"amount": "240000",
"currency": "SAR"
}
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_marketplace001",
"kind": "merchandise",
"kindVersion": 1,
"attributes": {
"category": "watch",
"brand": "Rolex",
"model": "Explorer",
"serialNumber": "RX-2026-0001",
"condition": "excellent",
"yearOfManufacture": "2024"
},
"declaredValue": {
"amount": "3500000",
"currency": "SAR"
}
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_insurance001",
"kind": "policy_risk",
"kindVersion": 1,
"attributes": {
"category": "travel_delay",
"description": "Scheduled trip interruption cover",
"jurisdiction": "SA",
"reference": "TRIP-2026-0001"
},
"declaredValue": {
"amount": "500000",
"currency": "SAR"
}
}
```
Raw JSON request body
```json
{
"productId": "prd_sandbox_travelagency001",
"kind": "traveler_party",
"kindVersion": 1,
"attributes": {
"travelers": [
{
"role": "self",
"yearOfBirth": 1990
}
],
"destinationRegion": "GCC",
"originCountry": "SA"
},
"declaredValue": {
"amount": "800000",
"currency": "SAR"
}
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"currency": "SAR",
"platformAccountId": "acct_sandbox_tradefees01",
"productId": "prd_sandbox_exchange0001",
"sideAAccountId": "acct_sandbox_tradera0001",
"sideAAmount": "100000",
"sideAServiceFeeAmount": "1000",
"sideBAccountId": "acct_sandbox_traderb0001",
"sideBAmount": "85000",
"sideBServiceFeeAmount": "850"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"actorAccountId": "acct_sandbox_exchangeparty1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"departAt": "2026-09-01T21:00:00.000Z",
"memo": "Jeddah corniche long weekend.",
"payerAccountId": "acct_sandbox_traveler0001",
"productId": "prd_sandbox_travel000001",
"subject": "sbj_sandbox_travelparty01"
}
```
Raw JSON request body
```json
{
"trustReviewId": "vcs_sandbox_livekyb001",
"trustEvidenceId": "vev_sandbox_wathq0001",
"response": "Bank letter uploaded for review.",
"metadata": {
"channel": "product"
}
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"buyerAccountId": "acct_sandbox_buyer000001",
"currency": "SAR",
"policyId": "mpol_sandbox_cover000001",
"price": "250000",
"productId": "prd_sandbox_marketplace01",
"sellerAccountId": "acct_sandbox_seller00001",
"subject": "sbj_sandbox_landcruiser1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"askingPrice": "250000",
"currency": "SAR",
"headline": "2024 Toyota Land Cruiser",
"productId": "prd_sandbox_marketplace01",
"sellerAccountId": "acct_sandbox_seller00001",
"subject": "sbj_sandbox_landcruiser1"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"currency": "SAR",
"holderAccountId": "acct_sandbox_holder00001",
"limitAmount": "100000",
"productId": "prd_sandbox_wallet000001"
}
```
Raw JSON request body
```json
{
"amount": "50000"
}
```
Raw JSON request body
```json
{
"amount": "50000"
}
```
Raw JSON request body
```json
{
"amount": "35000"
}
```
Raw JSON request body
```json
{
"amount": "15000",
"beneficiaryAccountId": "acct_sandbox_merchant0001",
"productId": "prd_sandbox_wallet000001",
"walletId": "wal_sandbox_member000001"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"url": "https://hooks.example.test/hyperscale",
"enabledEvents": [
"account.created"
],
"description": "Ledger events",
"productId": "prd_sandbox_riyadhresale01"
}
```
Raw JSON request body
```json
{
"since": "2026-06-04T00:00:00.000Z"
}
```
Raw JSON request body
```json
{}
```
Raw JSON request body
```json
{
"url": "https://hooks.example.test/hyperscale-v2",
"reason": "Receiver moved to the v2 ingestion path"
}
```