# Hyp API Documentation

## Hyp Platform

- [Introduction to the Hyp Payment Platform](https://developers.hyp.co.il/introduction-to-the-hyp-payment-platform.md)

## Hyp Pay

- [Hyp Pay Overview](https://developers.hyp.co.il/pay/introduction/index.md)
- [Key Concepts and Terminology](https://developers.hyp.co.il/pay/introduction/key-concepts-and-terminology.md)
- [What is a Payment Page](https://developers.hyp.co.il/pay/introduction/what-is-a-payment-page.md)
- [Prerequisites & Initial Setup](https://developers.hyp.co.il/pay/getting-started/prerequisites-and-initial-setup.md)
- [Authentication & Security](https://developers.hyp.co.il/pay/getting-started/authentication-security.md)
- [Safe Testing & Environments](https://developers.hyp.co.il/pay/getting-started/testing-environments.md)
- [Creating a Payment Page](https://developers.hyp.co.il/pay/getting-started/creating-a-payment-page.md)
- [Accepting Credit Cards](https://developers.hyp.co.il/pay/common-use-cases/credit-cards.md)
- [Customizing Payment Page Design](https://developers.hyp.co.il/pay/common-use-cases/customizing-payment-page-design.md)
- [Adding Installments to the Payment Page](https://developers.hyp.co.il/pay/common-use-cases/installments.md)
- [Accepting Digital Wallets](https://developers.hyp.co.il/pay/common-use-cases/digital-wallets.md)
- [Sending Payment Links via SMS or Email](https://developers.hyp.co.il/pay/common-use-cases/send-payment-links.md)
- [Saving Card Tokens](https://developers.hyp.co.il/pay/common-use-cases/tokenization.md)
- [Postponing Transactions](https://developers.hyp.co.il/pay/common-use-cases/postponing-transactions.md)
- [Cancelling Transactions](https://developers.hyp.co.il/pay/common-use-cases/cancellations.md)
- [Performing Refunds](https://developers.hyp.co.il/pay/common-use-cases/refunds.md)
- [Managing Recurring Payments](https://developers.hyp.co.il/pay/advanced-features/recurring-payments.md)
- [Handling Two-Phase Commits](https://developers.hyp.co.il/pay/advanced-features/two-phase-commits.md)
- [Accepting Gift Cards](https://developers.hyp.co.il/pay/advanced-features/gift-cards.md)
- [Performing Payouts](https://developers.hyp.co.il/pay/advanced-features/payouts.md)
- [3-D Secure (3DS)](https://developers.hyp.co.il/pay/advanced-features/3ds.md)
- [Basic Invoicing](https://developers.hyp.co.il/pay/invoicing/basic-invoicing.md)
- [Compliance & Security Overview](https://developers.hyp.co.il/pay/security/compliance-and-security-overview.md)
- [Network Security at Hyp](https://developers.hyp.co.il/pay/security/network-security-at-hyp.md)
- [Transaction Validation](https://developers.hyp.co.il/pay/security/transaction-validation.md)
- [Payment Page Security](https://developers.hyp.co.il/pay/security/payment-page-security.md)
- [Data Privacy, Access Control and Monitoring](https://developers.hyp.co.il/pay/security/data-privacy.md)
- [Certifications](https://developers.hyp.co.il/pay/security/certifications.md)
- [API Actions](https://developers.hyp.co.il/pay/reference/actions.md)
- [Status Codes](https://developers.hyp.co.il/pay/reference/response-status-codes.md)

## Hyp Enterprise

- [Hyp Enterprise Overview](https://developers.hyp.co.il/enterprise/introduction/overview.md)
- [Key Concepts and Terminology](https://developers.hyp.co.il/enterprise/introduction/key-concepts-and-terminology.md)
- [Prerequisites and Requirements](https://developers.hyp.co.il/enterprise/introduction/prerequisites-and-requirements.md)
- [Environment Setup](https://developers.hyp.co.il/enterprise/introduction/environment-setup.md)
- [Authentication and Security](https://developers.hyp.co.il/enterprise/introduction/authentication-and-security.md)
- [API Request & Response General Structure](https://developers.hyp.co.il/enterprise/introduction/request-and-response-general-structure.md)
- [Basic Integration Flow: Hello World With a Full Working Charge](https://developers.hyp.co.il/enterprise/introduction/basic-integration-flow-hello-world-with-a-full-working-charge.md)
- [When to Use Each Payment Flow](https://developers.hyp.co.il/enterprise/introduction/when-to-use.md)
- [Contacts](https://developers.hyp.co.il/enterprise/introduction/contacts.md)
- [Integrating Hyp’s Payment Page and Accepting Payment](https://developers.hyp.co.il/enterprise/payment-page-integration/integrating-hyps-payment-page-and-accepting-payment.md)
- [Full-Page Redirect vs Iframe-Based Integration](https://developers.hyp.co.il/enterprise/payment-page-integration/full-page-redirect-vs-iframe-based-integration.md)
- [Adding Installments to the Payment Page](https://developers.hyp.co.il/enterprise/payment-page-integration/installments.md)
- [Deferring Payments](https://developers.hyp.co.il/enterprise/payment-page-integration/deferring-payments.md)
- [Adding CAPTCHA](https://developers.hyp.co.il/enterprise/payment-page-integration/captcha.md)
- [Receiving Notifications via Webhooks](https://developers.hyp.co.il/enterprise/payment-page-integration/webhooks.md)
- [Payment Methods Overview](https://developers.hyp.co.il/enterprise/available-payment-options/overview.md)
- [Simple Credit Card](https://developers.hyp.co.il/enterprise/available-payment-options/simple-credit-card.md)
- [Saved Card](https://developers.hyp.co.il/enterprise/available-payment-options/saved-card.md)
- [Digital Wallets](https://developers.hyp.co.il/enterprise/available-payment-options/digital-wallets.md)
- [Pay By Link](https://developers.hyp.co.il/enterprise/available-payment-options/pay-by-link.md)
- [Payment Request](https://developers.hyp.co.il/enterprise/available-payment-options/payment-request.md)
- [Gift Cards](https://developers.hyp.co.il/enterprise/available-payment-options/gift-cards.md)
- [Physical Pinpad/Terminal](https://developers.hyp.co.il/enterprise/available-payment-options/physical-pinpad-terminal.md)
- [Account to Account](https://developers.hyp.co.il/enterprise/available-payment-options/account-to-account.md)
- [Overview](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/overview.md)
- [Changing the UI Language](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/changing-the-ui-language.md)
- [Customizing the Default Text](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/customizing-the-default-text.md)
- [Adding Business Logos and Custom Images](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/adding-business-logo-and-custom-images.md)
- [Configuring Field Display Options](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/configuring-field-display-options.md)
- [Modifying the Default Styles](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/modifying-the-default-styles.md)
- [Suggesting to Save Credit Card Data](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/suggesting-to-save-credit-card-data.md)
- [Showing Saved Credit Cards](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/showing-saved-credit-cards.md)
- [Managing Payment Methods](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/managing-payment-methods.md)
- [Showing or Hiding the Personal ID Field](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/israeli-id.md)
- [Hiding Other Elements from the Page](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/hiding-other-elements-from-the-page.md)
- [Configuring the Transition Page](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/configuring-the-transition-page.md)
- [Adding Custom Input Fields](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/adding-custom-input-fields.md)
- [Changing the Redirect Behavior When Using bit](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/changing-the-redirect-behavior-when-using-bit.md)
- [Payment Page Templates](https://developers.hyp.co.il/enterprise/changing-the-default-payment-page-appearance/templates.md)
- [Overview of Two-Phase Commits](https://developers.hyp.co.il/enterprise/two-phase-commits/overview.md)
- [Payment Page Authorization](https://developers.hyp.co.il/enterprise/two-phase-commits/payment-page-auth.md)
- [Card Verification Authorization](https://developers.hyp.co.il/enterprise/two-phase-commits/card-verification-auth.md)
- [Overview of Recurring Payments](https://developers.hyp.co.il/enterprise/recurring-payments-and-subscriptions/overview-of-recurring-payments.md)
- [Implementing Recurring Payments](https://developers.hyp.co.il/enterprise/recurring-payments-and-subscriptions/implementing-recurring-payments.md)
- [Implementing Hora'at Keva](https://developers.hyp.co.il/enterprise/recurring-payments-and-subscriptions/horaat-keva.md)
- [Refunds & Cancellations](https://developers.hyp.co.il/enterprise/additional-payment-scenarios/refunds-and-cancellations.md)
- [Tokenization](https://developers.hyp.co.il/enterprise/additional-payment-scenarios/tokenization.md)
- [Installments in Direct Charge and Two-Phase Commit](https://developers.hyp.co.il/enterprise/additional-payment-scenarios/installments-direct-charge.md)
- [Short-Term CC Data Storage](https://developers.hyp.co.il/enterprise/additional-payment-scenarios/short-term-cc-data-storage.md)
- [Payouts](https://developers.hyp.co.il/enterprise/additional-payment-scenarios/payouts.md)
- [Introduction to 3-D Secure (3DS)](https://developers.hyp.co.il/enterprise/3-d-secure-integration/introduction-to-3ds.md)
- [Registering for 3DS](https://developers.hyp.co.il/enterprise/3-d-secure-integration/service-registration.md)
- [3DS Flow in Payment Page](https://developers.hyp.co.il/enterprise/3-d-secure-integration/3ds-flow-in-payment-page.md)
- [Identifying 3DS Transactions](https://developers.hyp.co.il/enterprise/3-d-secure-integration/transaction-identification.md)
- [Overview of Documents and Invoicing](https://developers.hyp.co.il/enterprise/documents-and-invoicing/overview.md)
- [Enabling Invoicing in the Terminal](https://developers.hyp.co.il/enterprise/documents-and-invoicing/enabling-invoicing.md)
- [Issuing Invoices](https://developers.hyp.co.il/enterprise/documents-and-invoicing/issuing-invoices.md)
- [Overriding Invoice Account Details in the Request](https://developers.hyp.co.il/enterprise/documents-and-invoicing/overriding-invoice-account-details-in-the-request.md)
- [Invoicing for Refunds](https://developers.hyp.co.il/enterprise/documents-and-invoicing/refund-invoices.md)
- [Invoicing for Cancellations and Payouts](https://developers.hyp.co.il/enterprise/documents-and-invoicing/cancellations-payouts.md)
- [Invoice Inquiries](https://developers.hyp.co.il/enterprise/documents-and-invoicing/invoice-inquiries.md)
- [Overview of Transaction Inquiries](https://developers.hyp.co.il/enterprise/inquiring-transactions/overview.md)
- [Examples of Transaction Inquiries](https://developers.hyp.co.il/enterprise/inquiring-transactions/examples.md)
- [Pagination in Transaction Inquiries](https://developers.hyp.co.il/enterprise/inquiring-transactions/inquire-transactions-with-pagination.md)
- [Compliance & Security Overview](https://developers.hyp.co.il/enterprise/advanced-security-guidelines/compliance-and-security-overview.md)
- [Data Privacy](https://developers.hyp.co.il/enterprise/advanced-security-guidelines/data-privacy.md)
- [Network Security at Hyp](https://developers.hyp.co.il/enterprise/advanced-security-guidelines/network-security-at-hyp.md)
- [Payment Page Security](https://developers.hyp.co.il/enterprise/advanced-security-guidelines/payment-page-security.md)
- [Transaction Validation](https://developers.hyp.co.il/enterprise/advanced-security-guidelines/transaction-validation.md)
- [Backwards Compatibility](https://developers.hyp.co.il/enterprise/advanced-considerations/backwards-compatibility.md)
- [Request Validation Methods](https://developers.hyp.co.il/enterprise/advanced-considerations/request-validation-methods.md)
- [System Status Monitoring](https://developers.hyp.co.il/enterprise/advanced-considerations/status-monitoring.md)
- [API Reference Index](https://developers.hyp.co.il/enterprise/api-reference/index.md)
- [addCgInvoice](https://developers.hyp.co.il/enterprise/api-reference/addcginvoice.md)
- [cancelDeal](https://developers.hyp.co.il/enterprise/api-reference/canceldeal.md)
- [doDeal](https://developers.hyp.co.il/enterprise/api-reference/dodeal.md)
- [getCardId](https://developers.hyp.co.il/enterprise/api-reference/getcardid.md)
- [getCardNo](https://developers.hyp.co.il/enterprise/api-reference/getcardno.md)
- [getExternalCardId](https://developers.hyp.co.il/enterprise/api-reference/getexternalcardid.md)
- [getSessionId](https://developers.hyp.co.il/enterprise/api-reference/getsessionid.md)
- [inquireInvoice](https://developers.hyp.co.il/enterprise/api-reference/inquireinvoice.md)
- [inquireTransactions](https://developers.hyp.co.il/enterprise/api-reference/inquiretransactions.md)
- [refundCgInvoice](https://developers.hyp.co.il/enterprise/api-reference/refundcginvoice.md)
- [refundDeal](https://developers.hyp.co.il/enterprise/api-reference/refunddeal.md)
- [transmitInquire](https://developers.hyp.co.il/enterprise/api-reference/transmitinquire.md)
- [transmitTerminal](https://developers.hyp.co.il/enterprise/api-reference/transmitterminal.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.hyp.co.il/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.