Skip to content
API Reference
/
/
Onboard a merchant

API specification for Glomo (1.0.0)

The Glomo API follows REST architecture, utilizing resource-oriented URLs for clarity. It handles form-encoded request bodies, delivers responses in JSON format, and operates with standard HTTP methods, authentication, and response codes.

You can download the complete API collection by using the download options on the right.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail

developer@glomopay.com

License

Apache 2.0

Terms of Service

Languages
Servers
Production server

https://api.glomopay.com/api/v1/

Balance

This resource represents your Glomo balance. You can retrieve it to see the current balance on your Glomo account in all currencies enabled for your account.

SchemasOperations

Balance Conversions

Balance Conversion resource represents the details of the balance conversion. The balance conversion is the conversion of the balance from one supported currency to another supported currency.

SchemasOperations

Orders

This resource represents the order details. The order is the request to receive payment from your customer.

SchemasOperations

Customer

This resource represents a customer of your business. The customer can be an individual or a business from whom you will receive payments.

SchemasOperations

Document

Document resource represents the documents details uploaded. This document is used in payin, payout, etc.

Operations

Payment

This resource represents a payment attempt made by your customer. The payment can either be successfully completed or failed, depending on various factors.

SchemasOperations

Refund

This resource represents a refund transaction from your Glomo account to your customer. You can retrieve it to see the details of the refund transaction.

SchemasOperations

Price

This resource represents the pricing details of the payin or payout. The pricing details include the fees and the pricing type

SchemasOperations

Subscription

This resource represents a recurring billing agreement for a customer. Subscriptions allow businesses to automatically charge customers on a regular schedule according to a defined billing plan.

SchemasOperations

Payout

This resource represents the disbursement transactions from your Glomo account to your beneficiaries.

SchemasOperations

Beneficiary

This resource represents a payee of a payout initiated by your business. The beneficiary can be an individual or a business to whom you will send funds.

SchemasOperations

Bank Account Validation

Bank Account Validation resource represents the validation details of a bank account.

SchemasOperations

Internal Transfer

This resource represents internal fund movements between merchant accounts within the platform–partner model. Internal transfers enable seamless fund movement between merchants who operate under the same platform account. Internal transfers are restricted to accounts linked under the same platform hierarchy. The following transfer directions are supported:

Transfer TypeDescription
P → CFrom a Platform (P) account to one of its Child (C) merchant accounts.
C → PFrom a Child (C) merchant account back to its Platform (P) account.
C → C (same P)Between Child (C) accounts under the same Platform (P).
SchemasOperations

Withdrawal

[DEPRECATED] This resource represents the withdrawal transaction from your Glomo account to your withdrawal account.

SchemasOperations

Withdrawal Account

This resource represents the withdrawal account details. The withdrawal account is the bank account where the withdrawal amount will be credited.

SchemasOperations

Settlement

This resource represents the settlement details. The settlement is the process of transferring funds from your Glomo account to your bank account.

SchemasOperations

Virtual Account

This resource represents virtual account details. A virtual account is a unique account number provisioned for a customer, allowing payments to be received and transactions to be tracked against that customer.

SchemasOperations

Platform

This resource provides platform functionality that enables platforms to onboard merchants onto Glomo, with each merchant having their own dedicated Virtual Accounts (VA).

SchemasOperations

MerchantCreateResponse

messagestring

Success message

Example: "Merchant created successfully!"
dataobject(Merchant)
{
  "message": "Merchant created successfully!",
  "data": {
    "owner_merchant_id": "merch_68511919RVuf6",
    "merchant_id": "merch_68c777fcOOMpl",
    "status": "success",
    "name": "John Doe",
    "category": "Agricultural Services",
    "entity_type": "individual",
    "sub_category": "Veterinary Services",
    "gender": "male",
    "date_of_birth": "2001-08-04",
    "registration_number": "REG123456",
    "registration_country": "IND",
    "address": { … },
    "operation_countries": [ … ],
    "created_at": "2025-10-07T06:11:47Z",
    "updated_at": "2025-10-07T06:11:47Z",
    "jwt_token": "child_merchant_JWT",
    "public_key": "live_6889e287VfqrPVPg"
  }
}

Onboard a merchant

Request

Allows platforms to onboard a new merchant onto Glomo.

Security
JWT
Bodyapplication/jsonrequired
namestringrequired

Name of the merchant business

Example: "Child Business Name"
address_line1stringrequired

Primary address line

Example: "456 Commerce Street"
address_line2string

Secondary address line (optional)

Example: "Suite 101"
citystringrequired

City name

Example: "Mumbai"
statestringrequired

State or province

Example: "Maharashtra"
pincodestringrequired

Postal/ZIP code

Example: "400001"
registration_numberstringrequired

Business registration number

Example: "REG123456"
registration_countrystringrequired

Country where the business is registered (ISO 3166-1 alpha-3)

Example: "IND"
entity_typestringrequired

Type of entity

Enum"individual""business"
Example: "individual"
categorystringrequired

Merchant business category

Enum"Agricultural Services""Contracted Services""Transportation Services""Telecommunications""Utilities""Retail and Goods""Financial Services""Business Services""Professional Services""Government Services"
Example: "Agricultural Services"
sub_categorystringrequired

Merchant business sub-category (must be paired with correct category, check examples)

