Skip to content
API Reference
/
Refund
/
List all refunds

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

Create refund for a payment

Request

Creates refund for a payment entity if the payment is in success state and no other refund exists.

Security
JWT
Bodyapplication/jsonrequired
reasonstringrequired

The reason for the refund.

Enum"Requested By Customer""Duplicate""Fradulent""Others"
payment_idstringrequired

The unique identifier of payment linked to refund.

Example: "payt_E602dMzgjpDC"
document_idstring

The id of document that is uploaded for refund.

Example: "doc_E602dMd2adDC"
document_urlstring

The url of document that is uploaded for refund.

Example: "https://www.example.com/documents/invoice.pdf"
file_namestring

The name of document that is uploaded for refund.

Example: "invoice"
curl -i -X POST \
  https://api.glomopay.com/api/v1/refunds \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "Requested By Customer",
    "payment_id": "payt_E602dMzgjpDC",
    "document_id": "doc_E602dMd2adDC",
    "document_url": "https://www.example.com/documents/invoice.pdf",
    "file_name": "invoice"
  }'

Responses

Refund created successfully

Bodyapplication/json
idstring(string)read-only

The unique identifier for the refund.

Example: "refund_6776d57dnbTWj"
customer_idstring

The unique identifier of customer linked to refund.

Example: "cust_E602dMzgjpDC"
payment_idstring

The unique identifier of payment linked to refund.

Example: "payt_E602dMzgjpDC"
reasonstring

The reason for the refund.

Example: "Requested by Customer"
fx_feeobject(Money)

The foreign exchange fee charged for the refund.

txn_feeobject(Money)

The transaction fee charged for the refund.

documentsArray of objects or objects
statusstringread-only

The status of the refund.

Enum"success""failed""action_required""pending""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
created_atstring(timestamp)read-only

Timestamp representing when the refund was created

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

Timestamp representing when the refund was last updated

Example: "2021-06-01T12:00:00Z"
Response
application/json
{
  "id": "refund_6776d57dnbTWj",
  "customer_id": "cust_E602dMzgjpDC",
  "payment_id": "payt_E602dMzgjpDC",
  "reason": "Requested by Customer",
  "fx_fee": {
    "amount": 1000,
    "currency": "USD"
  },
  "txn_fee": {
    "amount": 1000,
    "currency": "USD"
  },
  "documents": [
    { … }
  ],
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

List all refunds

Request

Returns a list of refunds in response. The refunds are returned sorted by creation date, with the most recent refund appearing first.

Security
JWT
Query
customer_idstring

Refunds of customer to filter

payment_methodstring

Refunds of payment_methods to filter

payment_idstring

Refunds of payment_id to filter

statusstring

Refund status to filter

Enum"success""failed""action_required""pending""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/refunds?customer_id=string&payment_method=string&payment_id=string&status=success&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 Refunds matching the filters

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

Retrieve a refund

Request

Security
JWT
Path
idstringrequired

The unique identifier for the payout.

Example: pout_E602dMzgjpDC
curl -i -X GET \
  https://api.glomopay.com/api/v1/refunds/pout_E602dMzgjpDC \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Refund found

Bodyapplication/json
idstring(string)read-only

The unique identifier for the refund.

Example: "refund_6776d57dnbTWj"
customer_idstring

The unique identifier of customer linked to refund.

Example: "cust_E602dMzgjpDC"
payment_idstring

The unique identifier of payment linked to refund.

Example: "payt_E602dMzgjpDC"
reasonstring

The reason for the refund.

Example: "Requested by Customer"
fx_feeobject(Money)

The foreign exchange fee charged for the refund.

txn_feeobject(Money)

The transaction fee charged for the refund.

documentsArray of objects or objects
statusstringread-only

The status of the refund.

Enum"success""failed""action_required""pending""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
created_atstring(timestamp)read-only

Timestamp representing when the refund was created

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

Timestamp representing when the refund was last updated

Example: "2021-06-01T12:00:00Z"
Response
application/json
{
  "id": "refund_6776d57dnbTWj",
  "customer_id": "cust_E602dMzgjpDC",
  "payment_id": "payt_E602dMzgjpDC",
  "reason": "Requested by Customer",
  "fx_fee": {
    "amount": 1000,
    "currency": "USD"
  },
  "txn_fee": {
    "amount": 1000,
    "currency": "USD"
  },
  "documents": [
    { … }
  ],
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

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