API Reference

Create a Beneficiary

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

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.

Operations

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.

Operations

Payment Link

A payment link is a shareable URL that will take your customers to a Glomo-hosted payment page. The payment page can only be accessed by your customer after the completion of 1FA via their email.

Operations

Orders

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

Operations

Customer

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

Operations

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.

Operations

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.

Operations

Price

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

Operations

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.

Operations

Payout

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

Operations

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.

Operations

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"
}

Create a Beneficiary

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"
}

List all Beneficiaries

Request

Returns a list of your beneficiaries. The beneficiaries are returned sorted by creation date, with the most recent beneficiary appearing first.

Security

JWT

Query

beneficiary_typestring

Type of beneficiary to filter

Enum"individual""business"

countrystring(iso-3166-1-alpha-3, case-insensitive)

The ISO 3166-1 alpha-3 code of the country to filter validations

Example: country=IND

beforestring(timestamp)

ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid Page drift issue. See Pagination parameters for more details.

Example: before=2025-02-18T12:03:44Z

afterstring(timestamp)

ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid Page drift issue. See Pagination parameters for more details.

Example: after=2025-01-18T12:03:44Z

per_pageinteger

Number of resources per page. Should be between 1 and 100.

Default 20

pageinteger

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Default 1

curl -i -X GET \
  'https://api.glomopay.com/api/v1/beneficiaries?beneficiary_type=individual&country=IND&before=2025-02-18T12%3A03%3A44Z&after=2025-01-18T12%3A03%3A44Z&per_page=20&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of beneficiaries matching the filters

Bodyapplication/json

dataArray of objects(Beneficiary)

page_metaobject(PageMeta)

Response

application/json

{
  "data": [
    { … }
  ],
  "page_meta": {
    "current": 2,
    "previous": 1,
    "next": 3,
    "per_page": 20,
    "pages": 10,
    "count": 200
  }
}

Bank Account Validation

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

Operations

Withdrawal

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

Operations

Withdrawal Account

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

Operations

Settlement

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

Operations

API specification for Glomo (1.0.0)

Balance

Balance Conversions

Payment Link

Orders

Customer

Document

Payment

Refund

Price

Subscription

Payout

Beneficiary

Beneficiary

Create a Beneficiary

Request

Responses

Was this helpful?

List all Beneficiaries

Request

Responses

Was this helpful?

Bank Account Validation

Withdrawal

Withdrawal Account

Settlement