# Raïs API documentation > Raïs is a payment platform for Algeria. Businesses accept CIB and Edahabia card payments through a REST API, a hosted checkout and webhooks; amounts are in Algerian dinars (DZD), always integers in centimes. The API lives at https://api.rais.app/v1 (version 2026-10-26). Authenticate with a secret key (`Authorization: Bearer rais_sk_test_...` for the sandbox, `rais_sk_live_...` for live). Amounts are integers in centimes: 500000 is 5,000.00 DA. A payer's pages (`checkout_url`, `receipt_url`) live on https://pay.rais.app. A paid payment costs SATIM's fee (0.7% of the amount, between 10.00 DA and 300.00 DA) plus Raïs's (0.3%), a refund costs 10.00 DA, and every price excludes VAT: see the Pricing and fees guide. Payments and refunds carry `fees`, a payment also `net`. Every page below is available as Markdown by adding `.md` to its address. ## Get started - [Introduction](https://rais.app/docs/introduction.md): What Raïs is, how a payment travels from your server to the bank and back, and the concepts you will meet. - [Quickstart](https://rais.app/docs/quickstart.md): Create a store, get a test key, take a first test payment and verify it, in about ten minutes. - [Authentication](https://rais.app/docs/authentication.md): Secret API keys, the test and live environments, scopes, rotation and IP allowlists. ## Accept payments - [Payments](https://rais.app/docs/payments.md): Create, retrieve, list and cancel payments: amounts, statuses, metadata, items and expiry. - [Pricing and fees](https://rais.app/docs/pricing.md): What a payment and a refund cost, when a fee is charged, worked examples and the fee fields of the API. - [Hosted checkout and return URLs](https://rais.app/docs/checkout.md): Send the payer to the hosted page, bring them back to your site or app, and confirm the result on your server. - [Mobile and app integrations](https://rais.app/docs/mobile.md): iOS, Android, Flutter and React Native: open the checkout in a secure in-app browser and return with a deep link. ## After the payment - [Webhooks](https://rais.app/docs/webhooks.md): Receive signed events, verify them, handle retries and keep your endpoint healthy. - [Refunds](https://rais.app/docs/refunds.md): Refund all or part of a payment, and follow the refund to its end. - [Receipts](https://rais.app/docs/receipts.md): PDF receipts of paid payments: how to get a signed link and what a receipt contains. ## Test and launch - [Test cards and sandbox](https://rais.app/docs/testing.md): SATIM test cards, what the sandbox does and does not do, and how to rehearse failures. - [Going live](https://rais.app/docs/going-live.md): Business verification, live keys and the checklist to run before the first real payment. ## API fundamentals - [Errors](https://rais.app/docs/errors.md): The error envelope, every error code, request ids and what to do about each kind of error. - [Idempotency and retries](https://rais.app/docs/idempotency.md): Retry a request after a timeout without creating a payment or a refund twice. - [Rate limits](https://rais.app/docs/rate-limits.md): How many requests a key may send, what a 429 means and how to back off. - [Pagination](https://rais.app/docs/pagination.md): Walk through lists of payments, refunds and events with cursors. - [Versioning](https://rais.app/docs/versioning.md): The Rais-Version header, what counts as a breaking change and how upgrades work. ## Security and help - [Security and safety](https://rais.app/docs/security.md): How to handle keys, verify webhooks, protect personal data, and what Raïs does with card data. - [FAQ and troubleshooting](https://rais.app/docs/faq.md): Answers to the questions integrations raise, and what to check when something does not work. - [Use these docs with AI](https://rais.app/docs/ai-tools.md): Open any page in ChatGPT or Claude, copy it as Markdown, or give an assistant llms.txt and the OpenAPI file. ## API reference - [API reference](https://rais.app/docs/api.md): Every endpoint of the Raïs API: parameters, request and response objects, examples in nine languages and the errors each can return. ### Payments - [Create a payment](https://rais.app/docs/api/create-payment.md): Creates a payment and registers it with the payment gateway. - [List payments](https://rais.app/docs/api/list-payments.md): Returns the payments of your store in the environment of the key, newest first, 20 at a time by default. - [Retrieve a payment](https://rais.app/docs/api/retrieve-payment.md): Returns a payment of your store. - [Cancel a payment](https://rais.app/docs/api/cancel-payment.md): Cancels a payment that is still pending, so its checkout page can no longer be used. - [Retrieve the receipt of a payment](https://rais.app/docs/api/retrieve-payment-receipt.md): Returns a signed link (valid for 15 minutes) to the PDF receipt of a paid payment of your store: the payer, the items, the card used (masked), the approval code and any refunds. ### Refunds - [Refund a payment](https://rais.app/docs/api/create-refund.md): Refunds all or part of a paid payment. - [Retrieve a refund](https://rais.app/docs/api/retrieve-refund.md): Returns a refund of your store. - [List refunds](https://rais.app/docs/api/list-refunds.md): Returns the refunds of your store in the environment of the key, newest first. ### Events - [Retrieve an event](https://rais.app/docs/api/retrieve-event.md): Returns an event of your store in the environment of the key, if it happened in the last 30 days. - [List events](https://rais.app/docs/api/list-events.md): Returns the events of your store in the environment of the key from the last 30 days, newest first. ### Account - [Retrieve your account](https://rais.app/docs/api/retrieve-account.md): Returns the store the API key belongs to and the environment of the key. ### Objects - [The Payment object](https://rais.app/docs/api/objects/payment.md): A payment is one attempt to collect an amount from a payer. - [The Refund object](https://rais.app/docs/api/objects/refund.md): A refund returns all or part of a paid payment to the payer. - [The Event object](https://rais.app/docs/api/objects/event.md): An event records something that happened to a payment or a refund. - [The Account object](https://rais.app/docs/api/objects/account.md): The store an API key belongs to, and the environment of the key. - [The Receipt object](https://rais.app/docs/api/objects/receipt.md): A short-lived signed link to the PDF receipt of a paid payment. - [The Error object](https://rais.app/docs/api/objects/error.md): Every response that is not a success has exactly this envelope, whatever went wrong. ## Changelog - [Changelog](https://rais.app/docs/changelog.md): What changed in the Raïs API and in these docs, newest first. ## Optional - [OpenAPI document](https://rais.app/openapi.json): the machine-readable description of every endpoint (OpenAPI 3.1). - [All pages in one file](https://rais.app/llms-full.txt): the complete documentation as Markdown.