Skip to content
API Reference
/
/
Create an internal transf...

API specification for Glomo (1.0.0)

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.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail

developer@glomopay.com

License

Apache 2.0

Terms of Service

Languages
Servers
Production server

https://api.glomopay.com/api/v1/

Balance

This resource represents your Glomo balance. You can retrieve it to see the current balance on your Glomo account in all currencies enabled for your account.

SchemasOperations

Balance Conversions

Balance Conversion resource represents the details of the balance conversion. The balance conversion is the conversion of the balance from one supported currency to another supported currency.

SchemasOperations

Orders

This resource represents the order details. The order is the request to receive payment from your customer.

SchemasOperations

Customer

This resource represents a customer of your business. The customer can be an individual or a business from whom you will receive payments.

SchemasOperations

Document

Document resource represents the documents details uploaded. This document is used in payin, payout, etc.

Operations

Payment

This resource represents a payment attempt made by your customer. The payment can either be successfully completed or failed, depending on various factors.

SchemasOperations

Refund

This resource represents a refund transaction from your Glomo account to your customer. You can retrieve it to see the details of the refund transaction.

SchemasOperations

Price

This resource represents the pricing details of the payin or payout. The pricing details include the fees and the pricing type

SchemasOperations

Subscription

This resource represents a recurring billing agreement for a customer. Subscriptions allow businesses to automatically charge customers on a regular schedule according to a defined billing plan.

SchemasOperations

Payout

This resource represents the disbursement transactions from your Glomo account to your beneficiaries.

SchemasOperations

Beneficiary

This resource represents a payee of a payout initiated by your business. The beneficiary can be an individual or a business to whom you will send funds.

SchemasOperations

Bank Account Validation

Bank Account Validation resource represents the validation details of a bank account.

SchemasOperations

Internal Transfer

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 TypeDescription
P → CFrom a Platform (P) account to one of its Child (C) merchant accounts.
C → PFrom a Child (C) merchant account back to its Platform (P) account.
C → C (same P)Between Child (C) accounts under the same Platform (P).
SchemasOperations

InternalTransfer

idstringread-only

The unique identifier for the internal transfer.

Example: "inttransfer_68f1f9126GDCB"
from_merchant_idstring

The unique identifier of the merchant account from which funds were transferred.

Example: "merch_68cc1216xPrdU"
to_merchant_idstring

The unique identifier of the merchant account to which funds were transferred.

Example: "merch_68cc0571y5S4h"
owner_merchant_idstring

The unique identifier of the merchant account that owns/initiated this transfer.

Example: "merch_68cc0571y5S4h"
transfer_amountinteger

The amount transferred in cents. For example, 1000 cents is 10.00.

Example: 1000
transfer_currencystring(iso-4217, case-insensitive)

The currency in which the transfer was made. The currency code is in ISO 4217 format.

Example: "AED"
referencestring

The reference identifier provided for the transfer.

Example: "123"
feesobject

The fees associated with the internal transfer.

Example: {"txn_fee":{"currency":"AED","amount":0},"fx_fee":{"currency":"AED","amount":0}}
error_codestring or nullread-only

The error code if the internal transfer failed, null otherwise.

Example: null
error_descriptionstring or nullread-only

The error description if the internal transfer failed, null otherwise.

Example: null
created_atstring(date-time)read-only

The creation timestamp of the internal transfer.

Example: "2025-10-17T08:06:42Z"
updated_atstring(date-time)read-only

The last update timestamp of the internal transfer.

Example: "2025-10-17T08:06:42Z"
{
  "id": "inttransfer_68f1f9126GDCB",
  "from_merchant_id": "merch_68cc1216xPrdU",
  "to_merchant_id": "merch_68cc0571y5S4h",
  "owner_merchant_id": "merch_68cc0571y5S4h",
  "transfer_amount": 1000,
  "transfer_currency": "AED",
  "reference": "123",
  "fees": {
    "txn_fee": { … },
    "fx_fee": { … }
  },
  "error_code": null,
  "error_description": null,
  "created_at": "2025-10-17T08:06:42Z",
  "updated_at": "2025-10-17T08:06:42Z"
}

