# SeerBit Documentation - [Welcome](https://doc.seerbit.com/index.md) - [Introduction](https://doc.seerbit.com/introduction.md): What you can build with SeerBit, and the fastest route to your first payment. - [Quickstart](https://doc.seerbit.com/quickstart.md): Take your first test payment with SeerBit in about ten minutes - [Authentication](https://doc.seerbit.com/authentication.md): Which credential each SeerBit API expects, and how to produce it. - [Test and Live Modes](https://doc.seerbit.com/test-and-live.md): Test cards and credentials, how the two modes differ, and how to tell which one a transaction ran in. - [Go Live](https://doc.seerbit.com/go-live.md): Take your integration from a working test payment to processing real money. - [Accept Payments](https://doc.seerbit.com/online-payments/integrations/accept-payment.md): Choose an integration method and start accepting online payments. - [Simple checkout](https://doc.seerbit.com/online-payments/integrations/simple-checkout.md): Drop an inline, PCI-compliant payment form into your page. - [Standard checkout](https://doc.seerbit.com/online-payments/integrations/standard-checkout.md): Create a transaction server-side and redirect the customer to a hosted checkout page. - [SDKs](https://doc.seerbit.com/sdks/overview.md): Official SeerBit libraries for server, web and mobile platforms. - [E-commerce Integrations](https://doc.seerbit.com/online-payments/integrations/e-commerce-plugin.md): Accept payments on WooCommerce, Wix and other platforms without writing code. - [Payment Link](https://doc.seerbit.com/online-payments/payment-features/payment-link.md): Create shareable payment links your customers can pay from anywhere. - [Invoicing](https://doc.seerbit.com/online-payments/payment-features/invoicing.md): Create, send and track invoices for your customers. - [Bulk Invoicing](https://doc.seerbit.com/online-payments/payment-features/bulk-invoicing.md): Create and send many invoices in a single request. - [Recurring Payments (Subscriptions)](https://doc.seerbit.com/online-payments/payment-features/subscription.md): Set up plans and charge customers on a recurring schedule. - [Virtual Account](https://doc.seerbit.com/online-payments/payment-features/virtual-account.md): Reserve dedicated bank account numbers for your customers. - [Card Tokenise and Charge](https://doc.seerbit.com/online-payments/payment-features/card-tokenisation.md): Save a card once and charge it again without collecting details each time. - [Overview](https://doc.seerbit.com/payment-methods/overview.md): Compare the ways your customers can pay and choose the right ones. - [Card Payments](https://doc.seerbit.com/payment-methods/card-payment.md): Charge Mastercard, Visa and Verve cards, including PIN, OTP and 3-D Secure flows. - [Bank Account](https://doc.seerbit.com/payment-methods/bank-account.md): Debit a customer's bank account directly with their authorisation. - [Transfer](https://doc.seerbit.com/payment-methods/transfer.md): Give customers account details to transfer into and confirm on receipt. - [USSD](https://doc.seerbit.com/payment-methods/ussd-payment.md): Let customers pay from a feature phone using a short dial code. - [Mobile Money - MOMO](https://doc.seerbit.com/payment-methods/mobile-money.md): Collect payments through mobile money operators across supported markets. - [Verify a payment](https://doc.seerbit.com/online-payments/after-payments/verify-payment.md): Confirm a payment result server-side before you fulfil an order. - [Webhooks](https://doc.seerbit.com/online-payments/after-payments/webhook-events.md): Receive real-time server notifications when events occur on your account. - [Refunds](https://doc.seerbit.com/online-payments/after-payments/refund.md): Return a payment to a customer in full or in part, from the dashboard or the API. - [Failed Transactions](https://doc.seerbit.com/online-payments/after-payments/failed-transaction.md): Understand why a card was declined and what to do next. - [Receiving Settlements](https://doc.seerbit.com/online-payments/after-payments/receive-settlement.md): When settlements reach your bank account, by country. - [Overview](https://doc.seerbit.com/payouts/overview.md): Hold a balance in a SeerBit Pocket and send funds out to banks, pockets and sub-pockets. - [Pocket](https://doc.seerbit.com/online-payments/payment-features/pocket.md): Manage balances, sub-pockets and transfers within your SeerBit Pocket. - [Payout](https://doc.seerbit.com/online-payments/payment-features/payout.md): Send single or bulk bank transfers from your SeerBit Pocket. - [Sub-account creation](https://doc.seerbit.com/online-payments/integrations/sub-account.md): Register the parties you settle to, and get a sub-account code for each. - [Split settlement](https://doc.seerbit.com/platforms/split-settlement.md): Settle one payment across several accounts by fixed amount or percentage. - [Overview](https://doc.seerbit.com/in-store/overview.md): Accept card-present payments on a SeerBit POS terminal from your ERP, POS software, or retail management system. - [Initiate transaction](https://doc.seerbit.com/in-store/initiate-transaction.md): Start a payment on a connected SeerBit POS terminal. - [Transaction status](https://doc.seerbit.com/in-store/transaction-status.md): Retrieve the current status and settlement detail for a POS transaction. - [Webhooks](https://doc.seerbit.com/in-store/webhooks.md): Receive push notifications when a POS transaction reaches a final state. - [SeerBit Status Code](https://doc.seerbit.com/development-resources/responses/seerbit-status-code.md): Look up what a SeerBit response code means. - [Response Handling](https://doc.seerbit.com/development-resources/responses/response-handling.md): The shape of an error response and how to read it. - [Raw Acquirer Responses](https://doc.seerbit.com/development-resources/responses/raw-acquirer-responses.md): Common raw card-scheme responses behind a declined transaction. - [Currency Codes](https://doc.seerbit.com/development-resources/currency-codes/overview.md): Supported currencies and their ISO codes. - [Bank Codes](https://doc.seerbit.com/development-resources/bank-codes/overview.md): NIP institution codes to use as the bankCode when sending a payout to a Nigerian bank account. - [Generate Encrypted Secret Key](https://doc.seerbit.com/api-reference/authentication/generate-encrypted-secret-key.md): To make API calls on SeerBit, you will be required to pass a bearer token. To generate a token simply pass your pubic and secret key to rceive a token to process further API calls. - [Generate Hash](https://doc.seerbit.com/api-reference/standard-checkout/generate-hash.md): This is used to ensure the request payload has not been altered - [Payment Link From Checkout](https://doc.seerbit.com/api-reference/standard-checkout/payment-link-from-checkout.md): SeerBit Checkout Standard Initialises a transaction from merchants server to generate a payment link which redirects your customers to a page to make payment and after payment has been made the customer is redirected back to the merchants website. - [Create Order Before Payment](https://doc.seerbit.com/api-reference/order-checkout/create-order-before-payment.md): Create an order before payment - [Update Order](https://doc.seerbit.com/api-reference/order-checkout/update-order.md): Update an order - [Create Order After Payment](https://doc.seerbit.com/api-reference/order-checkout/create-order-after-payment.md): Create an order after payment - [Get Orders](https://doc.seerbit.com/api-reference/order-checkout/get-orders.md): Get a list of orders - [Get an Order with Payment Reference](https://doc.seerbit.com/api-reference/order-checkout/get-an-order-with-payment-reference.md): Get order details with payment reference - [Get Order with Order Id](https://doc.seerbit.com/api-reference/order-checkout/get-order-with-order-id.md): Get order details with OrderId - [Initiate Payment](https://doc.seerbit.com/api-reference/payment-method/initiate-payment.md): Accept more payments with our unified payments API. Accept payments from all major cards and the most popular local and alternative payment methods all in a single integration. - [Get Banks](https://doc.seerbit.com/api-reference/payment-method/get-banks.md): Get list of banks - [OTP Momo](https://doc.seerbit.com/api-reference/momo/otp-momo.md): When making MOMO transfers, and OTP is required to complete the payment - [Charge Card](https://doc.seerbit.com/api-reference/non-3ds-payment/charge-card.md): This payment option is used to charge non 3d transactions - [Check Status](https://doc.seerbit.com/api-reference/card/check-status.md): This Operation allows you to check the status of a transaction via the status check api. This is done by making a Get request to the endpoint below with your payment reference. - [Validate Transaction](https://doc.seerbit.com/api-reference/account/validate-transaction.md): This option is used to complete an account transaction, when OTP is required - [Tokenize a Card](https://doc.seerbit.com/api-reference/tokenize/tokenize-a-card.md): In order to store your customers payment details, you need to pass some additional parameter when making the first payment request using the payments/tokenize endpoint, the Cvv field and pin are optional(this could be null). After the first payment is made, the payment details is collected and a to… - [Authorise](https://doc.seerbit.com/api-reference/authorise/authorise.md): In SeerBit API, the term “authorisation” indicates, that payment is authorised but not captured. This allows a merchant to cancel transaction at their discretion, typically based but not limited to fraud-related activities. This authorisation state is valid for a limited period of time, which provid… - [3DS Authorise](https://doc.seerbit.com/api-reference/authorise/3ds-authorise.md): PIN and CVV are not Required to complete Transaction. Authorization is completed on 3DS. - [Capture](https://doc.seerbit.com/api-reference/preauthorization/capture.md): Captures a payment if supported by the payment method. - [Refund](https://doc.seerbit.com/api-reference/preauthorization/refund.md): Refunds a payment if supported by the payment method. - [Cancel](https://doc.seerbit.com/api-reference/preauthorization/cancel.md): Cancel a payment if supported by the payment method. - [Initiate Subscription](https://doc.seerbit.com/api-reference/recurrent/initiate-subscription.md): To complete this transaction, merchant is expected to redirect to the 3DSecure site via the redirect URL provided with the response below. However if the redirect url is not returned and the code is S20 and the message is transaction is pending, the Validate OTP endpoint should be called as the cust… - [Get a Subscription](https://doc.seerbit.com/api-reference/recurrent/get-a-subscription.md): Get customer subscription - [Retail & E-commerce](https://doc.seerbit.com/use-cases/retail-and-ecommerce.md): Take payments online, in-store, or both — and reconcile them in one place. - [Education](https://doc.seerbit.com/use-cases/education.md): Collect fees, reconcile them to the right student, and let families pay in instalments. - [Travel & Hospitality](https://doc.seerbit.com/use-cases/travel-and-hospitality.md): Take deposits and balances, settle across outlets, and pay the property rather than the platform. - [Faith-based Institutions](https://doc.seerbit.com/use-cases/faith-based-institutions.md): Keep designated funds separate, fund and oversee branches, and collect giving across every channel. ## OpenAPI Specs - [external-api](https://raw.githubusercontent.com/seerbit/openapi/master/specs/external-api.yml) ## Optional - [Open in Postman](https://telecoms-architect-44543891-s-team.postman.co/workspace/My-Workspace~d2f0c317-8eaa-4166-841c-2c4173391f2c/collection/28675505-f1e4647f-4a15-478d-b152-113caa3f1922?action=share&source=copy-link&creator=28675505) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.