Skip to content

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
Languages
Servers
Production server (v1)
https://api.glomopay.com/api/v1/
Production server (v2)
https://api.glomopay.com/api/v2/

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

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 details of the referral fees to be configured at the order or payment link level. Only platform businesses are allowed to create prices. The first Price created is set as default for a business.

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

Beneficiary

idstringread-only

The unique identifier for the beneficiary.

Example: "bene_5JU9yv0lGSUP"
holder_namestring

The name of the beneficiary.

Example: "Test Arts & Crafts Pvt Ltd"
account_numberstring

The account number of the beneficiary.

Example: "1234567890"
bank_namestring

The name of the bank where the account is held.

Example: "Yes Bank"
beneficiary_typestring

The type of beneficiary

Enum"individual""business"
bic_primarystring

The primary BIC of the bank account. This is the BIC of the bank where the account is held. This is also known as the SWIFT code.

Example: "QWERIN000"
bic_secondarystring

The local routing code or domestic clearing code of the bank account. For reference, this is the IFSC code in India, SORT in UK, ABA in the US, etc.

Example: "YESB0000002"
emailstring(email)

The email address of the beneficiary.

Example: "prabhat+beneficiaryArt@glomopay.com"
address_line1string

The street address of the beneficiary.

Example: "123 Main St"
address_line2string

The second line of street address of the beneficiary.

Example: "Near Apts"
citystring

The city where the beneficiary is located.

Example: "Anytown"
statestring

The state where the beneficiary is located.

Example: "Anystate"
countrystring(iso-3166-1-alpha-3)

The country where the beneficiary is located. Country should be sent as a ISO 3166-1 alpha-3 code.

Example: "Ind"
pincodestring

The postal code of the beneficiary's address.

Example: "560048"
nicknamestring

A nickname for the beneficiary.

Example: "Test Beneficiary"
intermediate_bank_namestring

The name of the intermediate bank, if any.

Example: "Intermediate Bank"
intermediate_bank_countrystring(iso-3166-1-alpha-3)

The country of the intermediate bank, if any. Country should be sent as a ISO 3166-1 alpha-3 code.

Example: "IND"
intermediate_bank_swift_codestring

The SWIFT code of the intermediate bank, if any.

Example: "INTBANKSWIFT"
created_atstring(timestamp)read-only

Timestamp representing when the beneficiary was created

Example: "2021-06-01T12:00:00Z"
updated_atstring(timestamp)read-only

Timestamp representing when the beneficiary was last updated

Example: "2021-06-01T12:00:00Z"
{ "id": "bene_5JU9yv0lGSUP", "holder_name": "Test Arts & Crafts Pvt Ltd", "account_number": "1234567890", "bank_name": "Yes Bank", "beneficiary_type": "individual", "bic_primary": "QWERIN000", "bic_secondary": "YESB0000002", "email": "prabhat+beneficiaryArt@glomopay.com", "address_line1": "123 Main St", "address_line2": "Near Apts", "city": "Anytown", "state": "Anystate", "country": "Ind", "pincode": "560048", "nickname": "Test Beneficiary", "intermediate_bank_name": "Intermediate Bank", "intermediate_bank_country": "IND", "intermediate_bank_swift_code": "INTBANKSWIFT", "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z" }

BeneficiaryV2

idstringread-only

The unique identifier for the beneficiary.

Example: "ben_5JU9yv0lGSUP"
namestring

The name of the beneficiary.

Example: "ACME Corporation"
typestring

The type of beneficiary. Defaults to "business" if not provided.

Enum"individual""business"
Example: "business"
categorystringread-only

The category of the beneficiary.

Enum"lrs""payout"
Example: "lrs"
emailstring(email)

The email address of the beneficiary.

Example: "finance@acme.com"
phonestring

The phone number of the beneficiary.

Example: "+1-555-123-4567"
nicknamestring

A nickname for the beneficiary. If not provided, auto-generated as "{beneficiary_name} - {bank_name}".

Example: "ACME Primary Account"
addressobject

The address of the beneficiary.

bank_accountobject

The bank account details of the beneficiary.

created_atstring(date-time)read-only

Timestamp representing when the beneficiary was created in ISO 8601 format.

Example: "2025-01-15T10:00:00Z"
updated_atstring(date-time)read-only

Timestamp representing when the beneficiary was last updated in ISO 8601 format.

Example: "2025-01-15T10:00:00Z"
{ "id": "ben_5JU9yv0lGSUP", "name": "ACME Corporation", "type": "business", "category": "lrs", "email": "finance@acme.com", "phone": "+1-555-123-4567", "nickname": "ACME Primary Account", "address": { "address_line1": "123 Business Park", "address_line2": "Suite 100", "city": "New York", "state": "NY", "country_code": "USA", "postal_code": "10001" }, "bank_account": { "account_number": "1234567890", "name": "Citibank NA", "swift_code": "CITIUS33", "local_routing_number": "021000089", "currency": "USD", "address": { … }, "intermediate_bank": { … } }, "created_at": "2025-01-15T10:00:00Z", "updated_at": "2025-01-15T10:00:00Z" }

Request

Creates a beneficiary with information such as name, contact, address, and banking information.

Security
JWT
Bodyapplication/jsonrequired
holder_namestringrequired

The name of the beneficiary.

Example: "Test Arts & Crafts Pvt Ltd"
account_numberstringrequired

The account number of the beneficiary.

Example: "1234567890"
bank_namestringrequired

The name of the bank where the account is held.

Example: "Yes Bank"
beneficiary_typestringrequired