Create an internal transfer

Request

Creates an internal transfer between two merchant accounts.

Security
JWT
Bodyapplication/jsonrequired
amountinteger>= 1required

The amount to transfer in cents. For example, 10000 cents is 100.00. The currency is determined by the currency field.

Example: 10000
currencystring(iso-4217, case-insensitive)required

The currency in which the transfer is made. The currency code is in ISO 4217 format. Currently only AED is supported for internal transfers.

Value"AED"
Example: "AED"
referencestring<= 100 charactersrequired

A reference identifier for the transfer. Maximum length is 100 characters.

Example: "sample-reference"
from_merchant_idstringrequired

The unique identifier of the merchant account from which funds will be transferred.

Example: "merch_68cc1216xPrdU"
to_merchant_idstringrequired

The unique identifier of the merchant account to which funds will be transferred. Must be different from from_merchant_id.

Example: "merch_68cc0571y5S4h"
curl -i -X POST \
  https://api.glomopay.com/api/v1/internal-transfer \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 10000,
    "currency": "AED",
    "reference": "sample-reference",
    "from_merchant_id": "merch_68cc1216xPrdU",
    "to_merchant_id": "merch_68cc0571y5S4h"
  }'

Responses

Internal transfer created successfully

Bodyapplication/json
idstringread-only

The unique identifier for the internal transfer.

Example: "inttransfer_68f1f9126GDCB"
from_merchant_idstring

The unique identifier of the merchant account from which funds were transferred.

Example: "merch_68cc1216xPrdU"
to_merchant_idstring

The unique identifier of the merchant account to which funds were transferred.

Example: "merch_68cc0571y5S4h"
owner_merchant_idstring

The unique identifier of the merchant account that owns/initiated this transfer.

Example: "merch_68cc0571y5S4h"
transfer_amountinteger

The amount transferred in cents. For example, 1000 cents is 10.00.

Example: 1000
transfer_currencystring(iso-4217, case-insensitive)

The currency in which the transfer was made. The currency code is in ISO 4217 format.

Example: "AED"
referencestring

The reference identifier provided for the transfer.

Example: "123"
feesobject

The fees associated with the internal transfer.

Example: {"txn_fee":{"currency":"AED","amount":0},"fx_fee":{"currency":"AED","amount":0}}
error_codestring or nullread-only

The error code if the internal transfer failed, null otherwise.

Example: null
error_descriptionstring or nullread-only

The error description if the internal transfer failed, null otherwise.

Example: null
created_atstring(date-time)read-only

The creation timestamp of the internal transfer.

Example: "2025-10-17T08:06:42Z"
updated_atstring(date-time)read-only

The last update timestamp of the internal transfer.

Example: "2025-10-17T08:06:42Z"
Response
application/json
{
  "id": "inttransfer_68f1f9126GDCB",
  "from_merchant_id": "merch_68cc1216xPrdU",
  "to_merchant_id": "merch_68cc0571y5S4h",
  "owner_merchant_id": "merch_68cc0571y5S4h",
  "transfer_amount": 1000,
  "transfer_currency": "AED",
  "reference": "123",
  "fees": {
    "txn_fee": { … },
    "fx_fee": { … }
  },
  "error_code": null,
  "error_description": null,
  "created_at": "2025-10-17T08:06:42Z",
  "updated_at": "2025-10-17T08:06:42Z"
}

Withdrawal

[DEPRECATED] This resource represents the withdrawal transaction from your Glomo account to your withdrawal account.

SchemasOperations

Withdrawal Account

This resource represents the withdrawal account details. The withdrawal account is the bank account where the withdrawal amount will be credited.

SchemasOperations

Settlement

This resource represents the settlement details. The settlement is the process of transferring funds from your Glomo account to your bank account.

SchemasOperations

Virtual Account

This resource represents virtual account details. A virtual account is a unique account number provisioned for a customer, allowing payments to be received and transactions to be tracked against that customer.

SchemasOperations

Platform

This resource provides platform functionality that enables platforms to onboard merchants onto Glomo, with each merchant having their own dedicated Virtual Accounts (VA).

SchemasOperations