API reference and playground
Run every endpoint against the test environment
Save your test keys once. Every endpoint page then fills its own auth fields and request body, so you can press Send and read the live response.
Check your setup
Runs 34 checks against the test environment with your saved keys. Nothing is charged, transferred, or deleted.
Payment sessions
- Create payment sessionPOST /v3/payment/sessions
Opens a hosted checkout for one order. This is the starting point for most integrations — you create a session, then send the shopper to the returned URL to pay.
- Get payment sessionGET /v3/payment/sessions/{sessionId}/payment
Reads back a session and its payment state. Use it to confirm what actually happened after the shopper returns, rather than trusting the redirect alone.
Transactions
- List transactionsGET /v2/aggregator/transactions
Lists recent transactions with paging. The backbone of any reconciliation or admin screen you build.
- Transaction detailsGET /v2/aggregator/transactions/{transactionId}
Full detail for one transaction — card metadata, provider, fees, refund and capture totals. Use it when a shopper disputes a charge.
- Export transaction batchesGET /v3/payment/export
Kicks off a transaction export batch. Use it for finance reporting instead of paging the list endpoint.
Tokens
- Retrieve saved card tokensGET /v3/cards/customer
Lists a customer's saved cards so you can offer one-tap repeat payments. Needs a Kashier-Hash keyed with your Payment API Key.
Installments
- Installment banksGET /merchant/installments/banks/plans
Lists banks offering installments for an amount, with their card BIN ranges. Call it first to build the bank picker at checkout.
- Installment plansGET /merchant/installments/plans
Lists the concrete plans (tenor, interest, admin fee) for one bank. Call it once the shopper picks a bank or you detect their card BIN.
Payment links
- List payment linksGET /v2/payment-link
Lists reusable payment links. Use it for a dashboard of the links your team has shared.
Customers
- List customersGET /v2/customers
Lists saved customers. Use it to attach repeat orders and saved cards to a known shopper.
Invoices
- List invoicesGET /v2/paymentRequests
Lists payment requests (invoices) you have issued. Use it to chase or reconcile unpaid invoices.
Payment pages
- List payment pagesGET /v2/paymentPage
Lists your hosted storefront pages. Use it when you sell without building a checkout of your own.
Payouts
- Payouts account infoGET /v2/account
Returns the payout accounts on the merchant. Read this before creating a transfer so you know where money can land.
- List transfersGET /v2/transfers
Lists outgoing payouts with status. Use it to reconcile what you have actually paid out.
- Transfer detailsGET /v2/transfers/{transferId}
Full detail and status history for one payout. Use it to answer "where is my money" questions.
- List payout schedulersGET /v2/transfers/schedulers
Lists recurring payout schedules. Use it for automated supplier or payroll runs.
- List transfer batchesGET /v2/transfers/batch
Lists bulk payout batches. Use it when paying many beneficiaries at once.
- Payout fee inquiryPOST /v2/transfers/fee-inquiry
Quotes the fee for a prospective payout before you send it. Use it to decide the method or pass the cost on.
Constants
- Bank listGET /v2/constants/banks
Reference list of supported banks with their codes. Use it to populate bank dropdowns rather than hard-coding.
- City listGET /v2/constants/cities
Reference list of cities. Use it for address forms and payout beneficiary details.
- Payment method definitionsGET /v2/constants/payment-method-definition
Describes every payment method and the fields each one needs. Use it to render method-specific forms dynamically.
Checkout reference data
- Merchant payment methodsGET /v2/merchants/MID-XXXX-XXX/paymentMethods
The payment methods enabled on your account specifically. Use it to show only what this merchant can actually accept.
- Installment banks for merchantGET /v2/merchants/MID-XXXX-XXX/installments/banks
Installment banks enabled for your merchant. The account-scoped counterpart to the general installments list.
Balance and accounts
- Balance accounts overviewGET /v2/account/overview/accounts-list
Overview of your balance accounts and available funds. Use it for a wallet or balance screen.
- Primary payout methodGET /v2/account/payoutMethod
The default destination for settlements. Confirm this before changing payout details.
Settlement reporting
- Settlement windowsGET /v3/payment/settlement/windows
Lists settlement windows — the batches Kashier pays you in. Use it to match a bank deposit to its transactions.
- Settled transactionsGET /v2/aggregator/settlement-transactions
Lists transactions inside settlements, with fees and net amounts. The detail behind each deposit.
Products
- List productsGET /v2/products
Lists your catalogue products. Use it when building payment links or pages from a catalogue.
Categories
- List categoriesGET /v2/category
Lists product categories. Use it to organise a storefront.
Bulk batches
- List batchesGET /v2/batch
Lists bulk batches for mass link or invoice creation. Requires a currency.
Fees and discounts
- Calculate payment feesGET /v2/payment-fees/calculate
Calculates the fee on a given amount before you charge. Use it to show the shopper or absorb the cost knowingly.
Terminals
- List POS terminalsGET /v2/terminals
Lists POS terminals on the account. Use it to route in-person payments to the right device.
POS terminals
- POS branchesGET /v3/payment/pos/branches
Lists branches that own POS terminals. Use it for per-branch reporting.
Instant settlement
- Instant settlement fee inquiryPOST /v3/payment/instant-settlements/instant/inquiry
Quotes what you would receive if today's eligible sales were settled early, and what the instant settlement fee would be — without committing to anything. Call it to show the merchant the net amount before they agree. The transaction ids below are documentation examples, so on a live account expect "Reachable" rather than a real quote; pull real ones from the eligible-transactions endpoint first.
Endpoints
Payment sessions
Create and inspect payment sessions. 5 endpoints.
Transactions
Retrieve transaction data and export transaction batch data so merchants can monitor their transactions efficiently. 4 endpoints.
Order operations
Refund, void, capture and reversal against an existing order. 5 endpoints.
Tokens
Card tokenization — pay with a saved card token, retrieve a customer's saved card tokens, and delete a token. 8 endpoints.
Installments
Retrieve installment-enabled banks and their installment plans. 2 endpoints.
Payouts
Payout bank and wallet transfer APIs — check account balance, list transfers, inquire about fees, and create single or bulk transfers to pay… 12 endpoints.
Customers
Store, update, and retrieve customer profiles, so payments and payment links can be linked back to the person who paid. 11 endpoints.
Invoices
Invoices (payment requests) — create a payable invoice or payment link, share it with a customer by email or SMS, track whether it has been… 9 endpoints.
Payment links
Create, share, update, and export payment links — shareable pages your customers open and pay on, with no integration required. 13 endpoints.
Payment pages
Payment pages — merchant-built, shareable pages that collect a payment without any integration work: either a regular page that asks for one… 14 endpoints.
Balance and accounts
Read your Kashier balance accounts — the ledger Kashier keeps for you. 14 endpoints.
Settlement reporting
Read how your captured sales are grouped into settlement windows and batches, and what fees were taken on the way. 6 endpoints.
Bulk batches
Batches group many invoices (payment requests) into one job so a merchant can bill a whole list of customers at once: create a batch, fill i… 11 endpoints.
Checkout reference data
Read-only lookups a custom checkout needs before it can render: which payment methods your merchant account is entitled to, which banks offe… 4 endpoints.
Constants
Static Kashier reference lists — Egyptian banks, cities, countries, industries, and the payment method definitions behind the gateway. 5 endpoints.
Fees and discounts
Calculators that tell you what a payment will actually cost before it is made: how much processing fee a customer-borne pricing model adds o… 6 endpoints.
Instant settlement
Get your not-yet-settled sales paid out early instead of waiting for their normal settlement date, in exchange for a fee. 7 endpoints.
POS terminals
Card-present POS integration: drive a Kashier-managed terminal from your backend by relaying a sale or details message to it, generate a POS… 9 endpoints.
Terminals
Read the POS terminals registered on your merchant account, their branches, and an Excel export of the terminal list. 4 endpoints.
Products
A merchant's product catalogue — the items a product payment page or a payment link line item is built from. 10 endpoints.
Categories
Product categories — the grouping layer above products. 7 endpoints.
Webhooks
The webhook management module (/v2/webhooks). 9 endpoints.
Credentials and access
The two credentials Kashier issues you and the IP allow-list that gates them. 12 endpoints.
Good to know
- Requests go straight from your browser to Kashier — the documented URLs point at the test hosts, and your keys never reach this site's servers.
- Keys stay in your browser's localStorage and travel only with requests you fire.
- Each endpoint renders your request as cURL, JavaScript, Python, PHP and more.
- Everything here is generated from the OpenAPI spec — point your tooling or AI agent at it.
- New to the API? The quick start walks one payment end to end.
Going live
A checklist for moving a working test integration to live mode, and the differences that only show up once you do
List payment sessions GET
Lists the payment sessions on your merchant account — the sessions you created, in whatever state they reached. Use it to sweep up sessions your own records lost track of; to poll one particular se…