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.
https://api.glomopay.com/api/v1/
https://api.glomopay.com/api/v1/orders/{id}
curl -i -X GET \
https://api.glomopay.com/api/v1/orders/order_678a4c88hpAjf \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Payment link retrieved successfully
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.
The status of the Order.
The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.
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.
Description about the invoice submitted with order
The amount in cents for which invoice was generated. It can be more than the amount requested in this order
Bank account details associated with the customer for this order. If provided in the request, all fields will be returned. If bic_primary or bic_secondary was not provided in the request, they will be null in the response.
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.
Timestamp representing when the order was created
Timestamp representing when the order was last updated
List of required documents for RFI (Request for Information). This field is only present when the order status is 'action_required', indicating that sanction screening has been triggered and additional documents are required to proceed with the payment.
{ "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, "reference_number": "R0001", "product": { "name": "ShieldGuard Insurance", "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage" }, "notes": { "key1": "value1", "key2": "value2" }, "bank_account_details": { "account_number": "1234567890", "bic_primary": "HDFCINBBDEL", "bank_customer_id": "7189204715", "bic_secondary": null }, "payment_methods": [ "card" ], "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z", "rfi_documents": [ { … }, { … } ] }
https://api.glomopay.com/api/v1/orders/{id}/update_rfi
curl -i -X PATCH \
https://api.glomopay.com/api/v1/orders/order_678a4c88hpAjf/update_rfi \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"documents": [
{
"id": "doc_67fc2f42468Bw",
"rfi_doc_id": "rfidoc_68c8dffedhMHD"
}
]
}'RFI document updated successfully
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.
The status of the Order.
The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.
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.
Description about the invoice submitted with order
The amount in cents for which invoice was generated. It can be more than the amount requested in this order
Bank account details associated with the customer for this order. If provided in the request, all fields will be returned. If bic_primary or bic_secondary was not provided in the request, they will be null in the response.
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.
Timestamp representing when the order was created
Timestamp representing when the order was last updated
List of required documents for RFI (Request for Information). This field is only present when the order status is 'action_required', indicating that sanction screening has been triggered and additional documents are required to proceed with the payment.
{ "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, "reference_number": "R0001", "product": { "name": "ShieldGuard Insurance", "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage" }, "notes": { "key1": "value1", "key2": "value2" }, "bank_account_details": { "account_number": "1234567890", "bic_primary": "HDFCINBBDEL", "bank_customer_id": "7189204715", "bic_secondary": null }, "payment_methods": [ "card" ], "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z", "rfi_documents": [ { … }, { … } ] }
This resource represents internal fund movements between merchant accounts within the platform–partner model. Internal transfers enable seamless fund movement between merchants who operate under the same platform account. Internal transfers are restricted to accounts linked under the same platform hierarchy. The following transfer directions are supported:
| Transfer Type | Description |
|---|---|
| P → C | From a Platform (P) account to one of its Child (C) merchant accounts. |
| C → P | From a Child (C) merchant account back to its Platform (P) account. |
| C → C (same P) | Between Child (C) accounts under the same Platform (P). |