The type of beneficiary

Enum"individual""business"
bic_primarystringrequired

The primary BIC of the bank account. This is the BIC of the bank where the account is held. This is also known as the SWIFT code.

Example: "QWERIN000"
bic_secondarystringrequired

The local routing code or domestic clearing code of the bank account. For reference, this is the IFSC code in India, SORT in UK, ABA in the US, etc.

Example: "YESB0000002"
emailstring(email)required

The email address of the beneficiary.

Example: "prabhat+beneficiaryArt@glomopay.com"
address_line1stringrequired

The street address of the beneficiary.

Example: "123 Main St"
address_line2string

The second line of street address of the beneficiary.

Example: "Near Apts"
citystringrequired

The city where the beneficiary is located.

Example: "Anytown"
statestringrequired

The state where the beneficiary is located.

Example: "Anystate"
countrystring(iso-3166-1-alpha-3)required

The country where the beneficiary is located. Country should be sent as a ISO 3166-1 alpha-3 code.

Example: "Ind"
pincodestringrequired

The postal code of the beneficiary's address.

Example: "560048"
nicknamestringrequired

A nickname for the beneficiary.

Example: "Test Beneficiary"
intermediate_bank_namestring

The name of the intermediate bank, if any.

Example: "Intermediate Bank"
intermediate_bank_countrystring(iso-3166-1-alpha-3)

The country of the intermediate bank, if any. Country should be sent as a ISO 3166-1 alpha-3 code.

Example: "IND"
intermediate_bank_swift_codestring

The SWIFT code of the intermediate bank, if any.

Example: "INTBANKSWIFT"
curl -i -X POST \
  https://api.glomopay.com/api/v1/beneficiaries \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "holder_name": "Test Arts & Crafts Pvt Ltd",
    "account_number": "1234567890",
    "bank_name": "Yes Bank",
    "beneficiary_type": "individual",
    "bic_primary": "QWERIN000",
    "bic_secondary": "YESB0000002",
    "email": "prabhat+beneficiaryArt@glomopay.com",
    "address_line1": "123 Main St",
    "address_line2": "Near Apts",
    "city": "Anytown",
    "state": "Anystate",
    "country": "Ind",
    "pincode": "560048",
    "nickname": "Test Beneficiary",
    "intermediate_bank_name": "Intermediate Bank",
    "intermediate_bank_country": "IND",
    "intermediate_bank_swift_code": "INTBANKSWIFT"
  }'

Responses

Beneficiary created successfully

Bodyapplication/json
idstringread-only

The unique identifier for the beneficiary.

Example: "bene_5JU9yv0lGSUP"
holder_namestring

The name of the beneficiary.

Example: "Test Arts & Crafts Pvt Ltd"
account_numberstring

The account number of the beneficiary.

Example: "1234567890"
bank_namestring

The name of the bank where the account is held.

Example: "Yes Bank"
beneficiary_typestring

The type of beneficiary

Enum"individual""business"
bic_primarystring

The primary BIC of the bank account. This is the BIC of the bank where the account is held. This is also known as the SWIFT code.

Example: "QWERIN000"
bic_secondarystring

The local routing code or domestic clearing code of the bank account. For reference, this is the IFSC code in India, SORT in UK, ABA in the US, etc.

Example: "YESB0000002"
emailstring(email)

The email address of the beneficiary.

Example: "prabhat+beneficiaryArt@glomopay.com"
address_line1string

The street address of the beneficiary.

Example: "123 Main St"
address_line2string

The second line of street address of the beneficiary.

Example: "Near Apts"
citystring

The city where the beneficiary is located.

Example: "Anytown"
statestring

The state where the beneficiary is located.

Example: "Anystate"
countrystring(iso-3166-1-alpha-3)

The country where the beneficiary is located. Country should be sent as a ISO 3166-1 alpha-3 code.

Example: "Ind"
pincodestring

The postal code of the beneficiary's address.

Example: "560048"
nicknamestring

A nickname for the beneficiary.

Example: "Test Beneficiary"
intermediate_bank_namestring

The name of the intermediate bank, if any.

Example: "Intermediate Bank"
intermediate_bank_countrystring(iso-3166-1-alpha-3)

The country of the intermediate bank, if any. Country should be sent as a ISO 3166-1 alpha-3 code.

Example: "IND"
intermediate_bank_swift_codestring

The SWIFT code of the intermediate bank, if any.

Example: "INTBANKSWIFT"
created_atstring(timestamp)read-only

Timestamp representing when the beneficiary was created

Example: "2021-06-01T12:00:00Z"
updated_atstring(timestamp)read-only

Timestamp representing when the beneficiary was last updated

Example: "2021-06-01T12:00:00Z"
Response
application/json
{ "id": "bene_5JU9yv0lGSUP", "holder_name": "Test Arts & Crafts Pvt Ltd", "account_number": "1234567890", "bank_name": "Yes Bank", "beneficiary_type": "individual", "bic_primary": "QWERIN000", "bic_secondary": "YESB0000002", "email": "prabhat+beneficiaryArt@glomopay.com", "address_line1": "123 Main St", "address_line2": "Near Apts", "city": "Anytown", "state": "Anystate", "country": "Ind", "pincode": "560048", "nickname": "Test Beneficiary", "intermediate_bank_name": "Intermediate Bank", "intermediate_bank_country": "IND", "intermediate_bank_swift_code": "INTBANKSWIFT", "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z" }

Bank Account Validation

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

SchemasOperations

Document

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

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

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