Skip to content
API Reference
/
Orders
/
Orders

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.

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

Orders

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

Operations

Orders

idstring(string)read-only

The unique identifier for the order.

Example: "order_678a4c88hpAjf"
customer_idstring

The unique identifier of customer linked to order.

Example: "cust_E602dMzgjpDC"
document_idstring

The unique identifier of document linked to order. This document entity should contain the required documents to process incoming payments. Refer this Document entity for more details.

Example: "doc_nYUqLpuYQ0M8"
statusstringread-only

The status of the Order.

Enum"active""paid""failed""action_required""cancelled""under_review"
Example: "success"
currencystring(iso-4217)

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

Example: "USD"
amountnumber>= 1

The amount you want to receive, 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.

Example: 1000
purpose_codestring

Purpose code for why you want to receive this payment

Example: "P1401"
invoice_numberstring

Number/Id of the invoice submitted with order.

Example: "RG12FF590"
invoice_descriptionstring

Description about the invoice submitted with order

Example: "Payment requested for services provided"
invoice_amountnumber

The amount in cents for which invoice was generated. It can be more than the amount requested in this order

Example: 1000
productobject(Product)

Details of the product that the payment is related to.

notesobject

Any additional notes for the order

Example: {"key1":"value1","key2":"value2"}
created_atstring(timestamp)read-only

Timestamp representing when the order was created

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

Timestamp representing when the order was last updated

Example: "2021-06-01T12:00:00Z"
{
  "id": "order_678a4c88hpAjf",
  "customer_id": "cust_E602dMzgjpDC",
  "document_id": "doc_nYUqLpuYQ0M8",
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "purpose_code": "P1401",
  "invoice_number": "RG12FF590",
  "invoice_description": "Payment requested for services provided",
  "invoice_amount": 1000,
  "product": {
    "name": "ShieldGuard Insurance",
    "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage"
  },
  "notes": {
    "key1": "value1",
    "key2": "value2"
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

Create a new order

Request

Creates an order for checkout.

Security
JWT
Bodyapplication/jsonrequired
customer_idstringrequired

The unique identifier of customer linked to order.

Example: "cust_E602dMzgjpDC"
document_idstring

The unique identifier of document linked to order. This document entity should contain the required documents to process incoming payments. Refer this Document entity for more details.

Example: "doc_nYUqLpuYQ0M8"
currencystring(iso-4217)required

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

Example: "USD"
amountnumber>= 1required

The amount you want to receive, 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.

Example: 1000
purpose_codestring

Purpose code for why you want to receive this payment

Example: "P1401"
invoice_numberstring

Number/Id of the invoice submitted with order.

Example: "RG12FF590"
invoice_descriptionstring

Description about the invoice submitted with order

Example: "Payment requested for services provided"
invoice_amountnumber

The amount in cents for which invoice was generated. It can be more than the amount requested in this order

Example: 1000
productobject(Product)

Details of the product that the payment is related to.

notesobject

Any additional notes for the order

Example: {"key1":"value1","key2":"value2"}
curl -i -X POST \
  https://api.glomopay.com/api/v1/orders \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer_id": "cust_E602dMzgjpDC",
    "document_id": "doc_nYUqLpuYQ0M8",
    "currency": "USD",
    "amount": 1000,
    "purpose_code": "P1401",
    "invoice_number": "RG12FF590",
    "invoice_description": "Payment requested for services provided",
    "invoice_amount": 1000,
    "product": {
      "name": "ShieldGuard Insurance",
      "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage"
    },
    "notes": {
      "key1": "value1",
      "key2": "value2"
    }
  }'

Responses

Order created successfully

Bodyapplication/json
idstring(string)read-only

The unique identifier for the order.

Example: "order_678a4c88hpAjf"
customer_idstring

The unique identifier of customer linked to order.

Example: "cust_E602dMzgjpDC"
document_idstring

The unique identifier of document linked to order. This document entity should contain the required documents to process incoming payments. Refer this Document entity for more details.

Example: "doc_nYUqLpuYQ0M8"
statusstringread-only

The status of the Order.

Enum"active""paid""failed""action_required""cancelled""under_review"
Example: "success"
currencystring(iso-4217)

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

Example: "USD"
amountnumber>= 1

The amount you want to receive, 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.

Example: 1000
purpose_codestring

Purpose code for why you want to receive this payment

Example: "P1401"
invoice_numberstring

Number/Id of the invoice submitted with order.

Example: "RG12FF590"
invoice_descriptionstring

Description about the invoice submitted with order

Example: "Payment requested for services provided"
invoice_amountnumber

The amount in cents for which invoice was generated. It can be more than the amount requested in this order

Example: 1000
productobject(Product)

Details of the product that the payment is related to.

notesobject

Any additional notes for the order

Example: {"key1":"value1","key2":"value2"}
created_atstring(timestamp)read-only

Timestamp representing when the order was created

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

Timestamp representing when the order was last updated

Example: "2021-06-01T12:00:00Z"
Response
application/json
{
  "id": "order_678a4c88hpAjf",
  "customer_id": "cust_E602dMzgjpDC",
  "document_id": "doc_nYUqLpuYQ0M8",
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "purpose_code": "P1401",
  "invoice_number": "RG12FF590",
  "invoice_description": "Payment requested for services provided",
  "invoice_amount": 1000,
  "product": {
    "name": "ShieldGuard Insurance",
    "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage"
  },
  "notes": {
    "key1": "value1",
    "key2": "value2"
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

List all orders

Request

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

Security
JWT
Query
customer_idstring

Orders of customer to filter

statusstring

Status of order to filter

Enum"active""paid""failed""action_required""cancelled""under_review"
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/orders?customer_id=string&status=active&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 orders matching the filters

Bodyapplication/json
dataArray of objects(Orders)
page_metaobject(PageMeta)
Response
application/json
{
  "data": [
    { … }
  ],
  "page_meta": {
    "current": 2,
    "previous": 1,
    "next": 3,
    "per_page": 20,
    "pages": 10,
    "count": 200
  }
}

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