API Reference

Convert balances

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

BalanceConversion

idstring(string)read-only

The unique identifier for the balance balance.

Example: "conv_6776d57dnbTWj"

fromobject(Money)

the amount and currency of the balance used for conversion

toobject(Money)

the amount and currency of the balance after conversion

feesobject(Money)

Total fees for the conversion

mid_market_rateobject(ConversionRate)

The mid-market rate at the time of conversion

statusstringread-only

The status of the balance conversion.

Enum"success""failed""pending"

Example: "success"

created_atstring(date-time)read-only

The date and time the balance conversion was created.

Example: "2021-01-01T00:00:00Z"

{
  "id": "conv_6776d57dnbTWj",
  "from": {
    "amount": 1000,
    "currency": "USD"
  },
  "to": {
    "amount": 1000,
    "currency": "USD"
  },
  "fees": {
    "amount": 1000,
    "currency": "USD"
  },
  "mid_market_rate": {
    "currency": "USD",
    "rate": 1.4
  },
  "status": "success",
  "created_at": "2021-01-01T00:00:00Z"
}

Convert balances

Request

Converts balance from one currency to another. In the API you can either send target_amount or source_amount and the API will calculate the other amount for you.

Security

JWT

Bodyapplication/jsonrequired

One of:

source_currencystring(iso-4217)required

The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.

Example: "USD"

target_currencystring(iso-4217)required

The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.

Example: "USD"

source_amountnumber>= 1required

The amount you want to convert. A positive integer representing the smallest currency unit. For example, if the amount is $299.00, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295. Only one of `source_amount` or `target_amount` can be sent.

Example: 1000

curl -i -X POST \
  https://api.glomopay.com/api/v1/balance_conversions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "source_currency": "USD",
    "target_currency": "USD",
    "target_amount": 1000
  }'

Responses

Refund created successfully

Bodyapplication/json

idstring(string)read-only

The unique identifier for the balance balance.

Example: "conv_6776d57dnbTWj"

fromobject(Money)

the amount and currency of the balance used for conversion

toobject(Money)

the amount and currency of the balance after conversion

feesobject(Money)

Total fees for the conversion

mid_market_rateobject(ConversionRate)

The mid-market rate at the time of conversion

statusstringread-only

The status of the balance conversion.

Enum"success""failed""pending"

Example: "success"

created_atstring(date-time)read-only

The date and time the balance conversion was created.

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "id": "conv_6776d57dnbTWj",
  "from": {
    "amount": 1000,
    "currency": "USD"
  },
  "to": {
    "amount": 1000,
    "currency": "USD"
  },
  "fees": {
    "amount": 1000,
    "currency": "USD"
  },
  "mid_market_rate": {
    "currency": "USD",
    "rate": 1.4
  },
  "status": "success",
  "created_at": "2021-01-01T00:00:00Z"
}

List all Balance Conversions

Request

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

Security

JWT

Query

source_currencystring(iso-4217)

The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.

Example: source_currency=USD

target_currencystring(iso-4217)

The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.

Example: target_currency=USD

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/balance_conversions?source_currency=USD&target_currency=USD&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 balance conversions matching the filters

Bodyapplication/json

dataArray of objects(BalanceConversion)

page_metaobject(PageMeta)

Response

application/json

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

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

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

BalanceConversion

Convert balances

Request

Responses

Was this helpful?

List all Balance Conversions

Request

Responses

Was this helpful?

Payment Link

Orders

Customer

Document

Payment

Refund

Price

Subscription

Payout

Beneficiary

Bank Account Validation

Withdrawal

Withdrawal Account

Settlement