{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["iconCardsStack","note"]},"type":"markdown"},"seo":{"title":"Introduction","llmstxt":{"title":"Glomopay developer documentation","description":"Cross-border payments APIs, organised by product. Each product section carries both the explanation of its objects and the job-shaped integration guides that set them up.","details":{"content":"How to use these docs:\n\n- Get started is the front door. It carries a routing table from\n  \"what are you building\" to the page that builds it, plus how to get\n  API keys.\n- The product sections - Payin, Payout, Multi-currency accounts,\n  Verification, Request for Information (RFI) - each hold two kinds of page.\n  Pages titled as a noun (\"Subscriptions\", \"Bank Transfer\") explain what\n  an object is. Pages titled as a job (\"Set up recurring subscriptions\",\n  \"Collect LRS remittances from India\") are complete integration flows\n  and live one level under the object they set up. Match a user's goal\n  against the job-shaped titles first.\n- Reports and Identity and Access Management are the two subjects with no\n  API counterpart. There are no endpoints for reports, users, roles or\n  invites; both pages document the merchant dashboard. A dashboard\n  procedure for something the API also does (a refund, a payout) is NOT\n  here - it stays in the product that owns it.\n- API reference is generated from OpenAPI and carries endpoint detail.\n- The OpenAPI description itself is published as a single self-contained\n  document at /openapi.yaml, and the same document as JSON at\n  /openapi.json. Every $ref is resolved into it, so one fetch is the\n  whole contract: 61 paths, 81 operations, 68 schemas - the same\n  endpoints the API reference pages render. Fetch that instead of\n  reading the 129 pages under /api-reference/.\n- Developer resources covers what every integration touches and no single\n  product owns: auth, errors, pagination, rate limits, webhooks,\n  versioning, supported countries, quotes, and the client SDKs.\n"},"sections":[{"title":"Get started","description":"The front door. The routing table from a merchant's goal to the flow that delivers it, how to obtain API keys, and the platform glossary.","includeFiles":["**/get-started/**"]},{"title":"Payin","description":"Collecting money: customers, orders, checkout, payment links, payment methods (cards, bank transfer, pay via bank), refunds, disputes, purpose codes, fee models, custom fields, subscriptions, and resident India remittance under LRS. Includes the flows that set each up - bank transfers, subscriptions, LRS remittances, and server-to-server card payments.","includeFiles":["**/payin/**"]},{"title":"Payout","description":"Sending money: the payout life cycle, queued payouts, creating and cancelling a payout, rails, beneficiaries, purpose codes, and the action required state.","includeFiles":["**/payout/**"]},{"title":"Multi-currency accounts","description":"Holding money: balances, balance conversion, adding balance, withdrawing balance, and the settlement holiday calendar - the Indian and US bank and FX holidays on which settlement to the merchant's bank account, and money movement generally, is affected.","includeFiles":["**/multi-currency-account/**"]},{"title":"Verification","description":"Proving who someone is and that an account is theirs: KYC, bank account validation, and third-party verification (TPV) with the flow that verifies a payer's bank account.","includeFiles":["**/verification/**"]},{"title":"Request for Information (RFI)","description":"Responding to a compliance request for information, per object - payment link, order, payment, payout - plus compliance reviews and RFIs raised on already-successful payments.","includeFiles":["**/request-for-information/**"]},{"title":"Reports","description":"The downloadable and scheduled reports a merchant pulls from the dashboard for reconciliation, compliance and treasury: payment, subscription, settlement breakup, balance statement and KYC reports, plus scheduling one for recurring email delivery. Dashboard only - there is no reports API.","includeFiles":["**/reports/**"]},{"title":"Identity and Access Management","description":"Administering who can use a merchant account: one set of credentials across multiple MIDs, switching between them without logging out, the Admin / Member / Sales Partner roles and what each may see and do, and inviting a new member. Dashboard only - there is no users, roles or invites API.","includeFiles":["**/access-management/**"]},{"title":"API reference","description":"Endpoint reference generated from the Glomopay OpenAPI description.","includeFiles":["**/api-reference/**"]},{"title":"Developer resources","description":"What every integration touches and no single product owns: auth, errors, pagination, rate limits, webhooks, versioning, API validations, security, supported countries, quotes, and the client SDKs - React Native, Flutter, Android and the Unified Web SDK, with per-version references and changelogs. Reports and Identity and Access Management used to be listed here and are now their own sections.","includeFiles":["**/platform/**"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"introduction","__idx":0},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Glomo is an innovative payment service solution aiming to simplify the process of collecting, managing, and sending money across the globe. Glomo enables clients to collect payments into their multi-currency account, manage currencies, and send payments to their desired beneficiaries in the currency of their choice, ensuring compliance, transparency, and efficiency. This document serves as a guide to help you understand Glomo capabilities and integrate Glomo into your system and start accepting payments with ease."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/overview.8f2b36d5b63e88493e45cc467e7356fe12fab6f8e617585f6bb3081aa183e3e9.9c1bb791.png","alt":"Payment Flow Diagram"},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"glossary","__idx":1},"children":["Glossary"]},{"$$mdtype":"Tag","name":"IconCardsStack","attributes":{"items":[{"title":"Merchant","description":"Merchant refers to businesses with a Glomo account. Upon onboarding to Glomo, every business will be assigned a unique merchant ID. Merchants are only onboarded and enabled for live transactions only after Glomo’s due diligence is complete.","icon":"building"},{"title":"Payin","description":"Payin in Glomo terminology means money to be collected from consumers against purchases of goods & services from you or your underlying customers. In general, Glomo will enable its merchants to collect payments from multiple sources into their Glomo account. All such collections across merchant’s Glomo accounts are considered as Payin.","icon":"arrowSquareDownLeft"},{"title":"Payout","description":"Payouts refers to sending money to your beneficiaries(vendors/suppliers/employees/others) from your Glomo account. Glomo acts as remitter of funds for both domestic and cross border money transfers.","icon":"arrowSquareUpRight"},{"title":"Customer","description":"Customer refers to the end user you are collecting money from. This collection can be done through bank transfer or any other payment method supported by Glomo.","icon":"user"},{"title":"Beneficiary","description":"A beneficiary is the recipient of funds (vendor, supplier or any other entity) that you choose to send money to from your Glomo account.","icon":"user"}]},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":2},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"Note","attributes":{"text":"Glomo is available to a limited number of users at this time. If you wish to get onboarded and start using our platform, please contact us at [support@glomopay.com](mailto:support@glomopay.com).","variant":"purple"},"children":[]}]},"headings":[{"value":"Introduction","id":"introduction","depth":1},{"value":"Glossary","id":"glossary","depth":1},{"value":"Getting Started","id":"getting-started","depth":1}],"frontmatter":{"title":"Introduction","glossary":[{"title":"Merchant","description":"Merchant refers to businesses with a Glomo account. Upon onboarding to Glomo, every business will be assigned a unique merchant ID. Merchants are only onboarded and enabled for live transactions only after Glomo’s due diligence is complete.","icon":"building"},{"title":"Payin","description":"Payin in Glomo terminology means money to be collected from consumers against purchases of goods & services from you or your underlying customers. In general, Glomo will enable its merchants to collect payments from multiple sources into their Glomo account. All such collections across merchant’s Glomo accounts are considered as Payin.","icon":"arrowSquareDownLeft"},{"title":"Payout","description":"Payouts refers to sending money to your beneficiaries(vendors/suppliers/employees/others) from your Glomo account. Glomo acts as remitter of funds for both domestic and cross border money transfers.","icon":"arrowSquareUpRight"},{"title":"Customer","description":"Customer refers to the end user you are collecting money from. This collection can be done through bank transfer or any other payment method supported by Glomo.","icon":"user"},{"title":"Beneficiary","description":"A beneficiary is the recipient of funds (vendor, supplier or any other entity) that you choose to send money to from your Glomo account.","icon":"user"}],"note":"Glomo is available to a limited number of users at this time. If you wish to get onboarded and start using our platform, please contact us at [support@glomopay.com](mailto:support@glomopay.com).","seo":{"title":"Introduction"}},"lastModified":"2026-09-22T05:15:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/get-started/glomo-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}