Skip to content
API Reference
/
Withdrawal

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

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

idstring(uuid)read-only

The unique identifier for the withdrawal.

Example: "payout_DdWpHUbOnlg"
statusstringread-only

The status of the withdrawal.

Enum"in_progress""success""failed""action_required""cancelled""under_review"
Example: "success"
currencystring(iso-4217)

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

Example: "USD"
amountnumber>= 1

The amount you want to receive in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field. Cents is a general term for the smallest unit of currency in any currency. It does not necessarily mean USD cents.

Example: 1000
withdrawal_account_idstring(uuid)

The unique identifier for the withdrawal account.

Example: "accwith_5JU9yv0lGSUP"
payment_methodstring

The payment method to use for the withdrawal.

Value"bank_transfer"
Example: "bank_transfer"
balance_usedArray of objects(Balance)read-only

The amount in cents that was deducted from your balance for this withdrawal.

purpose_codestring

Purpose code for why you want to receive this payment

Example: "S0017"
mid_market_rateArray of objects(ConversionRate)read-only

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

fx_feesArray of objects(Balance)read-only

The FX fees applied to the withdrawal.

txn_feesArray of objects(Balance)read-only

The transaction fees applied to the withdrawal.

created_atstring(timestamp)read-only

Timestamp representing when the payin was created

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

Timestamp representing when the payin was last updated

Example: "2021-06-01T12:00:00Z"
{
  "id": "payout_DdWpHUbOnlg",
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "withdrawal_account_id": "accwith_5JU9yv0lGSUP",
  "payment_method": "bank_transfer",
  "balance_used": [
    { … }
  ],
  "purpose_code": "S0017",
  "mid_market_rate": [
    { … }
  ],
  "fx_fees": [
    { … }
  ],
  "txn_fees": [
    { … }
  ],
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

Create a new withdrawal

Request

Security
JWT
Bodyapplication/jsonrequired
amountnumber>= 1required

The amount you want to receive.

Example: 1000
balance_currencystring(iso-4217)required

The balance which you want use to make the withdrawal. For example, USD. This is the currency in which the amount will be deducted from your balance. The target currency in which the amount will be settled will be the currency set in the withdrawal account.

Example: "USD"
withdrawal_account_idstring

The unique identifier for the withdrawal account.

Example: "accwith_5JU9yv0lGSUP"
curl -i -X POST \
  https://api.glomopay.com/api/v1/withdrawals \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 1000,
    "balance_currency": "USD",
    "withdrawal_account_id": "accwith_5JU9yv0lGSUP"
  }'

Responses

Withdrawal created successfully

Bodyapplication/json
idstring(uuid)read-only

The unique identifier for the withdrawal.

Example: "payout_DdWpHUbOnlg"
statusstringread-only

The status of the withdrawal.

Enum"in_progress""success""failed""action_required""cancelled""under_review"
Example: "success"
currencystring(iso-4217)

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

Example: "USD"
amountnumber>= 1

The amount you want to receive in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field. Cents is a general term for the smallest unit of currency in any currency. It does not necessarily mean USD cents.

Example: 1000
withdrawal_account_idstring(uuid)

The unique identifier for the withdrawal account.

Example: "accwith_5JU9yv0lGSUP"
payment_methodstring

The payment method to use for the withdrawal.

Value"bank_transfer"
Example: "bank_transfer"
balance_usedArray of objects(Balance)read-only

The amount in cents that was deducted from your balance for this withdrawal.

purpose_codestring

Purpose code for why you want to receive this payment

Example: "S0017"
mid_market_rateArray of objects(ConversionRate)read-only

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

fx_feesArray of objects(Balance)read-only

The FX fees applied to the withdrawal.

txn_feesArray of objects(Balance)read-only

The transaction fees applied to the withdrawal.

created_atstring(timestamp)read-only

Timestamp representing when the payin was created

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

Timestamp representing when the payin was last updated

Example: "2021-06-01T12:00:00Z"
Response
application/json
{
  "id": "payout_DdWpHUbOnlg",
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "withdrawal_account_id": "accwith_5JU9yv0lGSUP",
  "payment_method": "bank_transfer",
  "balance_used": [
    { … }
  ],
  "purpose_code": "S0017",
  "mid_market_rate": [
    { … }
  ],
  "fx_fees": [
    { … }
  ],
  "txn_fees": [
    { … }
  ],
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

List all withdrawals

Request

Security
JWT
Query
withdrawal_account_idstring

The unique identifier of the beneficiary

Example: withdrawal_account_id=accwith_162843c10333
statusstring

Status of withdrawal 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/withdrawals?withdrawal_account_id=accwith_162843c10333&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 withdrawals matching the filters

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

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