{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"About Reefpay APIs","description":"Reefpay is the groundbreaking payment gateway that lets you integrate with the future of payments.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"about-reefpay-apis","__idx":0},"children":["About ","Reefpay"," APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-the-api-provides","__idx":1},"children":["What the API provides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ","Reefpay"," API gives you programmatic access to every capability of the platform."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payments"]},": Create sales, authorizations, captures, voids, and refunds for credit cards and bank accounts."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tokenization"]},": Store and manage payment methods securely."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account management"]},": Create and manage clients, integrations (processor connections), and persons."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reporting"]},": Query transactions, list batches, and export settlement data."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Security"]},": Retrieve encryption keys, manage passwords, and verify multi-factor authentication challenges."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints live under a single base URL and use a consistent request/response format."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Base URL"},"children":["Base URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sandbox"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.dev.paradisegateway.net"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.paradisegateway.net"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-the-api-is-organized","__idx":2},"children":["How the API is organized"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API is organized around resources. Each resource has a predictable URL pattern and supports standard HTTP methods."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Base path"},"children":["Base path"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Operations"},"children":["Operations"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Authentication"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/auth/keys"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retrieve API key and encryption keys"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Transactions"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/transactions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create, list, retrieve, update, capture, cancel"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Payment tokens"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/payment_tokens"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create, list, retrieve, update, delete"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Clients"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/clients"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create, list, retrieve, update, delete"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Integrations"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/integrations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create, list, retrieve, update, delete"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Users"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/users"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create, list, retrieve, update, delete"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Batches"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/batches"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List batches, update batch status"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["MFA"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/mfa"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Create challenges, verify codes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Passwords"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/users/me/passwords"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Change password"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication-overview","__idx":3},"children":["Authentication overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API uses an API key for authentication. Include the API key in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIKEY"]}," header."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"further-reading","__idx":4},"children":["Further reading"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/get-started/quickstart"},"children":["Quickstart"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/get-started"},"children":["About ","Reefpay"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/get-started/integration-best-practices"},"children":["About best practices for integration"]}]}]}]},"headings":[{"value":"About Reefpay APIs","id":"about-reefpay-apis","depth":1},{"value":"What the API provides","id":"what-the-api-provides","depth":2},{"value":"How the API is organized","id":"how-the-api-is-organized","depth":2},{"value":"Authentication overview","id":"authentication-overview","depth":2},{"value":"Further reading","id":"further-reading","depth":2}],"frontmatter":{"shortTitle":"Introduction","intro":"The {% $env.PUBLIC_BRAND_NAME %} API is a RESTful interface that lets you process payments, manage accounts, and retrieve reports using standard HTTP methods and JSON payloads.","type":"overview","seo":{"title":"About Reefpay APIs"}},"lastModified":"2026-06-05T02:46:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/concepts/api-fundamentals/intro","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}