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 ISO 3166-1 alpha-3 code of the country to filter validations
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.
curl -i -X GET \
'https://api.glomopay.com/api/v1/beneficiaries?beneficiary_type=individual&country=IND&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 } }
curl -i -X GET \
'https://api.glomopay.com/api/v1/beneficiaries/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Beneficiary details
The primary BIC of the bank account. This is the BIC of the bank where the account is held. This is also known as the SWIFT code.
The local routing code or domestic clearing code of the bank account. For reference, this is the IFSC code in India, SORT in UK, ABA in the US, etc.
The email address of the beneficiary.
The country where the beneficiary is located. Country should be sent as a ISO 3166-1 alpha-3 code.
The country of the intermediate bank, if any. Country should be sent as a ISO 3166-1 alpha-3 code.
The SWIFT code of the intermediate bank, if any.
Timestamp representing when the beneficiary was created
{ "id": "bene_5JU9yv0lGSUP", "holder_name": "Test Arts & Crafts Pvt Ltd", "account_number": "1234567890", "bank_name": "Yes Bank", "beneficiary_type": "individual", "bic_primary": "QWERIN000", "bic_secondary": "YESB0000002", "email": "prabhat+beneficiaryArt@glomopay.com", "address_line1": "123 Main St", "address_line2": "Near Apts", "city": "Anytown", "state": "Anystate", "country": "Ind", "pincode": "560048", "nickname": "Test Beneficiary", "intermediate_bank_name": "Intermediate Bank", "intermediate_bank_country": "IND", "intermediate_bank_swift_code": "INTBANKSWIFT", "created_at": "2021-06-01T12:00:00Z", "updated_at": "2021-06-01T12:00:00Z" }
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.
The bank account details of the beneficiary.
The account number of the beneficiary (required).
The name of the bank where the account is held (required).
The SWIFT/BIC code of the bank (required). Must be 8-11 characters with first 6 being letters only. For LRS category, must be exactly 8 characters (no branch suffix like XXX).
The local routing code or domestic clearing code of the bank account. Required for LRS category, optional for payout category. For reference, this is the IFSC code in India, SORT in UK, ABA in the US, etc.
The address of the bank. All fields except address_line2 are required.
The street address of the bank (required).
The second line of street address of the bank (optional).
The city where the bank is located (required).
The state or administrative area where the bank is located (required).
The country where the bank 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}".
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", "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": { … } } }
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). |