Skip to content
API Reference
/
Payout
/
Create a new payout

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.

Operations

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.

Operations

Orders

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

Operations

Customer

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

Operations

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.

Operations

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.

Operations

Price

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

Operations

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.

Operations

Payout

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

Operations

Payout

idstring(uuid)read-only

The unique identifier for the payin.

Example: "payout_DdWp_HUbOnlg"
statusstringread-only

The status of the payout.

Example: "success"
destination_amountnumber>= 1

The amount the beneficiary will receive, expressed in the smallest unit of the specified currency (e.g., cents for USD, paisa for INR). For example, 1000 represents $10.00 in USD. The actual currency is determined by the currency field. Note: "cents" is used generically to denote the minimal currency unit, not necessarily USD.

Example: 1000
destination_currencystring(iso-4217)

The currency code in ISO 4217 format. For example, USD.

Example: "USD"
source_amountnumber>= 1

The amount you intend to send, also specified in the smallest unit of the selected currency. For example, 1000 equates to $10.00 in USD. The currency field determines which currency is used. As with destination_amount, "cents" is a placeholder for the minimal unit, not specifically USD.

Example: 1000
source_currencystring(iso-4217)

The currency code in ISO 4217 format. For example, USD.

Example: "USD"
beneficiary_idstring(uuid)

The unique identifier for the beneficiary.

Example: "bene_5JU9yv0lGSUP"
documentsArray of objects(AttachedDocument)

The attached documents for the payout.

purpose_codestring

Purpose code for why you want to receive this payment

Example: "S0017"
mid_market_ratenumberread-only

The mid-market rate at the time of payout creation.

Example: 1
feesobjectread-only

The fees applied to this payout

created_atstring(timestamp)read-only

Timestamp representing when the payout was created

Example: "2021-06-01T12:00:00Z"
updated_atstring(timestamp)read-only

Timestamp representing when the payout was last updated

Example: "2021-06-01T12:00:00Z"
{
  "id": "payout_DdWp_HUbOnlg",
  "status": "success",
  "destination_amount": 1000,
  "destination_currency": "USD",
  "source_amount": 1000,
  "source_currency": "USD",
  "beneficiary_id": "bene_5JU9yv0lGSUP",
  "documents": [
    { … }
  ],
  "purpose_code": "S0017",
  "mid_market_rate": 1,
  "fees": {
    "fx": { … },
    "transaction": { … }
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

Create a new payout

Request

Security
JWT
Bodyapplication/jsonrequired
source_currencystring(iso-4217)required

The currency from which you want the amount to be deducted from source balance.

Example: "USD"
source_amountnumber>= 1

The amount you intend to send, also specified in the smallest unit of the selected currency. For example, 1000 equates to $10.00 in USD. The currency field determines which currency is used. As with destination_amount, "cents" is a placeholder for the minimal unit, not specifically USD.

Example: 1000
destination_currencystring(iso-4217)required

The currency in which recipient will receive the payout. The currency code should be in ISO 4217 format. For example, USD.

Example: "USD"
destination_amountnumber>= 1

The amount the beneficiary will receive, expressed in the smallest unit of the specified currency (e.g., cents for USD, paisa for INR). For example, 1000 represents $10.00 in USD. The actual currency is determined by the currency field. Note: "cents" is used generically to denote the minimal currency unit, not necessarily USD.

Example: 1000
beneficiary_idstring(uuid)required

The unique identifier for the beneficiary.

Example: "bene_5JU9yv0lGSUP"
purpose_codestringrequired

Purpose code for why you want to receive this payment

Example: "S0017"
documentsArray of stringsrequired

List of documents to attach to the payout

Example: ["doc_5JU9yv0lGSUP","doc_678a5aa9SKkEr"]
curl -i -X POST \
  https://api.glomopay.com/api/v1/payouts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "source_currency": "USD",
    "source_amount": 1000,
    "destination_currency": "USD",
    "destination_amount": 1000,
    "beneficiary_id": "bene_5JU9yv0lGSUP",
    "purpose_code": "S0017",
    "documents": [
      "doc_5JU9yv0lGSUP",
      "doc_678a5aa9SKkEr"
    ]
  }'

Responses

Payout created successfully

Bodyapplication/json
idstring(uuid)read-only

The unique identifier for the payin.

Example: "payout_DdWp_HUbOnlg"
statusstringread-only

The status of the payout.

Example: "success"
destination_amountnumber>= 1

The amount the beneficiary will receive, expressed in the smallest unit of the specified currency (e.g., cents for USD, paisa for INR). For example, 1000 represents $10.00 in USD. The actual currency is determined by the currency field. Note: "cents" is used generically to denote the minimal currency unit, not necessarily USD.

Example: 1000
destination_currencystring(iso-4217)

The currency code in ISO 4217 format. For example, USD.

Example: "USD"
source_amountnumber>= 1

The amount you intend to send, also specified in the smallest unit of the selected currency. For example, 1000 equates to $10.00 in USD. The currency field determines which currency is used. As with destination_amount, "cents" is a placeholder for the minimal unit, not specifically USD.

Example: 1000
source_currencystring(iso-4217)

The currency code in ISO 4217 format. For example, USD.

Example: "USD"
beneficiary_idstring(uuid)

The unique identifier for the beneficiary.

Example: "bene_5JU9yv0lGSUP"
documentsArray of objects(AttachedDocument)

The attached documents for the payout.

purpose_codestring

Purpose code for why you want to receive this payment

Example: "S0017"
mid_market_ratenumberread-only

The mid-market rate at the time of payout creation.

Example: 1
feesobjectread-only

The fees applied to this payout

created_atstring(timestamp)read-only

Timestamp representing when the payout was created

Example: "2021-06-01T12:00:00Z"
updated_atstring(timestamp)read-only

Timestamp representing when the payout was last updated

Example: "2021-06-01T12:00:00Z"
Response
application/json
{
  "id": "payout_DdWp_HUbOnlg",
  "status": "success",
  "destination_amount": 1000,
  "destination_currency": "USD",
  "source_amount": 1000,
  "source_currency": "USD",
  "beneficiary_id": "bene_5JU9yv0lGSUP",
  "documents": [
    { … }
  ],
  "purpose_code": "S0017",
  "mid_market_rate": 1,
  "fees": {
    "fx": { … },
    "transaction": { … }
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

List all payouts

Request

Security
JWT
Query
beneficiary_idstring

The unique identifier of the beneficiary

Example: beneficiary_id=bene_5JU9yv0lGSUP
statusstring

Status of payout to filter

Enum"in_progress""success""failed""action_required""cancelled""under_review"
beforestring(timestamp)

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.

Example: before=2025-02-18T12:03:44Z
afterstring(timestamp)

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.

Example: after=2025-01-18T12:03:44Z
per_pageinteger

Number of resources per page. Should be between 1 and 100.

Default 20
pageinteger

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Default 1
curl -i -X GET \
  'https://api.glomopay.com/api/v1/payouts?beneficiary_id=bene_5JU9yv0lGSUP&status=in_progress&before=2025-02-18T12%3A03%3A44Z&after=2025-01-18T12%3A03%3A44Z&per_page=20&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of payouts matching the filters

Bodyapplication/json
dataArray of objects(Payout)
page_metaobject(PageMeta)
Response
application/json
{
  "data": [
    { … }
  ],
  "page_meta": {
    "current": 2,
    "previous": 1,
    "next": 3,
    "per_page": 20,
    "pages": 10,
    "count": 200
  }
}

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.

Operations

Bank Account Validation

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

Operations

Withdrawal

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

Operations

Withdrawal Account

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

Operations

Settlement

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

Operations