API Reference

List all settlements

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

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

Settlement

idstringread-only

The unique identifier for the settlement.

Example: "setl_6878e266jt1P3"

statusstring

The status of the settlement.

Example: "success"

payment_methodstring

The payment method used for the settlement.

Example: "swift_transfer"

amountnumber>= 1

The amount of the settlement in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field.

Example: 1000

currencystring(iso-4217, case-insensitive)

The currency in which the settlement is made. The currency code is in ISO 4217 format. For example, USD.

Example: "USD"

feesobject

The fees associated with the settlement.

utrstring

The Unique Transaction Reference (UTR) for the settlement.

Example: "1568176960vxp0rj"

created_atstring(date-time)read-only

The creation timestamp of the settlement.

Example: "2024-12-06T11:38:37.130Z"

updated_atstring(date-time)read-only

The last update timestamp of the settlement.

Example: "2024-12-06T11:38:37.130Z"

{
  "id": "setl_6878e266jt1P3",
  "status": "success",
  "payment_method": "swift_transfer",
  "amount": 1000,
  "currency": "USD",
  "fees": {
    "fx_fee": { … },
    "txn_fee": { … }
  },
  "utr": "1568176960vxp0rj",
  "created_at": "2024-12-06T11:38:37.130Z",
  "updated_at": "2024-12-06T11:38:37.130Z"
}

List all settlements

Request

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

Security

JWT

Query

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/settlements?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 withdrawals matching the filters

Bodyapplication/json

dataArray of objects(Settlement)

page_metaobject(PageMeta)

Response

application/json

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

Retrieve a settlement

Request

Returns a specific settlement by its unique identifier.

Security

JWT

Path

idstringrequired

The unique identifier of the settlement

Example: setl_6878e266jt1P3

curl -i -X GET \
  https://api.glomopay.com/api/v1/settlements/setl_6878e266jt1P3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Settlement found

Bodyapplication/json

idstringread-only

The unique identifier for the settlement.

Example: "setl_6878e266jt1P3"

statusstring

The status of the settlement.

Example: "success"

payment_methodstring

The payment method used for the settlement.

Example: "swift_transfer"

amountnumber>= 1

The amount of the settlement in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field.

Example: 1000

currencystring(iso-4217, case-insensitive)

The currency in which the settlement is made. The currency code is in ISO 4217 format. For example, USD.

Example: "USD"

feesobject

The fees associated with the settlement.

utrstring

The Unique Transaction Reference (UTR) for the settlement.

Example: "1568176960vxp0rj"

created_atstring(date-time)read-only

The creation timestamp of the settlement.

Example: "2024-12-06T11:38:37.130Z"

updated_atstring(date-time)read-only

The last update timestamp of the settlement.

Example: "2024-12-06T11:38:37.130Z"

Response

application/json

{
  "id": "setl_6878e266jt1P3",
  "status": "success",
  "payment_method": "swift_transfer",
  "amount": 1000,
  "currency": "USD",
  "fees": {
    "fx_fee": { … },
    "txn_fee": { … }
  },
  "utr": "1568176960vxp0rj",
  "created_at": "2024-12-06T11:38:37.130Z",
  "updated_at": "2024-12-06T11:38:37.130Z"
}

API specification for Glomo (1.0.0)

Balance

Balance Conversions

Payment Link

Orders

Customer

Document

Payment

Refund

Price

Subscription

Payout

Beneficiary

Bank Account Validation

Withdrawal

Withdrawal Account

Settlement

Settlement

List all settlements

Request

Responses

Was this helpful?

Retrieve a settlement

Request

Responses

Was this helpful?