# Docs

- Overview
  - [Precium API Documentation](/docs/overview): Integration reference for the Precium card gateway and the Direct Debit order API.
- Server-to-Server
  - [Technical reference documentation](/docs/server-to-server/technical-reference-documentation): The endpoint and field reference for the Precium card API. Interactive documentation and ready-to-run request collections are linked below; the…
  - [Introduction](/docs/server-to-server/introduction): The Precium Server-to-Server (S2S) API gives you direct control of the full card payment flow.
  - [Integration quick start](/docs/server-to-server/integration-quick-start): The shortest path to a successful test transaction: create a client, create a purchase, submit card data, complete 3D Secure, confirm the result.
  - [Integration guide](/docs/server-to-server/integration-guide): The complete Server-to-Server flow reference. Every payment scenario, the purchase lifecycle, tokenisation, webhooks and the operations available…
  - [Error mapping](/docs/server-to-server/error-mapping): This document provides a comprehensive reference for all error codes returned by the Precium S2S API.
  - [Issuer response codes](/docs/server-to-server/issuer-response-codes): The ISO 8583 Field 39 (F39) response code is the authoritative indicator of why a card transaction was approved or declined.
  - [Code examples](/docs/server-to-server/code-examples): This document provides production-ready code examples in multiple programming languages for integrating with Precium's Server-to-Server API.
  - [Reconciliation](/docs/server-to-server/reconciliation): The Precium Reconciliation Service provides automated transaction reconciliation between your payment processing activity and settlement data.
  - [Test scenarios](/docs/server-to-server/test-scenarios): This document provides a comprehensive testing checklist to ensure your integration handles all payment scenarios correctly before going live.
  - [Troubleshooting](/docs/server-to-server/troubleshooting): This guide helps you diagnose and resolve common issues when integrating with the Precium S2S API.
  - [Glossary](/docs/server-to-server/glossary): A security protocol that provides an additional layer of authentication for online card transactions.
  - [Advanced refund management](/docs/server-to-server/advanced-refund-management): How refunds behave on the card API: what can be refunded, how much, how partial refunds accumulate, and what happens when one fails.
  - [Going live](/docs/server-to-server/going-live): Production credentials, throughput, IP allow-listing and the checks to complete before a merchant processes real money.
- Payment Orchestration
  - [Introduction](/docs/payment-orchestration/introduction): Welcome to the Precium Payment Orchestration API documentation.
  - [Technical reference documentation](/docs/payment-orchestration/technical-reference-documentation)
  - [Integration quick start](/docs/payment-orchestration/integration-quick-start): Get your first payment working in under 10 minutes.
  - [Integration guide](/docs/payment-orchestration/integration-guide): This comprehensive guide covers all payment scenarios, API endpoints, and integration patterns for the Precium Payment API.
  - [Error mapping](/docs/payment-orchestration/error-mapping): This document provides a comprehensive reference for all error codes, their causes, and recommended resolution steps.
  - [Code examples](/docs/payment-orchestration/code-examples): Production-ready code examples in multiple programming languages.
  - [Reconciliation](/docs/payment-orchestration/reconciliation): The Precium Reconciliation Service provides automated transaction reconciliation between your payment processing activity and settlement data.
  - [Test scenarios](/docs/payment-orchestration/test-scenarios): Comprehensive test scenarios and sandbox testing instructions for the Precium Payment API.
  - [Troubleshooting](/docs/payment-orchestration/troubleshooting): Solutions to common integration issues and debugging techniques.
  - [Glossary](/docs/payment-orchestration/glossary): Definitions of payment industry terms and Precium-specific concepts.
  - [Instant EFT](/docs/payment-orchestration/instant-eft): Ozow and OneGate: the same redirect flow with two provider identifiers, and the one field that differs between them.
