PayGlocal API

openapi: 3.1.0
info:
  title: PayGlocal API
  version: '2026-10-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-26: 26 operation(s) read from 13 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; PayGlocal has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 10
    documentation: 16
    pages-with-code: 10
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://payglocal.in/docs/api-reference/get-status
  - https://payglocal.in/docs/api-reference/payment/refund
  - https://payglocal.in/docs/api-reference/payment/overview
  - https://payglocal.in/docs/api-reference/upload-documents
  - https://payglocal.in/docs/api-reference/create-onboarding
  - https://payglocal.in/docs/api-reference/mca/account-fetch
  - https://payglocal.in/docs/api-reference/mca/mca-ingestion
  - https://payglocal.in/docs/api-reference/payload-templates
  - https://payglocal.in/docs/api-reference/configure-products
  - https://payglocal.in/docs/api-reference/mca/document-upload
  - https://payglocal.in/docs/api-reference/onboarding-overview
  - https://payglocal.in/docs/api-reference/update-bank-details
  - https://payglocal.in/docs/api-reference/add-beneficial-owner
servers:
- url: https://api.onboard.payglocal.in
paths:
  /auth-signatory:
    put:
      operationId: put_auth_signatory
      tags:
      - Auth Signatory
      summary: Update Authorised Signatory
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /bank-details:
    put:
      operationId: put_bank_details
      tags:
      - Bank Details
      summary: Update Bank Details
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /beneficial-owner:
    put:
      operationId: put_beneficial_owner
      tags:
      - Beneficial Owner
      summary: Add / Update Beneficial Owner
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutBeneficialOwnerRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /business-details:
    put:
      operationId: put_business_details
      tags:
      - Business Details
      summary: Update Business Details
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /docs:
    put:
      operationId: put_docs
      tags:
      - Docs
      summary: Upload Documents
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gcc/v1/ffms/external/transaction/{gid}/upload-presigned:
    post:
      operationId: post_gcc_v1_ffms_external_transaction_gid_upload_presigned
      tags:
      - Gcc
      summary: POST /gcc/v1/ffms/external/transaction/{gid}/upload-presigned
      x-source: https://payglocal.in/docs/api-reference/mca/document-upload
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostGccV1FfmsExternalTransactionGidUploadPresignedResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl curl --request POST  --url https://gcc.prod.payglocal.in/gcc/v1/ffms/external/transaction/{gid}/upload-presigned  --header\
          \ 'Content-Type: application/json'  --header 'x-gl-auth: <api-key>'  --data ' \n { \n \"amount\": \"1000.00\", \n \"currency\": \"USD\"\
          , \n \"invoiceType\": \"INVOICE\", \n \"paymentType\": \"FULL\", \n \"merchantId\": \"merchant_001\", \n \"customerFullName\": \"John\
          \ Doe\", \n \"shippingDetails\": \"Bangalo"
  /gcc/v2/partner/merchant/onboard:
    post:
      operationId: post_gcc_v2_partner_merchant_onboard
      tags:
      - Gcc
      summary: POST /gcc/v2/partner/merchant/onboard
      x-source: https://payglocal.in/docs/api-reference/create-onboarding
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostGccV2PartnerMerchantOnboardResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl curl --request POST  --url https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard  --header 'Content-Type: application/json'\
          \  --header 'x-gl-auth: <api-key>'  --header 'x-gl-digest: <api-key>'  --data ' \n { \n \"externalOnboardingId\": \"partner-merchant-001\"\
          , \n \"panNumber\": \"ABCDE1234F\" \n } \n ' import requests\nurl = \"https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard\"\
          \npay"
  /gcc/v2/partner/merchant/onboard/{onboardingid}/docs:
    put:
      operationId: put_gcc_v2_partner_merchant_onboard_onboardingid_docs
      tags:
      - Gcc
      summary: PUT /gcc/v2/partner/merchant/onboard/{onboardingid}/docs
      x-source: https://payglocal.in/docs/api-reference/upload-documents
      parameters:
      - name: onboardingid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl curl --request PUT  --url https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs  --header\
          \ 'Content-Type: application/json'  --header 'x-gl-auth: <api-key>'  --header 'x-gl-digest: <api-key>'  --data ' \n { \n \"merchantDocType\"\
          : \"COI_DOCUMENT\", \n \"url\": \"https://your-storage.com/documents/coi.pdf\", \n \"fileName\": \"certificate_of_incorporation.pdf\"\
          \ \n } \n ' import req"
  /gl/v1/payments/initiate:
    post:
      operationId: post_gl_v1_payments_initiate
      tags:
      - Gl
      summary: Auth Initiation Full Capture Partial Capture Auth Reversal Holds funds on the customer’s card without charging.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGlV1PaymentsInitiateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gl/v1/payments/initiate/paycollect:
    post:
      operationId: post_gl_v1_payments_initiate_paycollect
      tags:
      - Gl
      summary: Payloads for initiating a one-time payment via PayGlocal.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGlV1PaymentsInitiatePaycollectRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gl/v1/payments/si/sale:
    post:
      operationId: post_gl_v1_payments_si_sale
      tags:
      - Gl
      summary: Triggers a manual deduction against an existing Variable SI mandate.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGlV1PaymentsSiSaleRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gl/v1/payments/si/status:
    post:
      operationId: post_gl_v1_payments_si_status
      tags:
      - Gl
      summary: Query the current status and details of an existing mandate.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGlV1PaymentsSiStatusRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_gl_v1_payments_si_status
      tags:
      - Gl
      summary: Temporarily suspends a mandate — stops deductions without cancelling it.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutGlV1PaymentsSiStatusRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gl/v1/payments/{gid}/capture:
    post:
      operationId: post_gl_v1_payments_gid_capture
      tags:
      - Gl
      summary: Captures the full authorized amount. Use the gid returned from the auth response.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGlV1PaymentsGidCaptureRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gl/v1/payments/{gid}/refund:
    post:
      operationId: post_gl_v1_payments_gid_refund
      tags:
      - Gl
      summary: POST /gl/v1/payments/{gid}/refund
      x-source: https://payglocal.in/docs/api-reference/payment/refund
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostGlV1PaymentsGidRefundResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl curl --request POST  --url https://api.payglocal.in/gl/v1/payments/{gid}/refund  --header 'Content-Type: application/json'\
          \  --header 'x-gl-token-external: <api-key>'  --data ' \n { \n \"refundType\": \"P\", \n \"paymentData\": { \n \"totalAmount\": \"25.00\"\
          , \n \"txnCurrency\": \"INR\" \n } \n } \n ' import requests\nurl = \"https://api.payglocal.in/gl/v1/payments/{gid}/refund\"\npayload\
          \ = {\n \"refundType\": \"P\",\n \"pay"
  /gl/v1/payments/{gid}/reversal:
    post:
      operationId: post_gl_v1_payments_gid_reversal
      tags:
      - Gl
      summary: Cancels the authorization and releases the held funds. Only possible before capture.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGlV1PaymentsGidReversalRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /gl/v1/payments/{gid}/status:
    get:
      operationId: get_gl_v1_payments_gid_status
      tags:
      - Gl
      summary: Query the real-time status of any transaction using its gid.
      x-source: https://payglocal.in/docs/api-reference/payload-templates
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /initiate:
    post:
      operationId: post_initiate
      tags:
      - Initiate
      summary: Payment APIs Overview - PayGlocal Developers
      x-source: https://payglocal.in/docs/api-reference/payment/overview
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /onboard:
    post:
      operationId: post_onboard
      tags:
      - Onboard
      summary: Create Onboarding
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOnboardResponse'
      x-evidence:
        kind: documentation
  /payments/{gid}/auth-reversal:
    post:
      operationId: post_payments_gid_auth_reversal
      tags:
      - Payments
      summary: Payment APIs Overview - PayGlocal Developers
      x-source: https://payglocal.in/docs/api-reference/payment/overview
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /payments/{gid}/capture:
    post:
      operationId: post_payments_gid_capture
      tags:
      - Payments
      summary: Payment APIs Overview - PayGlocal Developers
      x-source: https://payglocal.in/docs/api-reference/payment/overview
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /payments/{gid}/refund:
    post:
      operationId: post_payments_gid_refund
      tags:
      - Payments
      summary: Payment APIs Overview - PayGlocal Developers
      x-source: https://payglocal.in/docs/api-reference/payment/overview
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /payments/{gid}/status:
    get:
      operationId: get_payments_gid_status
      tags:
      - Payments
      summary: Payment APIs Overview - PayGlocal Developers
      x-source: https://payglocal.in/docs/api-reference/payment/overview
      parameters:
      - name: gid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /products:
    put:
      operationId: put_products
      tags:
      - Products
      summary: Configure Products and Fees
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /status:
    get:
      operationId: get_status
      tags:
      - Status
      summary: Get Onboarding Status
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /verification/{id}/redirect:
    put:
      operationId: put_verification_id_redirect
      tags:
      - Verification
      summary: Get Verification Redirect
      x-source: https://payglocal.in/docs/api-reference/onboarding-overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutVerificationIdRedirectResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PutBeneficialOwnerRequest:
      type: object
      properties:
        Array:
          type: string
          description: Replaces existing UBOs — always send all together
      required:
      - Array
    PostGccV1FfmsExternalTransactionGidUploadPresignedResponse:
      type: object
      properties:
        gid:
          type: string
        status:
          type: string
        message:
          type: string
        timestamp:
          type: string
        reasonCode:
          type: string
        data:
          type:
          - string
          - 'null'
        errors:
          type:
          - string
          - 'null'
    PostGccV2PartnerMerchantOnboardResponse:
      type: object
      properties:
        gid:
          type: string
        timestamp:
          type: string
        reasonCode:
          type: string
        data:
          type: object
          properties:
            merchantInfo:
              type: object
              properties:
                onboardingId:
                  type: string
                partnerOnboardingId:
                  type: string
                onboardingStatus:
                  type: string
    PostGlV1PaymentsInitiateRequest:
      type: object
      properties:
        merchantTxnId:
          type: string
        paymentData:
          type: string
        paymentData.totalAmount:
          type: string
        paymentData.txnCurrency:
          type: string
        captureTxn:
          type: string
        merchantCallbackURL:
          type: string
      required:
      - merchantTxnId
      - paymentData
      - paymentData.totalAmount
      - paymentData.txnCurrency
      - captureTxn
      - merchantCallbackURL
    PostGlV1PaymentsInitiatePaycollectRequest:
      type: object
      properties:
        merchantUniqueId:
          type: string
        merchantTxnId:
          type: string
        paymentData:
          type: string
        paymentData.totalAmount:
          type: string
        paymentData.txnCurrency:
          type: string
        merchantCallbackURL:
          type: string
        riskData:
          type: string
        riskData.shippingData:
          type: string
        riskData.billingData:
          type: string
        riskData.flightData:
          type: string
        riskData.lodgingData:
          type: string
        riskData.cabData:
          type: string
        riskData.trainData:
          type: string
        captureTxn:
          type: string
        standingInstruction:
          type: string
      required:
      - merchantUniqueId
      - merchantTxnId
      - paymentData
      - paymentData.totalAmount
      - paymentData.txnCurrency
      - merchantCallbackURL
    PostGlV1PaymentsSiSaleRequest:
      type: object
      properties:
        merchantUniqueId:
          type: string
        merchantTxnId:
          type: string
        paymentData:
          type: string
        paymentData.totalAmount:
          type: string
        standingInstruction:
          type: string
        standingInstruction.mandateId:
          type: string
      required:
      - merchantUniqueId
      - merchantTxnId
      - paymentData
      - paymentData.totalAmount
      - standingInstruction
      - standingInstruction.mandateId
    PostGlV1PaymentsSiStatusRequest:
      type: object
      properties:
        merchantTxnId:
          type: string
        standingInstruction:
          type: string
        standingInstruction.mandateId:
          type: string
      required:
      - merchantTxnId
      - standingInstruction
      - standingInstruction.mandateId
    PutGlV1PaymentsSiStatusRequest:
      type: object
      properties:
        merchantTxnId:
          type: string
        standingInstruction:
          type: string
        standingInstruction.action:
          type: string
        standingInstruction.mandateId:
          type: string
      required:
      - merchantTxnId
      - standingInstruction
      - standingInstruction.action
      - standingInstruction.mandateId
    PostGlV1PaymentsGidCaptureRequest:
      type: object
      properties:
        merchantTxnId:
          type: string
      required:
      - merchantTxnId
    PostGlV1PaymentsGidRefundResponse:
      type: object
      properties:
        gid:
          type: string
        status:
          type: string
        timestamp:
          type: string
        reasonCode:
          type: string
        data:
          type: object
          properties:
            gid:
              type: string
            originalGid:
              type: string
            status:
              type: string
            refundAmount:
              type: string
    PostGlV1PaymentsGidReversalRequest:
      type: object
      properties:
        merchantTxnId:
          type: string
      required:
      - merchantTxnId
    PostOnboardResponse:
      type: object
      properties:
        onboardingId:
          type: string
          description: Returned onboardingId — required for all subsequent calls
    PutVerificationIdRedirectResponse:
      type: object
      properties:
        redirectLink:
          type: string
          description: Returns redirectLink for iFrame verification (24h session token)
tags:
- name: Auth Signatory
- name: Bank Details
- name: Beneficial Owner
- name: Business Details
- name: Docs
- name: Gcc
- name: Gl
- name: Initiate
- name: Onboard
- name: Payments
- name: Products
- name: Status
- name: Verification