{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["note"]},"type":"markdown"},"seo":{"title":"Overview","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":"overview","__idx":0},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Glomo supports ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["declaration collection"]}," during card payment checkout for merchants to help meet ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["regulatory and compliance requirements"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This feature enables merchants to capture additional ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["customer attestations"]}," (e.g., payer relationship or NRE/NRO confirmation) at the time of payment, ensuring that funds are collected from ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["legitimate and permissible sources"]}," in accordance with industry or regulator expectations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, insurance companies can use this feature to verify whether the person making the payment is the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["policyholder"]}," or a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["permitted relative"]},"."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/customer_declaration_checkout.920b815fc49fe55e67f957b93dd311c341367fe2905c00dc00a3406e571baab3.9c1bb791.png","alt":"Customer Declaration Checkout"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"experience-for-the-customer-on-the-ui","__idx":1},"children":["Experience for the Customer on the UI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["During checkout, after entering card details, the customer will need to enter cardholder's relationship to the customer's name. If applicable (for India-issued cards), the customer may also be asked to confirm that their card is linked to an NRE/NRO account."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The customer is prompted to select their relationship to the policyholder(e.g., Self, Spouse, Parent, Child, Grandparent). Then, acknowledge the consent by checking the declaration checkbox before continuing with the payment."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payment can only proceed after the customer has completed and consented to the declaration. If the customer declines to consent or skips the declaration, the payment will not be processed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"viewing-data-as-a-merchant","__idx":2},"children":["Viewing Data as a Merchant"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["One the dahsboard, Merchants can view the collected declaration data in the transaction details section of the Glomo Merchant Dashboard."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For each transaction, the following fields will be displayed(if applicable):"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payer Relationship – The relationship selected by the customer."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["NRE/NRO Declaration – The customer’s consent is collected that payments are originating from an NRE/NRO Indian account."]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These fields will are available in both of the following locations:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payment Details View - The individual payment details page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payment Reports - Included in batch export reports."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"viewing-data-in-the-apis","__idx":3},"children":["Viewing Data in the APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The declaration data is also available programmatically through the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payments API"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the feature is enabled for a merchant, the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payment"]}," Object includes two new fields:"]},{"$$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":"Field"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payer_relationship"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Relationship declared by the customer (e.g., \"myself\", \"spouse\", \"parent\", “grandparent”, “child”)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nre_nro_declaration"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether the customer confirmed that the card is linked to an NRE account."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These fields appear in:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payment status API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payment webhooks"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reporting API responses"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Payment Reports"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This allows merchants to store or process declaration data within their internal compliance systems."]},{"$$mdtype":"Tag","name":"Note","attributes":{"text":"For merchants in the Insurance category, this feature is enabled by default.\n\nTo enable declaration collection for other industries or use cases, please reach out to us at [support@glomopay.com](mailto:support@glomopay.com).                                                                                      \n","variant":"orange"},"children":[]}]},"headings":[{"value":"Overview","id":"overview","depth":1},{"value":"Experience for the Customer on the UI","id":"experience-for-the-customer-on-the-ui","depth":2},{"value":"Viewing Data as a Merchant","id":"viewing-data-as-a-merchant","depth":3},{"value":"Viewing Data in the APIs","id":"viewing-data-in-the-apis","depth":3}],"frontmatter":{"title":"Customer_Declaration","note":"For merchants in the Insurance category, this feature is enabled by default.\n\nTo enable declaration collection for other industries or use cases, please reach out to us at [support@glomopay.com](mailto:support@glomopay.com).                                                                                      \n","seo":{"title":"Overview"}},"lastModified":"2026-09-22T05:15:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/payin/checkout/declaration-collection","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}