# Shuttle Documentation > Documentation for Shuttle ## Guides: documentation - [Welcome to Shuttle 🚀](https://docs.shuttleglobal.com/docs/welcome.md) - [What Shuttle Can Do](https://docs.shuttleglobal.com/docs/what-shuttle-does.md) - [Platform Integration Approaches](https://docs.shuttleglobal.com/docs/platform-integration-approaches.md) ## Guides: embedded payments for platforms - [Introduction](https://docs.shuttleglobal.com/docs/epfp-intro.md) - [Applications](https://docs.shuttleglobal.com/docs/epfp-applications.md) - [Multi Tenancy / Instances](https://docs.shuttleglobal.com/docs/epfp-instances.md) - [UX Components](https://docs.shuttleglobal.com/docs/ux-components.md) - [Merchant Setup](https://docs.shuttleglobal.com/docs/onboarding.md) - [Merchant Setup Integration Guide](https://docs.shuttleglobal.com/docs/onboarding-integration-guide.md) - [Merchant Setup Options](https://docs.shuttleglobal.com/docs/onboarding-options.md) - [Checkout](https://docs.shuttleglobal.com/docs/checkout.md) - [Checkout Integration Guide](https://docs.shuttleglobal.com/docs/checkout-integration-guide.md) - [Express Checkout](https://docs.shuttleglobal.com/docs/express-checkout.md) - [Buy Now Pay Later Messaging](https://docs.shuttleglobal.com/docs/bnpl-messaging.md) - [Merchant View](https://docs.shuttleglobal.com/docs/activity-view.md) - [Merchant View Integration Guide](https://docs.shuttleglobal.com/docs/activity-view-integration-guide.md) - [Merchant View Options](https://docs.shuttleglobal.com/docs/activity-view-options.md) - [shuttle.js](https://docs.shuttleglobal.com/docs/epfp-shuttlejs.md) - [Apple Pay / Google Pay](https://docs.shuttleglobal.com/docs/apple-pay-google-pay.md) ## Guides: payment links for platforms - [Zero Integration Onboarding](https://docs.shuttleglobal.com/docs/plfp-zero-integration-onboarding.md) - [Integration Guide](https://docs.shuttleglobal.com/docs/plfp-intro.md) - [Authentication](https://docs.shuttleglobal.com/docs/plfp-authentication.md) - [Actions / Events](https://docs.shuttleglobal.com/docs/plfp-api-endpoints.md) - [Webhooks](https://docs.shuttleglobal.com/docs/plfp-webhooks.md) ## Guides: payment links - [Introduction](https://docs.shuttleglobal.com/docs/links-intro.md) - [Getting Started](https://docs.shuttleglobal.com/docs/links-getting-started.md) - [Personalised Links](https://docs.shuttleglobal.com/docs/links-single-use-links.md) - [Process Flow](https://docs.shuttleglobal.com/docs/links-single-use-process.md) - [Via UX](https://docs.shuttleglobal.com/docs/links-single-use-via-ux.md) - [Via Agent Link Generator](https://docs.shuttleglobal.com/docs/links-single-use-via-agent-link-generator.md) - [via API](https://docs.shuttleglobal.com/docs/links-single-use-via-api.md) - [via Workflow Automation (iPaaS)](https://docs.shuttleglobal.com/docs/links-single-use-via-workflow.md) - [via Multi-Tenant API](https://docs.shuttleglobal.com/docs/links-single-use-via-multi-tenant-api.md) - [via Multi-Tenant iPaaS](https://docs.shuttleglobal.com/docs/links-single-use-via-multi-tenant-ipaas.md) - [Multi Use Links](https://docs.shuttleglobal.com/docs/links-multi-use-links.md) - [Link Branding](https://docs.shuttleglobal.com/docs/links-branding.md) - [Payment Processors](https://docs.shuttleglobal.com/docs/links-processors.md) - [Works With](https://docs.shuttleglobal.com/docs/works-with.md) - [Generic](https://docs.shuttleglobal.com/docs/works-with-generic.md) - [AWS Connect](https://docs.shuttleglobal.com/docs/works-with-aws-connect.md) - [Xero](https://docs.shuttleglobal.com/docs/works-with-xero.md) - [Integration Guide](https://docs.shuttleglobal.com/docs/works-with-integration-guide.md) ## Guides: twilio - [Introduction](https://docs.shuttleglobal.com/docs/twilio-intro.md) - [How It Works](https://docs.shuttleglobal.com/docs/twilio-pay-architecture.md) - [Twilio IVR Integration Guide](https://docs.shuttleglobal.com/docs/twilio-integration-guide.md) - [Twilio Agent Assist Integration Guide](https://docs.shuttleglobal.com/docs/twilio-agent-assist-guide.md) - [Shuttle Pay Connector Reference](https://docs.shuttleglobal.com/docs/shuttle-connector-reference.md) - [Bring Your Own Carrier](https://docs.shuttleglobal.com/docs/byo-carrier.md) - [Telnyx](https://docs.shuttleglobal.com/docs/twilio-telnyx-guide.md) - [Other Platforms](https://docs.shuttleglobal.com/docs/twilio-byoc-guide.md) ## Guides: merchant portal - [Introduction](https://docs.shuttleglobal.com/docs/mp-intro.md) - [Payment Configuration](https://docs.shuttleglobal.com/docs/mp-payment-configuration.md) - [Activity View](https://docs.shuttleglobal.com/docs/mp-activity-view.md) - [Billing](https://docs.shuttleglobal.com/docs/mp-billing.md) - [Team Management](https://docs.shuttleglobal.com/docs/mp-teams.md) - [Multi-Tenancy](https://docs.shuttleglobal.com/docs/mp-multi-tenancy.md) ## Guides: user guides - [Core Concepts](https://docs.shuttleglobal.com/docs/ug-concepts.md) - [Payment Types](https://docs.shuttleglobal.com/docs/epfp-payment-types.md) - [Payment Lifecycle](https://docs.shuttleglobal.com/docs/epfp-payments.md) - [Scheduler](https://docs.shuttleglobal.com/docs/epfp-scheduler.md) - [Merchant Setup](https://docs.shuttleglobal.com/docs/ug-onboarding.md) - [Merchant Setup roles](https://docs.shuttleglobal.com/docs/ug-onboarding-roles.md) - [Accepting the terms](https://docs.shuttleglobal.com/docs/ug-onboarding-activate.md) - [Your integrations](https://docs.shuttleglobal.com/docs/ug-onboarding-integrations-list.md) - [Adding a payment processor](https://docs.shuttleglobal.com/docs/ug-onboarding-add-integration.md) - [Entering connection details](https://docs.shuttleglobal.com/docs/ug-onboarding-connect-processor.md) - [Managing a connection](https://docs.shuttleglobal.com/docs/ug-onboarding-gateway-view.md) - [Payment method amount rules](https://docs.shuttleglobal.com/docs/ug-onboarding-payment-rules.md) - [Merchant View - Operations](https://docs.shuttleglobal.com/docs/ug-operations.md) - [Merchant View roles](https://docs.shuttleglobal.com/docs/ug-operations-roles.md) - [Account search](https://docs.shuttleglobal.com/docs/ug-admin-accounts-search.md) - [Account](https://docs.shuttleglobal.com/docs/ug-admin-accounts-view.md) - [Create or edit an account](https://docs.shuttleglobal.com/docs/ug-admin-account-form.md) - [Payment method](https://docs.shuttleglobal.com/docs/ug-admin-payment-method-view.md) - [Contract search](https://docs.shuttleglobal.com/docs/ug-admin-contracts-search.md) - [Contract](https://docs.shuttleglobal.com/docs/ug-admin-contracts-view.md) - [Edit a contract](https://docs.shuttleglobal.com/docs/ug-admin-contract-edit.md) - [Edit an upcoming charge or payment](https://docs.shuttleglobal.com/docs/ug-admin-contract-upcoming.md) - [Charge](https://docs.shuttleglobal.com/docs/ug-admin-contract-charge.md) - [Transaction search](https://docs.shuttleglobal.com/docs/ug-admin-transactions-search.md) - [Transaction](https://docs.shuttleglobal.com/docs/ug-admin-transactions-view.md) - [Refund a transaction](https://docs.shuttleglobal.com/docs/ug-admin-transaction-refund.md) - [Capture a transaction](https://docs.shuttleglobal.com/docs/ug-admin-transaction-capture.md) - [Sections on every screen](https://docs.shuttleglobal.com/docs/ug-admin-sections-shared.md) - [Account screen sections](https://docs.shuttleglobal.com/docs/ug-admin-sections-accounts.md) - [Payment method screen sections](https://docs.shuttleglobal.com/docs/ug-admin-sections-payment-methods.md) - [Contract screen sections](https://docs.shuttleglobal.com/docs/ug-admin-sections-contracts.md) - [Transaction screen sections](https://docs.shuttleglobal.com/docs/ug-admin-sections-transactions.md) - [Merchant View - Admin](https://docs.shuttleglobal.com/docs/ug-admin.md) - [Merchant View Admin roles](https://docs.shuttleglobal.com/docs/ug-admin-roles.md) - [Localisation editor](https://docs.shuttleglobal.com/docs/ug-admin-localisation-edit.md) - [Checkout](https://docs.shuttleglobal.com/docs/ug-checkout.md) - [Payment form](https://docs.shuttleglobal.com/docs/ug-checkout-checkout-payment.md) - [Receipt](https://docs.shuttleglobal.com/docs/ug-checkout-checkout-receipt.md) - [When a payment is interrupted](https://docs.shuttleglobal.com/docs/ug-checkout-checkout-interrupted.md) - [Business Rules](https://docs.shuttleglobal.com/docs/ug-rules.md) - [Roles and permissions](https://docs.shuttleglobal.com/docs/ug-rules-roles.md) - [Create an account](https://docs.shuttleglobal.com/docs/ug-rules-account-create.md) - [Update an account](https://docs.shuttleglobal.com/docs/ug-rules-account-update.md) - [Archive a saved payment method](https://docs.shuttleglobal.com/docs/ug-rules-payment-method-archive.md) - [Add or edit a note with attachments](https://docs.shuttleglobal.com/docs/ug-rules-note-save.md) - [Delete a note or an attachment](https://docs.shuttleglobal.com/docs/ug-rules-note-delete.md) - [Amend a contract's terms](https://docs.shuttleglobal.com/docs/ug-rules-contract-amend.md) - [Amend a scheduled contract's instalments](https://docs.shuttleglobal.com/docs/ug-rules-contract-amend-schedule.md) - [Change the payment method on a contract](https://docs.shuttleglobal.com/docs/ug-rules-contract-change-payment-method.md) - [Collect a contract's arrears now](https://docs.shuttleglobal.com/docs/ug-rules-contract-make-payment.md) - [Move the next charge](https://docs.shuttleglobal.com/docs/ug-rules-contract-reschedule-next-charge.md) - [Reschedule the next payment](https://docs.shuttleglobal.com/docs/ug-rules-contract-reschedule-payment.md) - [Resume a contract](https://docs.shuttleglobal.com/docs/ug-rules-contract-resume.md) - [Set up a recurring or scheduled agreement](https://docs.shuttleglobal.com/docs/ug-rules-contract-create.md) - [Suspend a contract](https://docs.shuttleglobal.com/docs/ug-rules-contract-suspend.md) - [Terminate a contract](https://docs.shuttleglobal.com/docs/ug-rules-contract-terminate.md) - [Amend a charge](https://docs.shuttleglobal.com/docs/ug-rules-charge-amend.md) - [Write off a charge](https://docs.shuttleglobal.com/docs/ug-rules-charge-void.md) - [Attribute an unattributed payment](https://docs.shuttleglobal.com/docs/ug-rules-payment-reattribute.md) - [Capture an authorised payment](https://docs.shuttleglobal.com/docs/ug-rules-payment-capture.md) - [Mark an unresolved payment approved or declined](https://docs.shuttleglobal.com/docs/ug-rules-payment-override-status.md) - [Refund a payment](https://docs.shuttleglobal.com/docs/ug-rules-payment-refund.md) - [Save a payment method without charging it](https://docs.shuttleglobal.com/docs/ug-rules-payment-tokenise.md) - [Take a one-off payment](https://docs.shuttleglobal.com/docs/ug-rules-payment-take.md) - [Undo an offline refund](https://docs.shuttleglobal.com/docs/ug-rules-payment-undo-refund.md) - [Void an authorisation](https://docs.shuttleglobal.com/docs/ug-rules-payment-void.md) - [Import branded strings from a file](https://docs.shuttleglobal.com/docs/ug-rules-localisation-import-strings.md) - [Override a branded string](https://docs.shuttleglobal.com/docs/ug-rules-localisation-update-string.md) - [Reset a branded string to its original](https://docs.shuttleglobal.com/docs/ug-rules-localisation-reset-string.md) - [Connect a payment processor](https://docs.shuttleglobal.com/docs/ug-rules-gateway-connect.md) - [Disconnect a provider](https://docs.shuttleglobal.com/docs/ug-rules-gateway-disconnect.md) - [Dismiss an archived provider's notice](https://docs.shuttleglobal.com/docs/ug-rules-gateway-dismiss-archive-notice.md) - [Reconnect a provider](https://docs.shuttleglobal.com/docs/ug-rules-gateway-reconnect.md) - [Restore an archived provider](https://docs.shuttleglobal.com/docs/ug-rules-gateway-restore.md) - [Update a provider's settings](https://docs.shuttleglobal.com/docs/ug-rules-gateway-update.md) - [Connect a fraud workflow](https://docs.shuttleglobal.com/docs/ug-rules-workflow-connect.md) - [Restrict a payment method by transaction amount](https://docs.shuttleglobal.com/docs/ug-rules-legal-entity-route-set-amount-rules.md) - [Route a payment method to a provider](https://docs.shuttleglobal.com/docs/ug-rules-legal-entity-route-set-payment-method-routing.md) - [Stop offering a payment method](https://docs.shuttleglobal.com/docs/ug-rules-legal-entity-route-disable-payment-method.md) - [Accept Shuttle's terms for the instance](https://docs.shuttleglobal.com/docs/ug-rules-instance-accept-terms.md) - [Enable wallet support for the instance](https://docs.shuttleglobal.com/docs/ug-rules-instance-enable-wallets.md) - [Set the merchant name and country](https://docs.shuttleglobal.com/docs/ug-rules-instance-set-merchant-details.md) ## Guides: processors - [ACI Speedpay](https://docs.shuttleglobal.com/docs/proc-aci-speedpay.md) - [Adyen](https://docs.shuttleglobal.com/docs/proc-adyen.md) - [Connecting Adyen](https://docs.shuttleglobal.com/docs/proc-adyen-connect.md) - [Creating an Adyen Sandbox Account](https://docs.shuttleglobal.com/docs/proc-adyen-sandbox.md) - [Affirm](https://docs.shuttleglobal.com/docs/proc-affirm.md) - [Connecting Affirm](https://docs.shuttleglobal.com/docs/proc-affirm-connect.md) - [AndDone](https://docs.shuttleglobal.com/docs/proc-anddone.md) - [Connecting AndDone](https://docs.shuttleglobal.com/docs/proc-anddone-connect.md) - [Authorize.Net](https://docs.shuttleglobal.com/docs/proc-authorize-net.md) - [Connecting with OAuth](https://docs.shuttleglobal.com/docs/proc-authorize-net-connect.md) - [Connecting with API keys](https://docs.shuttleglobal.com/docs/proc-authorize-net-api-keys-connect.md) - [Authorize.Net FAQs](https://docs.shuttleglobal.com/docs/proc-authorize-net-faqs.md) - [Bill it Now](https://docs.shuttleglobal.com/docs/proc-bill-it-now.md) - [Boulevard](https://docs.shuttleglobal.com/docs/proc-boulevard.md) - [Connecting Boulevard](https://docs.shuttleglobal.com/docs/proc-boulevard-connect.md) - [Braintree](https://docs.shuttleglobal.com/docs/proc-braintree.md) - [Connecting Braintree](https://docs.shuttleglobal.com/docs/proc-braintree-connect.md) - [BS Payone](https://docs.shuttleglobal.com/docs/proc-bs-payone.md) - [Connecting BS Payone](https://docs.shuttleglobal.com/docs/proc-bs-payone-connect.md) - [CardConnect](https://docs.shuttleglobal.com/docs/proc-cardconnect.md) - [Connecting CardConnect](https://docs.shuttleglobal.com/docs/proc-cardconnect-connect.md) - [Checkout.com](https://docs.shuttleglobal.com/docs/proc-checkout-com.md) - [Cybersource](https://docs.shuttleglobal.com/docs/proc-cybersource.md) - [Connecting Cybersource](https://docs.shuttleglobal.com/docs/proc-cybersource-connect.md) - [Cybersource Sandbox Credentials](https://docs.shuttleglobal.com/docs/proc-cybersource-sandbox.md) - [Ecommpay](https://docs.shuttleglobal.com/docs/proc-ecommpay.md) - [Fat Zebra](https://docs.shuttleglobal.com/docs/proc-fat-zebra.md) - [Connecting Fat Zebra](https://docs.shuttleglobal.com/docs/proc-fat-zebra-connect.md) - [Fat Zebra Sandbox Credentials](https://docs.shuttleglobal.com/docs/proc-fat-zebra-sandbox.md) - [Fortis](https://docs.shuttleglobal.com/docs/proc-fortis.md) - [FreedomPay](https://docs.shuttleglobal.com/docs/proc-freedompay.md) - [Connecting FreedomPay](https://docs.shuttleglobal.com/docs/proc-freedompay-connect.md) - [UAT Credentials](https://docs.shuttleglobal.com/docs/proc-freedompay-uat-credentials.md) - [FreedomPay FAQ](https://docs.shuttleglobal.com/docs/proc-freedompay-faq.md) - [Global Payments](https://docs.shuttleglobal.com/docs/proc-global-payments.md) - [Connecting Global Payments](https://docs.shuttleglobal.com/docs/proc-global-payments-connect.md) - [GMO Payment Gateway](https://docs.shuttleglobal.com/docs/proc-gmo.md) - [GoCardless](https://docs.shuttleglobal.com/docs/proc-gocardless.md) - [Connecting GoCardless](https://docs.shuttleglobal.com/docs/proc-gocardless-connect.md) - [InterProse](https://docs.shuttleglobal.com/docs/proc-interprose.md) - [Connecting InterProse](https://docs.shuttleglobal.com/docs/proc-interprose-connect.md) - [InterProse Sandbox Testing](https://docs.shuttleglobal.com/docs/proc-interprose-faq.md) - [Kount](https://docs.shuttleglobal.com/docs/proc-kount.md) - [Connecting Kount](https://docs.shuttleglobal.com/docs/proc-kount-connect.md) - [LiqPay](https://docs.shuttleglobal.com/docs/proc-liqpay.md) - [Connecting LiqPay](https://docs.shuttleglobal.com/docs/proc-liqpay-connect.md) - [Mollie](https://docs.shuttleglobal.com/docs/proc-mollie.md) - [Connecting Mollie](https://docs.shuttleglobal.com/docs/proc-mollie-connect.md) - [Moneris](https://docs.shuttleglobal.com/docs/proc-moneris.md) - [Connecting Moneris](https://docs.shuttleglobal.com/docs/proc-moneris-connect.md) - [NMI](https://docs.shuttleglobal.com/docs/proc-nmi.md) - [Connecting NMI](https://docs.shuttleglobal.com/docs/proc-nmi-connect.md) - [Opayo](https://docs.shuttleglobal.com/docs/proc-opayo.md) - [Connecting Opayo](https://docs.shuttleglobal.com/docs/proc-opayo-connect.md) - [Working With Opayo](https://docs.shuttleglobal.com/docs/proc-opayo-tokenisation.md) - [PayPal Commerce](https://docs.shuttleglobal.com/docs/proc-paypal-commerce.md) - [Connecting PayPal Commerce](https://docs.shuttleglobal.com/docs/proc-paypal-commerce-connect.md) - [PayPal Sandbox Testing](https://docs.shuttleglobal.com/docs/proc-paypal-commerce-testing.md) - [PayPal Payflow Pro](https://docs.shuttleglobal.com/docs/proc-paypal-payflow-pro.md) - [Connecting PayPal Payflow Pro](https://docs.shuttleglobal.com/docs/proc-paypal-payflow-pro-connect.md) - [PaySafe](https://docs.shuttleglobal.com/docs/proc-paysafe.md) - [Connecting PaySafe](https://docs.shuttleglobal.com/docs/proc-paysafe-connect.md) - [PayTomorrow](https://docs.shuttleglobal.com/docs/proc-paytomorrow.md) - [Connecting PayTomorrow](https://docs.shuttleglobal.com/docs/proc-paytomorrow-connect.md) - [Using PayTomorrow](https://docs.shuttleglobal.com/docs/proc-paytomorrow-using.md) - [PayU](https://docs.shuttleglobal.com/docs/proc-payu.md) - [Connecting PayU](https://docs.shuttleglobal.com/docs/proc-payu-connect.md) - [QuickBooks Payments](https://docs.shuttleglobal.com/docs/proc-quickbooks-payments.md) - [Connecting QuickBooks Payments](https://docs.shuttleglobal.com/docs/proc-quickbooks-payments-connect.md) - [Sandbox](https://docs.shuttleglobal.com/docs/proc-sandbox.md) - [Shift4](https://docs.shuttleglobal.com/docs/proc-shift4.md) - [Square](https://docs.shuttleglobal.com/docs/proc-square.md) - [Connecting Square](https://docs.shuttleglobal.com/docs/proc-square-connect.md) - [Stripe](https://docs.shuttleglobal.com/docs/proc-stripe.md) - [Connecting Stripe](https://docs.shuttleglobal.com/docs/proc-stripe-connect.md) - [ACH & SEPA Direct Debit Settlement](https://docs.shuttleglobal.com/docs/proc-stripe-ach-sepa.md) - [Bank Transfers & SPEI](https://docs.shuttleglobal.com/docs/proc-stripe-bank-transfer.md) - [Transbank](https://docs.shuttleglobal.com/docs/proc-transbank.md) - [Connecting Transbank](https://docs.shuttleglobal.com/docs/proc-transbank-connect.md) - [Trust Payments](https://docs.shuttleglobal.com/docs/proc-trust-payments.md) - [Connecting Trust Payments](https://docs.shuttleglobal.com/docs/proc-trust-payments-connect.md) - [USAePay](https://docs.shuttleglobal.com/docs/proc-usaepay.md) - [Connecting USAePay](https://docs.shuttleglobal.com/docs/proc-usaepay-connect.md) - [ACH Payments & Returns](https://docs.shuttleglobal.com/docs/proc-usaepay-ach.md) - [Veem](https://docs.shuttleglobal.com/docs/proc-veem.md) - [Worldpay Access](https://docs.shuttleglobal.com/docs/proc-worldpay-access.md) - [Connecting Worldpay Access](https://docs.shuttleglobal.com/docs/proc-worldpay-access-connect.md) - [Xendit](https://docs.shuttleglobal.com/docs/proc-xendit.md) - [Connecting Xendit](https://docs.shuttleglobal.com/docs/proc-xendit-connect.md) ## Guides: release notes - [Release Notes](https://docs.shuttleglobal.com/docs/release-notes.md) ## Guides: mcp server - [AI Assistants and MCP](https://docs.shuttleglobal.com/docs/mcp.md) ## Guides: testing - [Sandbox Accounts](https://docs.shuttleglobal.com/docs/sandbox-accounts.md) - [Sandbox Gateway](https://docs.shuttleglobal.com/docs/sandbox-gateway.md) - [Testing with Processors](https://docs.shuttleglobal.com/docs/testing-test-cards.md) ## Guides: corporate - [Branding](https://docs.shuttleglobal.com/docs/org-branding.md) - [PSP Integration Checklist](https://docs.shuttleglobal.com/docs/psp-integration-checklist.md) - [Security](https://docs.shuttleglobal.com/docs/org-security.md) ## API Reference: api reference - [API Overview](https://docs.shuttleglobal.com/reference/ref-overview.md) ## API Reference: platform api - [Introduction](https://docs.shuttleglobal.com/reference/plat-introduction.md) - [Instances](https://docs.shuttleglobal.com/reference/platform-instances.md) - [List instances](https://docs.shuttleglobal.com/reference/plat-listinstances.md): Performs a search against instance objects with optional filtering, sorting, and pagination. - [Create an instance](https://docs.shuttleglobal.com/reference/plat-createinstance.md): Create a new merchant instance - [Get an instance](https://docs.shuttleglobal.com/reference/plat-getinstance.md): Retrieve a specific instance by ID or instance_key - [Update an instance](https://docs.shuttleglobal.com/reference/plat-updateinstance.md): Update an existing instance. Only the passed fields will be updated, fields not passed will not be updated. To blank a field, pass the field with an empty string. - [Delete an instance](https://docs.shuttleglobal.com/reference/plat-deleteinstance.md): Mark an instance as INACTIVE. This action cannot be reversed and should be used with extreme caution. This endpoint will, with immediate effect, mark an instance as INACTIVE. While the instance may… ## API Reference: merchant instance api - [Introduction](https://docs.shuttleglobal.com/reference/inst-introduction.md) - [Accounts](https://docs.shuttleglobal.com/reference/accounts.md) - [List accounts](https://docs.shuttleglobal.com/reference/inst-listaccounts.md): Search and list account objects with various filtering criteria. The search criteria syntax supports various operators: - `=` Exact match (multiple values with `;` for IN) - `~=` Partial match… - [Create an account](https://docs.shuttleglobal.com/reference/inst-createaccount.md): Create a new account in the system. - [Get an account](https://docs.shuttleglobal.com/reference/inst-getaccount.md): Retrieve a single account by ID or CRM key. When using a CRM key in the path, this endpoint will return the first account that was created with that CRM key. - [Update an account](https://docs.shuttleglobal.com/reference/inst-updateaccount.md): Update an existing account's details. When using a CRM key in the path, this endpoint will update the first account that was created with that CRM key. Note: Multiple accounts can share the same CRM… - [Captures](https://docs.shuttleglobal.com/reference/captures.md) - [Get a capture](https://docs.shuttleglobal.com/reference/inst-getcapture.md): Retrieve details of a specific capture transaction. You can expand the following fields: * account * created_session * parts * source_transaction * updated_session - [Capture an authorisation](https://docs.shuttleglobal.com/reference/inst-capturepayment.md): Capture funds for a previously authorized payment. You must have created a payment with action=AUTH first. You can capture the full authorized amount or a partial amount. Multiple partial captures… - [Charges](https://docs.shuttleglobal.com/reference/charges.md) - [List charges](https://docs.shuttleglobal.com/reference/inst-listcharges.md): Search and filter charge objects with pagination support. Available fields for criteria and order: - id - alt_key - contract - created - due - outstanding_amount - recurring: "Y" (true) "N" (false)… - [Get a charge](https://docs.shuttleglobal.com/reference/inst-getcharge.md): Retrieve details of a specific charge. You can expand the following fields: - contract - created_session - updated_session - [Update a charge](https://docs.shuttleglobal.com/reference/inst-updatecharge.md): Update specific properties of a charge. Only certain fields can be modified: - status: Toggle between ACTIVE or WRITTENOFF - amount: New amount due (cannot be less than amount already paid) - due:… - [Checkouts](https://docs.shuttleglobal.com/reference/checkouts.md) - [Create a checkout](https://docs.shuttleglobal.com/reference/inst-createcheckout.md): Create a hosted checkout session. The checkout accepts all parameters from the Create Payment API (except `payment_method`), plus additional options that control the checkout UX. The response… - [Get a checkout](https://docs.shuttleglobal.com/reference/inst-getcheckout.md): Retrieve details of an existing checkout session by its nonce. - [Delete a checkout](https://docs.shuttleglobal.com/reference/inst-deletecheckout.md): Delete (invalidate) a checkout session. The checkout will no longer be usable. - [Contracts](https://docs.shuttleglobal.com/reference/contracts.md) - [List contracts](https://docs.shuttleglobal.com/reference/inst-listcontracts.md): Search and filter contract objects with pagination support. Available fields for criteria and order: * id * account * alt_key * channel * completed * created * designation * division * frequency *… - [Get a contract](https://docs.shuttleglobal.com/reference/inst-getcontract.md): Retrieve details of a specific contract. The contract_id can be either: * id: Our assigned ID * alt_key: Your assigned ID (most recent if not unique) You can expand the following fields: * account *… - [Update a contract](https://docs.shuttleglobal.com/reference/inst-updatecontract.md): Update specific properties of a contract. The following fields can be modified: * next_charge: Next charge date or 'now'. Not accepted on a scheduled-charges contract or together with `charges` (move… - [Get future charges](https://docs.shuttleglobal.com/reference/inst-getfuturecharges.md): Lists projected future charges for a recurring (frequency-based) contract — up to 3 years or 100 charges ahead. For contracts created with explicit scheduled charges, use [List contract… - [List contract charges](https://docs.shuttleglobal.com/reference/inst-listcontractcharges.md): List the charges attached to a contract. Ordered by due date ascending by default. This endpoint is most useful for contracts created with explicit scheduled charges, where all charges are created… - [Cancel a contract](https://docs.shuttleglobal.com/reference/inst-cancelcontract.md): Cancelling a contract will prevent future charges being created on a contract and stop all automated payments. A contract may still have an outstanding balance at time of cancellation. - [Create a payment on a contract](https://docs.shuttleglobal.com/reference/inst-contract-createpayment.md): For recurring payments which have an amount overdue you can instruct us to attempt payment of the outstanding balance on either the default payment method or an alternative one. - [Create URL to update payment method](https://docs.shuttleglobal.com/reference/inst-contract-createpaymentmethodurl.md): Generate an encoded URL to direct a browser to, allowing a user to modify their method of payment on a recurring contract. - [Deep Links](https://docs.shuttleglobal.com/reference/deep-links.md) - [Create a deep link](https://docs.shuttleglobal.com/reference/inst-createdeeplink.md): Create a new deep link. All fields are nested under the `deep_link` field. See the deep link types section for available deep links and their specific parameters. - [Get a deep link](https://docs.shuttleglobal.com/reference/inst-getdeeplink.md): Retrieve details of an existing deep link. - [Update a deep link](https://docs.shuttleglobal.com/reference/inst-updatedeeplink.md): Update an existing deep link - [Delete a deep link](https://docs.shuttleglobal.com/reference/inst-deletedeeplink.md): Delete an existing deep link - [Gateways](https://docs.shuttleglobal.com/reference/gateways.md) - [List gateways](https://docs.shuttleglobal.com/reference/inst-listgateways.md): List and search gateways for an instance. Available search fields: * `id`: Gateway ID * `code`: Your gateway reference * `created`: Creation timestamp * `division`: Division ID * `processor`:… - [Create a gateway](https://docs.shuttleglobal.com/reference/inst-creategateway.md): Create a new gateway connection - [Get a gateway](https://docs.shuttleglobal.com/reference/inst-getgateway.md): Get details of a specific gateway - [Update a gateway](https://docs.shuttleglobal.com/reference/inst-updategateway.md): Updating a gateway is intended to be used in conjunction with Shuttle support. * `gateway_id` can be either ID or code Request fields: * `status` (optional) - update the status to one of `ACTIVE`,… - [Get gateway connection](https://docs.shuttleglobal.com/reference/inst-getgatewayconnection.md): Get the current connection status of a gateway - [Get gateway settings](https://docs.shuttleglobal.com/reference/inst-getgatewaysettings.md): Get the settings for a specific gateway - [Get gateway payment method count](https://docs.shuttleglobal.com/reference/inst-getgatewaypaymentmethodcount.md): Get the approximate number of saved payment methods on a gateway. Note: The number is accurate as of the "updated" date, however a cached value will be returned if more than 100 in total. The… - [Instances](https://docs.shuttleglobal.com/reference/instances.md) - [Get capabilities](https://docs.shuttleglobal.com/reference/inst-getinstancecapabilities.md): Retrieve the payment capabilities of the current instance. This endpoint is available within the merchant instance context and does not require an instance ID in the path. - [Legal Entities](https://docs.shuttleglobal.com/reference/legal-entities.md) - [List legal entities](https://docs.shuttleglobal.com/reference/inst-listlegalentities.md): Search and list legal entity objects with pagination support. - [Get a legal entity](https://docs.shuttleglobal.com/reference/inst-getlegalentity.md): Retrieve details of a specific legal entity by ID or code. - [Legal Entity Routes](https://docs.shuttleglobal.com/reference/legal-entity-routes.md) - [List legal entity routes](https://docs.shuttleglobal.com/reference/inst-listlegalentityroutes.md): Search and list legal entity route objects with pagination support. - [Get a legal entity route](https://docs.shuttleglobal.com/reference/inst-getlegalentityroute.md): Retrieve details of a specific legal entity route. - [Payment Links](https://docs.shuttleglobal.com/reference/payment-links.md) - [Get a payment link](https://docs.shuttleglobal.com/reference/inst-getpaymentlink.md) - [Create a payment link](https://docs.shuttleglobal.com/reference/inst-createpaymentlink.md) - [Update a payment link](https://docs.shuttleglobal.com/reference/inst-updatepaymentlink.md) - [Archive a payment link](https://docs.shuttleglobal.com/reference/inst-archivepaymentlink.md) - [Payment Methods](https://docs.shuttleglobal.com/reference/payment-methods.md) - [List payment methods](https://docs.shuttleglobal.com/reference/inst-listpaymentmethods.md): Search and list payment method objects with various filtering criteria. - [Create a payment method](https://docs.shuttleglobal.com/reference/inst-createpaymentmethod.md): Create a new payment method. This API supports two main use cases: 1. Data import/copy (token import) 2. Third-party UI integration (payment details capture and gateway tokenization) For third-party… - [Get a payment method](https://docs.shuttleglobal.com/reference/inst-getpaymentmethod.md): Retrieve a single payment method by ID or code. - [Update a payment method](https://docs.shuttleglobal.com/reference/inst-updatepaymentmethod.md): Update an existing payment method's details. - [Delete a payment method](https://docs.shuttleglobal.com/reference/inst-deletepaymentmethod.md): Archive (soft delete) a payment method. - [Payments](https://docs.shuttleglobal.com/reference/payments.md) - [Create a payment](https://docs.shuttleglobal.com/reference/inst-createpayment.md): Create a new payment. The payment can be immediate or scheduled, one-time or recurring. Unless rejected prior to processing, the API request will succeed and return a payment object in a SUCCESS or… - [Get a payment](https://docs.shuttleglobal.com/reference/inst-getpayment.md): Retrieve details of a specific payment. You can expand additional related objects using the expand parameter. Available expand options: * contract * transaction * parts * payment_method - [Processors](https://docs.shuttleglobal.com/reference/processors.md) - [List processors](https://docs.shuttleglobal.com/reference/inst-listprocessors.md): Returns a list of payment processors available to the application. Filter for `visible: true` to get processors available for new connections. - [Get processor settings](https://docs.shuttleglobal.com/reference/inst-getprocessorsettings.md): Retrieve the field definitions and default values for connecting a processor. This returns the form schema used when creating a gateway connection. Note: The `settings` and `values` response fields… - [Refunds](https://docs.shuttleglobal.com/reference/refunds.md) - [Get a refund](https://docs.shuttleglobal.com/reference/inst-getrefund.md): Retrieve details of a specific refund. You can expand additional related objects using the expand parameter. Available expand options: * account * created_session * parts * source_transaction *… - [Refund a payment](https://docs.shuttleglobal.com/reference/inst-refundpayment.md): You can refund a payment in part or full, or simply mark a payment as refunded (if refunded offline). You can refund "PAYMENT" and "CAPTURE" type transactions, but not "AUTH" (you must void an AUTH… - [Refund a capture](https://docs.shuttleglobal.com/reference/inst-refundcapture.md): You can refund a capture in part or full, or simply mark a payment as refunded (if refunded offline). Note, support for multi-refund (e.g., I pay $100 and refund $20 followed by a second refund of… - [Refund a contract](https://docs.shuttleglobal.com/reference/inst-refundcontract.md): You can refund a contract, which allows you to refund multiple transactions at once for recurring payments / subscriptions. - [Transactions](https://docs.shuttleglobal.com/reference/transactions.md) - [List transactions](https://docs.shuttleglobal.com/reference/inst-listtransactions.md): This request performs a simple search against `transaction` objects. Available fields for `criteria` and `order`: * account * action * alt_key * amount * contract * created * currency * gateway *… - [Get a transaction](https://docs.shuttleglobal.com/reference/inst-gettransaction.md): Get details of a specific transaction. You can expand the following fields: - account - captures - contract - created_session - gateway - parts - payment_method - refunds - source_transaction -… - [Voids](https://docs.shuttleglobal.com/reference/voids.md) - [Get a void](https://docs.shuttleglobal.com/reference/inst-getvoid.md): Retrieve details of a specific void transaction. You can expand the following fields: * account * created_session * parts * source_transaction * updated_session - [Void an authorisation](https://docs.shuttleglobal.com/reference/inst-voidpayment.md): Void (cancel) a previously authorized payment that has not yet been captured. This releases the hold on the customer's funds. There are no parameters required to void a payment. - [Workflows](https://docs.shuttleglobal.com/reference/workflows.md) - [List workflows](https://docs.shuttleglobal.com/reference/inst-listworkflows.md): List workflows configured for the instance. - [Get a workflow](https://docs.shuttleglobal.com/reference/inst-getworkflow.md): Retrieve details of a specific workflow. - [Get workflow connection](https://docs.shuttleglobal.com/reference/inst-getworkflowconnection.md): Retrieve the connection status of a workflow. - [Get workflow settings](https://docs.shuttleglobal.com/reference/inst-getworkflowsettings.md): Retrieve the settings/configuration of a workflow. ## API Reference: payment-links-for-platforms-api - [Introduction](https://docs.shuttleglobal.com/reference/plfp-introduction.md) - [Authentication](https://docs.shuttleglobal.com/reference/plfp-authentication.md) - [OAuth 2.0](https://docs.shuttleglobal.com/reference/plfp-oauth2.md) - [Introduction](https://docs.shuttleglobal.com/reference/oauth-intro.md) - [Initiate authorization](https://docs.shuttleglobal.com/reference/authorize.md) - [Exchange code for tokens](https://docs.shuttleglobal.com/reference/gettoken.md) - [Revoke a token](https://docs.shuttleglobal.com/reference/revoketoken.md) - [Introspect token details](https://docs.shuttleglobal.com/reference/introspecttoken.md) - [Get client identity](https://docs.shuttleglobal.com/reference/getclientidentity.md) - [Webhooks](https://docs.shuttleglobal.com/reference/instance-webhooks.md) - [Attach webhook](https://docs.shuttleglobal.com/reference/attachwebhook.md) - [Detach webhook](https://docs.shuttleglobal.com/reference/detachwebhook.md) ## API Reference: payment-links-api - [Introduction](https://docs.shuttleglobal.com/reference/links-intro.md) - [Authentication](https://docs.shuttleglobal.com/reference/auth-api-keys.md) ## API Reference: Webhooks - [Introduction](https://docs.shuttleglobal.com/reference/webhooks-intro.md) - [Events](https://docs.shuttleglobal.com/reference/webhooks-events.md)