Skip to content
API Reference
/
Document
/
Create a new document

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

Create a new document

Request

Security
JWT
Bodymultipart/form-datarequired
document_namestringrequired

The name of the document

Example: "invoice"
filestring(binary)required

The file to be uploaded. This should be sent as a binary in the multipart/form-data request.

curl -i -X POST \
  https://api.glomopay.com/api/v1/document \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F document_name=invoice \
  -F file=string

Responses

Document created successfully

Bodyapplication/json
idstringread-only

The unique identifier for the Document.

Example: "doc_nYUqLpuYQ0M8"
document_namestring

The name of document

Example: "invoice"
file_namestringread-only

The name of the file you uploaded.

Example: "invoice_BC8tFdE.pdf"
statusstringread-only

The status of file you uploaded. Values can be uploaded, approved and rejected.

Example: "uploaded"
created_atstring(timestamp)read-only

Timestamp representing when the document was created

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

Timestamp representing when the document was last updated

Example: "2021-06-01T12:00:00Z"
Response
application/json
{
  "id": "doc_nYUqLpuYQ0M8",
  "document_name": "invoice",
  "file_name": "invoice_BC8tFdE.pdf",
  "status": "uploaded",
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

List all documents

Request

Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first.

Security
JWT
Query
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/document?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 documents matching the filters

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

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 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