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/
The status of the refund.
The amount you want to receive in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field. Cents is a general term for the smallest unit of currency in any currency. It does not necessarily mean USD cents.
Timestamp representing when the refund was created
{ "id": "refund_6776d57dnbTWj", "customer_id": "cust_E602dMzgjpDC", "payment_id": "payt_E602dMzgjpDC", "reason": "Requested by Customer", "fx_fee": { "amount": 1000, "currency": "USD" }, "txn_fee": { "amount": 1000, "currency": "USD" }, "documents": [ { … } ], "status": "success", "currency": "USD", "amount": 1000, "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z" }
The reason for the refund.
The unique identifier of payment linked to refund.
The url of document that is uploaded for refund.
https://api.glomopay.com/api/v1/refunds
curl -i -X POST \
https://api.glomopay.com/api/v1/refunds \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"reason": "Requested By Customer",
"payment_id": "payt_E602dMzgjpDC",
"document_id": "doc_E602dMd2adDC",
"document_url": "https://www.example.com/documents/invoice.pdf",
"file_name": "invoice"
}'Refund created successfully
The status of the refund.
The amount you want to receive in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field. Cents is a general term for the smallest unit of currency in any currency. It does not necessarily mean USD cents.
Timestamp representing when the refund was created
{ "id": "refund_6776d57dnbTWj", "customer_id": "cust_E602dMzgjpDC", "payment_id": "payt_E602dMzgjpDC", "reason": "Requested by Customer", "fx_fee": { "amount": 1000, "currency": "USD" }, "txn_fee": { "amount": 1000, "currency": "USD" }, "documents": [ { … } ], "status": "success", "currency": "USD", "amount": 1000, "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z" }
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.
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.
https://api.glomopay.com/api/v1/refunds
curl -i -X GET \
'https://api.glomopay.com/api/v1/refunds?customer_id=string&payment_method=string&payment_id=string&status=success&before=2025-02-18T12%3A03%3A44Z&after=2025-01-18T12%3A03%3A44Z&per_page=20&page=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "data": [ { … } ], "page_meta": { "current": 2, "previous": 1, "next": 3, "per_page": 20, "pages": 10, "count": 200 } }
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). |