Skip to content
API Reference
/
/
Orders

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""under_review""expired"
Example:"active"
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
reference_numberstring

optional identifier to be sent for reconciliations

Example:"R0001"
price_idstring

The unique identifier of 'Price' entity linked to the order. This is the referral fee for this order. Note: price_id is only applicable for platform businesses.

Example:"price_E602dMzgjpDC"
split_idsArray of strings(SplitIds)

The pricing splits to apply, each entry an id returned by Create a pricing split. A split fixes your share of a dynamic rule's fee and the customer bears the remainder. Omit split_ids and no dynamic rule is applied — pricing falls back to your normal (non-dynamic) rules.

split_ids and payment_methods are independent. payment_methods restricts which methods the checkout offers. split_ids only changes how the fee for a method is priced: a split applies to its own payment method whether or not that method appears in payment_methods, and a split never adds a method to the checkout or removes one from it. One checkout can therefore price one method from a dynamic split and another method from your normal rules.

Every id must exist, must belong to your business, and must still point at a live dynamic rule. When two dynamic rules share a dimension — the same payment method, subtype, rail, currency and fee type — declare a split for every one of them or the request is rejected. On payment links and orders, a split whose payment method is not enabled for your business is also rejected.

A subscription only ever charges card, or pay_via_bank when SEPA-eligible, so a split declared for any other payment method is rejected at subscription creation and on an auto debit. An auto-debit override must be declared for the method the subscription actually charges.

Glomo can configure your account to require a declaration. On such an account, a payment link, an order, a payin quote or an as_presented subscription that omits split_ids is rejected.

Example:
[
  "psplit_7Kq2mXbTdLp9"
]
productobject(Product)

Details of the product that the payment is related to.

Example:
{
  "name": "ShieldGuard Insurance",
  "description": "Flexible insurance for belongings travel and digital assets easy to manage"
}
notesobject or null(Notes)

Optional key-value pairs for attaching custom metadata (e.g. invoice references, project codes). Keys must be strings and cannot collide with reserved field names. If your business has custom field rules configured (e.g. enum constraints), values are validated against those rules. Each key appears as a separate column in CSV report exports, with corresponding values populating the rows.

Example:
{
  "invoice_ref": "INV-2026-001",
  "project": "Alpha"
}
bank_account_detailsobject

Optional bank account details to associate with the customer for this order. When provided, the bank account will be linked to the customer and associated with this order. Either bic_primary or bic_secondary must be provided when including this field.

Example:
{
  "account_number": "1234567890",
  "bic_primary": "HDFCINBBDEL",
  "bank_customer_id": "7189204715"
}
payment_methodsArray of strings

Array of payment methods that should be available for the customer on the checkout page. This field allows you to control which payment options your customers can use to complete the payment. You can specify one or multiple payment methods in the array.

Items Enum:"bank_transfer""pay_via_bank""card"
Example:
[
  "card"
]
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"
request_idstring

Optional idempotency key.

Example:"unique_order_request_id_123"
{
  "id": "order_678a4c88hpAjf",
  "customer_id": "cust_E602dMzgjpDC",
  "document_id": "doc_nYUqLpuYQ0M8",
  "status": "active",
  "currency": "USD",
  "amount": 1000,
  "purpose_code": "P1401",
  "invoice_number": "RG12FF590",
  "invoice_description": "Payment requested for services provided",
  "invoice_amount": 1000,
  "reference_number": "R0001",
  "price_id": "price_E602dMzgjpDC",
  "split_ids": [
    "psplit_7Kq2mXbTdLp9"
  ],
  "product": {
    "name": "ShieldGuard Insurance",
    "description": "Flexible insurance for belongings travel and digital assets easy to manage"
  },
  "notes": {
    "invoice_ref": "INV-2026-001",
    "project": "Alpha"
  },
  "bank_account_details": {
    "account_number": "1234567890",
    "bic_primary": "HDFCINBBDEL",
    "bank_customer_id": "7189204715"
  },
  "payment_methods": [
    "card"
  ],
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z",
  "request_id": "unique_order_request_id_123"
}