# Bob Pay API Documentation

> Developer documentation for the Bob Pay public API: accept online payments, create payment links, manage payouts, account settings and billing for South African businesses. Base URLs: sandbox `https://api.sandbox.bobpay.co.za`, production `https://api.bobpay.co.za`. All endpoints except login require a Bearer token obtained via `POST /login`.

Every page is also available as plain Markdown by appending `.md` to its URL path.

## Introduction

- [Introduction to the Bob Pay API](/introduction.md): The Bob Pay API enables seamless integration with Bob Pay, allowing you to start accepting payments quickly and easily.

## Authentication

- [POST Login](/authentication.md): Bob Pay uses Bearer Token authentication.

## Getting started

- [Generating a payment URL](/getting-started.md): To direct your customer to the Bob Pay payment screen, you will need to create a payment URL and then navigate to that URL.

## Payment links

- [POST Create payment link](/payment-links.md): This endpoint allows you to generate a unique, secure payment link for a customer, which they can use to complete payment via supported methods.

## Validate with Bob Pay

- [POST Validate](/validate-with-bob-pay.md): Validate a payment intent by sending the full webhook payload received from Bob Pay.

## Payments

- [Payments](/payments.md): The Payments API allows you to query and manage payments across your accounts with a variety of filters to tailor your searches.
- [GET Payment intent](/payments/payment-intent.md): This endpoint allows you to query and retrieve comprehensive information about payment intents across your accounts.
- [GET Get public payment methods](/payments/payment-methods-public.md): This endpoint retrieves the list of payment methods available for a specific account, including their status and display order.
- [POST Refund payment (payment reversal)](/payments/refund-payment.md): This endpoint enables you to initiate a refund for a specific payment.
- [POST Shorten url](/payments/shorten-url.md): Generate a shortened version of a payment intent URL.
- [POST Validate payment intent signature](/payments/signature.md): This endpoint checks whether a previously generated signature is valid for a payment intent.

## Payouts

- [Payouts](/payouts.md): The Payouts API allows you to manage and query payout requests across your accounts.
- [GET Get payout requests](/payouts/payout-requests.md): This endpoint allows you to retrieve detailed information about payout requests for your accounts.
- [GET Get scheduled payouts](/payouts/schedule.md): This endpoint retrieves the automated payout schedules configured for your account, including frequency, minimum payout amounts, and payout days.

## Account settings

- [Account settings](/account-settings.md): The Account Settings API allows you to query specific configuration settings for your accounts.
- [GET Get account payment method settings](/account-settings/account-payment-methods.md): This endpoint retrieves the payment method settings for a specified account.
- [GET Get account payout fee settings](/account-settings/payout-fee-settings.md): This endpoint retrieves the payout fee settings for a specified account.

## Billing

- [Billing](/billing.md): The Billing API allows you to retrieve comprehensive billing documents and data related to your account, enabling streamlined financial reconciliation and tr...
- [GET Get credit notes](/billing/credit-notes.md): This endpoint retrieves credit note data for specified credit note IDs, with options for PDF or CSV export.
- [GET Get invoices](/billing/invoices.md): This endpoint retrieves invoice data for specified invoice IDs, with options for PDF/CSV export and filtering by status.
- [GET Get billing statement](/billing/statement.md): This endpoint retrieves an account statement for a specified period, with an option to download as PDF.
- [GET Transactions](/billing/transactions.md): This endpoint allows you to query and retrieve detailed information about transactions across your accounts.

## Legacy payment link

- [Bob Pay API documentation (legacy)](/legacy-payment-link.md): This documentation describes the legacy method of generating payment URLs by manually constructing query parameters and signatures.

## Optional

- [Complete documentation in a single file](/llms-full.txt)