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.
The type of beneficiary. Defaults to "business" if not provided.
A nickname for the beneficiary. If not provided, auto-generated as "{beneficiary_name} - {bank_name}".
The current review status of the beneficiary.
List of document IDs attached to the beneficiary.
The UPI account details of the beneficiary. Present when the beneficiary uses UPI, otherwise null.
Timestamp representing when the beneficiary was created in ISO 8601 format.
{ "id": "ben_5JU9yv0lGSUP", "name": "ACME Corporation", "type": "business", "category": "lrs", "email": "finance@acme.com", "phone": "+1-555-123-4567", "nickname": "ACME Primary Account", "address": { "address_line1": "123 Business Park", "address_line2": "Suite 100", "city": "New York", "state": "NY", "country_code": "USA", "postal_code": "10001" }, "bank_account": { "account_number": "1234567890", "name": "Citibank NA", "swift_code": "CITIUS33", "local_routing_number": "021000089", "currency": "USD", "address": { … }, "intermediate_bank": { … } }, "status": "pending", "documents": [ "doc_68e7980auYRAs" ], "upi_account": { "upi_id": "1111111111@ybl" }, "created_at": "2025-01-15T10:00:00Z", "updated_at": "2025-01-15T10:00:00Z" }
Creates a beneficiary with structured nested objects for beneficiary details, address, and bank account or UPI information.
The category of the beneficiary. Use "lrs" for LRS (Liberalised Remittance Scheme) beneficiaries or "payout" for payout beneficiaries.
The beneficiary details including name, contact information, and address.
The name of the beneficiary. This is a required field.
The type of beneficiary. Defaults to "business" if not provided.
A nickname for the beneficiary. If not provided, it will be auto-generated as "{beneficiary_name} - {bank_name}".
The address of the beneficiary. All fields except address_line2 are required.
The street address of the beneficiary (required).
The second line of street address of the beneficiary (optional).
The city where the beneficiary is located (required).
The state or administrative area where the beneficiary is located (required).
The country where the beneficiary is located (required). Country should be sent as a ISO 3166-1 alpha-3 code.
curl -i -X POST \
https://api.glomopay.com/api/v2/beneficiaries \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"category": "lrs",
"beneficiary": {
"name": "ACME Corporation",
"type": "business",
"email": "finance@acme.com",
"phone": "+1-555-123-4567",
"nickname": "ACME Primary Account",
"address": {
"address_line1": "123 Business Park",
"address_line2": "Suite 100",
"city": "New York",
"state": "NY",
"country_code": "USA",
"postal_code": "10001"
}
},
"bank_account": {
"account_number": "1234567890",
"name": "Citibank NA",
"swift_code": "CITIUS33",
"local_routing_number": "021000089",
"currency": "USD",
"address": {
"address_line1": "388 Greenwich Street",
"city": "New York",
"state": "NY",
"country_code": "USA",
"postal_code": "10013"
},
"intermediate_bank": {
"name": "JPMorgan Chase Bank",
"country": "USA",
"swift_code": "CHASUS33",
"account_number": "123456789"
}
}
}'Beneficiary created successfully
The type of beneficiary. Defaults to "business" if not provided.
A nickname for the beneficiary. If not provided, auto-generated as "{beneficiary_name} - {bank_name}".
The current review status of the beneficiary.
List of document IDs attached to the beneficiary.
The UPI account details of the beneficiary. Present when the beneficiary uses UPI, otherwise null.
Timestamp representing when the beneficiary was created in ISO 8601 format.
{ "id": "bene_5JU9yv0lGSUP", "name": "ACME Corporation", "type": "business", "category": "lrs", "status": "pending", "email": "finance@acme.com", "phone": "+1-555-123-4567", "nickname": "ACME Primary Account", "upi_account": null, "created_at": "2025-01-15T10:00:00Z", "updated_at": "2025-01-15T10:00:00Z", "address": { "address_line1": "123 Business Park", "address_line2": "Suite 100", "city": "New York", "state": "NY", "country_code": "USA", "postal_code": "10001" }, "bank_account": { "account_number": "1234567890", "name": "Citibank NA", "swift_code": "CITIUS33", "local_routing_number": "021000089", "currency": "USD", "address": { … }, "intermediate_bank": { … } } }
curl -i -X GET \
'https://api.glomopay.com/api/v2/beneficiaries?status=active&page=1&per_page=20' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "data": [ { … } ], "page_meta": { "current": 1, "previous": null, "next": null, "per_page": 20, "pages": 1, "count": 10 } }
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). |