- Direct Debit
  - [Introduction](/docs/direct-debit/introduction): Welcome to the Precium Debit Order API documentation. This API enables you to process debit order collections and EFT payments in South Africa.
  - [Technical reference documentation](/docs/direct-debit/technical-reference-documentation): The endpoint reference for the Precium Direct Debit (Mandates) API.
  - [Integration quick start](/docs/direct-debit/integration-quick-start): The Precium Debit Order API enables you to generate ad-hoc or recurring debit order payments and collections.
  - [Authentication](/docs/direct-debit/authentication): The Precium API uses OAuth 2.0 Client Credentials Flow for authentication.
  - [EFT Debit orders](/docs/direct-debit/eft-debit-orders): EFT debit orders (standard debit orders) enable merchants to collect funds from customer bank accounts with written, electronic, or voice-recorded…
  - [Merchant profiles](/docs/direct-debit/merchant-profiles): Merchant profiles store your banking configuration and are required for processing collections and payments.
  - [DebiCheck](/docs/direct-debit/debicheck): DebiCheck is an authenticated debit order system that requires customers to electronically confirm mandate details before collections can be…
  - [EFT Payments](/docs/direct-debit/eft-payments): EFT Payments (EFT Credits) enable merchants to send outbound payments to bank accounts.
  - [Webhooks](/docs/direct-debit/webhooks): Webhooks enable real-time notifications when transaction statuses change.
  - [Response codes](/docs/direct-debit/response-codes): HTTP status codes and error handling for the Precium API.
  - [Risk management](/docs/direct-debit/risk-management): The Payments Association of South Africa (PASA) enforces strict rules for debit order processing.
  - [Testing](/docs/direct-debit/testing): The Revio sandbox environment provides a mock-bank infrastructure for comprehensive testing.
  - [Troubleshooting](/docs/direct-debit/troubleshooting): Symptom:401 Unauthorized response
  - [Going live](/docs/direct-debit/going-live): Requirements and timeline for launching debit order collections in production.
  - [Glossary](/docs/direct-debit/glossary): A short identifier (maximum 10 characters) that appears on customer bank statements to identify the merchant.
