{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Get started with Glomopay","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":"get-started-with-glomopay","__idx":0},"children":["Get started with Glomopay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Glomopay is a cross-border payments platform. The documentation is organised by"," ","product, and each product section holds two kinds of page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pages titled as a noun — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Subscriptions"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Bank Transfer"]}," — explain what an object"," ","is. Pages titled as a job — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Set up recurring subscriptions"]}," — are complete"," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["integration flows"]},": the APIs that job needs, in the order to call them. A flow"," ","lives one level under the object it sets up, so the explanation and the task for"," ","the same subject sit together."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-are-you-building","__idx":1},"children":["What are you building?"]},{"$$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":{"data-label":"If you are building…"},"children":["If you are building…"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Start here"},"children":["Start here"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Taking card details on your own PCI-DSS certified surface"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payin/server-to-server-payments"},"children":["Accept card payments server-to-server"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Charging a customer on a repeating or on-demand schedule"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payin/subscriptions/set-up"},"children":["Set up recurring subscriptions"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remitting funds abroad for a resident Indian investor under LRS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payin/resident-india-remittance-under-lrs/set-up"},"children":["Collect LRS remittances from India"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Proving a payer owns the bank account funding a transaction"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/verification/third-party-verification/set-up"},"children":["Verify a payer's bank account (TPV)"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collecting payments into a static virtual account by bank transfer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payin/payment-methods/bank-transfer/set-up"},"children":["Set up bank transfers"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-rest-of-the-documentation","__idx":2},"children":["The rest of the documentation"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/get-started/glomo-overview"},"children":["Glomo overview"]}]}," — the platform glossary. What an LRS order, purpose code, virtual account or RFI actually ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["is"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payin"},"children":["Payin"]}]}," — collecting money: customers, orders, checkout, payment links, payment methods, refunds, disputes, subscriptions, LRS."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payout"},"children":["Payout"]}]}," — sending money: the payout life cycle, rails, beneficiaries, purpose codes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/multi-currency-account"},"children":["Multi-currency accounts"]}]}," — holding money: balances, conversion, add and withdraw, and the settlement holiday calendar."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/verification/kyc"},"children":["Verification"]}]}," — KYC, bank account validation and TPV."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/request-for-information"},"children":["Request for Information (RFI)"]}]}," — responding to a compliance request, per object."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/reports"},"children":["Reports"]}]}," — the reports you download or schedule from the dashboard for reconciliation, compliance and treasury."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/access-management"},"children":["Identity and Access Management"]}]}," — one login across your MIDs, the Admin/Member/Sales Partner roles, and inviting your team."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/openapi"},"children":["API reference"]}]}," — every endpoint, generated from OpenAPI. The"," ","OpenAPI description itself is published as one self-contained file at"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi.yaml"},"children":["/openapi.yaml"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi.json"},"children":["JSON"]},") — point your SDK generator, HTTP client or"," ","coding agent at it directly."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/platform"},"children":["Developer resources"]}]}," — authentication, errors, pagination, rate limits, webhooks, versioning, supported countries, quotes and the client SDKs."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-your-api-keys","__idx":3},"children":["Get your API keys"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get started with Glomo APIs, API keys are essential. These API keys, available on the Glomo dashboard, must be"," ","included in all API requests to the Glomo platform."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"follow-the-below-steps-to-obtain-keys-and-start-integration","__idx":4},"children":["Follow the below steps to obtain keys and start integration."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Login to your Glomo Account"]},": Login to your account via the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://api.glomopay-eng.com/login"},"children":["Glomo Dashboard"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Obtain API Keys"]},": After logging in, navigate to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," section from settings to access your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Live"]}," keys."," ",{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/api_keys.5e6788b98d66acc8f93a1ddea725fb2144aa439e116f764793764594d91aa3de.9c1bb791.svg","alt":"API Keys Section"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Choose Your Environment"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test Environment"]},": Use test API keys to simulate transactions without real money in test environment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Live Environment"]},": Switch to live API keys when you're ready to process real payments on your production environment."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integrate the APIs"]},": See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/platform/authentication"},"children":["Authentication"]}," for how to send the key on every request, then follow your integration flow above."]}]}]}]},"headings":[{"value":"Get started with Glomopay","id":"get-started-with-glomopay","depth":1},{"value":"What are you building?","id":"what-are-you-building","depth":2},{"value":"The rest of the documentation","id":"the-rest-of-the-documentation","depth":2},{"value":"Get your API keys","id":"get-your-api-keys","depth":2},{"value":"Follow the below steps to obtain keys and start integration.","id":"follow-the-below-steps-to-obtain-keys-and-start-integration","depth":4}],"frontmatter":{"title":"Get started with Glomopay","description":"Start here. Pick the integration flow that matches what you are building, then get your API keys.","seo":{"title":"Get started with Glomopay"}},"lastModified":"2026-09-22T05:38:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/get-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}