[{"t":"Accessibility","u":"/docs/accessibility","k":"Guide","w":"Start","x":"What we aim for How we check it What we know falls short Tell us about a barrier The WCAG 2.2 AA target of Orrerie Pay and Orrerie Merchant, how their pages are tested, what is known to fall short and how to report a barrier.","q":"accessibility a11y wcag screen reader keyboard contrast zoom text size reduced motion european accessibility act barrier"},{"t":"Conventions","u":"/docs/api","k":"Guide","w":"Using the API","x":"Base address and transport Versions Requests and responses Money Time and ids Metadata Pagination Filtering, sorting and expanding The states every object uses Fields that explain a state API reference How the Orrerie Merchant API works: base URL, versions, money as decimal strings, ids, metadata, pagination, object states, and all 126 endpoints.","q":"base url versions pagination cursor page list limit starting_after ending_before has_more filtering expand metadata money amounts decimal ids prefix states reference","n":"Origin secret_key_in_browser v1 api_version code failure_code message Sunset version_unsupported request_too_large parameter_unknown sucess_url PATCH null POST DELETE Orrerie-Version req_ GET amount_invalid USD JPY order.fx ethereum bsc polygon arbitrum optimism base solana tron bitcoin litecoin dogecoin amount ord_ cs_ evt_ metadata created limit starting_after ending_before has_more parameters_exclusive gte gt lte lt true false reference client_reference_id expand data. insufficient_scope orrerie open processing paid underpaid overpaid expired cancelled refunded partially_refunded waiting detected delivered refunded_by_provider failed seen confirmed settled reverted draft awaiting_approval signed sent unknown address_ready deploying active unverified verification_pending verified verification_failed restricted orrerie_app relay direct paid_late accepted_short screening_hold provider_refund_received has_unconfirmed finalized completed awaiting_address completed_with_failures needs_attention incomplete past_due unpaid ended incomplete_expired paused ended_reason unpaid_30_days periods_complete no_instruction ambiguous_amount app_report_mismatch wrong_asset_on_order_address after_late_window pending_attribution payment.unmatched cancellation_reason cancelled_by_api rejected_by_member destination_removed removed void overdue enabled disabled disabled_reason by_member consecutive_failures failing inactive in_progress awaiting_people in_review needs_more approved declined lapsed pending succeeded queued running ready rolling revoked invited wallet two_of_three_in_force address can_receive wallet_not_activated display_state not_activated not_enabled payment_instruction payment rail_reason payer_chose_app merchant_direct_only relay_no_route below_relay_minimum same_asset_utxo default payer_chose_after_relay_refusal provider_refund_counted recipient_kind fee_account recipient refund_to provider_request_id refund_wallet_protected order screening status clear review blocked unchecked reviewed settlement.recipient_kind tip subscription max_periods refund destination_kind claim_link payer_orrerie_wallet saved_address approvable_at payout kind split_rule split_leg withdrawal webhook_endpoint failing_since"},{"t":"Authentication","u":"/docs/authentication","k":"Guide","w":"Using the API","x":"The three kinds of key What no key can do Scopes Rotation API keys of the Orrerie Merchant API: secret, restricted and publishable keys, scopes, IP limits, rotation, and what no key of any kind can ever do.","q":"api keys secret restricted publishable scopes bearer roll revoke rotation ip allow","n":"sk_live_ sk_test_ pk_live_ pk_test_ status api_key_invalid livemode_mismatch passkey_approval_required write read insufficient_scope allowed_ips ip_not_allowed expires_at parameter_invalid wider_than_caller Idempotency-Key secret expires_in revoked api_key_expired"},{"t":"The pay button","u":"/docs/button","k":"Guide","w":"Taking payments","x":"A plain link The button script Attributes The JavaScript interface Your content-security policy The integrity value What the button never is Test it Put a pay button on any site: a plain link that needs no script, or the button script with its attributes, its JavaScript interface and its integrity value.","q":"embed button payment link script integrity sha384 data-orrerie-pay publishable key csp OrreriePay","n":"quantity amount reference locale data-orrerie-pay url pk_live_ pk_test_ payment_link client_reference_id customer_email allow_publishable_key true data-payment-link plink_ data-publishable-key data-reference data-email data-quantity data-amount adjustable_quantity min_amount max_amount data-label pay_with_crypto pay_with_orrerie donate subscribe buy_now data-size small medium large data-theme dark light data-target same_tab new_tab data-locale auto en button.v1.js button.v1.1.0.0.js sha384 integrity pay.orrerie.com order.paid api.orrerie.com async"},{"t":"Changelog","u":"/docs/changelog","k":"Guide","w":"More","x":"2026-10-11 How versions work Every dated version of the Orrerie Merchant API and what changed in it. The current version is 2026-10-11.","q":"changelog versions release notes api version","n":"doc_url Orrerie-Version"},{"t":"The hosted checkout","u":"/docs/checkout","k":"Guide","w":"Taking payments","x":"The rule for every address The pages and their parameters Return URLs What the payer sees Pay with Orrerie Any wallet, routed by Relay Any wallet, straight to yours When a way to pay is not available After the payer has sent Languages Test mode The hosted pages on pay.orrerie.com: their addresses and URL parameters, return URLs and placeholders, and what a payer sees on each rail.","q":"hosted checkout pay.orrerie.com url parameters success_url cancel_url return rail relay direct orrerie app in transit locale","n":"pay.orrerie.com merchant.orrerie.com locale auto en asset rail orrerie_app relay direct quantity amount min_amount max_amount reference client_reference_id customer_email sub_ url success_url cancel_url https cs_ ord_ paid overpaid underpaid processing order.paid rail_unavailable reason route_fee_over_cap in_transit_notice rail_reason status open expired cancelled sk_test_"},{"t":"Keeping funds safe","u":"/docs/custody","k":"Guide","w":"Start","x":"Two of three keys What the keys do not protect What we recommend API keys What Orrerie does on its side How custody works on Orrerie Merchant: two of three keys, what the keys do not protect, and what we recommend for a treasury and for a browser.","q":"custody security non-custodial recovery tool treasury browser profile extensions keys recovery key orrerie app backup words","n":"merchant.orrerie.com"},{"t":"Errors","u":"/docs/errors","k":"Guide","w":"Using the API","x":"The error object How to react, by family Every error code authentication_error permission_error limit_error invalid_request_error not_found_error idempotency_error state_error rate_limit_error provider_error api_error Codes this release adds invalid_request_error authentication_error permission_error limit_error state_error api_error The error object of the Orrerie Merchant API and all 180 error codes, each with its HTTP status, its family and what it means. Every doc_url points here.","q":"error codes doc_url http status code retry failure","n":"limit single_order first_orders type invalid_request_error authentication_error permission_error not_found_error idempotency_error state_error limit_error rate_limit_error provider_error api_error code message param doc_url request_id Orrerie-Request-Id available needed usable_at retry_after reason available_assets refundable scope instruction Retry-After rail_unavailable order_not_open api_key_missing api_key_invalid api_key_revoked api_key_expired expires_at secret_key_in_browser Origin ip_not_allowed allowed_ips insufficient_scope error.scope publishable_key_not_allowed pk_ passkey_approval_required merchant_restricted test_helper_in_live_mode destination_blocked verification_required tier_order_limit error.limit own_limit_reached tier_volume_limit error.window lifetime tier_open_orders_limit payout_daily_limit_reached payout_batch_not_allowed member_limit_reached key_limit_reached webhook_endpoint_limit_reached invalid_json unsupported_media_type request_too_large method_not_allowed route_not_found version_unsupported Orrerie-Version parameter_missing error.param parameter_invalid parameter_unknown parameters_exclusive amount line_items metadata_invalid url_invalid https amount_invalid amount_below_minimum currency_unsupported asset_unsupported asset_not_enabled settlement_invalid settle destination_invalid event_type_unknown enabled_events file_type_not_allowed file_too_large simulation_invalid livemode_mismatch rail_not_allowed relay split_rule_invalid active other payout_batch_too_large export_too_large resource_missing idempotency_key_required Idempotency-Key idempotency_key_invalid idempotency_key_reused request_in_progress open underpaid order_not_payable cancelled paid overpaid order_not_underpaid order_not_overpaid order_not_refundable instruction_in_flight detected order_has_payment instruction_limit_reached money_out_not_draft draft instruction_live error.instruction session_not_open completed expired customer_required customer_email_required customer_has_active_subscription member_exists invoice_not_draft invoice_not_open invoice_not_editable price_not_recurring one_time price_inactive payment_link_inactive subscription_not_active past_due subscription_not_paused paused payment_not_unmatched refund_amount_exceeds_refundable amount_paid error.refundable money_out_not_cancellable signed saved_address_not_usable awaiting_approval waiting error.usable_at removed insufficient_balance error.available fee_account_low error.needed conversion_no_route error.offers_url quote_expired webhook_endpoint_disabled event_expired file_in_use wallet_not_activated error.wallet refund_wallet_not_protected browser_key_backup_required export_limit_reached email_limit_reached rate_limit_exceeded screening_unavailable error.reason relay_unavailable relay_no_route relay_amount_too_low relay_low_liquidity relay_paused route_fee_over_cap provider_route_mismatch provider_deposit_mismatch refund_wallet_unavailable recipient_not_attested asset_not_covered error.available_assets price_unavailable merchant_worker_waking outcome_unknown instruction_unknown service_unavailable internal_error https_required cookie_not_allowed Authorization accent_too_dark field ink accepted_assets_empty batch_network_required payout_batch_invalid errors target_same_order secret_scanning_signature_invalid payer_email_off merchant_closing app_pay_not_allowed link_secret_invalid file_limit_reached product_limit_reached support_email_required link_open_orders_limit asset_not_available order_has_instruction subscription_ended link_used link_expired check_window_closed rail_not_direct direct rail rail_not_relay wallet_not_active wallet_needs_review owner_change_pending retention_hold refund_open screening_pending balance_changed payment_not_confirmed payer_wallet_unknown refund_source_not_supported refund_rate_basis_unavailable rate_basis today refund_not_approvable_yet approvable_at waiting_notice refund_not_awaiting_address state refund_not_routed payout_not_routed payout_in_batch split_leg_held split_order_not_paid approval_document_unsupported money_out_not_signable money_out_not_signed money_out_not_lapsable conversion_not_prepared relay_delivery_expired expired_at relay_delivery_not_prepared sweep_not_offered sweep_in_progress sweep_inputs_changed changed screening_not_in_review status screening_blocked customer_credit_currency_mismatch customer_credit_insufficient invoice_credit_already_applied payment_being_matched payment_being_refunded payment_reverted provider_refund_not_held provider_refund_proof_missing order_not_paid_twice payment_not_on_order payment_not_second payment_already_decided order_has_refunds payment_not_movable payment_shared_out payment_under_review order_would_not_stay_paid target_other_customer target_currency_mismatch target_not_open target_expired cosigner_unavailable"},{"t":"Every webhook event","u":"/docs/events","k":"Guide","w":"Webhooks","x":"The ones most integrations need Every event type ping checkout_session.* order.* payment_instruction.* payment.* refund.* payout.* conversion.* payout_batch.* saved_address.* invoice.* payment_link.* product.* price.* customer.* subscription.* receipt.* wallet.* fee_account.* export.* merchant.* member.* api_key.* webhook_endpoint.* All 115 webhook event types of the Orrerie Merchant API, by family, with when each is sent and a page for each with its complete example payload.","q":"event types catalogue order.paid subscribe families","n":"order.paid paid overpaid order.underpaid order.expired order.unpaid order.screening_hold refund.confirmed subscription.activated subscription.renewed subscription.unpaid ping data.object checkout_session.created checkout_session checkout_session.completed checkout_session.expired order.created order order.processing status underpaid expired cancelled finalized false order.finalized amount_due order.overpaid order.updated description reference customer metadata screening_hold provider_refund_received expires_at processing order.cancelled order.refunded amount_paid order.partially_refunded order.overpayment_resolved refunded kept_as_credit order.payment_reverted review blocked pending screening.status order.screening_released reviewed unchecked clear payment_instruction.created payment_instruction payment_instruction.detected payment_instruction.delivered payment_instruction.refunded_by_provider payment_instruction.failed payment_instruction.expired late_until payment.seen payment payment.confirmed payment.settled payment.reverted open payment.unmatched payment.screening_flagged refund.created awaiting_approval refund refund.signed refund.sent refund.failed refund.unknown refund.cancelled cancelled_by_api rejected_by_member destination_removed refund.approval_lapsed draft refund.address_requested refund.address_lapsed payout.created payout payout.signed payout.sent payout.confirmed payout.failed payout.unknown payout.cancelled payout.approval_lapsed conversion.created conversion conversion.signed conversion.sent conversion.confirmed conversion.failed conversion.unknown conversion.cancelled conversion.approval_lapsed payout_batch.created payout_batch payout_batch.processing payout_batch.completed completed confirmed completed_with_failures counts payout_batch.needs_attention unknown payout_batch.cancelled saved_address.created saved_address saved_address.approved saved_address.active saved_address.removed invoice.created invoice invoice.finalized invoice.sent invoice.overdue invoice.paid invoice.voided payment_link.created payment_link payment_link.updated payment_link.deactivated max_uses product.created product product.updated price.created price price.updated customer.created customer.updated credit_balance customer.deleted subscription.created subscription subscription.renewal_due subscription.past_due active subscription.ended unpaid subscription.incomplete_expired subscription.payment_reverted past_due subscription.paused subscription.resumed subscription.updated cancel_at_period_end subscription.cancelled receipt.created receipt wallet.deploying wallet wallet.active fee_account.low fee_account fee_account.topped_up export.ready export export.failed merchant.tier_changed merchant merchant.limit_approaching usage limits merchant.restricted merchant.unrestricted member.invited member member.joined member.role_changed member.removed api_key.created api_key api_key.rolled api_key.revoked webhook_endpoint.disabled webhook_endpoint"},{"t":"Invoices","u":"/docs/guides/invoices","k":"Guide","w":"Guides","x":"How an invoice works Send an invoice from the dashboard Send an invoice with the API Reminders What your customer sees Change, void or settle an invoice Follow an invoice from your server Try it in test mode Bill a customer in crypto: draft an invoice, finalize it, send your customer its pay link and PDF, and handle reminders, part payment and voiding.","q":"invoice bill customer due date finalize send reminder overdue void pdf number tax discount","n":"inv_ status draft open paid void overdue INV- tax_amount invoice url pdf order order.paid payer_email_off reminders due_date memo footer metadata order_has_payment instruction_in_flight invoice.created invoice.finalized invoice.sent invoice.overdue invoice.paid invoice.voided sk_test_"},{"t":"Payment links","u":"/docs/guides/payment-links","k":"Guide","w":"Guides","x":"What a payment link is Create a link in the dashboard Create a link with the API Share it What the payer sees Know that it was paid Try it in test mode Take a payment with a link and no code: create a payment link in the dashboard or with the API, and share it as a link, a QR code or a button.","q":"payment link plink no code share qr donate open amount fixed amount max uses expires","n":"plink_ amount currency line_items min_amount max_amount payment_link url max_uses expires_at order_expiry_seconds collect success_url active false amount_type quantity reference locale order.paid client_reference_id payment_link.created payment_link.updated payment_link.deactivated sk_test_ paid"},{"t":"Point of sale","u":"/docs/guides/point-of-sale","k":"Guide","w":"Guides","x":"What you need Pair a device Set staff PINs Take a payment What the till says Sales in your own systems Try it Take crypto in person with a keypad on any phone or tablet: pair a device, set staff PINs, charge an amount and show the customer a QR code.","q":"point of sale pos till keypad tablet in person shop cashier pin pair device qr tip receipt","n":"order.paid pos_device"},{"t":"Site builders and no-code tools","u":"/docs/guides/site-builders","k":"Guide","w":"Guides","x":"The recipe Where a link works If your builder accepts HTML What not to try Pass something along Take crypto on a site made with a site builder, with no plug-in: put an Orrerie payment link behind a button block, a text link, a QR code or an email.","q":"site builder no code wix squarespace webflow wordpress carrd linktree notion button block link qr email newsletter","n":"pay.orrerie.com order.paid client_reference_id"},{"t":"Subscriptions","u":"/docs/guides/subscriptions","k":"Guide","w":"Guides","x":"Nobody is charged automatically Three ways a customer can renew Set up a plan Start a subscription Send the pay link The cycle States Part payment of a period Pause, cancel, change What your customer has Try it in test mode Sell a repeating plan paid in crypto. Nothing is ever pulled from a payer: each period is an order the customer pays, with a pay link you send and a grace time.","q":"subscription recurring renewal period reminder grace past due unpaid lapsed pay ahead prepaid cancel pause advance clock","n":"past_due unpaid subscription.unpaid recurring incomplete latest_order active reminder_days grace_days prepaid_periods_allowed proration subscription.renewal_due url subscription.activated subscription.renewed subscription.past_due ended subscription.ended status incomplete_expired paused cancelled none underpaid proportional instruction_in_flight sub_ sk_test_ to renewal_opens period_end grace_end unpaid_end"},{"t":"Idempotency keys","u":"/docs/idempotency","k":"Guide","w":"Using the API","x":"How it works Where the key is required What a repeat answers When the outcome is unknown Send an Idempotency-Key header and a retry can never run twice: where the API requires the key, how long it is kept, and what to do on an unknown outcome.","q":"idempotency key retry duplicate timeout unknown outcome safe","n":"POST GET PATCH DELETE request_in_progress idempotency_key_required idempotency_key_reused outcome_unknown unknown"},{"t":"Take crypto payments with the Orrerie Merchant API","u":"/docs/","k":"Guide","w":"Start here","x":"How a payment works What to know before you write code Take crypto payments with the Orrerie Merchant API: hosted checkout, webhooks and an API reference with 126 endpoints. Orrerie never holds your money.","q":"overview introduction how it works start","n":"doc_url url pay.orrerie.com order.paid Authorization in_transit_notice relay rail_unavailable reason route_fee_over_cap direct paid fetch requests sk_test_"},{"t":"Money out","u":"/docs/money-out","k":"Guide","w":"Using the API","x":"The rule From request to money sent unknown is a real state Failure codes of refunds, payouts and conversions Refunds, in particular Network fees: what you must hold What the Orrerie Merchant API can do with money: it requests refunds, payouts and conversions, and a person approves each one with a passkey.","q":"payout refund withdrawal conversion approval passkey unattended automatic saved address unknown","n":"merchant.orrerie.com awaiting_approval signed Idempotency-Key active approval_url approval_expires_at payout.created cancelled rejected_by_member payout.signed failed sent transaction_hash confirmed unknown draft payout.approval_lapsed payout.confirmed payout.failed failure_code transaction_reverted insufficient_fee balance_changed policy_refused destination_blocked slippage_exceeded relay_fill_below_minimum provider_route_failed provider_refunded_underpayment deployment_failed broadcast_outcome_unknown dropped_from_mempool awaiting_address destination approvable_at refund.sent refund.confirmed orrerie code fee_account_low needed needed.account topup"},{"t":"Networks and assets","u":"/docs/networks","k":"Guide","w":"Taking payments","x":"The matrix Confirmations The three rails Minimum order Read the matrix from the API Settlement assets Solana and TRON before activation What can be lost What a payment costs The eleven networks of Orrerie Merchant: what a payer can send on each, by which rail, the confirmations an order waits for, and what you can settle in.","q":"networks assets matrix ethereum bnb polygon arbitrum optimism base solana tron bitcoin litecoin dogecoin usdt usdc confirmations minimum settlement relay direct","n":"pay false paid asset confirmations finalized rail orrerie_app relay direct minimum_order null minimum_order.direct settle address wallet_not_activated rail_unavailable reason route_fee_over_cap"},{"t":"Shopify","u":"/docs/plugins/shopify","k":"Guide","w":"Guides","x":"What it is Get the app and connect it Going live Settings What the buyer sees What happens to the Shopify order Refunds Removing the app For one product at a fixed price The Orrerie Pay app for Shopify: how a shop gets and connects it, what the buyer sees after checkout, and when the Shopify order is marked paid.","q":"shopify app manual payment method pay now thank you page order status order confirmation email custom app","n":"your-shop.myshopify.com whsec_ sk_test_ sk_live_ order.paid order.underpaid order.expired order.cancelled order.unpaid"},{"t":"WooCommerce","u":"/docs/plugins/woocommerce","k":"Guide","w":"Guides","x":"What it is Install and connect Settings What happens at checkout What happens to the WooCommerce order Refunds Subscriptions Checking that it works Orrerie Pay for WooCommerce: how to install and connect it, every setting, what happens to an order for each Orrerie event, and how refunds behave.","q":"woocommerce wordpress plugin plug-in gateway redirect install settings hpos checkout block","n":"pay.orrerie.com orrerie-pay-for-woocommerce-1.0.7.zip sk_test_ whsec_ url Idempotency-Key Orrerie-Signature order.paid order.underpaid order.expired order.cancelled order.unpaid refund.confirmed refund.failed refund.cancelled"},{"t":"Quick start","u":"/docs/quickstart","k":"Guide","w":"Start","x":"1. Add a support email 2. Get a test key 3. Add your webhook endpoint Working on your own computer 4. Create a checkout session 5. Simulate a payment 6. Receive the webhook 7. Fulfil on order.paid 8. Go live From nothing to a paid test order in ten minutes: a support email, a webhook endpoint, a checkout session, a simulated payment and a verified order.paid.","q":"getting started first payment tutorial simulate","n":"support_email_required Idempotency-Key order-1042-attempt-2 sk_test_ whsec_ order.unpaid https localhost http url_invalid url checkout_session order success_url seen confirmed settled paid order.paid ping data.object.status overpaid status tier_order_limit tier_volume_limit tier_open_orders_limit payout_daily_limit_reached"},{"t":"Rate limits","u":"/docs/rate-limits","k":"Guide","w":"Using the API","x":"The limits The headers on every response Not the same as business limits Rate limits of the Orrerie Merchant API: requests per minute by tier, the RateLimit response headers, what a 429 answers, and how business limits differ.","q":"rate limit 429 throttle retry-after requests per minute","n":"payer_email_off RateLimit-Reset rate_limit_exceeded limit_error"},{"t":"Service status","u":"/docs/status","k":"Status","w":"Orrerie Merchant","x":"Not measured Services Merchant dashboard Checkout Merchant API Incidents and planned maintenance What a reading means Following this page from your tools Your money during an outage If something is wrong and this page says working Whether the Orrerie Merchant dashboard, checkout and API are answering now, with every published incident. Never shows working without a fresh reading.","q":"status uptime incident outage maintenance down degraded health working","n":"merchant.orrerie.com pay.orrerie.com api.orrerie.com code request_id"},{"t":"Test mode","u":"/docs/test-mode","k":"Guide","w":"Start","x":"Live mode and test mode, side by side What a test key cannot change What simulation covers The helper endpoints Going live Test mode of the Orrerie Merchant API: sk_test_ keys, simulated payments, no test networks, no address ever shown, and helper endpoints for every state.","q":"test mode sandbox simulate livemode helpers sk_test","n":"sk_live_ pk_live_ sk_test_ pk_test_ payment_instruction.address null test_simulation_url livemode_mismatch live_profile failed unknown test_helper_in_live_mode tier_order_limit tier_volume_limit tier_open_orders_limit payout_daily_limit_reached"},{"t":"Checking a webhook signature","u":"/docs/webhooks/signatures","k":"Guide","w":"Webhooks","x":"The scheme The function, in four languages The test vector Common mistakes After the signature Verify the Orrerie-Signature header in JavaScript, Python, PHP and Ruby with the standard library alone: HMAC-SHA256 over the timestamp and the raw body.","q":"verify signature hmac sha256 whsec orrerie-signature javascript python php ruby test vector","n":"whsec_ v1 v2 ORRERIE_WEBHOOK_SECRET order.paid"},{"t":"Receiving webhooks","u":"/docs/webhooks","k":"Guide","w":"Webhooks","x":"The request you receive What your endpoint must do What an endpoint is sent Working on your own computer The signature Check a signature in this page Replay protection Rolling a signing secret Retries A handler that is correct Orrerie webhooks: the request your endpoint receives, what it must do, the signature, replay protection, rolling a secret and the retry schedule.","q":"webhook endpoint delivery retry signature replay secret whsec handler","n":"id type api_version data.object created livemode data.previous_attributes request idempotency_key pending_webhooks data.object.status paid overpaid status object redacted https localhost http url_invalid whsec_ v1 v2 Orrerie-Signature expires_in failed data.object.updated failing_since disabled webhook_endpoint.disabled PATCH"},{"t":"List checkout sessions","u":"/docs/api/checkout-sessions/list-checkout-sessions","k":"Endpoint","w":"GET /v1/checkout_sessions","x":"list checkout sessions Checkout sessions GET /v1/checkout_sessions: List your checkout sessions newest first, filtered by status, order, customer or client reference.","n":"status order customer client_reference_id limit starting_after ending_before created[gte] created[lt] expand Orrerie-Version"},{"t":"Create a checkout session","u":"/docs/api/checkout-sessions/create-a-checkout-session","k":"Endpoint","w":"POST /v1/checkout_sessions","x":"create a checkout session Checkout sessions POST /v1/checkout_sessions: Creates the session and, unless order is given, its order. Parameters, errors and examples in four languages.","n":"Orrerie-Version Idempotency-Key order amount currency line_items description reference customer customer_email success_url cancel_url client_reference_id collect locale expires_in fee_bearer rails_allowed accept settle mode subscription_data metadata payment_link quantity"},{"t":"Retrieve a checkout session","u":"/docs/api/checkout-sessions/retrieve-a-checkout-session","k":"Endpoint","w":"GET /v1/checkout_sessions/{id}","x":"retrieve a checkout session Checkout sessions GET /v1/checkout_sessions/{id}: With a publishable key the response holds only id, object, status, order, livemode.","n":"id expand Orrerie-Version"},{"t":"Expire a checkout session","u":"/docs/api/checkout-sessions/expire-a-checkout-session","k":"Endpoint","w":"POST /v1/checkout_sessions/{id}/expire","x":"expire a checkout session Checkout sessions POST /v1/checkout_sessions/{id}/expire: Closes an open session so its page shows \"This checkout has expired\". Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List orders","u":"/docs/api/orders/list-orders","k":"Endpoint","w":"GET /v1/orders","x":"list orders Orders GET /v1/orders: List your orders newest first, filtered by status, source, customer, reference, payment link, subscription, refund, paid time or amount.","n":"status source customer reference payment_link subscription refunded paid_at[gte] amount[gte] currency limit starting_after ending_before created[gte] created[lt] expand Orrerie-Version"},{"t":"Create an order","u":"/docs/api/orders/create-an-order","k":"Endpoint","w":"POST /v1/orders","x":"create an order Orders POST /v1/orders: Creates an open order with no checkout session. Parameters, errors and examples in four languages.","n":"Orrerie-Version Idempotency-Key amount currency line_items description reference customer customer_email expires_in fee_bearer rails_allowed accept settle metadata"},{"t":"Retrieve an order","u":"/docs/api/orders/retrieve-an-order","k":"Endpoint","w":"GET /v1/orders/{id}","x":"retrieve an order Orders GET /v1/orders/{id}: expand=customer,payments,instructions,receipt replaces those ids with the objects. Parameters, errors and examples in four languages.","n":"id expand Orrerie-Version"},{"t":"Update an order","u":"/docs/api/orders/update-an-order","k":"Endpoint","w":"PATCH /v1/orders/{id}","x":"update an order Orders PATCH /v1/orders/{id}: Only description, reference, customer and metadata can change, and only these. Parameters, errors and examples in four languages.","n":"id Orrerie-Version description reference customer metadata"},{"t":"Cancel an order","u":"/docs/api/orders/cancel-an-order","k":"Endpoint","w":"POST /v1/orders/{id}/cancel","x":"cancel an order Orders POST /v1/orders/{id}/cancel: Allowed only while the order is open. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List the ways an order can be paid","u":"/docs/api/orders/list-the-ways-an-order-can-be-paid","k":"Endpoint","w":"GET /v1/orders/{id}/payment_options","x":"list the ways an order can be paid Orders GET /v1/orders/{id}/payment_options: Every asset a payer could choose for this order, with the rail it would use and an estimate.","n":"id Orrerie-Version"},{"t":"List an order's payment instructions","u":"/docs/api/orders/list-an-orders-payment-instructions","k":"Endpoint","w":"GET /v1/orders/{id}/instructions","x":"list an order s payment instructions Orders GET /v1/orders/{id}/instructions: List the payment instructions of one order, newest first: what to send, where and by which rail.","n":"id limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create a payment instruction","u":"/docs/api/orders/create-a-payment-instruction","k":"Endpoint","w":"POST /v1/orders/{id}/instructions","x":"create a payment instruction Orders POST /v1/orders/{id}/instructions: Fixes a quote for one asset and returns the address to pay. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key asset rail payer_refund_address"},{"t":"Retrieve a payment instruction","u":"/docs/api/orders/retrieve-a-payment-instruction","k":"Endpoint","w":"GET /v1/payment_instructions/{id}","x":"retrieve a payment instruction Orders GET /v1/payment_instructions/{id}: Retrieve one payment instruction by its id, with every field of the payment_instruction object.","n":"id Orrerie-Version"},{"t":"Accept an underpaid order as paid","u":"/docs/api/orders/accept-an-underpaid-order-as-paid","k":"Endpoint","w":"POST /v1/orders/{id}/accept_underpayment","x":"accept an underpaid order as paid Orders POST /v1/orders/{id}/accept_underpayment: Moves an underpaid order to paid with accepted_short: true. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"Keep an overpayment as customer credit","u":"/docs/api/orders/keep-an-overpayment-as-customer-credit","k":"Endpoint","w":"POST /v1/orders/{id}/keep_overpayment","x":"keep an overpayment as customer credit Orders POST /v1/orders/{id}/keep_overpayment: Records the excess of an overpaid order as credit on the order's customer (credit_balance).","n":"id Orrerie-Version Idempotency-Key"},{"t":"Retrieve a payment","u":"/docs/api/payments/retrieve-a-payment","k":"Endpoint","w":"GET /v1/payments/{id}","x":"retrieve a payment Payments GET /v1/payments/{id}: Retrieve one payment by its id, with every field of the payment object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"List payments","u":"/docs/api/payments/list-payments","k":"Endpoint","w":"GET /v1/payments","x":"list payments Payments GET /v1/payments: List your payments newest first, filtered by order, status, rail, asset, unmatched or transaction hash.","n":"order status rail asset unmatched transaction_hash limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Assign an unmatched payment to an order","u":"/docs/api/payments/assign-an-unmatched-payment-to-an-order","k":"Endpoint","w":"POST /v1/payments/{id}/assign","x":"assign an unmatched payment to an order Payments POST /v1/payments/{id}/assign: Credits the payment to the order at the value it had when it settled. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key order"},{"t":"Ignore an unmatched payment","u":"/docs/api/payments/ignore-an-unmatched-payment","k":"Endpoint","w":"POST /v1/payments/{id}/ignore","x":"ignore an unmatched payment Payments POST /v1/payments/{id}/ignore: Removes it from the unmatched list. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List products","u":"/docs/api/products-and-prices/list-products","k":"Endpoint","w":"GET /v1/products","x":"list products Products and prices GET /v1/products: List your products newest first, filtered by active. Parameters, errors and examples in four languages.","n":"active limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create a product","u":"/docs/api/products-and-prices/create-a-product","k":"Endpoint","w":"POST /v1/products","x":"create a product Products and prices POST /v1/products: Create a product and get back the new product object. A retry with the same Idempotency-Key creates nothing twice.","n":"Orrerie-Version Idempotency-Key name description image metadata"},{"t":"Retrieve a product","u":"/docs/api/products-and-prices/retrieve-a-product","k":"Endpoint","w":"GET /v1/products/{id}","x":"retrieve a product Products and prices GET /v1/products/{id}: Retrieve one product by its id, with every field of the product object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Update a product","u":"/docs/api/products-and-prices/update-a-product","k":"Endpoint","w":"PATCH /v1/products/{id}","x":"update a product Products and prices PATCH /v1/products/{id}: Update a product: only the fields you send change, and null clears an optional one. Parameters, errors and examples in four languages.","n":"id Orrerie-Version name description image active metadata"},{"t":"List prices","u":"/docs/api/products-and-prices/list-prices","k":"Endpoint","w":"GET /v1/prices","x":"list prices Products and prices GET /v1/prices: List your prices newest first, filtered by product, active or type. Parameters, errors and examples in four languages.","n":"product active type limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create a price","u":"/docs/api/products-and-prices/create-a-price","k":"Endpoint","w":"POST /v1/prices","x":"create a price Products and prices POST /v1/prices: Create a price and get back the new price object. A retry with the same Idempotency-Key creates nothing twice.","n":"Orrerie-Version Idempotency-Key product amount currency type recurring nickname metadata"},{"t":"Retrieve a price","u":"/docs/api/products-and-prices/retrieve-a-price","k":"Endpoint","w":"GET /v1/prices/{id}","x":"retrieve a price Products and prices GET /v1/prices/{id}: Retrieve one price by its id, with every field of the price object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Update a price","u":"/docs/api/products-and-prices/update-a-price","k":"Endpoint","w":"PATCH /v1/prices/{id}","x":"update a price Products and prices PATCH /v1/prices/{id}: Update a price: only the fields you send change, and null clears an optional one. Parameters, errors and examples in four languages.","n":"id Orrerie-Version active nickname metadata"},{"t":"List payment links","u":"/docs/api/payment-links/list-payment-links","k":"Endpoint","w":"GET /v1/payment_links","x":"list payment links Payment links GET /v1/payment_links: List your payment links newest first, filtered by active. Parameters, errors and examples in four languages.","n":"active limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create a payment link","u":"/docs/api/payment-links/create-a-payment-link","k":"Endpoint","w":"POST /v1/payment_links","x":"create a payment link Payment links POST /v1/payment_links: Create a payment link and get back the new payment_link object. A retry with the same Idempotency-Key creates nothing twice.","n":"Orrerie-Version Idempotency-Key name amount_type amount currency min_amount max_amount line_items collect success_url allow_publishable_key order_expiry_seconds max_uses expires_at metadata"},{"t":"Retrieve a payment link","u":"/docs/api/payment-links/retrieve-a-payment-link","k":"Endpoint","w":"GET /v1/payment_links/{id}","x":"retrieve a payment link Payment links GET /v1/payment_links/{id}: Retrieve one payment link by its id, with every field of the payment_link object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Update a payment link","u":"/docs/api/payment-links/update-a-payment-link","k":"Endpoint","w":"PATCH /v1/payment_links/{id}","x":"update a payment link Payment links PATCH /v1/payment_links/{id}: Changes apply to orders created afterwards. Parameters, errors and examples in four languages.","n":"id Orrerie-Version name min_amount max_amount collect success_url allow_publishable_key order_expiry_seconds max_uses expires_at metadata active"},{"t":"List invoices","u":"/docs/api/invoices/list-invoices","k":"Endpoint","w":"GET /v1/invoices","x":"list invoices Invoices GET /v1/invoices: List your invoices newest first, filtered by status, customer, overdue or due date. Parameters, errors and examples in four languages.","n":"status customer overdue due_date[lte] limit starting_after ending_before created[gte] created[lt] expand Orrerie-Version"},{"t":"Create a draft invoice","u":"/docs/api/invoices/create-a-draft-invoice","k":"Endpoint","w":"POST /v1/invoices","x":"create a draft invoice Invoices POST /v1/invoices: Create a draft invoice and get back the new invoice object. A retry with the same Idempotency-Key creates nothing twice.","n":"Orrerie-Version Idempotency-Key customer currency line_items discount_amount tax_amount due_date memo footer reminders metadata"},{"t":"Retrieve an invoice","u":"/docs/api/invoices/retrieve-an-invoice","k":"Endpoint","w":"GET /v1/invoices/{id}","x":"retrieve an invoice Invoices GET /v1/invoices/{id}: Retrieve one invoice by its id, with every field of the invoice object. Parameters, errors and examples in four languages.","n":"id expand Orrerie-Version"},{"t":"Update a draft invoice","u":"/docs/api/invoices/update-a-draft-invoice","k":"Endpoint","w":"PATCH /v1/invoices/{id}","x":"update a draft invoice Invoices PATCH /v1/invoices/{id}: Any create parameter, while draft. Parameters, errors and examples in four languages.","n":"id Orrerie-Version currency line_items discount_amount tax_amount due_date memo footer reminders metadata"},{"t":"Delete a draft invoice","u":"/docs/api/invoices/delete-a-draft-invoice","k":"Endpoint","w":"DELETE /v1/invoices/{id}","x":"delete a draft invoice Invoices DELETE /v1/invoices/{id}: Delete an invoice that is still a draft. A finalized invoice is refused with invoice_not_draft.","n":"id Orrerie-Version"},{"t":"Finalize an invoice","u":"/docs/api/invoices/finalize-an-invoice","k":"Endpoint","w":"POST /v1/invoices/{id}/finalize","x":"finalize an invoice Invoices POST /v1/invoices/{id}/finalize: Assigns the number, creates the order and the PDF. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key send"},{"t":"Send an invoice by email","u":"/docs/api/invoices/send-an-invoice-by-email","k":"Endpoint","w":"POST /v1/invoices/{id}/send","x":"send an invoice by email Invoices POST /v1/invoices/{id}/send: Sends (or sends again) the invoice email with its pay link from the fixed Orrerie sender.","n":"id Orrerie-Version Idempotency-Key to"},{"t":"Void an invoice","u":"/docs/api/invoices/void-an-invoice","k":"Endpoint","w":"POST /v1/invoices/{id}/void","x":"void an invoice Invoices POST /v1/invoices/{id}/void: Cancels the invoice and its order. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List customers","u":"/docs/api/customers/list-customers","k":"Endpoint","w":"GET /v1/customers","x":"list customers Customers GET /v1/customers: List your customers newest first, filtered by email. Parameters, errors and examples in four languages.","n":"email limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create a customer","u":"/docs/api/customers/create-a-customer","k":"Endpoint","w":"POST /v1/customers","x":"create a customer Customers POST /v1/customers: Create a customer and get back the new customer object. A retry with the same Idempotency-Key creates nothing twice.","n":"Orrerie-Version Idempotency-Key name email description billing_address locale metadata"},{"t":"Retrieve a customer","u":"/docs/api/customers/retrieve-a-customer","k":"Endpoint","w":"GET /v1/customers/{id}","x":"retrieve a customer Customers GET /v1/customers/{id}: Retrieve one customer by its id, with every field of the customer object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Update a customer","u":"/docs/api/customers/update-a-customer","k":"Endpoint","w":"PATCH /v1/customers/{id}","x":"update a customer Customers PATCH /v1/customers/{id}: Update a customer: only the fields you send change, and null clears an optional one.","n":"id Orrerie-Version name email description billing_address locale metadata"},{"t":"Delete a customer","u":"/docs/api/customers/delete-a-customer","k":"Endpoint","w":"DELETE /v1/customers/{id}","x":"delete a customer Customers DELETE /v1/customers/{id}: Erases the name, email, addresses and metadata. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"List subscriptions","u":"/docs/api/subscriptions/list-subscriptions","k":"Endpoint","w":"GET /v1/subscriptions","x":"list subscriptions Subscriptions GET /v1/subscriptions: List your subscriptions newest first, filtered by status, customer, price or current period end.","n":"status customer price current_period_end[lte] limit starting_after ending_before created[gte] created[lt] expand Orrerie-Version"},{"t":"Create a subscription","u":"/docs/api/subscriptions/create-a-subscription","k":"Endpoint","w":"POST /v1/subscriptions","x":"create a subscription Subscriptions POST /v1/subscriptions: Create a subscription and get back the new subscription object. A retry with the same Idempotency-Key creates nothing twice.","n":"Orrerie-Version Idempotency-Key customer items reminder_days grace_days prepaid_periods_allowed proration start trial_days metadata"},{"t":"Retrieve a subscription","u":"/docs/api/subscriptions/retrieve-a-subscription","k":"Endpoint","w":"GET /v1/subscriptions/{id}","x":"retrieve a subscription Subscriptions GET /v1/subscriptions/{id}: Retrieve one subscription by its id, with every field of the subscription object. Parameters, errors and examples in four languages.","n":"id expand Orrerie-Version"},{"t":"Update a subscription","u":"/docs/api/subscriptions/update-a-subscription","k":"Endpoint","w":"PATCH /v1/subscriptions/{id}","x":"update a subscription Subscriptions PATCH /v1/subscriptions/{id}: Changes to items apply from the next period; there is no mid-period proration. Parameters, errors and examples in four languages.","n":"id Orrerie-Version items reminder_days grace_days prepaid_periods_allowed proration metadata cancel_at_period_end"},{"t":"Cancel a subscription","u":"/docs/api/subscriptions/cancel-a-subscription","k":"Endpoint","w":"POST /v1/subscriptions/{id}/cancel","x":"cancel a subscription Subscriptions POST /v1/subscriptions/{id}/cancel: Ends it now and cancels the open renewal order. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key reason"},{"t":"Pause a subscription","u":"/docs/api/subscriptions/pause-a-subscription","k":"Endpoint","w":"POST /v1/subscriptions/{id}/pause","x":"pause a subscription Subscriptions POST /v1/subscriptions/{id}/pause: No renewal orders or reminders are created while paused. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"Resume a subscription","u":"/docs/api/subscriptions/resume-a-subscription","k":"Endpoint","w":"POST /v1/subscriptions/{id}/resume","x":"resume a subscription Subscriptions POST /v1/subscriptions/{id}/resume: Resume a paused subscription. A subscription in any other state is refused with subscription_not_paused.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List refunds","u":"/docs/api/refunds/list-refunds","k":"Endpoint","w":"GET /v1/refunds","x":"list refunds Refunds GET /v1/refunds: List your refunds newest first, filtered by order or status. Parameters, errors and examples in four languages.","n":"order status limit starting_after ending_before created[gte] created[lt] expand Orrerie-Version"},{"t":"Request a refund","u":"/docs/api/refunds/request-a-refund","k":"Endpoint","w":"POST /v1/refunds","x":"request a refund Refunds POST /v1/refunds: Request a refund of an order. Nothing is sent until an Owner or Finance member approves it in the dashboard with a passkey.","n":"Orrerie-Version Idempotency-Key order amount reason note destination address_confirmed_with_customer source_asset rate_basis fee_bearer deduct_network_fee metadata"},{"t":"Retrieve a refund","u":"/docs/api/refunds/retrieve-a-refund","k":"Endpoint","w":"GET /v1/refunds/{id}","x":"retrieve a refund Refunds GET /v1/refunds/{id}: Retrieve one refund by its id, with every field of the refund object. Parameters, errors and examples in four languages.","n":"id expand Orrerie-Version"},{"t":"Cancel a refund request","u":"/docs/api/refunds/cancel-a-refund-request","k":"Endpoint","w":"POST /v1/refunds/{id}/cancel","x":"cancel a refund request Refunds POST /v1/refunds/{id}/cancel: Allowed while awaiting_address, draft or awaiting_approval. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"Send a lapsed refund for approval again","u":"/docs/api/refunds/send-a-lapsed-refund-for-approval-again","k":"Endpoint","w":"POST /v1/refunds/{id}/submit","x":"send a lapsed refund for approval again Refunds POST /v1/refunds/{id}/submit: For a draft whose approval lapsed after 7 days. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List saved addresses","u":"/docs/api/saved-addresses/list-saved-addresses","k":"Endpoint","w":"GET /v1/saved_addresses","x":"list saved addresses Saved addresses GET /v1/saved_addresses: List your saved addresses newest first, filtered by status, network or kind. Parameters, errors and examples in four languages.","n":"status network kind limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Propose a saved address","u":"/docs/api/saved-addresses/propose-a-saved-address","k":"Endpoint","w":"POST /v1/saved_addresses","x":"propose a saved address Saved addresses POST /v1/saved_addresses: Propose an address to send money to. It becomes active only after a passkey approval in the dashboard and a 24-hour wait.","n":"Orrerie-Version Idempotency-Key label address network asset kind metadata"},{"t":"Retrieve a saved address","u":"/docs/api/saved-addresses/retrieve-a-saved-address","k":"Endpoint","w":"GET /v1/saved_addresses/{id}","x":"retrieve a saved address Saved addresses GET /v1/saved_addresses/{id}: Retrieve one saved address by its id, with every field of the saved_address object.","n":"id Orrerie-Version"},{"t":"Remove a saved address","u":"/docs/api/saved-addresses/remove-a-saved-address","k":"Endpoint","w":"DELETE /v1/saved_addresses/{id}","x":"remove a saved address Saved addresses DELETE /v1/saved_addresses/{id}: Takes effect at once and needs no further approval. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"List payouts","u":"/docs/api/payouts/list-payouts","k":"Endpoint","w":"GET /v1/payouts","x":"list payouts Payouts GET /v1/payouts: List your payouts newest first, filtered by status, kind, batch, destination or reference. Parameters, errors and examples in four languages.","n":"status kind batch destination reference limit starting_after ending_before created[gte] created[lt] expand Orrerie-Version"},{"t":"Request a payout or withdrawal","u":"/docs/api/payouts/request-a-payout-or-withdrawal","k":"Endpoint","w":"POST /v1/payouts","x":"request a payout or withdrawal Payouts POST /v1/payouts: Request a payout or a withdrawal to an active saved address. Nothing is sent until an Owner or Finance member approves it with a passkey.","n":"Orrerie-Version Idempotency-Key source destination deliver_asset description reference metadata"},{"t":"Retrieve a payout","u":"/docs/api/payouts/retrieve-a-payout","k":"Endpoint","w":"GET /v1/payouts/{id}","x":"retrieve a payout Payouts GET /v1/payouts/{id}: Retrieve one payout by its id, with every field of the payout object. Parameters, errors and examples in four languages.","n":"id expand Orrerie-Version"},{"t":"Cancel a payout request","u":"/docs/api/payouts/cancel-a-payout-request","k":"Endpoint","w":"POST /v1/payouts/{id}/cancel","x":"cancel a payout request Payouts POST /v1/payouts/{id}/cancel: Allowed while awaiting_approval. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"Send a lapsed payout for approval again","u":"/docs/api/payouts/send-a-lapsed-payout-for-approval-again","k":"Endpoint","w":"POST /v1/payouts/{id}/submit","x":"send a lapsed payout for approval again Payouts POST /v1/payouts/{id}/submit: For a draft whose approval lapsed after 7 days. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List payout batches","u":"/docs/api/payouts/list-payout-batches","k":"Endpoint","w":"GET /v1/payout_batches","x":"list payout batches Payouts GET /v1/payout_batches: List your payout batches newest first, filtered by status. Parameters, errors and examples in four languages.","n":"status limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Request a payout batch","u":"/docs/api/payouts/request-a-payout-batch","k":"Endpoint","w":"POST /v1/payout_batches","x":"request a payout batch Payouts POST /v1/payout_batches: Request up to 200 payouts in one batch. Nothing is sent until an Owner or Finance member approves it with a passkey.","n":"Orrerie-Version Idempotency-Key description rows metadata"},{"t":"Retrieve a payout batch","u":"/docs/api/payouts/retrieve-a-payout-batch","k":"Endpoint","w":"GET /v1/payout_batches/{id}","x":"retrieve a payout batch Payouts GET /v1/payout_batches/{id}: Retrieve one payout batch by its id, with every field of the payout_batch object.","n":"id Orrerie-Version"},{"t":"Cancel a payout batch","u":"/docs/api/payouts/cancel-a-payout-batch","k":"Endpoint","w":"POST /v1/payout_batches/{id}/cancel","x":"cancel a payout batch Payouts POST /v1/payout_batches/{id}/cancel: Cancels a payout batch that is waiting for approval, so none of its payouts is sent.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List the eleven wallets","u":"/docs/api/wallets-and-balances/list-the-eleven-wallets","k":"Endpoint","w":"GET /v1/wallets","x":"list the eleven wallets Wallets and balances GET /v1/wallets: Always eleven items, in the fixed order ethereum, bsc, polygon, arbitrum, optimism, base, solana, tron, bitcoin, litecoin, dogecoin.","n":"Orrerie-Version"},{"t":"Retrieve a wallet","u":"/docs/api/wallets-and-balances/retrieve-a-wallet","k":"Endpoint","w":"GET /v1/wallets/{id}","x":"retrieve a wallet Wallets and balances GET /v1/wallets/{id}: On Bitcoin, Litecoin and Dogecoin address is the wallet's base script address (index 0); per-order addresses are on payment instructions.","n":"id Orrerie-Version"},{"t":"List balances","u":"/docs/api/wallets-and-balances/list-balances","k":"Endpoint","w":"GET /v1/balances","x":"list balances Wallets and balances GET /v1/balances: One item per asset held, across all wallets. Parameters, errors and examples in four languages.","n":"wallet network asset include_zero currency Orrerie-Version"},{"t":"Retrieve the fee account","u":"/docs/api/wallets-and-balances/retrieve-the-fee-account","k":"Endpoint","w":"GET /v1/fee_account","x":"retrieve the fee account Wallets and balances GET /v1/fee_account: The merchant-owned single-key account that pays network fees on the EVM networks and Solana.","n":"Orrerie-Version"},{"t":"List ledger entries","u":"/docs/api/wallets-and-balances/list-ledger-entries","k":"Endpoint","w":"GET /v1/ledger_entries","x":"list ledger entries Wallets and balances GET /v1/ledger_entries: The merchant's money record, newest first: every movement in or out of a merchant wallet and every fee.","n":"type wallet asset order source limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Retrieve a ledger entry","u":"/docs/api/wallets-and-balances/retrieve-a-ledger-entry","k":"Endpoint","w":"GET /v1/ledger_entries/{id}","x":"retrieve a ledger entry Wallets and balances GET /v1/ledger_entries/{id}: Retrieve one ledger entry by its id, with every field of the ledger_entry object.","n":"id Orrerie-Version"},{"t":"List conversion offers","u":"/docs/api/conversions/list-conversion-offers","k":"Endpoint","w":"GET /v1/conversions/offers","x":"list conversion offers Conversions GET /v1/conversions/offers: Not stored; asking allocates nothing at any venue. Parameters, errors and examples in four languages.","n":"from_asset to_asset amount Orrerie-Version"},{"t":"List conversions","u":"/docs/api/conversions/list-conversions","k":"Endpoint","w":"GET /v1/conversions","x":"list conversions Conversions GET /v1/conversions: List your conversions newest first, filtered by status or venue. Parameters, errors and examples in four languages.","n":"status venue limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Request a conversion","u":"/docs/api/conversions/request-a-conversion","k":"Endpoint","w":"POST /v1/conversions","x":"request a conversion Conversions POST /v1/conversions: Request a conversion of a balance through the venue you chose. Nothing moves until a passkey approval in the dashboard.","n":"Orrerie-Version Idempotency-Key from to_asset venue max_slippage_bps metadata"},{"t":"Retrieve a conversion","u":"/docs/api/conversions/retrieve-a-conversion","k":"Endpoint","w":"GET /v1/conversions/{id}","x":"retrieve a conversion Conversions GET /v1/conversions/{id}: Retrieve one conversion by its id, with every field of the conversion object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Cancel a conversion request","u":"/docs/api/conversions/cancel-a-conversion-request","k":"Endpoint","w":"POST /v1/conversions/{id}/cancel","x":"cancel a conversion request Conversions POST /v1/conversions/{id}/cancel: Cancels a conversion that is waiting for approval, so nothing is converted. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"Send a lapsed conversion for approval again","u":"/docs/api/conversions/send-a-lapsed-conversion-for-approval-again","k":"Endpoint","w":"POST /v1/conversions/{id}/submit","x":"send a lapsed conversion for approval again Conversions POST /v1/conversions/{id}/submit: For a draft whose approval lapsed after 7 days. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List assets","u":"/docs/api/rates-and-assets/list-assets","k":"Endpoint","w":"GET /v1/assets","x":"list assets Rates and assets GET /v1/assets: List every asset on the eleven networks: the rails that accept it, settlement, confirmations and the minimum order.","n":"network rail settle Orrerie-Version"},{"t":"List exchange rates","u":"/docs/api/rates-and-assets/list-exchange-rates","k":"Endpoint","w":"GET /v1/rates","x":"list exchange rates Rates and assets GET /v1/rates: The price of one unit of each asset in currency. Parameters, errors and examples in four languages.","n":"currency assets Orrerie-Version"},{"t":"List webhook endpoints","u":"/docs/api/webhook-endpoints/list-webhook-endpoints","k":"Endpoint","w":"GET /v1/webhook_endpoints","x":"list webhook endpoints Webhook endpoints GET /v1/webhook_endpoints: List your webhook endpoints newest first, a page at a time. Parameters, errors and examples in four languages.","n":"limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create a webhook endpoint","u":"/docs/api/webhook-endpoints/create-a-webhook-endpoint","k":"Endpoint","w":"POST /v1/webhook_endpoints","x":"create a webhook endpoint Webhook endpoints POST /v1/webhook_endpoints: Create a webhook endpoint and get back the new webhook_endpoint object. A retry with the same Idempotency-Key creates nothing twice.","n":"Orrerie-Version Idempotency-Key url description enabled_events api_version metadata"},{"t":"Retrieve a webhook endpoint","u":"/docs/api/webhook-endpoints/retrieve-a-webhook-endpoint","k":"Endpoint","w":"GET /v1/webhook_endpoints/{id}","x":"retrieve a webhook endpoint Webhook endpoints GET /v1/webhook_endpoints/{id}: Retrieve one webhook endpoint by its id, with every field of the webhook_endpoint object.","n":"id Orrerie-Version"},{"t":"Update a webhook endpoint","u":"/docs/api/webhook-endpoints/update-a-webhook-endpoint","k":"Endpoint","w":"PATCH /v1/webhook_endpoints/{id}","x":"update a webhook endpoint Webhook endpoints PATCH /v1/webhook_endpoints/{id}: Changes only the fields sent. Parameters, errors and examples in four languages.","n":"id Orrerie-Version url description enabled_events status metadata"},{"t":"Delete a webhook endpoint","u":"/docs/api/webhook-endpoints/delete-a-webhook-endpoint","k":"Endpoint","w":"DELETE /v1/webhook_endpoints/{id}","x":"delete a webhook endpoint Webhook endpoints DELETE /v1/webhook_endpoints/{id}: Deletes a webhook endpoint: no event is sent to it any more. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Roll the signing secret","u":"/docs/api/webhook-endpoints/roll-the-signing-secret","k":"Endpoint","w":"POST /v1/webhook_endpoints/{id}/roll_secret","x":"roll the signing secret Webhook endpoints POST /v1/webhook_endpoints/{id}/roll_secret: Returns a new secret. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key expires_in"},{"t":"Send a test event","u":"/docs/api/webhook-endpoints/send-a-test-event","k":"Endpoint","w":"POST /v1/webhook_endpoints/{id}/ping","x":"send a test event Webhook endpoints POST /v1/webhook_endpoints/{id}/ping: Sends one ping event to this endpoint now, in either mode, and returns the delivery attempt.","n":"id Orrerie-Version Idempotency-Key"},{"t":"List delivery attempts","u":"/docs/api/webhook-endpoints/list-delivery-attempts","k":"Endpoint","w":"GET /v1/webhook_endpoints/{id}/deliveries","x":"list delivery attempts Webhook endpoints GET /v1/webhook_endpoints/{id}/deliveries: Attempts of the last 30 days, newest first. Parameters, errors and examples in four languages.","n":"id status event limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Retrieve an event","u":"/docs/api/events/retrieve-an-event","k":"Endpoint","w":"GET /v1/events/{id}","x":"retrieve an event Events GET /v1/events/{id}: Retrieve one event by its id, with every field of the event object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"List events","u":"/docs/api/events/list-events","k":"Endpoint","w":"GET /v1/events","x":"list events Events GET /v1/events: List your events newest first, filtered by type, object or delivery status. Parameters, errors and examples in four languages.","n":"type object_id delivery_status limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Resend an event","u":"/docs/api/events/resend-an-event","k":"Endpoint","w":"POST /v1/events/{id}/resend","x":"resend an event Events POST /v1/events/{id}/resend: Queues one new delivery of a stored event to one endpoint. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key endpoint"},{"t":"List files","u":"/docs/api/files-and-exports/list-files","k":"Endpoint","w":"GET /v1/files","x":"list files Files and exports GET /v1/files: List your files newest first, filtered by purpose. Parameters, errors and examples in four languages.","n":"purpose limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Upload a file","u":"/docs/api/files-and-exports/upload-a-file","k":"Endpoint","w":"POST /v1/files","x":"upload a file Files and exports POST /v1/files: multipart/form-data with parts file and purpose. Parameters, errors and examples in four languages.","n":"Orrerie-Version Idempotency-Key file purpose"},{"t":"Retrieve a file","u":"/docs/api/files-and-exports/retrieve-a-file","k":"Endpoint","w":"GET /v1/files/{id}","x":"retrieve a file Files and exports GET /v1/files/{id}: Retrieve one file by its id, with every field of the file object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Delete a file","u":"/docs/api/files-and-exports/delete-a-file","k":"Endpoint","w":"DELETE /v1/files/{id}","x":"delete a file Files and exports DELETE /v1/files/{id}: Only files you uploaded and that nothing uses. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Download a file","u":"/docs/api/files-and-exports/download-a-file","k":"Endpoint","w":"GET /v1/files/{id}/content","x":"download a file Files and exports GET /v1/files/{id}/content: Answers 302 to a single-use URL valid for 5 minutes. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"List exports","u":"/docs/api/files-and-exports/list-exports","k":"Endpoint","w":"GET /v1/exports","x":"list exports Files and exports GET /v1/exports: List your exports newest first, filtered by type or status. Parameters, errors and examples in four languages.","n":"type status limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create an export","u":"/docs/api/files-and-exports/create-an-export","k":"Endpoint","w":"POST /v1/exports","x":"create an export Files and exports POST /v1/exports: Start a CSV or PDF export of your orders, payments, refunds, payouts or ledger. It is built in the background and kept 7 days.","n":"Orrerie-Version Idempotency-Key type format filters timezone display_currency"},{"t":"Retrieve an export","u":"/docs/api/files-and-exports/retrieve-an-export","k":"Endpoint","w":"GET /v1/exports/{id}","x":"retrieve an export Files and exports GET /v1/exports/{id}: Retrieve one export by its id, with every field of the export object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Retrieve a receipt","u":"/docs/api/receipts-and-pos/retrieve-a-receipt","k":"Endpoint","w":"GET /v1/receipts/{id}","x":"retrieve a receipt Receipts and POS GET /v1/receipts/{id}: Retrieve one receipt by its id, with every field of the receipt object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Email a receipt","u":"/docs/api/receipts-and-pos/email-a-receipt","k":"Endpoint","w":"POST /v1/receipts/{id}/send","x":"email a receipt Receipts and POS POST /v1/receipts/{id}/send: At most 5 sends per receipt per 24 hours. Parameters, errors and examples in four languages.","n":"id Orrerie-Version Idempotency-Key to"},{"t":"List point-of-sale devices","u":"/docs/api/receipts-and-pos/list-point-of-sale-devices","k":"Endpoint","w":"GET /v1/pos_devices","x":"list point of sale devices Receipts and POS GET /v1/pos_devices: List your point-of-sale devices newest first, a page at a time. Parameters, errors and examples in four languages.","n":"limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"List split rules","u":"/docs/api/split-rules/list-split-rules","k":"Endpoint","w":"GET /v1/split_rules","x":"list split rules Split rules GET /v1/split_rules: Lists the merchant's split rules. Parameters, errors and examples in four languages.","n":"status scope_kind limit starting_after ending_before Orrerie-Version"},{"t":"Propose a split rule","u":"/docs/api/split-rules/create-split-rule","k":"Endpoint","w":"POST /v1/split_rules","x":"create split rule Split rules POST /v1/split_rules: Creates a rule in awaiting_approval. Parameters, errors and examples in four languages.","n":"Orrerie-Version name scope shares shares[].saved_address shares[].percent remind_daily"},{"t":"Retrieve a split rule","u":"/docs/api/split-rules/retrieve-split-rule","k":"Endpoint","w":"GET /v1/split_rules/{id}","x":"retrieve split rule Split rules GET /v1/split_rules/{id}: Returns one split rule by its id, with its shares and its state. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Change a split rule","u":"/docs/api/split-rules/update-split-rule","k":"Endpoint","w":"PATCH /v1/split_rules/{id}","x":"update split rule Split rules PATCH /v1/split_rules/{id}: A change of shares returns the rule to awaiting_approval; the old shares keep applying until a key-holding member confirms.","n":"id Orrerie-Version name scope shares shares[].saved_address shares[].percent remind_daily"},{"t":"Switch a split rule off","u":"/docs/api/split-rules/deactivate-split-rule","k":"Endpoint","w":"DELETE /v1/split_rules/{id}","x":"deactivate split rule Split rules DELETE /v1/split_rules/{id}: Sets the rule inactive. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Retrieve the merchant","u":"/docs/api/merchant-team-and-keys/retrieve-the-merchant","k":"Endpoint","w":"GET /v1/merchant","x":"retrieve the merchant Merchant, team and keys GET /v1/merchant: Retrieve the merchant object of the business your key belongs to: its profile, tier and settings.","n":"Orrerie-Version"},{"t":"Update the public profile","u":"/docs/api/merchant-team-and-keys/update-the-public-profile","k":"Endpoint","w":"PATCH /v1/merchant","x":"update the public profile Merchant, team and keys PATCH /v1/merchant: Only support_email, branding.logo, branding.accent_color (Verified tier) and default_order_expiry_seconds.","n":"Orrerie-Version support_email branding default_order_expiry_seconds"},{"t":"List members","u":"/docs/api/merchant-team-and-keys/list-members","k":"Endpoint","w":"GET /v1/team/members","x":"list members Merchant, team and keys GET /v1/team/members: Includes pending invitations (status: \"invited\"). Parameters, errors and examples in four languages.","n":"role status limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Retrieve a member","u":"/docs/api/merchant-team-and-keys/retrieve-a-member","k":"Endpoint","w":"GET /v1/team/members/{id}","x":"retrieve a member Merchant, team and keys GET /v1/team/members/{id}: Retrieve one member by its id, with every field of the member object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Change a member's role","u":"/docs/api/merchant-team-and-keys/change-a-members-role","k":"Endpoint","w":"PATCH /v1/team/members/{id}","x":"change a member s role Merchant, team and keys PATCH /v1/team/members/{id}: No API key changes the team: this call answers passkey_approval_required for every member and role.","n":"id Orrerie-Version role"},{"t":"Remove a member or revoke an invitation","u":"/docs/api/merchant-team-and-keys/remove-a-member-or-revoke-an-invitation","k":"Endpoint","w":"DELETE /v1/team/members/{id}","x":"remove a member or revoke an invitation Merchant, team and keys DELETE /v1/team/members/{id}: No API key changes the team: this call answers passkey_approval_required for every member and invitation.","n":"id Orrerie-Version"},{"t":"Invite a member","u":"/docs/api/merchant-team-and-keys/invite-a-member","k":"Endpoint","w":"POST /v1/team/invitations","x":"invite a member Merchant, team and keys POST /v1/team/invitations: No API key changes the team: after checking email and role, this call answers passkey_approval_required for every role.","n":"Orrerie-Version Idempotency-Key email role name"},{"t":"List API keys","u":"/docs/api/merchant-team-and-keys/list-api-keys","k":"Endpoint","w":"GET /v1/keys","x":"list api keys Merchant, team and keys GET /v1/keys: Keys of the calling key's mode. Parameters, errors and examples in four languages.","n":"type status limit starting_after ending_before created[gte] created[lt] Orrerie-Version"},{"t":"Create an API key","u":"/docs/api/merchant-team-and-keys/create-an-api-key","k":"Endpoint","w":"POST /v1/keys","x":"create an api key Merchant, team and keys POST /v1/keys: The response is the only time secret is shown. Parameters, errors and examples in four languages.","n":"Orrerie-Version Idempotency-Key name type scopes allowed_ips expires_at"},{"t":"Retrieve an API key","u":"/docs/api/merchant-team-and-keys/retrieve-an-api-key","k":"Endpoint","w":"GET /v1/keys/{id}","x":"retrieve an api key Merchant, team and keys GET /v1/keys/{id}: Retrieve one API key by its id, with every field of the api_key object. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Revoke an API key","u":"/docs/api/merchant-team-and-keys/revoke-an-api-key","k":"Endpoint","w":"DELETE /v1/keys/{id}","x":"revoke an api key Merchant, team and keys DELETE /v1/keys/{id}: Immediate and permanent. Parameters, errors and examples in four languages.","n":"id Orrerie-Version"},{"t":"Roll an API key","u":"/docs/api/merchant-team-and-keys/roll-an-api-key","k":"Endpoint","w":"POST /v1/keys/{id}/roll","x":"roll an api key Merchant, team and keys POST /v1/keys/{id}/roll: Creates a replacement key with the same name, type, scopes and IP list, and returns it with its secret.","n":"id Orrerie-Version Idempotency-Key expires_in"},{"t":"Simulate a payment","u":"/docs/api/test-mode-helpers/simulate-a-payment","k":"Endpoint","w":"POST /v1/test/orders/{id}/simulate_payment","x":"simulate a payment Test mode helpers POST /v1/test/orders/{id}/simulate_payment: Creates a simulated payment on the order and walks it through seen → confirmed → settled over about 6 seconds.","n":"id Orrerie-Version Idempotency-Key scenario asset rail amount instant"},{"t":"Approve or advance a test refund, payout or conversion","u":"/docs/api/test-mode-helpers/approve-or-advance-a-test-refund-payout-or-conversion","k":"Endpoint","w":"POST /v1/test/money_out/{id}/advance","x":"approve or advance a test refund payout or conversion Test mode helpers POST /v1/test/money_out/{id}/advance: Test mode has no wallets and no funds, so there is nothing for a passkey to sign.","n":"id Orrerie-Version Idempotency-Key to failure_code"},{"t":"Advance a test subscription's clock","u":"/docs/api/test-mode-helpers/advance-a-test-subscriptions-clock","k":"Endpoint","w":"POST /v1/test/subscriptions/{id}/advance","x":"advance a test subscription s clock Test mode helpers POST /v1/test/subscriptions/{id}/advance: Moves the subscription's own clock forward so that reminders, renewal orders, past_due and ended happen now.","n":"id Orrerie-Version Idempotency-Key to"},{"t":"Skip a test saved address's approval and wait","u":"/docs/api/test-mode-helpers/skip-a-test-saved-address-approval-and-wait","k":"Endpoint","w":"POST /v1/test/saved_addresses/{id}/activate","x":"skip a test saved address s approval and wait Test mode helpers POST /v1/test/saved_addresses/{id}/activate: In test mode, make a proposed saved address active at once, skipping the passkey approval and the 24-hour wait.","n":"id Orrerie-Version Idempotency-Key"},{"t":"Checkout sessions","u":"/docs/api/checkout-sessions","k":"Resource","w":"API reference","x":"checkout_session Checkout sessions in the Orrerie Merchant API: the checkout_session object, 4 endpoints and 3 webhook events.","n":"id object livemode created status mode order url app_url success_url cancel_url customer customer_email client_reference_id collect collect.email collect.name collect.shipping_address collected collected.email collected.name collected.shipping_address locale subscription expires_at completed_at metadata"},{"t":"Orders","u":"/docs/api/orders","k":"Resource","w":"API reference","x":"order payment_option payment_instruction Orders in the Orrerie Merchant API: the order, payment_option and payment_instruction objects, 11 endpoints and 22 webhook events.","n":"screening screening.status tip id object livemode created updated status source amount currency value value.amount value.currency fx description reference customer customer_email line_items line_items[].name line_items[].quantity line_items[].unit_amount line_items[].amount line_items[].price settlement settlement.mode settlement.asset settlement.amount_expected settlement.amount_received settlement.wallet settlement.recipient_kind fee_bearer amount_paid amount_due amount_refunded paid_late accepted_short refunded partially_refunded finalized has_unconfirmed screening_hold provider_refund_received overpayment rails_allowed accept app_pay_allowed active_instruction instructions payments checkout_session payment_link invoice subscription pos_device receipt expires_at paid_at cancelled_at metadata asset network symbol rail amount_mode available unavailable_reason estimated_pay_amount estimated_route_fee estimated_route_fee.amount estimated_route_fee.currency estimated_route_fee.bearer confirmations_required estimated_seconds rail_reason recipient_kind recipient refund_to refund_wallet_protected provider_request_id order provider pay_asset pay_amount address address.id address.address address.network address.owner address.solana_pay_reference address.derivation payment_uri quote quote.id quote.price_amount quote.price_currency quote.rate quote.route_fee quote.created quote.expires_at settle_asset settle_amount_expected in_transit_notice wrong_asset_warning late_until failure_code test_simulation_url"},{"t":"Payments","u":"/docs/api/payments","k":"Resource","w":"API reference","x":"payment Payments in the Orrerie Merchant API: the payment object, 4 endpoints and 6 webhook events.","n":"id object livemode created order instruction status rail rail_reason asset network amount value value.amount value.currency transaction_hash from_address to_address confirmations confirmations_required unmatched unmatched_reason late ignored finalized screening screening.id screening.status screening.checked_at settlement settlement.id settlement.asset settlement.network settlement.amount settlement.wallet settlement.to_address settlement.transaction_hash settlement.proved_by settlement.settled_at seen_at confirmed_at settled_at reverted_at"},{"t":"Products and prices","u":"/docs/api/products-and-prices","k":"Resource","w":"API reference","x":"product price Products and prices in the Orrerie Merchant API: the product and price objects, 8 endpoints and 4 webhook events.","n":"id object livemode created updated name description image active metadata product type amount currency recurring nickname"},{"t":"Payment links","u":"/docs/api/payment-links","k":"Resource","w":"API reference","x":"payment_link Payment links in the Orrerie Merchant API: the payment_link object, 4 endpoints and 3 webhook events.","n":"id object livemode created updated active name url amount_type amount currency min_amount max_amount line_items line_items[].price line_items[].quantity line_items[].adjustable_quantity collect collect.email collect.name collect.shipping_address success_url allow_publishable_key order_expiry_seconds max_uses uses paid_uses expires_at metadata"},{"t":"Invoices","u":"/docs/api/invoices","k":"Resource","w":"API reference","x":"invoice Invoices in the Orrerie Merchant API: the invoice object, 8 endpoints and 6 webhook events.","n":"id object livemode created updated number status overdue customer order currency line_items line_items[].name line_items[].quantity line_items[].unit_amount line_items[].amount line_items[].price subtotal discount_amount tax_amount total amount_paid amount_due due_date memo footer url pdf reminders reminders.days_before_due reminders.days_after_due finalized_at sent_at paid_at voided_at metadata"},{"t":"Customers","u":"/docs/api/customers","k":"Resource","w":"API reference","x":"customer Customers in the Orrerie Merchant API: the customer object, 5 endpoints and 3 webhook events.","n":"id object livemode created updated name email description billing_address billing_address.line1 billing_address.line2 billing_address.city billing_address.region billing_address.postal_code billing_address.country refund_addresses refund_addresses[].asset refund_addresses[].address refund_addresses[].added credit_balance credit_balance.amount credit_balance.currency locale metadata"},{"t":"Subscriptions","u":"/docs/api/subscriptions","k":"Resource","w":"API reference","x":"subscription Subscriptions in the Orrerie Merchant API: the subscription object, 7 endpoints and 13 webhook events.","n":"ended_reason max_periods id object livemode created updated status customer items items[].price items[].quantity amount currency interval interval_count reminder_days grace_days prepaid_periods_allowed proration current_period_start current_period_end prepaid_until latest_order renewal renewal.order renewal.checkout_url renewal.opens_at renewal.due_at renewal.grace_ends_at cancel_at_period_end cancelled_at paused_at ended_at cancellation_reason metadata"},{"t":"Refunds","u":"/docs/api/refunds","k":"Resource","w":"API reference","x":"refund Refunds in the Orrerie Merchant API: the refund object, 5 endpoints and 10 webhook events.","n":"id object livemode created updated status pending_reason order payment amount currency reason note rate_basis deduct_network_fee source source.wallet source.asset source.amount destination destination.address destination.asset destination.network destination.supplied_by destination.saved_address destination_kind address_claim address_claim.sent_to address_claim.sent_at address_claim.claimed_at address_claim.expires_at approvable_at delivery delivery.rail delivery.amount_estimated delivery.route_fee delivery.fee_bearer network_fee requested_by requested_by.type requested_by.id approved_by approval_url approval_expires_at transaction_hash failure_code cancellation_reason approved_at sent_at confirmed_at metadata"},{"t":"Saved addresses","u":"/docs/api/saved-addresses","k":"Resource","w":"API reference","x":"saved_address Saved addresses in the Orrerie Merchant API: the saved_address object, 4 endpoints and 4 webhook events.","n":"id object livemode created label kind address network asset status approved_by approved_at usable_at screening screening.id screening.status screening.checked_at approval_url metadata"},{"t":"Payouts","u":"/docs/api/payouts","k":"Resource","w":"API reference","x":"payout payout_batch Payouts in the Orrerie Merchant API: the payout and payout_batch objects, 9 endpoints and 13 webhook events.","n":"id object livemode created updated kind status pending_reason batch split_rule order source source.wallet source.asset source.amount destination destination.saved_address destination.address destination.network destination.asset delivery delivery.rail delivery.amount_estimated delivery.route_fee delivery.fee_bearer value value.amount value.currency description reference network_fee requested_by requested_by.type requested_by.id approved_by approval_url approval_expires_at transaction_hash failure_code cancellation_reason approved_at sent_at confirmed_at metadata row_count total_value total_value.amount total_value.currency counts counts.draft counts.awaiting_approval counts.signed counts.sent counts.confirmed counts.failed counts.unknown counts.cancelled payouts completed_at"},{"t":"Split rules","u":"/docs/api/split-rules","k":"Resource","w":"API reference","x":"split_rule Split rules in the Orrerie Merchant API: the split_rule object and 5 endpoints.","n":"id object livemode created name status scope scope.kind scope.product scope.payment_link shares shares[].saved_address shares[].percent kept_percent remind_daily pending pending.legs pending.totals"},{"t":"Wallets and balances","u":"/docs/api/wallets-and-balances","k":"Resource","w":"API reference","x":"wallet balance fee_account ledger_entry Wallets and balances in the Orrerie Merchant API: the wallet, balance, fee_account and ledger_entry objects, 6 endpoints and 4 webhook events.","n":"two_of_three_in_force display_state id object livemode created wallet_set network status address shape threshold owner_count can_receive can_send deployed deployment_note native_asset explorer_url wallet asset amount incoming_unconfirmed reserved available value value.amount value.currency as_of top_up_from_takings keys keys[].family keys[].address keys[].balances topup topup.enabled topup.last topup.eligible_order_range type direction order source transaction_hash description"},{"t":"Conversions","u":"/docs/api/conversions","k":"Resource","w":"API reference","x":"conversion_offer conversion Conversions in the Orrerie Merchant API: the conversion_offer and conversion objects, 6 endpoints and 8 webhook events.","n":"object venue available refusal_reason from from.asset from.amount to to.asset to.amount_estimated rate fees fees[].kind fees[].amount fees[].currency estimated_seconds expires_at id livemode created updated status pending_reason venue_progress from.wallet to.wallet to.amount_minimum to.amount_received max_slippage_bps in_transit_notice requested_by requested_by.type requested_by.id approved_by approval_url approval_expires_at send_transaction_hash receive_transaction_hash failure_code cancellation_reason approved_at sent_at confirmed_at metadata"},{"t":"Rates and assets","u":"/docs/api/rates-and-assets","k":"Resource","w":"API reference","x":"asset rate Rates and assets in the Orrerie Merchant API: the asset and rate objects and 2 endpoints.","n":"object id network symbol name decimals contract native pay pay.orrerie_app pay.relay pay.direct pay.relay_amount_mode settle confirmations confirmations[].order_value_up_to confirmations[].count confirmations[].unit minimum_order minimum_order.relay minimum_order.direct minimum_direct_amount asset currency rate as_of source fiat_table_as_of"},{"t":"Webhook endpoints","u":"/docs/api/webhook-endpoints","k":"Resource","w":"API reference","x":"webhook_endpoint webhook_delivery Webhook endpoints in the Orrerie Merchant API: the webhook_endpoint and webhook_delivery objects, 8 endpoints and 2 webhook events.","n":"id object livemode created url description enabled_events status disabled_reason failing failing_since api_version secret_last4 previous_secret_expires_at last_success_at last_failure_at metadata event endpoint attempt response_status duration_ms error next_attempt_at manual"},{"t":"Events","u":"/docs/api/events","k":"Resource","w":"API reference","x":"event The event object of the Orrerie Merchant API and its 3 endpoints: list events, retrieve one, and resend one to an endpoint.","n":"id object livemode created type api_version data data.object data.previous_attributes request request.id request.idempotency_key pending_webhooks"},{"t":"Files and exports","u":"/docs/api/files-and-exports","k":"Resource","w":"API reference","x":"file export Files and exports in the Orrerie Merchant API: the file and export objects, 8 endpoints and 2 webhook events.","n":"id object livemode created purpose filename mime_type size sha256 expires_at type format status filters filters.created filters.status timezone display_currency row_count file snapshot_at completed_at failure_code requested_by requested_by.type requested_by.id"},{"t":"Receipts and POS","u":"/docs/api/receipts-and-pos","k":"Resource","w":"API reference","x":"receipt pos_device Receipts and POS in the Orrerie Merchant API: the receipt and pos_device objects, 3 endpoints and 1 webhook event.","n":"id object livemode created number order url pdf sent_to sent_at label status paired_by display_url last_seen_at"},{"t":"Merchant, team and keys","u":"/docs/api/merchant-team-and-keys","k":"Resource","w":"API reference","x":"merchant member api_key Merchant, team and keys in the Orrerie Merchant API: the merchant, member and api_key objects, 12 endpoints and 11 webhook events.","n":"id object livemode created name slug profile_url country business_type support_email tier restricted verification verification.id verification.status verification.workflow verification.created verification.decided settlement settlement.mode settlement.asset fee_bearer default_order_expiry_seconds rails rails.orrerie_app rails.relay rails.direct app_pay_allowed branding branding.logo branding.accent_color limits limits.order_max limits.rolling_30_days_max limits.lifetime_max limits.open_orders_max limits.outside_payouts_daily_max limits.payout_batch_rows_max limits.members_max limits.live_keys_max limits.webhook_endpoints_max limits.requests_per_minute usage usage.rolling_30_days_paid usage.lifetime_paid usage.open_orders usage.outside_payouts_today usage.members usage.live_keys usage.webhook_endpoints user email role status holds_wallet_key passkey_count invited_by invitation_expires_at last_active_at type prefix last4 scopes allowed_ips api_version created_by created_by.type created_by.id last_used_at expires_at rolled_from"},{"t":"Test mode helpers","u":"/docs/api/test-mode-helpers","k":"Resource","w":"API reference","x":"The four test-mode helpers of the Orrerie Merchant API: simulate a payment, advance money out, move a subscription's clock, skip a saved address's wait."},{"t":"ping","u":"/docs/events/ping","k":"Event","w":"ping","x":"ping ping The ping webhook event: Sent by POST /v1/webhook_endpoints/{id}/ping and by the dashboard's \"Send test event\" button. Example payload and every field."},{"t":"checkout_session.created","u":"/docs/events/checkout-session-created","k":"Event","w":"checkout_session","x":"checkout session created checkout_session The checkout_session.created webhook event: A session was created. Example payload and every field."},{"t":"checkout_session.completed","u":"/docs/events/checkout-session-completed","k":"Event","w":"checkout_session","x":"checkout session completed checkout_session The checkout_session.completed webhook event: The session's order became paid or overpaid. Example payload and every field."},{"t":"checkout_session.expired","u":"/docs/events/checkout-session-expired","k":"Event","w":"checkout_session","x":"checkout session expired checkout_session The checkout_session.expired webhook event: The session's order expired unpaid, or the session was expired by the API. Example payload and every field."},{"t":"order.created","u":"/docs/events/order-created","k":"Event","w":"order","x":"order created order The order.created webhook event: An order was created by any source. Example payload and every field."},{"t":"order.processing","u":"/docs/events/order-processing","k":"Event","w":"order","x":"order processing order The order.processing webhook event: The first payment for the order was seen. Example payload and every field."},{"t":"order.paid","u":"/docs/events/order-paid","k":"Event","w":"order","x":"order paid order The order.paid webhook event: The event to fulfil on. Example payload and every field."},{"t":"order.underpaid","u":"/docs/events/order-underpaid","k":"Event","w":"order","x":"order underpaid order The order.underpaid webhook event: Less than the price arrived, beyond the 0.5% tolerance. Example payload and every field."},{"t":"order.overpaid","u":"/docs/events/order-overpaid","k":"Event","w":"order","x":"order overpaid order The order.overpaid webhook event: More than the price arrived, at first payment or by a later duplicate. Example payload and every field."},{"t":"order.finalized","u":"/docs/events/order-finalized","k":"Event","w":"order","x":"order finalized order The order.finalized webhook event: High-value orders only (above US$10,000 on Ethereum and the rollups): the payments behind… Example payload and every field."},{"t":"order.updated","u":"/docs/events/order-updated","k":"Event","w":"order","x":"order updated order The order.updated webhook event: A field changed without a more specific event: description, reference, customer, metadata, a… Example payload and every field."},{"t":"order.expired","u":"/docs/events/order-expired","k":"Event","w":"order","x":"order expired order The order.expired webhook event: The order passed expires_at with nothing credited. Example payload and every field."},{"t":"order.cancelled","u":"/docs/events/order-cancelled","k":"Event","w":"order","x":"order cancelled order The order.cancelled webhook event: The order was cancelled by the API, the dashboard or a voided invoice. Example payload and every field."},{"t":"order.refunded","u":"/docs/events/order-refunded","k":"Event","w":"order","x":"order refunded order The order.refunded webhook event: Confirmed refunds now equal amount_paid. Example payload and every field."},{"t":"order.partially_refunded","u":"/docs/events/order-partially-refunded","k":"Event","w":"order","x":"order partially refunded order The order.partially_refunded webhook event: A refund smaller than the remaining paid amount was confirmed. Example payload and every field."},{"t":"order.overpayment_resolved","u":"/docs/events/order-overpayment-resolved","k":"Event","w":"order","x":"order overpayment resolved order The order.overpayment_resolved webhook event: The excess was refunded (refunded) or kept as credit (kept_as_credit). Example payload and every field."},{"t":"payment_instruction.created","u":"/docs/events/payment-instruction-created","k":"Event","w":"payment_instruction","x":"payment instruction created payment_instruction The payment_instruction.created webhook event: A payer chose an asset and was shown an address (or opened Pay with Orrerie). Example payload and every field."},{"t":"payment_instruction.detected","u":"/docs/events/payment-instruction-detected","k":"Event","w":"payment_instruction","x":"payment instruction detected payment_instruction The payment_instruction.detected webhook event: The payer's transfer to the instruction's address was seen. Example payload and every field."},{"t":"payment_instruction.delivered","u":"/docs/events/payment-instruction-delivered","k":"Event","w":"payment_instruction","x":"payment instruction delivered payment_instruction The payment_instruction.delivered webhook event: The value reached the merchant wallet (wallet's own chain read). Example payload and every field."},{"t":"payment_instruction.refunded_by_provider","u":"/docs/events/payment-instruction-refunded-by-provider","k":"Event","w":"payment_instruction","x":"payment instruction refunded by provider payment_instruction The payment_instruction.refunded_by_provider webhook event: Relay could not route the deposit and returned it to the… Example payload and every field."},{"t":"payment_instruction.failed","u":"/docs/events/payment-instruction-failed","k":"Event","w":"payment_instruction","x":"payment instruction failed payment_instruction The payment_instruction.failed webhook event: The route failed and no provider refund has been seen. Example payload and every field."},{"t":"payment_instruction.expired","u":"/docs/events/payment-instruction-expired","k":"Event","w":"payment_instruction","x":"payment instruction expired payment_instruction The payment_instruction.expired webhook event: The 15-minute window passed with nothing seen. Example payload and every field."},{"t":"payment.seen","u":"/docs/events/payment-seen","k":"Event","w":"payment","x":"payment seen payment The payment.seen webhook event: A transfer was seen in the mempool or its first block. Example payload and every field."},{"t":"payment.confirmed","u":"/docs/events/payment-confirmed","k":"Event","w":"payment","x":"payment confirmed payment The payment.confirmed webhook event: The payer's transfer reached the network's confirmation count. Example payload and every field."},{"t":"payment.settled","u":"/docs/events/payment-settled","k":"Event","w":"payment","x":"payment settled payment The payment.settled webhook event: The value is in the merchant wallet. Example payload and every field."},{"t":"payment.reverted","u":"/docs/events/payment-reverted","k":"Event","w":"payment","x":"payment reverted payment The payment.reverted webhook event: A block reorganisation removed the transfer. Example payload and every field."},{"t":"payment.unmatched","u":"/docs/events/payment-unmatched","k":"Event","w":"payment","x":"payment unmatched payment The payment.unmatched webhook event: Money reached a merchant wallet and matches no order. Example payload and every field."},{"t":"payment.screening_flagged","u":"/docs/events/payment-screening-flagged","k":"Event","w":"payment","x":"payment screening flagged payment The payment.screening_flagged webhook event: The sender address screened as review or blocked, including a hit found later on… Example payload and every field."},{"t":"order.payment_reverted","u":"/docs/events/order-payment-reverted","k":"Event","w":"order","x":"order payment reverted order The order.payment_reverted webhook event: A credited payment was undone by a chain reorganisation. Example payload and every field."},{"t":"order.unpaid","u":"/docs/events/order-unpaid","k":"Event","w":"order","x":"order unpaid order The order.unpaid webhook event: Follows order.payment_reverted when the order had been paid or overpaid and no longer is. Example payload and every field."},{"t":"refund.created","u":"/docs/events/refund-created","k":"Event","w":"refund","x":"refund created refund The refund.created webhook event: A refund is awaiting_approval: requested by the API or a member, or the payer has just… Example payload and every field."},{"t":"refund.signed","u":"/docs/events/refund-signed","k":"Event","w":"refund","x":"refund signed refund The refund.signed webhook event: A key-holding member approved with a passkey and the co-signer added its signature. Example payload and every field."},{"t":"refund.sent","u":"/docs/events/refund-sent","k":"Event","w":"refund","x":"refund sent refund The refund.sent webhook event: The transaction was broadcast. Example payload and every field."},{"t":"refund.confirmed","u":"/docs/events/refund-confirmed","k":"Event","w":"refund","x":"refund confirmed refund The refund.confirmed webhook event: The transaction reached its confirmation count. Example payload and every field."},{"t":"refund.failed","u":"/docs/events/refund-failed","k":"Event","w":"refund","x":"refund failed refund The refund.failed webhook event: The transaction failed on chain or the route failed and the funds are back in the merchant… Example payload and every field."},{"t":"refund.unknown","u":"/docs/events/refund-unknown","k":"Event","w":"refund","x":"refund unknown refund The refund.unknown webhook event: The outcome could not be established (for example a broadcast timed out). Example payload and every field."},{"t":"refund.cancelled","u":"/docs/events/refund-cancelled","k":"Event","w":"refund","x":"refund cancelled refund The refund.cancelled webhook event: Ended before signing: by the API (cancelled_by_api), by a member rejecting it… Example payload and every field."},{"t":"refund.approval_lapsed","u":"/docs/events/refund-approval-lapsed","k":"Event","w":"refund","x":"refund approval lapsed refund The refund.approval_lapsed webhook event: Nobody approved within 7 days. Example payload and every field."},{"t":"payout.created","u":"/docs/events/payout-created","k":"Event","w":"payout","x":"payout created payout The payout.created webhook event: A payout is awaiting_approval: requested by the API or a member. Example payload and every field."},{"t":"payout.signed","u":"/docs/events/payout-signed","k":"Event","w":"payout","x":"payout signed payout The payout.signed webhook event: A key-holding member approved with a passkey and the co-signer added its signature. Example payload and every field."},{"t":"payout.sent","u":"/docs/events/payout-sent","k":"Event","w":"payout","x":"payout sent payout The payout.sent webhook event: The transaction was broadcast. Example payload and every field."},{"t":"payout.confirmed","u":"/docs/events/payout-confirmed","k":"Event","w":"payout","x":"payout confirmed payout The payout.confirmed webhook event: The transaction reached its confirmation count. Example payload and every field."},{"t":"payout.failed","u":"/docs/events/payout-failed","k":"Event","w":"payout","x":"payout failed payout The payout.failed webhook event: The transaction failed on chain or the route failed and the funds are back in the merchant… Example payload and every field."},{"t":"payout.unknown","u":"/docs/events/payout-unknown","k":"Event","w":"payout","x":"payout unknown payout The payout.unknown webhook event: The outcome could not be established (for example a broadcast timed out). Example payload and every field."},{"t":"payout.cancelled","u":"/docs/events/payout-cancelled","k":"Event","w":"payout","x":"payout cancelled payout The payout.cancelled webhook event: Ended before signing: by the API (cancelled_by_api), by a member rejecting it… Example payload and every field."},{"t":"payout.approval_lapsed","u":"/docs/events/payout-approval-lapsed","k":"Event","w":"payout","x":"payout approval lapsed payout The payout.approval_lapsed webhook event: Nobody approved within 7 days. Example payload and every field."},{"t":"conversion.created","u":"/docs/events/conversion-created","k":"Event","w":"conversion","x":"conversion created conversion The conversion.created webhook event: A conversion is awaiting_approval: requested by the API or a member. Example payload and every field."},{"t":"conversion.signed","u":"/docs/events/conversion-signed","k":"Event","w":"conversion","x":"conversion signed conversion The conversion.signed webhook event: A key-holding member approved with a passkey and the co-signer added its signature. Example payload and every field."},{"t":"conversion.sent","u":"/docs/events/conversion-sent","k":"Event","w":"conversion","x":"conversion sent conversion The conversion.sent webhook event: The transaction was broadcast. Example payload and every field."},{"t":"conversion.confirmed","u":"/docs/events/conversion-confirmed","k":"Event","w":"conversion","x":"conversion confirmed conversion The conversion.confirmed webhook event: The transaction reached its confirmation count and the converted amount is in the… Example payload and every field."},{"t":"conversion.failed","u":"/docs/events/conversion-failed","k":"Event","w":"conversion","x":"conversion failed conversion The conversion.failed webhook event: The transaction failed on chain or the route failed and the funds are back in the… Example payload and every field."},{"t":"conversion.unknown","u":"/docs/events/conversion-unknown","k":"Event","w":"conversion","x":"conversion unknown conversion The conversion.unknown webhook event: The outcome could not be established (for example a broadcast timed out). Example payload and every field."},{"t":"conversion.cancelled","u":"/docs/events/conversion-cancelled","k":"Event","w":"conversion","x":"conversion cancelled conversion The conversion.cancelled webhook event: Ended before signing: by the API (cancelled_by_api), by a member rejecting it… Example payload and every field."},{"t":"conversion.approval_lapsed","u":"/docs/events/conversion-approval-lapsed","k":"Event","w":"conversion","x":"conversion approval lapsed conversion The conversion.approval_lapsed webhook event: Nobody approved within 7 days. Example payload and every field."},{"t":"refund.address_requested","u":"/docs/events/refund-address-requested","k":"Event","w":"refund","x":"refund address requested refund The refund.address_requested webhook event: A refund was requested without an address, and its single-use claim link was made. Example payload and every field."},{"t":"refund.address_lapsed","u":"/docs/events/refund-address-lapsed","k":"Event","w":"refund","x":"refund address lapsed refund The refund.address_lapsed webhook event: The payer gave no address within 14 days. Example payload and every field."},{"t":"payout_batch.created","u":"/docs/events/payout-batch-created","k":"Event","w":"payout_batch","x":"payout batch created payout_batch The payout_batch.created webhook event: A batch was requested. Example payload and every field."},{"t":"payout_batch.processing","u":"/docs/events/payout-batch-processing","k":"Event","w":"payout_batch","x":"payout batch processing payout_batch The payout_batch.processing webhook event: The batch was approved; its rows are being signed and sent. Example payload and every field."},{"t":"payout_batch.completed","u":"/docs/events/payout-batch-completed","k":"Event","w":"payout_batch","x":"payout batch completed payout_batch The payout_batch.completed webhook event: Every row is final. Example payload and every field."},{"t":"payout_batch.needs_attention","u":"/docs/events/payout-batch-needs-attention","k":"Event","w":"payout_batch","x":"payout batch needs attention payout_batch The payout_batch.needs_attention webhook event: At least one row is unknown. Example payload and every field."},{"t":"payout_batch.cancelled","u":"/docs/events/payout-batch-cancelled","k":"Event","w":"payout_batch","x":"payout batch cancelled payout_batch The payout_batch.cancelled webhook event: The batch was withdrawn or rejected before approval. Example payload and every field."},{"t":"saved_address.created","u":"/docs/events/saved-address-created","k":"Event","w":"saved_address","x":"saved address created saved_address The saved_address.created webhook event: A saved address was proposed. Example payload and every field."},{"t":"saved_address.approved","u":"/docs/events/saved-address-approved","k":"Event","w":"saved_address","x":"saved address approved saved_address The saved_address.approved webhook event: A key-holding member approved it; the 24-hour wait began. Example payload and every field."},{"t":"saved_address.active","u":"/docs/events/saved-address-active","k":"Event","w":"saved_address","x":"saved address active saved_address The saved_address.active webhook event: The wait is over; payouts to it can be requested. Example payload and every field."},{"t":"saved_address.removed","u":"/docs/events/saved-address-removed","k":"Event","w":"saved_address","x":"saved address removed saved_address The saved_address.removed webhook event: It was removed. Example payload and every field."},{"t":"invoice.created","u":"/docs/events/invoice-created","k":"Event","w":"invoice","x":"invoice created invoice The invoice.created webhook event: A draft was created. Example payload and every field."},{"t":"invoice.finalized","u":"/docs/events/invoice-finalized","k":"Event","w":"invoice","x":"invoice finalized invoice The invoice.finalized webhook event: The invoice got its number, order and page. Example payload and every field."},{"t":"invoice.sent","u":"/docs/events/invoice-sent","k":"Event","w":"invoice","x":"invoice sent invoice The invoice.sent webhook event: The invoice email was accepted for sending. Example payload and every field."},{"t":"invoice.overdue","u":"/docs/events/invoice-overdue","k":"Event","w":"invoice","x":"invoice overdue invoice The invoice.overdue webhook event: The due date passed unpaid (at the end of that day in the merchant's time zone). Example payload and every field."},{"t":"invoice.paid","u":"/docs/events/invoice-paid","k":"Event","w":"invoice","x":"invoice paid invoice The invoice.paid webhook event: The invoice's order became paid or overpaid. Example payload and every field."},{"t":"invoice.voided","u":"/docs/events/invoice-voided","k":"Event","w":"invoice","x":"invoice voided invoice The invoice.voided webhook event: The invoice was voided. Example payload and every field."},{"t":"payment_link.created","u":"/docs/events/payment-link-created","k":"Event","w":"payment_link","x":"payment link created payment_link The payment_link.created webhook event: A link was created. Example payload and every field."},{"t":"payment_link.updated","u":"/docs/events/payment-link-updated","k":"Event","w":"payment_link","x":"payment link updated payment_link The payment_link.updated webhook event: A link was changed. Example payload and every field."},{"t":"payment_link.deactivated","u":"/docs/events/payment-link-deactivated","k":"Event","w":"payment_link","x":"payment link deactivated payment_link The payment_link.deactivated webhook event: The link was switched off, reached max_uses or passed expires_at. Example payload and every field."},{"t":"product.created","u":"/docs/events/product-created","k":"Event","w":"product","x":"product created product The product.created webhook event: A product was created. Example payload and every field."},{"t":"product.updated","u":"/docs/events/product-updated","k":"Event","w":"product","x":"product updated product The product.updated webhook event: A product was changed or archived. Example payload and every field."},{"t":"price.created","u":"/docs/events/price-created","k":"Event","w":"price","x":"price created price The price.created webhook event: A price was created. Example payload and every field."},{"t":"price.updated","u":"/docs/events/price-updated","k":"Event","w":"price","x":"price updated price The price.updated webhook event: A price was archived or renamed. Example payload and every field."},{"t":"customer.created","u":"/docs/events/customer-created","k":"Event","w":"customer","x":"customer created customer The customer.created webhook event: A customer was created by the API, the dashboard or a checkout that collected an email. Example payload and every field."},{"t":"customer.updated","u":"/docs/events/customer-updated","k":"Event","w":"customer","x":"customer updated customer The customer.updated webhook event: A customer was changed, including a new refund address or a change of credit_balance. Example payload and every field."},{"t":"customer.deleted","u":"/docs/events/customer-deleted","k":"Event","w":"customer (deleted)","x":"customer deleted customer (deleted) The customer.deleted webhook event: A customer's personal data was erased. Example payload and every field."},{"t":"subscription.created","u":"/docs/events/subscription-created","k":"Event","w":"subscription","x":"subscription created subscription The subscription.created webhook event: A subscription was created with its first order. Example payload and every field."},{"t":"subscription.activated","u":"/docs/events/subscription-activated","k":"Event","w":"subscription","x":"subscription activated subscription The subscription.activated webhook event: The first order was paid; the first period began. Example payload and every field."},{"t":"subscription.renewal_due","u":"/docs/events/subscription-renewal-due","k":"Event","w":"subscription","x":"subscription renewal due subscription The subscription.renewal_due webhook event: The next period's order was created (7 days before the period end by default). Example payload and every field."},{"t":"subscription.renewed","u":"/docs/events/subscription-renewed","k":"Event","w":"subscription","x":"subscription renewed subscription The subscription.renewed webhook event: A period order was paid. Example payload and every field."},{"t":"subscription.past_due","u":"/docs/events/subscription-past-due","k":"Event","w":"subscription","x":"subscription past due subscription The subscription.past_due webhook event: The period ended with its renewal order unpaid. Example payload and every field."},{"t":"subscription.unpaid","u":"/docs/events/subscription-unpaid","k":"Event","w":"subscription","x":"subscription unpaid subscription The subscription.unpaid webhook event: Grace ended unpaid and the renewal order expired. Example payload and every field."},{"t":"subscription.ended","u":"/docs/events/subscription-ended","k":"Event","w":"subscription","x":"subscription ended subscription The subscription.ended webhook event: 30 days passed in unpaid. Example payload and every field."},{"t":"subscription.incomplete_expired","u":"/docs/events/subscription-incomplete-expired","k":"Event","w":"subscription","x":"subscription incomplete expired subscription The subscription.incomplete_expired webhook event: The first order expired unpaid. Example payload and every field."},{"t":"subscription.payment_reverted","u":"/docs/events/subscription-payment-reverted","k":"Event","w":"subscription","x":"subscription payment reverted subscription The subscription.payment_reverted webhook event: A payment on a period order was undone by the chain. Example payload and every field."},{"t":"subscription.paused","u":"/docs/events/subscription-paused","k":"Event","w":"subscription","x":"subscription paused subscription The subscription.paused webhook event: The subscription was paused. Example payload and every field."},{"t":"subscription.resumed","u":"/docs/events/subscription-resumed","k":"Event","w":"subscription","x":"subscription resumed subscription The subscription.resumed webhook event: The subscription was resumed. Example payload and every field."},{"t":"subscription.updated","u":"/docs/events/subscription-updated","k":"Event","w":"subscription","x":"subscription updated subscription The subscription.updated webhook event: Items, reminder days, grace days, prepaid choices, proration, metadata or… Example payload and every field."},{"t":"subscription.cancelled","u":"/docs/events/subscription-cancelled","k":"Event","w":"subscription","x":"subscription cancelled subscription The subscription.cancelled webhook event: The subscription was cancelled, at once or at the period end. Example payload and every field."},{"t":"receipt.created","u":"/docs/events/receipt-created","k":"Event","w":"receipt","x":"receipt created receipt The receipt.created webhook event: A receipt was created for a paid order. Example payload and every field."},{"t":"wallet.deploying","u":"/docs/events/wallet-deploying","k":"Event","w":"wallet","x":"wallet deploying wallet The wallet.deploying webhook event: The wallet's first send was approved and its deployment transaction was broadcast. Example payload and every field."},{"t":"wallet.active","u":"/docs/events/wallet-active","k":"Event","w":"wallet","x":"wallet active wallet The wallet.active webhook event: The wallet is deployed and can send. Example payload and every field."},{"t":"fee_account.low","u":"/docs/events/fee-account-low","k":"Event","w":"fee_account","x":"fee account low fee_account The fee_account.low webhook event: A fee key fell below its low mark on a network. Example payload and every field."},{"t":"fee_account.topped_up","u":"/docs/events/fee-account-topped-up","k":"Event","w":"fee_account","x":"fee account topped up fee_account The fee_account.topped_up webhook event: An order between US$1 and US$10 was delivered as the network's own coin to the fee… Example payload and every field."},{"t":"export.ready","u":"/docs/events/export-ready","k":"Event","w":"export","x":"export ready export The export.ready webhook event: The export file can be downloaded. Example payload and every field."},{"t":"export.failed","u":"/docs/events/export-failed","k":"Event","w":"export","x":"export failed export The export.failed webhook event: The export could not be built. Example payload and every field."},{"t":"merchant.tier_changed","u":"/docs/events/merchant-tier-changed","k":"Event","w":"merchant","x":"merchant tier changed merchant The merchant.tier_changed webhook event: The tier changed (verification started, passed or failed). Example payload and every field."},{"t":"merchant.limit_approaching","u":"/docs/events/merchant-limit-approaching","k":"Event","w":"merchant","x":"merchant limit approaching merchant The merchant.limit_approaching webhook event: A volume limit reached 80% (sent once per limit per window). Example payload and every field."},{"t":"merchant.restricted","u":"/docs/events/merchant-restricted","k":"Event","w":"merchant","x":"merchant restricted merchant The merchant.restricted webhook event: New orders are switched off for this merchant. Example payload and every field."},{"t":"merchant.unrestricted","u":"/docs/events/merchant-unrestricted","k":"Event","w":"merchant","x":"merchant unrestricted merchant The merchant.unrestricted webhook event: The restriction was lifted. Example payload and every field."},{"t":"member.invited","u":"/docs/events/member-invited","k":"Event","w":"member","x":"member invited member The member.invited webhook event: A member was invited. Example payload and every field."},{"t":"member.joined","u":"/docs/events/member-joined","k":"Event","w":"member","x":"member joined member The member.joined webhook event: An invitation was accepted. Example payload and every field."},{"t":"member.role_changed","u":"/docs/events/member-role-changed","k":"Event","w":"member","x":"member role changed member The member.role_changed webhook event: A member's role changed. Example payload and every field."},{"t":"member.removed","u":"/docs/events/member-removed","k":"Event","w":"member","x":"member removed member The member.removed webhook event: A member was removed or an invitation revoked. Example payload and every field."},{"t":"api_key.created","u":"/docs/events/api-key-created","k":"Event","w":"api_key","x":"api key created api_key The api_key.created webhook event: A key was created. Example payload and every field."},{"t":"api_key.rolled","u":"/docs/events/api-key-rolled","k":"Event","w":"api_key","x":"api key rolled api_key The api_key.rolled webhook event: A key was rolled; data.object is the old key, now with an end time. Example payload and every field."},{"t":"api_key.revoked","u":"/docs/events/api-key-revoked","k":"Event","w":"api_key","x":"api key revoked api_key The api_key.revoked webhook event: A key was revoked or reached expires_at. Example payload and every field."},{"t":"webhook_endpoint.disabled","u":"/docs/events/webhook-endpoint-disabled","k":"Event","w":"webhook_endpoint","x":"webhook endpoint disabled webhook_endpoint The webhook_endpoint.disabled webhook event: Deliveries to an endpoint failed for 7 days running and it was switched off. Example payload and every field."},{"t":"order.screening_hold","u":"/docs/events/order-screening-hold","k":"Event","w":"order","x":"order screening hold order The order.screening_hold webhook event: The order's money has arrived and been credited, but a payer address screened as… Example payload and every field."},{"t":"order.screening_released","u":"/docs/events/order-screening-released","k":"Event","w":"order","x":"order screening released order The order.screening_released webhook event: The hold ended: a member marked a review as reviewed (reviewed), the check could… Example payload and every field."},{"t":"api_key_missing","u":"/docs/errors#api_key_missing","k":"Error","w":"401 authentication_error","x":"No Authorization: Bearer header."},{"t":"api_key_invalid","u":"/docs/errors#api_key_invalid","k":"Error","w":"401 authentication_error","x":"The key is not one Orrerie issued, or is malformed."},{"t":"api_key_revoked","u":"/docs/errors#api_key_revoked","k":"Error","w":"401 authentication_error","x":"The key was revoked or its roll window ended."},{"t":"api_key_expired","u":"/docs/errors#api_key_expired","k":"Error","w":"401 authentication_error","x":"The key passed its expires_at ."},{"t":"secret_key_in_browser","u":"/docs/errors#secret_key_in_browser","k":"Error","w":"403 authentication_error","x":"A secret key arrived with an Origin header. Secret keys are for servers; the key is flagged in the dashboard and the Owners are emailed."},{"t":"ip_not_allowed","u":"/docs/errors#ip_not_allowed","k":"Error","w":"403 permission_error","x":"The caller's IP address is not in the key's allowed_ips ."},{"t":"insufficient_scope","u":"/docs/errors#insufficient_scope","k":"Error","w":"403 permission_error","x":"The key lacks the scope the endpoint needs; error.scope names it."},{"t":"publishable_key_not_allowed","u":"/docs/errors#publishable_key_not_allowed","k":"Error","w":"403 permission_error","x":"The endpoint, or a parameter sent, cannot be used with a pk_ key."},{"t":"passkey_approval_required","u":"/docs/errors#passkey_approval_required","k":"Error","w":"403 permission_error","x":"The action can only be done by a signed-in member in the dashboard (settlement asset, key-holding roles, approvals). No API key can do it."},{"t":"merchant_restricted","u":"/docs/errors#merchant_restricted","k":"Error","w":"403 permission_error","x":"The merchant is restricted: new orders, payouts to others and conversions are off. Reads and withdrawals to saved addresses work."},{"t":"verification_required","u":"/docs/errors#verification_required","k":"Error","w":"403 limit_error","x":"The feature or value needs the Verified tier."},{"t":"test_helper_in_live_mode","u":"/docs/errors#test_helper_in_live_mode","k":"Error","w":"403 permission_error","x":"A /v1/test/... endpoint was called with a live key."},{"t":"invalid_json","u":"/docs/errors#invalid_json","k":"Error","w":"400 invalid_request_error","x":"The body is not valid JSON, or not a JSON object."},{"t":"unsupported_media_type","u":"/docs/errors#unsupported_media_type","k":"Error","w":"415 invalid_request_error","x":"The body is not application/json (or multipart/form-data for a file upload)."},{"t":"request_too_large","u":"/docs/errors#request_too_large","k":"Error","w":"413 invalid_request_error","x":"The body is over 256 KB (5 MB for a file upload)."},{"t":"method_not_allowed","u":"/docs/errors#method_not_allowed","k":"Error","w":"405 invalid_request_error","x":"The path exists but not with this method."},{"t":"route_not_found","u":"/docs/errors#route_not_found","k":"Error","w":"404 invalid_request_error","x":"No such path."},{"t":"version_unsupported","u":"/docs/errors#version_unsupported","k":"Error","w":"400 invalid_request_error","x":"The Orrerie-Version header names a version that does not exist or was retired."},{"t":"parameter_missing","u":"/docs/errors#parameter_missing","k":"Error","w":"400 invalid_request_error","x":"A required parameter is absent; error.param names it."},{"t":"parameter_invalid","u":"/docs/errors#parameter_invalid","k":"Error","w":"400 invalid_request_error","x":"A parameter has the wrong type, format or range; error.param names it."},{"t":"parameter_unknown","u":"/docs/errors#parameter_unknown","k":"Error","w":"400 invalid_request_error","x":"A parameter the endpoint does not take was sent. Unknown parameters are refused, not ignored, so that a typo cannot silently drop a field."},{"t":"parameters_exclusive","u":"/docs/errors#parameters_exclusive","k":"Error","w":"400 invalid_request_error","x":"Two parameters that cannot be combined were sent (for example amount and line_items )."},{"t":"metadata_invalid","u":"/docs/errors#metadata_invalid","k":"Error","w":"400 invalid_request_error","x":"More than 50 keys, a key over 40 characters, a value over 500 characters, or a non-string value."},{"t":"url_invalid","u":"/docs/errors#url_invalid","k":"Error","w":"400 invalid_request_error","x":"Not https , has credentials, is over 2,048 characters, or (webhooks) resolves to a private address."},{"t":"amount_invalid","u":"/docs/errors#amount_invalid","k":"Error","w":"400 invalid_request_error","x":"Not a decimal string, negative, zero, or more decimal places than the currency has."},{"t":"amount_below_minimum","u":"/docs/errors#amount_below_minimum","k":"Error","w":"400 invalid_request_error","x":"Below the minimum: US$1.00 for an order payable on the relay rail, the network dust limit on the direct rail or for a payout."},{"t":"currency_unsupported","u":"/docs/errors#currency_unsupported","k":"Error","w":"400 invalid_request_error","x":"Not a pricing currency the platform has a rate for."},{"t":"asset_unsupported","u":"/docs/errors#asset_unsupported","k":"Error","w":"400 invalid_request_error","x":"Not an asset id from GET /v1/assets , or not usable for this purpose."},{"t":"asset_not_enabled","u":"/docs/errors#asset_not_enabled","k":"Error","w":"400 invalid_request_error","x":"The asset exists but is not switched on for this merchant."},{"t":"settlement_invalid","u":"/docs/errors#settlement_invalid","k":"Error","w":"400 invalid_request_error","x":"settle names something that cannot be a settlement asset for this merchant."},{"t":"destination_invalid","u":"/docs/errors#destination_invalid","k":"Error","w":"400 invalid_request_error","x":"The address fails the network's format or checksum, or does not match the asset's network."},{"t":"event_type_unknown","u":"/docs/errors#event_type_unknown","k":"Error","w":"400 invalid_request_error","x":"An entry of enabled_events is not an event type."},{"t":"file_type_not_allowed","u":"/docs/errors#file_type_not_allowed","k":"Error","w":"400 invalid_request_error","x":"The upload is not PNG, JPEG, WebP or PDF, or its content does not match its type."},{"t":"file_too_large","u":"/docs/errors#file_too_large","k":"Error","w":"413 invalid_request_error","x":"The upload is over 5 MB."},{"t":"simulation_invalid","u":"/docs/errors#simulation_invalid","k":"Error","w":"400 invalid_request_error","x":"The test scenario cannot apply to the object in its present state."},{"t":"livemode_mismatch","u":"/docs/errors#livemode_mismatch","k":"Error","w":"400 invalid_request_error","x":"An id of the other mode was used: a test key naming a live object or the reverse."},{"t":"resource_missing","u":"/docs/errors#resource_missing","k":"Error","w":"404 not_found_error","x":"No object with that id belongs to this merchant in this mode."},{"t":"idempotency_key_required","u":"/docs/errors#idempotency_key_required","k":"Error","w":"400 idempotency_error","x":"The endpoint moves money on approval (refunds, payouts, batches, conversions, saved addresses) and needs an Idempotency-Key ."},{"t":"idempotency_key_invalid","u":"/docs/errors#idempotency_key_invalid","k":"Error","w":"400 idempotency_error","x":"The key is empty, over 255 characters or has characters outside printable ASCII."},{"t":"idempotency_key_reused","u":"/docs/errors#idempotency_key_reused","k":"Error","w":"422 idempotency_error","x":"The key was already used with a different method, path or body."},{"t":"request_in_progress","u":"/docs/errors#request_in_progress","k":"Error","w":"409 idempotency_error","x":"The first request with this key is still running. Retry after Retry-After seconds."},{"t":"order_not_open","u":"/docs/errors#order_not_open","k":"Error","w":"409 state_error","x":"The order is not open (or underpaid , for a top-up instruction)."},{"t":"order_not_payable","u":"/docs/errors#order_not_payable","k":"Error","w":"409 state_error","x":"The order is cancelled , or already paid / overpaid ."},{"t":"order_not_underpaid","u":"/docs/errors#order_not_underpaid","k":"Error","w":"409 state_error","x":"Only an underpaid order can be accepted as paid."},{"t":"order_not_overpaid","u":"/docs/errors#order_not_overpaid","k":"Error","w":"409 state_error","x":"Only an overpaid order with an unresolved excess has an overpayment to keep."},{"t":"order_not_refundable","u":"/docs/errors#order_not_refundable","k":"Error","w":"409 state_error","x":"The order has nothing paid, or everything paid is already refunded or in a refund request."},{"t":"instruction_in_flight","u":"/docs/errors#instruction_in_flight","k":"Error","w":"409 state_error","x":"A payment for this order is on its way (an instruction is detected ). Wait for it to settle, then refund if needed."},{"t":"order_has_payment","u":"/docs/errors#order_has_payment","k":"Error","w":"409 state_error","x":"The order has a payment, so it cannot be cancelled or voided. Refund it instead."},{"t":"instruction_limit_reached","u":"/docs/errors#instruction_limit_reached","k":"Error","w":"409 state_error","x":"The order has had 20 payment instructions, the most allowed. Create a new order."},{"t":"money_out_not_draft","u":"/docs/errors#money_out_not_draft","k":"Error","w":"409 state_error","x":"Only a draft whose approval lapsed can be submitted again."},{"t":"instruction_live","u":"/docs/errors#instruction_live","k":"Error","w":"409 state_error","x":"The order already has a live instruction on another asset; error.instruction is its id."},{"t":"session_not_open","u":"/docs/errors#session_not_open","k":"Error","w":"409 state_error","x":"The checkout session is completed or expired ."},{"t":"customer_required","u":"/docs/errors#customer_required","k":"Error","w":"409 state_error","x":"The action needs the order to have a customer."},{"t":"customer_email_required","u":"/docs/errors#customer_email_required","k":"Error","w":"409 state_error","x":"The customer or order has no email address."},{"t":"customer_has_active_subscription","u":"/docs/errors#customer_has_active_subscription","k":"Error","w":"409 state_error","x":"Cancel the customer's subscriptions first."},{"t":"member_exists","u":"/docs/errors#member_exists","k":"Error","w":"409 state_error","x":"That email is already a member or has a pending invitation."},{"t":"invoice_not_draft","u":"/docs/errors#invoice_not_draft","k":"Error","w":"409 state_error","x":"Only a draft invoice can be finalized or deleted."},{"t":"invoice_not_open","u":"/docs/errors#invoice_not_open","k":"Error","w":"409 state_error","x":"Only an open invoice can be sent or voided."},{"t":"invoice_not_editable","u":"/docs/errors#invoice_not_editable","k":"Error","w":"409 state_error","x":"The field cannot change in the invoice's present state."},{"t":"price_not_recurring","u":"/docs/errors#price_not_recurring","k":"Error","w":"409 state_error","x":"A subscription item names a one_time price, or items mix intervals or currencies."},{"t":"price_inactive","u":"/docs/errors#price_inactive","k":"Error","w":"409 state_error","x":"The price or its product is archived."},{"t":"payment_link_inactive","u":"/docs/errors#payment_link_inactive","k":"Error","w":"409 state_error","x":"The link is switched off, used up or expired."},{"t":"subscription_not_active","u":"/docs/errors#subscription_not_active","k":"Error","w":"409 state_error","x":"Only an active or past_due subscription can be paused."},{"t":"subscription_not_paused","u":"/docs/errors#subscription_not_paused","k":"Error","w":"409 state_error","x":"Only a paused subscription can be resumed."},{"t":"payment_not_unmatched","u":"/docs/errors#payment_not_unmatched","k":"Error","w":"409 state_error","x":"The payment already belongs to an order."},{"t":"refund_amount_exceeds_refundable","u":"/docs/errors#refund_amount_exceeds_refundable","k":"Error","w":"409 state_error","x":"More than amount_paid minus refunds confirmed or in request; error.refundable gives the figure."},{"t":"money_out_not_cancellable","u":"/docs/errors#money_out_not_cancellable","k":"Error","w":"409 state_error","x":"The request is signed or later. A signed transaction cannot be withdrawn."},{"t":"saved_address_not_usable","u":"/docs/errors#saved_address_not_usable","k":"Error","w":"409 state_error","x":"The saved address is awaiting_approval , waiting ( error.usable_at says until when) or removed ."},{"t":"insufficient_balance","u":"/docs/errors#insufficient_balance","k":"Error","w":"409 state_error","x":"The available balance (amount minus reserved) of the source asset is too low; error.available gives it."},{"t":"fee_account_low","u":"/docs/errors#fee_account_low","k":"Error","w":"409 state_error","x":"The fee account cannot pay the network fee. error.needed says how much of which coin on which network must be held, for example {\"asset\": \"tron:trx\", \"amount\": \"30\"} ."},{"t":"conversion_no_route","u":"/docs/errors#conversion_no_route","k":"Error","w":"409 state_error","x":"The chosen venue has no route for this pair or amount now. error.offers_url lists what every venue says."},{"t":"quote_expired","u":"/docs/errors#quote_expired","k":"Error","w":"409 state_error","x":"The quote behind the request passed its 15 minutes."},{"t":"webhook_endpoint_disabled","u":"/docs/errors#webhook_endpoint_disabled","k":"Error","w":"409 state_error","x":"Re-enable the endpoint before resending to it."},{"t":"event_expired","u":"/docs/errors#event_expired","k":"Error","w":"409 state_error","x":"The event is older than 30 days."},{"t":"file_in_use","u":"/docs/errors#file_in_use","k":"Error","w":"409 state_error","x":"The file is a logo, product image or attachment in use, or was generated by the platform."},{"t":"rail_not_allowed","u":"/docs/errors#rail_not_allowed","k":"Error","w":"400 invalid_request_error","x":"The rail is off for this order, merchant or asset (for example relay for Litecoin)."},{"t":"tier_order_limit","u":"/docs/errors#tier_order_limit","k":"Error","w":"403 limit_error","x":"error.limit is single_order : over the tier's single-order maximum (US$1,000 Unverified, US$50,000 Verified). Or first_orders : an Unverified merchant's first three paid orders may be at most US$250 each (\"Your first three orders can be up to US$250 each.\")."},{"t":"wallet_not_activated","u":"/docs/errors#wallet_not_activated","k":"Error","w":"409 state_error","x":"The order would settle in, or be paid directly to, a Solana or TRON wallet that is not yet activated. Until activation that wallet is behind one key, so it is not used. error.wallet is its id; activate it in the dashboard."},{"t":"refund_wallet_not_protected","u":"/docs/errors#refund_wallet_not_protected","k":"Error","w":"409 state_error","x":"The payer chose Solana or TRON, the merchant's wallet there is not activated, and it already holds more than its cap (US$20 on Solana, the value of 100 TRX on TRON). No further instruction with that payer network is issued until the wallet is activated."},{"t":"browser_key_backup_required","u":"/docs/errors#browser_key_backup_required","k":"Error","w":"409 state_error","x":"Live mode only: the merchant has not saved its browser key backup, so live orders cannot be created yet."},{"t":"own_limit_reached","u":"/docs/errors#own_limit_reached","k":"Error","w":"403 limit_error","x":"A withdrawal to the merchant's own saved address would pass the merchant's own safety limit for the last 24 hours (default US$10,000 Unverified, US$100,000 Verified)."},{"t":"split_rule_invalid","u":"/docs/errors#split_rule_invalid","k":"Error","w":"400 invalid_request_error","x":"Shares total more than 100%, a share is not above zero, a saved address is not active or not of kind other , or the scope object does not exist."},{"t":"tier_volume_limit","u":"/docs/errors#tier_volume_limit","k":"Error","w":"403 limit_error","x":"error.window is 30_days : paid orders and unmatched payments you kept in the last 30 days, plus this one, would pass the tier limit (US$5,000 / US$250,000). Or lifetime : an Unverified merchant passed US$20,000 of such takings in total and must verify to create new orders. A reverted payment is taken back out."},{"t":"tier_open_orders_limit","u":"/docs/errors#tier_open_orders_limit","k":"Error","w":"403 limit_error","x":"50 (Unverified) or 2,000 (Verified) unpaid orders are open. Cancel or let some expire."},{"t":"payout_daily_limit_reached","u":"/docs/errors#payout_daily_limit_reached","k":"Error","w":"403 limit_error","x":"Payouts to others in the last 24 hours (payouts, split legs and refunds to a saved address) plus this one would pass US$1,000 (Unverified) or US$100,000 (Verified). Withdrawals to own saved addresses have no tier limit."},{"t":"payout_batch_not_allowed","u":"/docs/errors#payout_batch_not_allowed","k":"Error","w":"403 limit_error","x":"Batches need the Verified tier."},{"t":"payout_batch_too_large","u":"/docs/errors#payout_batch_too_large","k":"Error","w":"400 invalid_request_error","x":"More than 200 rows, or more than 50 rows sent from one EVM network."},{"t":"member_limit_reached","u":"/docs/errors#member_limit_reached","k":"Error","w":"403 limit_error","x":"2 (Unverified) or 25 (Verified) members, counting pending invitations."},{"t":"key_limit_reached","u":"/docs/errors#key_limit_reached","k":"Error","w":"403 limit_error","x":"2 (Unverified) or 20 (Verified) live keys. Test keys: 20 in either tier."},{"t":"webhook_endpoint_limit_reached","u":"/docs/errors#webhook_endpoint_limit_reached","k":"Error","w":"403 limit_error","x":"1 (Unverified) or 10 (Verified) endpoints per mode."},{"t":"export_limit_reached","u":"/docs/errors#export_limit_reached","k":"Error","w":"429 rate_limit_error","x":"More than 10 exports in an hour."},{"t":"export_too_large","u":"/docs/errors#export_too_large","k":"Error","w":"400 invalid_request_error","x":"The filters match more than 500,000 rows. Narrow the dates."},{"t":"email_limit_reached","u":"/docs/errors#email_limit_reached","k":"Error","w":"429 rate_limit_error","x":"More than 5 sends of the same invoice or receipt in 24 hours."},{"t":"rate_limit_exceeded","u":"/docs/errors#rate_limit_exceeded","k":"Error","w":"429 rate_limit_error","x":"Too many requests. Wait Retry-After seconds."},{"t":"destination_blocked","u":"/docs/errors#destination_blocked","k":"Error","w":"403 permission_error","x":"The destination address is on a sanctions list. The request is refused and recorded."},{"t":"screening_unavailable","u":"/docs/errors#screening_unavailable","k":"Error","w":"503 provider_error","x":"The sanctions check could not be made. A failed check is never treated as clean; retry later."},{"t":"rail_unavailable","u":"/docs/errors#rail_unavailable","k":"Error","w":"503 provider_error","x":"The rail cannot be used now. error.reason is the exact refusal: relay_unavailable , relay_no_route , relay_amount_too_low , relay_low_liquidity , relay_paused , route_fee_over_cap , provider_route_mismatch , provider_deposit_mismatch , refund_wallet_unavailable , recipient_not_attested , or asset_not_covered ; error.available_assets lists what can be used instead. Nothing was created at the provider and nothing was switched."},{"t":"price_unavailable","u":"/docs/errors#price_unavailable","k":"Error","w":"503 provider_error","x":"No fresh price for the asset or currency. A stale price is never used for a quote."},{"t":"provider_error","u":"/docs/errors#provider_error","k":"Error","w":"502 provider_error","x":"An outside service answered wrongly. No provider record was left half-made; safe to retry with the same idempotency key."},{"t":"merchant_worker_waking","u":"/docs/errors#merchant_worker_waking","k":"Error","w":"503 api_error","x":"The merchant's own server process was asleep and is starting. Retry after Retry-After (2 seconds)."},{"t":"outcome_unknown","u":"/docs/errors#outcome_unknown","k":"Error","w":"504 api_error","x":"The request may or may not have taken effect (the engine's instruction_unknown for a payment instruction). Retry with the same idempotency key ; never with a new one. For an instruction: show the payer nothing until it resolves."},{"t":"service_unavailable","u":"/docs/errors#service_unavailable","k":"Error","w":"503 api_error","x":"The API is briefly unavailable (deploy or overload). Retry with backoff."},{"t":"internal_error","u":"/docs/errors#internal_error","k":"Error","w":"500 api_error","x":"A fault on Orrerie's side. Quote request_id to support."},{"t":"https_required","u":"/docs/errors#https_required","k":"Error","w":"400 invalid_request_error","x":"The request did not arrive over HTTPS. Nothing was done; a key sent in the clear should be rolled."},{"t":"cookie_not_allowed","u":"/docs/errors#cookie_not_allowed","k":"Error","w":"400 invalid_request_error","x":"The request carried a cookie. This host takes no cookie. Send the key in the Authorization header only."},{"t":"secret_scanning_signature_invalid","u":"/docs/errors#secret_scanning_signature_invalid","k":"Error","w":"401 authentication_error","x":"Answered only on POST /v1/_secret_scanning , which GitHub's secret scanning partner programme calls when it finds an Orrerie secret key in public code. The report is not signed by a GitHub key Orrerie holds, so nothing was changed. Your own integration never calls this address."},{"t":"accent_too_dark","u":"/docs/errors#accent_too_dark","k":"Error","w":"400 invalid_request_error","x":"The accent colour does not reach a contrast of 4.5:1 against the checkout's dark field, or no text colour reads on it at 4.5:1; see reason . Choose a lighter colour. reason is field (the dark field) or ink (the text on it); the dashboard checks the same rule while you type."},{"t":"accepted_assets_empty","u":"/docs/errors#accepted_assets_empty","k":"Error","w":"400 invalid_request_error","x":"The change would switch off every way to pay. Keep at least one accepted asset switched on."},{"t":"batch_network_required","u":"/docs/errors#batch_network_required","k":"Error","w":"400 invalid_request_error","x":"The rows of the batch that wait for approval are on more than one network, so the network to approve must be named."},{"t":"payout_batch_invalid","u":"/docs/errors#payout_batch_invalid","k":"Error","w":"400 invalid_request_error","x":"A payout batch has rows that cannot be paid. errors lists each bad row with its own code, and nothing of the batch was created."},{"t":"target_same_order","u":"/docs/errors#target_same_order","k":"Error","w":"400 invalid_request_error","x":"A payment can be moved only to another order, never to the order it is on."},{"t":"payer_email_off","u":"/docs/errors#payer_email_off","k":"Error","w":"403 permission_error","x":"Orrerie does not email payers in this release, so nothing was sent. Give the customer the link yourself; retrying does not change this. Answered by POST /v1/invoices/{id}/send , POST /v1/receipts/{id}/send and an invoice's finalize with send: true ."},{"t":"merchant_closing","u":"/docs/errors#merchant_closing","k":"Error","w":"403 permission_error","x":"The business is closing: new orders, payment links and invoices are off, and money goes out only to its own saved addresses. Reads, exports and withdrawals to saved addresses work until it closes."},{"t":"app_pay_not_allowed","u":"/docs/errors#app_pay_not_allowed","k":"Error","w":"403 permission_error","x":"The business does not take payment through the Orrerie app, or the app did not say which account pays."},{"t":"link_secret_invalid","u":"/docs/errors#link_secret_invalid","k":"Error","w":"403 permission_error","x":"The secret in a single-use link does not match: the link was changed, or it is not the one that was sent."},{"t":"file_limit_reached","u":"/docs/errors#file_limit_reached","k":"Error","w":"403 limit_error","x":"The business has 500 stored pictures, the most it may have; see limit . Delete one it no longer uses first. A picture is deleted with DELETE /v1/files/{id} ; uploading the same picture again answers the file already stored."},{"t":"product_limit_reached","u":"/docs/errors#product_limit_reached","k":"Error","w":"403 limit_error","x":"The account has 500 products that are not archived, or this product has 20 prices that are not archived; see reason and limit . Archive one first."},{"t":"support_email_required","u":"/docs/errors#support_email_required","k":"Error","w":"409 state_error","x":"The business has no support email yet, and no order can be created without one, in test mode too. A member adds it in the dashboard under Settings, Business profile, Support email ; then retry."},{"t":"link_open_orders_limit","u":"/docs/errors#link_open_orders_limit","k":"Error","w":"409 state_error","x":"The payment link has 32 unpaid orders open, or has taken 240 orders in 24 hours, the most allowed. Open orders expire by themselves; retry later."},{"t":"asset_not_available","u":"/docs/errors#asset_not_available","k":"Error","w":"409 state_error","x":"The asset cannot be switched on, because no rail takes it now. The dashboard shows it as Not available yet."},{"t":"order_has_instruction","u":"/docs/errors#order_has_instruction","k":"Error","w":"409 state_error","x":"The order already has payment details or a payment, so its amount or its periods can no longer be changed."},{"t":"subscription_ended","u":"/docs/errors#subscription_ended","k":"Error","w":"409 state_error","x":"The subscription has ended, ends at the close of this period, or has no period left, so this change can no longer be made."},{"t":"link_used","u":"/docs/errors#link_used","k":"Error","w":"410 state_error","x":"The single-use link was already used."},{"t":"link_expired","u":"/docs/errors#link_expired","k":"Error","w":"410 state_error","x":"The single-use link has expired. Ask for a new one."},{"t":"check_window_closed","u":"/docs/errors#check_window_closed","k":"Error","w":"409 state_error","x":"An address can be checked again for 12 months after its payment instruction expired, and that time has passed."},{"t":"rail_not_direct","u":"/docs/errors#rail_not_direct","k":"Error","w":"409 state_error","x":"For this order the asset is not paid on the direct rail; rail names the rail it is paid on. Nothing was created."},{"t":"rail_not_relay","u":"/docs/errors#rail_not_relay","k":"Error","w":"409 state_error","x":"For this order the asset is not paid on the relay rail; rail names the rail it is paid on. Nothing was created."},{"t":"wallet_not_active","u":"/docs/errors#wallet_not_active","k":"Error","w":"409 state_error","x":"The wallet this needs is not in force: the business has not made its wallets yet, or the wallet on that network is not the one the request was made with. Nothing was done."},{"t":"wallet_needs_review","u":"/docs/errors#wallet_needs_review","k":"Error","w":"409 state_error","x":"The wallet holds less than Orrerie's records show, because money left it that nothing recorded. Money out from it waits until an Owner has reviewed the wallet in the dashboard."},{"t":"owner_change_pending","u":"/docs/errors#owner_change_pending","k":"Error","w":"409 state_error","x":"A change of the business's keys is waiting or finishing, so this cannot be approved now; reason names the case. Payouts to anyone else wait until the change has ended. Withdrawals to the business's own saved addresses still go ahead."},{"t":"retention_hold","u":"/docs/errors#retention_hold","k":"Error","w":"409 state_error","x":"A legal hold keeps this business's records, so nothing can be erased or merged while it lasts."},{"t":"refund_open","u":"/docs/errors#refund_open","k":"Error","w":"409 state_error","x":"The order has a refund that has not ended, so the payer's data cannot be erased yet. Retry once the refund has ended."},{"t":"screening_pending","u":"/docs/errors#screening_pending","k":"Error","w":"409 state_error","x":"A live payment of the order is still waiting for its payer's screening, so the payer's data cannot be erased yet. Retry once the check has a result."},{"t":"balance_changed","u":"/docs/errors#balance_changed","k":"Error","w":"409 state_error","x":"The balance moved after the amount was worked out, so the amount no longer holds. Ask again for a fresh one."},{"t":"payment_not_confirmed","u":"/docs/errors#payment_not_confirmed","k":"Error","w":"409 state_error","x":"The payment is still confirming. It can be sent back once it is confirmed."},{"t":"payer_wallet_unknown","u":"/docs/errors#payer_wallet_unknown","k":"Error","w":"409 state_error","x":"The refund was asked to go back to the payer's Orrerie wallet, but the order has no record of one on this network, or the refund is more than that wallet paid. Refund to an address, or by a claim link, instead."},{"t":"refund_source_not_supported","u":"/docs/errors#refund_source_not_supported","k":"Error","w":"409 state_error","x":"Money that Relay returned can be paid back from another balance only from the order's settlement asset, and not when the order keeps what was paid."},{"t":"refund_rate_basis_unavailable","u":"/docs/errors#refund_rate_basis_unavailable","k":"Error","w":"409 state_error","x":"The order's own rate exists only for an asset the order was settled in. From this balance a refund can be paid only at today's value: send rate_basis today ."},{"t":"refund_not_approvable_yet","u":"/docs/errors#refund_not_approvable_yet","k":"Error","w":"409 state_error","x":"The refund goes to an address that was not saved before, so it waits 24 hours after the Owners were told; approvable_at says when it can be approved."},{"t":"waiting_notice","u":"/docs/errors#waiting_notice","k":"Error","w":"409 state_error","x":"The wait has not started, because the notice email to the Owners is not out yet. It can be approved once approvable_at is set and reached."},{"t":"refund_not_awaiting_address","u":"/docs/errors#refund_not_awaiting_address","k":"Error","w":"409 state_error","x":"The refund no longer waits for the payer's address; state says where it is."},{"t":"refund_not_routed","u":"/docs/errors#refund_not_routed","k":"Error","w":"409 state_error","x":"The refund is not sent through Relay, so it has no route to read or renew."},{"t":"payout_not_routed","u":"/docs/errors#payout_not_routed","k":"Error","w":"409 state_error","x":"The payout is not sent through Relay, so it has no route to read or renew."},{"t":"payout_in_batch","u":"/docs/errors#payout_in_batch","k":"Error","w":"409 state_error","x":"The payout is a row of a batch. It is approved with its batch, never alone."},{"t":"split_leg_held","u":"/docs/errors#split_leg_held","k":"Error","w":"409 state_error","x":"This share of a split payment is held, so it cannot be approved until the hold ends."},{"t":"split_order_not_paid","u":"/docs/errors#split_order_not_paid","k":"Error","w":"409 state_error","x":"The order this share of a split payment comes from is no longer paid, so the share cannot be paid out."},{"t":"approval_document_unsupported","u":"/docs/errors#approval_document_unsupported","k":"Error","w":"409 state_error","x":"This release cannot prepare the approval for what was asked, so nothing is offered for signing; reason says why. Ask for it in parts."},{"t":"money_out_not_signable","u":"/docs/errors#money_out_not_signable","k":"Error","w":"409 state_error","x":"The refund, payout, conversion or sweep no longer waits for approval, so it cannot be signed; state says where it is."},{"t":"money_out_not_signed","u":"/docs/errors#money_out_not_signed","k":"Error","w":"409 state_error","x":"The money-out has not been signed, so it cannot be sent; state says where it is."},{"t":"money_out_not_lapsable","u":"/docs/errors#money_out_not_lapsable","k":"Error","w":"409 state_error","x":"Only a money-out that waits for approval can lapse, and this one does not wait; state says where it is."},{"t":"conversion_not_prepared","u":"/docs/errors#conversion_not_prepared","k":"Error","w":"409 state_error","x":"The conversion has no order at its venue yet, so it cannot be approved. Ask for a new conversion."},{"t":"relay_delivery_expired","u":"/docs/errors#relay_delivery_expired","k":"Error","w":"409 state_error","x":"Relay's quote for this delivery has expired; expired_at says when. Ask for a new one."},{"t":"relay_delivery_not_prepared","u":"/docs/errors#relay_delivery_not_prepared","k":"Error","w":"409 state_error","x":"The delivery through Relay has no address yet, or its address or amount is not the one quoted. Ask for a new quote."},{"t":"sweep_not_offered","u":"/docs/errors#sweep_not_offered","k":"Error","w":"409 state_error","x":"Combining small coins is not offered on this wallet now; reason says why."},{"t":"sweep_in_progress","u":"/docs/errors#sweep_in_progress","k":"Error","w":"409 state_error","x":"The wallet is already combining its small coins. Wait for that to end."},{"t":"sweep_inputs_changed","u":"/docs/errors#sweep_inputs_changed","k":"Error","w":"409 state_error","x":"The coins to combine changed after the sweep was prepared; changed says how many. Prepare it again."},{"t":"screening_not_in_review","u":"/docs/errors#screening_not_in_review","k":"Error","w":"409 state_error","x":"The order's payer is not waiting for a screening decision, so there is nothing to decide; status says where it stands."},{"t":"screening_blocked","u":"/docs/errors#screening_blocked","k":"Error","w":"409 state_error","x":"The payer's address was blocked by screening, so this cannot go ahead."},{"t":"customer_credit_currency_mismatch","u":"/docs/errors#customer_credit_currency_mismatch","k":"Error","w":"409 state_error","x":"The customer's credit is held in another currency, so it cannot be used here."},{"t":"customer_credit_insufficient","u":"/docs/errors#customer_credit_insufficient","k":"Error","w":"409 state_error","x":"The customer holds less credit than was asked; available says how much, in minor units."},{"t":"invoice_credit_already_applied","u":"/docs/errors#invoice_credit_already_applied","k":"Error","w":"409 state_error","x":"Credit was already applied to this invoice."},{"t":"payment_being_matched","u":"/docs/errors#payment_being_matched","k":"Error","w":"409 state_error","x":"The payment arrived and is still being matched to an order, so nothing can be decided on it yet."},{"t":"payment_being_refunded","u":"/docs/errors#payment_being_refunded","k":"Error","w":"409 state_error","x":"The payment is being sent back."},{"t":"payment_reverted","u":"/docs/errors#payment_reverted","k":"Error","w":"409 state_error","x":"The payment is no longer on its network."},{"t":"provider_refund_not_held","u":"/docs/errors#provider_refund_not_held","k":"Error","w":"409 state_error","x":"Nothing that Relay returned for this payment is still held."},{"t":"provider_refund_proof_missing","u":"/docs/errors#provider_refund_proof_missing","k":"Error","w":"409 state_error","x":"The transfer Relay returned cannot be read right now. Retry later."},{"t":"order_not_paid_twice","u":"/docs/errors#order_not_paid_twice","k":"Error","w":"409 state_error","x":"The order has no second payment to move."},{"t":"payment_not_on_order","u":"/docs/errors#payment_not_on_order","k":"Error","w":"409 state_error","x":"The payment is no longer on this order."},{"t":"payment_not_second","u":"/docs/errors#payment_not_second","k":"Error","w":"409 state_error","x":"Only the newest payment of an order paid twice can be moved."},{"t":"payment_already_decided","u":"/docs/errors#payment_already_decided","k":"Error","w":"409 state_error","x":"Part of the extra on this order was already refunded or kept. Decide the rest on the order."},{"t":"order_has_refunds","u":"/docs/errors#order_has_refunds","k":"Error","w":"409 state_error","x":"The order has a refund, so no payment can leave it."},{"t":"payment_not_movable","u":"/docs/errors#payment_not_movable","k":"Error","w":"409 state_error","x":"The payment cannot be moved. Refund it, or keep it as customer credit."},{"t":"payment_shared_out","u":"/docs/errors#payment_shared_out","k":"Error","w":"409 state_error","x":"Shares of this payment were already paid out under a split rule, so it cannot be moved. Refund it, or keep it as customer credit."},{"t":"payment_under_review","u":"/docs/errors#payment_under_review","k":"Error","w":"409 state_error","x":"The paying address is flagged for review. Decide that first."},{"t":"order_would_not_stay_paid","u":"/docs/errors#order_would_not_stay_paid","k":"Error","w":"409 state_error","x":"Without this payment the order would no longer be paid, so the payment cannot be moved."},{"t":"target_other_customer","u":"/docs/errors#target_other_customer","k":"Error","w":"409 state_error","x":"A payment can be moved only to an open order of the same customer."},{"t":"target_currency_mismatch","u":"/docs/errors#target_currency_mismatch","k":"Error","w":"409 state_error","x":"A payment can be moved only to an order priced in the same currency."},{"t":"target_not_open","u":"/docs/errors#target_not_open","k":"Error","w":"409 state_error","x":"A payment can be moved only to an order that is still open."},{"t":"target_expired","u":"/docs/errors#target_expired","k":"Error","w":"409 state_error","x":"The order chosen has run out of time. Choose an order that is still open."},{"t":"cosigner_unavailable","u":"/docs/errors#cosigner_unavailable","k":"Error","w":"503 api_error","x":"Orrerie's co-signer is not available, so nothing that needs its signature was done. Receiving payments is unaffected. Retry later; retry_after , when sent, says when."}]