- API reference
  - [API reference](/docs/reference): Every operation on the card gateway and the Direct Debit (Mandates) API, generated from their specifications.
  - Card API
    - [Card API](/docs/reference/card): Every operation on the card gateway (purchases, payouts, billing, webhooks), generated from the specification.
    - [Create a purchase – the main request for any e-commerce integration.](/docs/reference/card/purchases/post-purchases-)
    - [Retrieve an object by ID.](/docs/reference/card/purchases/get-purchases-id-)
    - [Cancel a pending purchase.](/docs/reference/card/purchases/post-purchases-id-cancel-)
    - [Release funds on hold.](/docs/reference/card/purchases/post-purchases-id-release-)
    - [Capture a previously authorized payment.](/docs/reference/card/purchases/post-purchases-id-capture-)
    - [Charge or Hold a purchase using a saved token.](/docs/reference/card/purchases/post-purchases-id-charge-)
    - [Delete a recurring token associated with a purchase.](/docs/reference/card/purchases/post-purchases-id-delete-recurring-token-)
    - [Refund a paid purchase.](/docs/reference/card/purchases/post-purchases-id-refund-)
    - [Mark a purchase as paid.](/docs/reference/card/purchases/post-purchases-id-mark-as-paid-)
    - [Re-sends invoice](/docs/reference/card/purchases/post-purchases-id-resend-invoice-)
    - [Get the list of payment methods available for your purchase.](/docs/reference/card/payment-methods/get-payment-methods-)
    - [Get the list of payout methods available for your payout.](/docs/reference/card/payout-methods/get-payout-methods-)
    - [Create an unprocessed payout object. A separate request is needed to execute the payout.](/docs/reference/card/payouts/post-payouts-)
    - [Retrieve an object by ID.](/docs/reference/card/payouts/get-payouts-id-)
    - [Send an invoice to one or several clients.](/docs/reference/card/billing/post-billing-)
    - [List all billing templates.](/docs/reference/card/billing/get-billing-templates-)
    - [Create a template to issue repeated invoices from in the future, with or without a subscription.](/docs/reference/card/billing/post-billing-templates-)
    - [Retrieve a billing template by ID.](/docs/reference/card/billing/get-billing-templates-id-)
    - [Delete a billing template by ID.](/docs/reference/card/billing/delete-billing-templates-id-)
    - [Update a billing template by ID.](/docs/reference/card/billing/put-billing-templates-id-)
    - [Send an invoice, generating a purchase from billing template data.](/docs/reference/card/billing/post-billing-templates-id-send-invoice-)
    - [Add a billing template client and activate recurring billing (is_subscription: true).](/docs/reference/card/billing/post-billing-templates-id-add-subscriber-)
    - [List all billing template clients for this billing template.](/docs/reference/card/billing/get-billing-templates-id-clients-)
    - [Retrieve a billing template client by client's ID.](/docs/reference/card/billing/get-billing-templates-id-clients-id-)
    - [Partially update a billing template client by client's ID.](/docs/reference/card/billing/patch-billing-templates-id-clients-id-)
    - [Retrieve a list of Purchases and Refunds for a Client.](/docs/reference/card/billing/get-billing-templates-id-clients-id-feed-)
    - [List all clients.](/docs/reference/card/clients/get-clients-)
    - [Create a new client.](/docs/reference/card/clients/post-clients-)
    - [Retrieve an object by ID.](/docs/reference/card/clients/get-clients-id-)
    - [Partially update a client by ID.](/docs/reference/card/clients/patch-clients-id-)
    - [Delete a client by ID.](/docs/reference/card/clients/delete-clients-id-)
    - [Update a client by ID.](/docs/reference/card/clients/put-clients-id-)
    - [Retrieve a list of Purchases and Refunds for a Client.](/docs/reference/card/clients/get-clients-id-feed-)
    - [List recurring tokens saved for a client.](/docs/reference/card/clients/get-clients-id-recurring-tokens-)
    - [Retrieve an object by ID.](/docs/reference/card/clients/get-clients-id-recurring-tokens-id-)
    - [Delete a client recurring token by ID.](/docs/reference/card/clients/delete-clients-id-recurring-tokens-id-)
    - [List all webhooks.](/docs/reference/card/webhooks/get-webhooks-)
    - [Create a new webhook.](/docs/reference/card/webhooks/post-webhooks-)
    - [Retrieve an object by ID.](/docs/reference/card/webhooks/get-webhooks-id-)
    - [Partially update a webhook by ID.](/docs/reference/card/webhooks/patch-webhooks-id-)
    - [Delete a webhook by ID.](/docs/reference/card/webhooks/delete-webhooks-id-)
    - [Update a webhook by ID.](/docs/reference/card/webhooks/put-webhooks-id-)
    - [List webhook deliveries for a specific object.](/docs/reference/card/webhooks/get-webhooks-deliveries-)
    - [Get a callback public key.](/docs/reference/card/public-key/get-public-key-)
    - [Get company balance.](/docs/reference/card/account/get-account-json-balance-)
    - [Get company turnover.](/docs/reference/card/account/get-account-json-turnover-)
    - [Get balance data.](/docs/reference/card/balance/get-balance-)
    - [List all generated statements.](/docs/reference/card/company-statements/get-company-statements-)
    - [Schedule a statement generation.](/docs/reference/card/company-statements/post-company-statements-)
    - [Retrieve a statement by ID.](/docs/reference/card/company-statements/get-company-statements-id-)
    - [Cancel a statement generation by ID.](/docs/reference/card/company-statements/post-company-statements-id-cancel-)
  - Debit order API
    - [Debit order API](/docs/reference/debit-orders): Every operation on the Mandates (Direct Debit) API, generated from the specification.
    - [/v2/accountverification/verify](/docs/reference/debit-orders/accountverification/post-v2-accountverification-verify)
    - [/v2/accountverification/validate](/docs/reference/debit-orders/accountverification/post-v2-accountverification-validate)
    - [Lists all Markoff Details](/docs/reference/debit-orders/bankaccountmarkoff/get-v2-bankaccountmarkoff)
    - [List Bank Account Settlement executions](/docs/reference/debit-orders/bankaccountsettlement/get-v2-bankaccountsettlement-config-configid-execute)
    - [Lists all Bank Account Statements](/docs/reference/debit-orders/bankaccountstatement/get-v2-bankaccountstatement-bankaccountnumber)
    - [Gets a specific Bank Account Statement](/docs/reference/debit-orders/bankaccountstatement/get-v2-bankaccountstatement-bankaccountnumber-id)
    - [Creates a Debicheck Mandate Callback](/docs/reference/debit-orders/callback/post-v2-callback-mandate-debicheck-mandateid)
    - [Creates a Debicheck Collection Callback](/docs/reference/debit-orders/callback/post-v2-callback-collection-debicheck-collectionid)
    - [Creates a Eft Collection Callback](/docs/reference/debit-orders/callback/post-v2-callback-collection-eft-collectionid)
    - [Creates a Eft Payment Callback](/docs/reference/debit-orders/callback/post-v2-callback-payment-eft-paymentid)
    - [Tests Debicheck Mandate Callback](/docs/reference/debit-orders/callback/post-v2-callback-test-mandate-debicheck-mandateid)
    - [Tests a Debicheck Collection Callback](/docs/reference/debit-orders/callback/post-v2-callback-test-collection-debicheck-collectionid)
    - [Tests a Eft Collection Callback](/docs/reference/debit-orders/callback/post-v2-callback-test-collection-eft-collectionid)
    - [Tests a Eft Payment Callback](/docs/reference/debit-orders/callback/post-v2-callback-test-payment-eft-paymentid)
    - [Tests a Settlement Callback](/docs/reference/debit-orders/callback/post-v2-callback-test-settlement-settlementid)
    - [Lists all Client Callback URLs](/docs/reference/debit-orders/clientcallbackurl/get-v2-clientcallbackurl)
    - [Create a new Client CallbackUrl](/docs/reference/debit-orders/clientcallbackurl/post-v2-clientcallbackurl)
    - [Gets a specific Client CallBack URL](/docs/reference/debit-orders/clientcallbackurl/get-v2-clientcallbackurl-id)
    - [Delete a Client Callback URL](/docs/reference/debit-orders/clientcallbackurl/delete-v2-clientcallbackurl-id)
    - [Update a Client Callback Url](/docs/reference/debit-orders/clientcallbackurl/put-v2-clientcallbackurl-id)
    - [Lists all Profiles for a specific client](/docs/reference/debit-orders/clientprofile/get-v2-clientprofile)
    - [Get a specific Profile for a specific client](/docs/reference/debit-orders/clientprofile/get-v2-clientprofile-id)
    - [Lists all Debicheck Collection](/docs/reference/debit-orders/collection/get-v2-collection-debicheck)
    - [Create a new Debicheck Collection](/docs/reference/debit-orders/collection/post-v2-collection-debicheck)
    - [Lists all EFT Collection](/docs/reference/debit-orders/collection/get-v2-collection-eft)
    - [Create a new EFT Mandate and Collection based on the created mandate](/docs/reference/debit-orders/collection/post-v2-collection-eft)
    - [Gets specific Debicheck Collection](/docs/reference/debit-orders/collection/get-v2-collection-debicheck-collectionid)
    - [Delete a Debicheck Collection](/docs/reference/debit-orders/collection/delete-v2-collection-debicheck-collectionid)
    - [Gets specific EFT Collection](/docs/reference/debit-orders/collection/get-v2-collection-eft-collectionid)
    - [Delete a EFT Collection](/docs/reference/debit-orders/collection/delete-v2-collection-eft-collectionid)
    - [Create a new Debicheck Collection from an existing Debicheck Mandate](/docs/reference/debit-orders/collection/post-v2-collection-debicheck-from-mandate)
    - [Recreate a Debicheck Collection as a new EFT Collection](/docs/reference/debit-orders/collection/post-v2-collection-debicheck-collectionid-recreate-as-eft)
    - [Create a new EFT Collection from an existing EFT Mandate](/docs/reference/debit-orders/collection/post-v2-collection-eft-from-mandate)
    - [Gets the latest status of a Debicheck Collection](/docs/reference/debit-orders/collection/get-v2-collection-debicheck-collectionid-status)
    - [Gets the latest status of a EFT Collection](/docs/reference/debit-orders/collection/get-v2-collection-eft-collectionid-status)
    - [Generate a csv template to upload debicheck collections](/docs/reference/debit-orders/collection/get-v2-collection-debicheck-upload-csv-generate-template)
    - [Download previously processed csv results after uploading debicheck collections](/docs/reference/debit-orders/collection/get-v2-collection-debicheck-download-csv-bulkuploadid)
    - [Create debicheck collections from a csv template](/docs/reference/debit-orders/collection/post-v2-collection-debicheck-upload-csv)
    - [Generate a csv template to upload eft collections](/docs/reference/debit-orders/collection/get-v2-collection-eft-upload-csv-generate-template)
    - [Create eft collections from a csv template](/docs/reference/debit-orders/collection/post-v2-collection-eft-upload-csv)
    - [Download previously processed csv results after uploading eft collections](/docs/reference/debit-orders/collection/get-v2-collection-eft-download-csv-bulkuploadid)
    - [Lists all Collection Results](/docs/reference/debit-orders/collectionresult/get-v2-collectionresult)
    - [Lists all collection events, ordered by the time they were created at](/docs/reference/debit-orders/event/get-v2-event-collection)
    - [Lists all payment events, ordered by the time they were created at](/docs/reference/debit-orders/event/get-v2-event-payment)
    - [Lists all mandate events, ordered by the time they were created at](/docs/reference/debit-orders/event/get-v2-event-mandate)
    - [Lists all profile events, ordered by the time they were created at](/docs/reference/debit-orders/event/get-v2-event-profile)
    - [Lists all Debicheck Mandates](/docs/reference/debit-orders/mandate/get-v2-mandate-debicheck)
    - [Create a new Debicheck Mandate](/docs/reference/debit-orders/mandate/post-v2-mandate-debicheck)
    - [Lists all EFT Mandates](/docs/reference/debit-orders/mandate/get-v2-mandate-eft)
    - [Create a new EFT Mandate](/docs/reference/debit-orders/mandate/post-v2-mandate-eft)
    - [Gets specific Debicheck Mandate](/docs/reference/debit-orders/mandate/get-v2-mandate-debicheck-mandateid)
    - [Patch a Debicheck Mandate](/docs/reference/debit-orders/mandate/patch-v2-mandate-debicheck-mandateid)
    - [Update a Debicheck Mandate](/docs/reference/debit-orders/mandate/put-v2-mandate-debicheck-mandateid)
    - [Gets specific EFT Mandate](/docs/reference/debit-orders/mandate/get-v2-mandate-eft-mandateid)
    - [Patch a EFT Mandate](/docs/reference/debit-orders/mandate/patch-v2-mandate-eft-mandateid)
    - [Delete an EFT Mandate](/docs/reference/debit-orders/mandate/delete-v2-mandate-eft-mandateid)
    - [Update an EFT Mandate](/docs/reference/debit-orders/mandate/put-v2-mandate-eft-mandateid)
    - [Authenticates a Specific Mandate](/docs/reference/debit-orders/mandate/post-v2-mandate-debicheck-mandateid-auth)
    - ['requiresAuth' is set internally, please do not override this value unless manual intervention is required
Amends a Specific Mandate at the bank](/docs/reference/debit-orders/mandate/post-v2-mandate-debicheck-mandateid-amend)
    - [Gets the latest status of a Debicheck Mandate](/docs/reference/debit-orders/mandate/get-v2-mandate-debicheck-mandateid-status)
    - [Gets the latest status of a EFT Mandate](/docs/reference/debit-orders/mandate/get-v2-mandate-eft-mandateid-status)
    - [Resets a debicheck mandate to the latest previously completed state.](/docs/reference/debit-orders/mandate/post-v2-mandate-debicheck-mandateid-reset)
    - [Starts polling a debicheck mandate result at the bank and potentially change the state.](/docs/reference/debit-orders/mandate/post-v2-mandate-debicheck-mandateid-poll)
    - [Generate a csv template to upload debicheck mandates](/docs/reference/debit-orders/mandate/get-v2-mandate-debicheck-upload-csv-generate-template)
    - [Create debicheck mandates from a csv template](/docs/reference/debit-orders/mandate/post-v2-mandate-debicheck-upload-csv)
    - [Download previously processed csv results after uploading debicheck mandates](/docs/reference/debit-orders/mandate/get-v2-mandate-debicheck-download-csv-bulkuploadid)
    - [Generate a csv template to upload eft mandates](/docs/reference/debit-orders/mandate/get-v2-mandate-eft-upload-csv-generate-template)
    - [Create eft mandates from a csv template](/docs/reference/debit-orders/mandate/post-v2-mandate-eft-upload-csv)
    - [Download previously processed csv results after uploading eft mandates](/docs/reference/debit-orders/mandate/get-v2-mandate-eft-download-csv-bulkuploadid)
    - [Lists all Mandate Audits or all profiles for a specific client](/docs/reference/debit-orders/mandateaudit/get-v2-mandateaudit)
    - [Create a new Mandate Audit](/docs/reference/debit-orders/mandateaudit/post-v2-mandateaudit)
    - [Get a specific Mandate Audit](/docs/reference/debit-orders/mandateaudit/get-v2-mandateaudit-id)
    - [Delete a Mandate Audit](/docs/reference/debit-orders/mandateaudit/delete-v2-mandateaudit-id)
    - [Lists all Mandate Results](/docs/reference/debit-orders/mandateresult/get-v2-mandateresult)
    - [Create a new Mandate Result](/docs/reference/debit-orders/mandateresult/post-v2-mandateresult)
    - [Lists all Merchant Profiles](/docs/reference/debit-orders/merchantprofile/get-v2-merchantprofile)
    - [Gets a specific Merchant Profile](/docs/reference/debit-orders/merchantprofile/get-v2-merchantprofile-id)
    - [Lists all Eft Payments](/docs/reference/debit-orders/payment/get-v2-payment-eft)
    - [Create a new Eft Payment](/docs/reference/debit-orders/payment/post-v2-payment-eft)
    - [Gets specific Eft Payment](/docs/reference/debit-orders/payment/get-v2-payment-eft-paymentid)
    - [Delete a Eft Payment](/docs/reference/debit-orders/payment/delete-v2-payment-eft-paymentid)
    - [Gets the latest status of a Eft Payment](/docs/reference/debit-orders/payment/get-v2-payment-eft-paymentid-status)
    - [Generate a csv template to upload eft payments](/docs/reference/debit-orders/payment/get-v2-payment-eft-upload-csv-generate-template)
    - [Create eft payments from a csv template](/docs/reference/debit-orders/payment/post-v2-payment-eft-upload-csv)
    - [Download previously processed csv results after uploading eft payments](/docs/reference/debit-orders/payment/get-v2-payment-eft-download-csv-bulkuploadid)
    - [Lists all reports per profile](/docs/reference/debit-orders/reporting/get-v2-reporting)
    - [Lists all Transaction Files](/docs/reference/debit-orders/transactionfile/get-v2-transactionfile)
    - [Get a specific Transaction File](/docs/reference/debit-orders/transactionfile/get-v2-transactionfile-id)
- Reconciliation
  - [Reconciliation files](/docs/reconciliation): The daily reconciliation, markoff and exception files: current schemas, parsing rules and how to match a transaction.

Agents can search these docs over MCP: http://localhost:3000/api/mcp