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 unique identifier for the payin. This is set only for payments associated to a payin.
The type of the payin. This is set only for payments associated to a payin.
The unique identifier for the subscription. This is set only for subscription-related payments.
The currency in which the customer pays. The currency code is in ISO 4217 format. For example, AED.
The total amount the customer pays in cents (includes customer-borne fees if applicable). For example, 374580 cents is 3,745.80 AED. The currency is determined by the payment_currency field.
The settlement currency after conversion. The currency code is in ISO 4217 format. For example, USD.
The final amount after currency conversion in cents (includes all fees). For example, 102000 cents is $1,020.00. The currency is determined by the converted_currency field.
The currency that was originally requested by the merchant. The currency code is in ISO 4217 format. For example, USD.
The amount originally requested by the merchant in cents, excluding customer-borne fees. For example, 100000 cents is $1,000.00. The currency is determined by the requested_currency field.
The purpose code of the payment. This should match the purpose code of the payin.
The transaction reference number. This should match the payin id.
The error code for the respective error. Error code mappings can be found in the product guide.
The error description corresponding to error code.
The creation timestamp of the payment.
The last update timestamp of the payment.
The name of the product associated with the payment.
The description of the product associated with the payment.
The country of the sender. Country should be sent as a ISO 3166-1 alpha-3 code.
A unique identifier generated by Glomo for the settlement batch in which this payment is included. This ID can be used to track and reconcile payments against corresponding settlements.
Indicates whether the funds for this payment are currently available with Glomo.
Values:
true - Funds are available with Glomo and can be included in a payout or settlementfalse - Funds are still in transit with Glomo's payment partners and are not yet available for useSpecifies the method used by the customer to complete the payment. This can include various options such as swift_transfer, card, and other payment methods.
{ "id": "payt_E602dMzgjpDC", "payin_id": "payin_E602dMzgjpDC", "payin_type": "payment_link", "subscription_id": "sub_68877570b5zeE", "status": "success", "payment_currency": "AED", "payment_amount": 374580, "converted_currency": "USD", "converted_amount": 102000, "requested_currency": "USD", "requested_amount": 100000, "purpose_code": "S0001", "transaction_reference_number": "payin_E602dMzgjpDC", "sender_name": "John Doe", "metadata": {}, "error_message": "string", "error_code": "PAYMENT_DECLINED", "error_description": "The payment attempt was declined. This could be due to issuer rejection, risk assessment, or restrictions on the card or account. The customer should contact their bank or try a different payment method.", "payment_date": "2024-12-06T11:38:37.130Z", "fee_bearer": "customer", "created_at": "2024-12-06T11:38:37.130Z", "updated_at": "2024-12-06T11:38:37.130Z", "customer_id": "cust_E602sMzgjpDC", "product_name": "ShieldGuard Insurance", "product_description": "Simple, monthly insurance plan that covers your basic belongings and key digital assets", "country": "Ind", "ordered_amount": 1000, "ordered_currency": "USD", "fx_fee": { "amount": 1000, "currency": "USD" }, "txn_fee": { "amount": 1000, "currency": "USD" }, "documents": [ { … } ], "settlement_id": "string", "funds_available": true, "payment_method": { "summary": "Swift Transfer Payment Method", "value": { … } }, "auto_debit": true }
Status of payin to filter
The unique identifier for the subscription.
The currency in which the payment is made. The currency code is in ISO 4217 format. For example, USD.
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/payment
curl -i -X GET \
'https://api.glomopay.com/api/v1/payment?customer_id=cust_E602sMzgjpDC&status=success&payin_id=payin_E602dMzgjpDC&subscription_id=sub_68877570b5zeE¤cy=USD&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 } }
The unique identifier for the payin. Required if no payment_method is passed.
https://api.glomopay.com/api/v1/payment/mock
curl -i -X POST \
https://api.glomopay.com/api/v1/payment/mock \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 10000,
"currency": "AED",
"payment_method": "BankTransfer",
"payin_id": "payin_E602dMzgjpDC",
"remitter_name": "Non_Sanctioned_Entity"
}'Payment created successfully
The unique identifier for the payin. This is set only for payments associated to a payin.
The type of the payin. This is set only for payments associated to a payin.
The unique identifier for the subscription. This is set only for subscription-related payments.
The currency in which the customer pays. The currency code is in ISO 4217 format. For example, AED.
The total amount the customer pays in cents (includes customer-borne fees if applicable). For example, 374580 cents is 3,745.80 AED. The currency is determined by the payment_currency field.
The settlement currency after conversion. The currency code is in ISO 4217 format. For example, USD.
The final amount after currency conversion in cents (includes all fees). For example, 102000 cents is $1,020.00. The currency is determined by the converted_currency field.
The currency that was originally requested by the merchant. The currency code is in ISO 4217 format. For example, USD.
The amount originally requested by the merchant in cents, excluding customer-borne fees. For example, 100000 cents is $1,000.00. The currency is determined by the requested_currency field.
The purpose code of the payment. This should match the purpose code of the payin.
The transaction reference number. This should match the payin id.
The error code for the respective error. Error code mappings can be found in the product guide.
The error description corresponding to error code.
The creation timestamp of the payment.
The last update timestamp of the payment.
The name of the product associated with the payment.
The description of the product associated with the payment.
The country of the sender. Country should be sent as a ISO 3166-1 alpha-3 code.
A unique identifier generated by Glomo for the settlement batch in which this payment is included. This ID can be used to track and reconcile payments against corresponding settlements.
Indicates whether the funds for this payment are currently available with Glomo.
Values:
true - Funds are available with Glomo and can be included in a payout or settlementfalse - Funds are still in transit with Glomo's payment partners and are not yet available for useSpecifies the method used by the customer to complete the payment. This can include various options such as swift_transfer, card, and other payment methods.
{ "id": "payt_E602dMzgjpDC", "payin_id": "payin_E602dMzgjpDC", "payin_type": "payment_link", "subscription_id": "sub_68877570b5zeE", "status": "success", "payment_currency": "AED", "payment_amount": 374580, "converted_currency": "USD", "converted_amount": 102000, "requested_currency": "USD", "requested_amount": 100000, "purpose_code": "S0001", "transaction_reference_number": "payin_E602dMzgjpDC", "sender_name": "John Doe", "metadata": {}, "error_message": "string", "error_code": "PAYMENT_DECLINED", "error_description": "The payment attempt was declined. This could be due to issuer rejection, risk assessment, or restrictions on the card or account. The customer should contact their bank or try a different payment method.", "payment_date": "2024-12-06T11:38:37.130Z", "fee_bearer": "customer", "created_at": "2024-12-06T11:38:37.130Z", "updated_at": "2024-12-06T11:38:37.130Z", "customer_id": "cust_E602sMzgjpDC", "product_name": "ShieldGuard Insurance", "product_description": "Simple, monthly insurance plan that covers your basic belongings and key digital assets", "country": "Ind", "ordered_amount": 1000, "ordered_currency": "USD", "fx_fee": { "amount": 1000, "currency": "USD" }, "txn_fee": { "amount": 1000, "currency": "USD" }, "documents": [ { … } ], "settlement_id": "string", "funds_available": true, "payment_method": { "summary": "Swift Transfer Payment Method", "value": { … } }, "auto_debit": true }
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). |