Enum"Veterinary Services""Agricultural Cooperatives""Horticultural and Landscaping Services""General Contractors—Residential and Commercial""Air Conditioning Heating and Plumbing Contractors""Electrical Contractors""Insulation Masonry Plastering Stonework and Tile Setting Contractors""Carpentry Contractors""Roofing and Siding Sheet Metal Work Contractors""Concrete Work Contractors"
Example: "Veterinary Services"
operation_countriesArray of stringsrequired

List of countries where the merchant operates

Example: ["IND","USA"]
date_of_birthstring(date)

Date of birth. Required only when entity_type is individual. Format YYYY-MM-DD

Example: "2001-08-04"
genderstring

Gender. Required only when entity_type is individual.

Enum"male""female""undefined"
Example: "male"
curl -i -X POST \
  https://api.glomopay.com/api/v1/platform/merchants \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Child Business Name",
    "address_line1": "456 Commerce Street",
    "address_line2": "Suite 101",
    "city": "Mumbai",
    "state": "Maharashtra",
    "pincode": "400001",
    "registration_number": "REG123456",
    "registration_country": "IND",
    "entity_type": "individual",
    "category": "Agricultural Services",
    "sub_category": "Veterinary Services",
    "operation_countries": [
      "IND",
      "USA"
    ],
    "date_of_birth": "2001-08-04",
    "gender": "male"
  }'

Responses

Merchant onboarded successfully

Bodyapplication/json
messagestring

Success message

Example: "Merchant created successfully!"
dataobject(Merchant)
Response
application/json
{
  "message": "Merchant created successfully!",
  "data": {
    "owner_merchant_id": "merch_68511919RVuf6",
    "merchant_id": "merch_68c777fcOOMpl",
    "status": "success",
    "name": "John Doe",
    "category": "Agricultural Services",
    "entity_type": "individual",
    "sub_category": "Veterinary Services",
    "gender": "male",
    "date_of_birth": "2001-08-04",
    "registration_number": "REG123456",
    "registration_country": "IND",
    "address": { … },
    "operation_countries": [ … ],
    "created_at": "2025-10-07T06:11:47Z",
    "updated_at": "2025-10-07T06:11:47Z",
    "jwt_token": "child_merchant_JWT",
    "public_key": "live_6889e287VfqrPVPg"
  }
}

Retrieve a merchant

Request

Retrieves details of a specific merchant by their merchant ID.

Security
JWT
Path
merchant_idstringrequired

Unique identifier of the merchant

Example: merch_68c777fcOOMpl
curl -i -X GET \
  https://api.glomopay.com/api/v1/platform/merchants/merch_68c777fcOOMpl \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Merchant retrieved successfully

Bodyapplication/json
owner_merchant_idstringrequired

The ID of the platform/owner merchant

Example: "merch_68511919RVuf6"
merchant_idstringrequired

Unique identifier for the merchant

Example: "merch_68c777fcOOMpl"
statusstringrequired

Status of the merchant onboarding

Enum"success""pending""failed"
Example: "success"
namestringrequired

Name of the merchant

Example: "John Doe"
categorystring

Business category

Example: "Agricultural Services"
entity_typestring

Type of merchant entity

Enum"individual""business"
Example: "individual"
sub_categorystring

Business sub-category (must be paired with correct category)

Example: "Veterinary Services"
genderstring

Gender (only required for individual entity_type)

Enum"male""female""undefined"
Example: "male"
date_of_birthstring(date)

Date of birth (only required for individual entity_type)

Example: "2001-08-04"
registration_numberstringrequired

Business registration number or individual ID

Example: "REG123456"
registration_countrystringrequired

Country where the merchant is registered (ISO 3166-1 alpha-3)

Example: "IND"
addressobjectrequired

Merchant address

address.​address_line1stringrequired

Primary address line

Example: "123 Main St"
address.​address_line2string

Secondary address line (optional)

Example: ""
address.​citystringrequired

City name

Example: "Bangalore"
address.​statestringrequired

State or province

Example: "Karnataka"
address.​pincodestringrequired

Postal/ZIP code

Example: "560060"
address.​countrystringrequired

Country code (ISO 3166-1 alpha-3)

Example: "IND"
operation_countriesArray of stringsrequired

List of countries where the merchant operates

Example: ["IND"]
created_atstring(date-time)required

Timestamp when the merchant was created

Example: "2025-10-07T06:11:47Z"
updated_atstring(date-time)required

Timestamp when the merchant was last updated

Example: "2025-10-07T06:11:47Z"
jwt_tokenstringrequired

JWT token for the merchant

Example: "child_merchant_JWT"
public_keystring

public key for the merchant

Example: "live_6889e287VfqrPVPg"
Response
application/json
{
  "owner_merchant_id": "merch_68511919RVuf6",
  "merchant_id": "merch_68c777fcOOMpl",
  "status": "success",
  "name": "John Doe",
  "category": "Agricultural Services",
  "entity_type": "individual",
  "sub_category": "Veterinary Services",
  "gender": "male",
  "date_of_birth": "2001-08-04",
  "registration_number": "REG123456",
  "registration_country": "IND",
  "address": {
    "address_line1": "123 Main St",
    "address_line2": "",
    "city": "Bangalore",
    "state": "Karnataka",
    "pincode": "560060",
    "country": "IND"
  },
  "operation_countries": [
    "IND"
  ],
  "created_at": "2025-10-07T06:11:47Z",
  "updated_at": "2025-10-07T06:11:47Z",
  "jwt_token": "child_merchant_JWT",
  "public_key": "live_6889e287VfqrPVPg"
}