# Documentation

## Documentation

- [Get started](https://guide.pay.gov.sg/overview/get-started.md): PaySG is a free-to-use platform built for government agencies to collect online payments. It enables agencies to collect payments through our no-code tools and/or by integrating our API
- [Resource guides](https://guide.pay.gov.sg/overview/resource-guides.md): Explore our resource guides, tailored to the key stakeholder groups that use PaySG.
- [For business users](https://guide.pay.gov.sg/overview/resource-guides/for-business-users.md)
- [For finance teams](https://guide.pay.gov.sg/overview/resource-guides/for-finance-teams.md)
- [For integration teams](https://guide.pay.gov.sg/overview/resource-guides/for-integration-teams.md): This page is for technical users who are looking to integrate with PaySG
- [Stripe onboarding](https://guide.pay.gov.sg/overview/stripe-onboarding.md)
- [Live use cases](https://guide.pay.gov.sg/overview/live-use-cases.md)
- [Usage overview](https://guide.pay.gov.sg/overview/live-use-cases/usage-overview.md): This page includes details of how PaySG can be incorporated into your agency's use cases.
- [Payment services](https://guide.pay.gov.sg/start-using-the-dashboard/payment-services.md): This guide will walk you through the process of creating a payment service in PaySG. Once you've created a payment service, you can start creating payment links to collect payments.
- [Collaborators and access control](https://guide.pay.gov.sg/start-using-the-dashboard/collaborators-and-access-control.md): The collaborator feature in PaySG allows you to add colleagues to your payment service, enabling them to view and edit the service's settings and payment links.
- [One-time payment links](https://guide.pay.gov.sg/start-using-the-dashboard/one-time-payment-links.md): Create payment links in your payment services to start collecting payments from MOPs.
- [Single link creation](https://guide.pay.gov.sg/start-using-the-dashboard/one-time-payment-links/single-link-creation.md): Single link creation is suitable for ad-hoc payments or scenarios where you need to create individual payment links.
- [Bulk link creation](https://guide.pay.gov.sg/start-using-the-dashboard/one-time-payment-links/bulk-link-creation.md): Bulk link creation is suitable when you need to create a large volume of payment links at once. It allows you to streamline the process and save time.
- [Send payment links](https://guide.pay.gov.sg/start-using-the-dashboard/one-time-payment-links/send-payment-links.md): Send payment links to payers collect fees, donations, or one-off payments—no ne
- [Payment link page](https://guide.pay.gov.sg/start-using-the-dashboard/one-time-payment-links/payment-link-page.md): Payment page example
- [Payment receipt email](https://guide.pay.gov.sg/start-using-the-dashboard/one-time-payment-links/payment-receipt-email.md): Payment confirmation email example
- [Subscriptions](https://guide.pay.gov.sg/start-using-the-dashboard/subscriptions.md): Initiate month recurring payments, aka subscriptions
- [Set-up](https://guide.pay.gov.sg/start-using-the-dashboard/subscriptions/set-up.md)
- [View subscriptions](https://guide.pay.gov.sg/start-using-the-dashboard/subscriptions/view-subscriptions.md)
- [Manage subscriptions](https://guide.pay.gov.sg/start-using-the-dashboard/subscriptions/manage-subscriptions.md)
- [Payments and refunds](https://guide.pay.gov.sg/start-using-the-dashboard/payments-and-refunds.md)
- [Payment methods](https://guide.pay.gov.sg/start-using-the-dashboard/payments-and-refunds/payment-methods.md): Information about available payment methods and how to add new payment methods.
- [Dashboard](https://guide.pay.gov.sg/start-using-the-dashboard/payments-and-refunds/dashboard.md)
- [Refunds](https://guide.pay.gov.sg/start-using-the-dashboard/payments-and-refunds/refunds.md)
- [Payouts](https://guide.pay.gov.sg/start-using-the-dashboard/payouts.md): A payout is the transfer of funds from an agency's Stripe account to their receiving bank account
- [Reports](https://guide.pay.gov.sg/start-using-the-dashboard/reports.md): This page provides information about the various reports that can be downloaded on the PaySG dashboard.
- [Payment workflows with Plumber](https://guide.pay.gov.sg/start-using-the-dashboard/payment-workflows-with-plumber.md): This section guides users on creating payment workflows with Plumber.
- [Set-up](https://guide.pay.gov.sg/start-using-the-dashboard/payment-workflows-with-plumber/set-up.md)
- [Testing](https://guide.pay.gov.sg/start-using-the-dashboard/payment-workflows-with-plumber/testing.md)
- [Payment forms](https://guide.pay.gov.sg/start-using-the-dashboard/payment-forms.md)
- [Set-up](https://guide.pay.gov.sg/start-using-the-dashboard/payment-forms/set-up.md): Payment forms use 3 platforms: PaySG, FormSG, and Plumber. You'll need to do some set up on each platform.
- [Testing](https://guide.pay.gov.sg/start-using-the-dashboard/payment-forms/testing.md)
- [Resources](https://guide.pay.gov.sg/start-using-the-dashboard/payment-forms/resources.md)
- [Get started](https://guide.pay.gov.sg/start-an-api-integration/get-started.md)
- [Endpoints](https://guide.pay.gov.sg/start-an-api-integration/endpoints.md)
- [Integrating with your e-services](https://guide.pay.gov.sg/start-an-api-integration/integrating-with-your-e-services.md): The following describes what you can expect when integrating your e-service with PaySG.
- [Errors](https://guide.pay.gov.sg/start-an-api-integration/errors.md)
- [Idempotency](https://guide.pay.gov.sg/start-an-api-integration/idempotency.md)
- [Pagination](https://guide.pay.gov.sg/start-an-api-integration/pagination.md)
- [Go-live checklist](https://guide.pay.gov.sg/start-an-api-integration/go-live-checklist.md)
- [Events](https://guide.pay.gov.sg/api-resources/events.md)
- [The event object](https://guide.pay.gov.sg/api-resources/events/the-event-object.md)
- [Types of events](https://guide.pay.gov.sg/api-resources/events/types-of-events.md)
- [Payments](https://guide.pay.gov.sg/api-resources/payments.md)
- [Create a payment](https://guide.pay.gov.sg/api-resources/payments/create-a-payment.md): Creates a payment object.
- [Retrieve payments](https://guide.pay.gov.sg/api-resources/payments/retrieve-payments.md): Retrieves the details of a payment that has previously been created.
- [Send email for payment](https://guide.pay.gov.sg/api-resources/payments/send-email-for-payment.md): Sends an email notification to intended payer with the details of a payment that has previously been created.
- [Cancel a payment](https://guide.pay.gov.sg/api-resources/payments/cancel-a-payment.md): Cancels a payment with an 'unpaid' status.
- [Refund a payment](https://guide.pay.gov.sg/api-resources/payments/refund-a-payment.md): Refunds a payment with a 'paid' status.
- [Get all payments from payment service](https://guide.pay.gov.sg/api-resources/payments/get-all-payments-from-payment-service.md): Returns a list of payments created within a payment service.
- [Introduction](https://guide.pay.gov.sg/webhooks/introduction.md)
- [Set-up](https://guide.pay.gov.sg/webhooks/set-up.md)
- [Events](https://guide.pay.gov.sg/webhooks/set-up/events.md)
- [Best practices](https://guide.pay.gov.sg/webhooks/set-up/best-practices.md): Review these best practices to make sure your webhooks remain secure and function well with your integration
- [Access](https://guide.pay.gov.sg/faq/access.md)
- [Costs](https://guide.pay.gov.sg/faq/costs.md)
- [Timeline](https://guide.pay.gov.sg/faq/timeline.md): The following guide provides more information on the estimated duration for each phase of integrating your e-service with PaySG.
- [API keys](https://guide.pay.gov.sg/faq/api-keys.md)
- [API integration](https://guide.pay.gov.sg/faq/api-integration.md): This page includes FAQs from technical teams and vendors when integrating with PaySG.
- [Payments](https://guide.pay.gov.sg/faq/payments.md)
- [Payment methods](https://guide.pay.gov.sg/faq/payment-methods.md)
- [Payouts and transaction fees](https://guide.pay.gov.sg/faq/payouts-and-transaction-fees.md)
- [Refunds](https://guide.pay.gov.sg/faq/refunds.md)
- [Security and compliance](https://guide.pay.gov.sg/faq/security-and-compliance.md)
- [Downtime and maintenance](https://guide.pay.gov.sg/faq/downtime-and-maintenance.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
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://guide.pay.gov.sg/overview/get-started.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
