# API specification for Glomo 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. Version: 1.0.0 License: Apache 2.0 ## Servers Production server ``` https://api.glomopay.com/api/v1 ``` ## Security ### JWT Your secret token to access the API. If you don't have one, please contact support. Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [API specification for Glomo](https://docs.glomopay.com/_bundle/api-documentation/apis/openapi.yaml) ## 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. ### Retrieve balances - [GET /balances](https://docs.glomopay.com/api-documentation/apis/openapi/balance/getbalance.md): Retrieves available balances for all currencies. ## 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. ### Convert balances - [POST /balance_conversions](https://docs.glomopay.com/api-documentation/apis/openapi/balance_conversions/createbalanceconversion.md): Converts balance from one currency to another. In the API you can either send target_amount or source_amount and the API will calculate the other amount for you. ### List all Balance Conversions - [GET /balance_conversions](https://docs.glomopay.com/api-documentation/apis/openapi/balance_conversions/getbalanceconversions.md): Returns a list of your balance conversions. The balance conversions are returned sorted by creation date, with the most recent beneficiary appearing first. ## Payment Link A payment link is a shareable URL that will take your customers to a Glomo-hosted payment page. The payment page can only be accessed by your customer after the completion of 1FA via their email. ### Create a new Payment Link - [POST /payin](https://docs.glomopay.com/api-documentation/apis/openapi/payment_link/createpayin.md): Creates a shareable URL for a hosted payment page. To check complete list of API validations, click here. ### List all payment links - [GET /payin](https://docs.glomopay.com/api-documentation/apis/openapi/payment_link/getpayins.md): Returns a list of your payment links. The payment links are returned sorted by creation date, with the most recent payment link appearing first. ### Retrieve a payment link - [GET /payin/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/payment_link/getpayinbyid.md): Retrieve details of a payment link. ### Update an existing payment link - [PATCH /payin/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/payment_link/updatepayin.md) ### Cancel a payment link - [PATCH /payin/{id}/cancel](https://docs.glomopay.com/api-documentation/apis/openapi/payment_link/cancelpayin.md): Invalidate payment link and prevent further transactions ### Update RFI documents for a payment link - [PATCH /payin/{id}/update_rfi](https://docs.glomopay.com/api-documentation/apis/openapi/payment_link/updatepayinrfi.md): Updates the RFI (Request for Information) document status for a payment link. This endpoint is used to submit required documents when a payment link is in 'action_required' status due to sanction screening. ### Mock review a payment link - [PATCH /payin/{id}/mock_mark_reviewed](https://docs.glomopay.com/api-documentation/apis/openapi/payment_link/mockreviewpaymentlink.md): Mark an under_review payment link reviewed ## Orders This resource represents the order details. The order is the request to receive payment from your customer. ### Create a new order - [POST /orders](https://docs.glomopay.com/api-documentation/apis/openapi/orders/createorder.md): Creates an order for checkout. To check complete list of API validations, click here. ### List all orders - [GET /orders](https://docs.glomopay.com/api-documentation/apis/openapi/orders/getorders.md): Returns a list of your orders. The orders are returned sorted by creation date, with the most recent order appearing first. ### Retrieve an order - [GET /orders/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/orders/getorderbyid.md): Retrieve details of an order. ### Update RFI documents for an order - [PATCH /orders/{id}/update_rfi](https://docs.glomopay.com/api-documentation/apis/openapi/orders/updateorderrfi.md): Updates the RFI (Request for Information) document status for an order. This endpoint is used to submit required documents when an order is in 'action_required' status due to sanction screening. ## Customer This resource represents a customer of your business. The customer can be an individual or a business from whom you will receive payments. ### Create a new customer - [POST /customer](https://docs.glomopay.com/api-documentation/apis/openapi/customer/createcustomer.md): Creates a customer with basic information such as name, contact information, and address. To check complete list of API validations, click here. ### List all customers - [GET /customer](https://docs.glomopay.com/api-documentation/apis/openapi/customer/getcustomers.md): Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first. ### Retrieve a customer - [GET /customer/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/customer/getcustomerbyid.md): Retrieves details of a Customer. ## Document Document resource represents the documents details uploaded. This document is used in payin, payout, etc. ### Create a new document - [POST /document](https://docs.glomopay.com/api-documentation/apis/openapi/document/createdocument.md) ### List all documents - [GET /document](https://docs.glomopay.com/api-documentation/apis/openapi/document/getdocuments.md): Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first. ## Payment This resource represents a payment attempt made by your customer. The payment can either be successfully completed or failed, depending on various factors. ### List all payments - [GET /payment](https://docs.glomopay.com/api-documentation/apis/openapi/payment/getpayments.md) ### Create a mock payment - [POST /payment/mock](https://docs.glomopay.com/api-documentation/apis/openapi/payment/createmockpayment.md): This API is only available in sandbox mode. Creates a mock payment of specified amount for any given Payment link. ### Retrieve a payment - [GET /payment/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/payment/getpaymentbyid.md) ### Update RFI for Payment - [PATCH /payment/{id}/update_rfi](https://docs.glomopay.com/api-documentation/apis/openapi/payment/updaterfipayment.md) ### Mock funds available - [PATCH /payment/{id}/mock-funds-available](https://docs.glomopay.com/api-documentation/apis/openapi/payment/mockupdatepaymentfundsavailable.md): This API is only available in sandbox mode. Updates the funds_available status of a payment to simulate the availability of funds for testing purposes. ## 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. ### Create refund for a payment - [POST /refunds](https://docs.glomopay.com/api-documentation/apis/openapi/refund/createrefund.md): Creates refund for a payment entity if the payment is in success state and no other refund exists. ### List all refunds - [GET /refunds](https://docs.glomopay.com/api-documentation/apis/openapi/refund/getrefunds.md): Returns a list of refunds in response. The refunds are returned sorted by creation date, with the most recent refund appearing first. ### Retrieve a refund - [GET /refunds/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/refund/getrefundbyid.md) ### Update RFI for Refund - [PATCH /refunds/{id}/update_rfi](https://docs.glomopay.com/api-documentation/apis/openapi/refund/updaterfirefund.md) ### Mock update a refund - [PATCH /refunds/{id}/mock_update_status](https://docs.glomopay.com/api-documentation/apis/openapi/refund/mockupdaterefund.md): Mark an in_progress refund as successful ## Price This resource represents the pricing details of the payin or payout. The pricing details include the fees and the pricing type ### Create a new price - [POST /prices](https://docs.glomopay.com/api-documentation/apis/openapi/price/createprice.md) ### List all prices - [GET /prices](https://docs.glomopay.com/api-documentation/apis/openapi/price/getprices.md) ### Retrieve a price - [GET /prices/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/price/getpricebyid.md) ## 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. ### List subscriptions - [GET /subscriptions](https://docs.glomopay.com/api-documentation/apis/openapi/subscription/getsubscriptions.md): Returns a list of subscriptions matching some criteria. The subscriptions are returned sorted by creation date, with the most recent subscriptions appearing first. ### Create a new subscription - [POST /subscriptions](https://docs.glomopay.com/api-documentation/apis/openapi/subscription/createsubscription.md): Creates a new subscription for a customer with specified billing plan and schedule. The subscription will be created in 'created' status and will be activated when the customer completes the first payment. ### Retrieve a subscription by ID - [GET /subscriptions/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/subscription/getsubscriptionbyid.md): Retrieves the details of a specific subscription by its unique identifier. ### Pause a subscription - [PATCH /subscriptions/{id}/pause](https://docs.glomopay.com/api-documentation/apis/openapi/subscription/pausesubscription.md): Pauses an active subscription. While paused, the subscription will not process any payments. A paused subscription can be resumed later using the resume endpoint. ### Resume a paused subscription - [PATCH /subscriptions/{id}/resume](https://docs.glomopay.com/api-documentation/apis/openapi/subscription/resumesubscription.md): Resumes a paused subscription. Once resumed, the subscription will continue processing payments according to its original schedule. Only subscriptions in 'paused' status can be resumed. ### Cancel a subscription - [PATCH /subscriptions/{id}/cancel](https://docs.glomopay.com/api-documentation/apis/openapi/subscription/cancelsubscription.md): Cancels a subscription. Once cancelled, the subscription will stop processing future payments. This action cannot be undone, but you can create a new subscription if needed. ## Payout This resource represents the disbursement transactions from your Glomo account to your beneficiaries. ### Create a new payout - [POST /payouts](https://docs.glomopay.com/api-documentation/apis/openapi/payout/createpayout.md) ### List all payouts - [GET /payouts](https://docs.glomopay.com/api-documentation/apis/openapi/payout/getpayouts.md) ### Retrieve a payout - [GET /payouts/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/payout/getpayoutbyid.md) ### Cancel a payout - [PATCH /payouts/{id}/cancel](https://docs.glomopay.com/api-documentation/apis/openapi/payout/cancelpayout.md) ### Update RFI for Payout - [PATCH /payouts/{id}/update_rfi](https://docs.glomopay.com/api-documentation/apis/openapi/payout/updaterfipayout.md) ### Mock update a payout status - [PATCH /payouts/mock](https://docs.glomopay.com/api-documentation/apis/openapi/payout/mockupdatepayoutstatus.md) ## 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. ### Create a Beneficiary - [POST /beneficiaries](https://docs.glomopay.com/api-documentation/apis/openapi/beneficiary/createbeneficiary.md): Creates a beneficiary with information such as name, contact, address, and banking information. ### List all Beneficiaries - [GET /beneficiaries](https://docs.glomopay.com/api-documentation/apis/openapi/beneficiary/getbeneficiaries.md): Returns a list of your beneficiaries. The beneficiaries are returned sorted by creation date, with the most recent beneficiary appearing first. ### Retrieve a beneficiary - [GET /beneficiaries/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/beneficiary/getbeneficiarybyid.md): Retrieves details of a beneficiary. ## Bank Account Validation Bank Account Validation resource represents the validation details of a bank account. ### Validate any bank account - [POST /bank_account_validation](https://docs.glomopay.com/api-documentation/apis/openapi/bank_account_validation/validatebankaccount.md) ### List all bank account validations - [GET /bank_account_validation](https://docs.glomopay.com/api-documentation/apis/openapi/bank_account_validation/getbankaccountvalidations.md) ## 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 Type | Description | | ------------------------------ | ------------------------------------------------------------------------------ | | **P → C** | From a **Platform** (P) account to one of its **Child** (C) merchant accounts. | | **C → P** | From a **Child** (C) merchant account back to its **Platform** (P) account. | | **C → C (same P)** | Between **Child** (C) accounts under the same **Platform** (P). | ### Create an internal transfer - [POST /internal-transfer](https://docs.glomopay.com/api-documentation/apis/openapi/internal_transfer/createinternaltransfer.md): Creates an internal transfer between two merchant accounts. ## Withdrawal **[DEPRECATED]** This resource represents the withdrawal transaction from your Glomo account to your withdrawal account. ### Create a new withdrawal - [POST /withdrawals](https://docs.glomopay.com/api-documentation/apis/openapi/withdrawal/createwithdrawal.md) ### List all withdrawals - [GET /withdrawals](https://docs.glomopay.com/api-documentation/apis/openapi/withdrawal/getwithdrawals.md) ## Withdrawal Account This resource represents the withdrawal account details. The withdrawal account is the bank account where the withdrawal amount will be credited. ### List all Withdrawal Accounts - [GET /withdrawal_accounts](https://docs.glomopay.com/api-documentation/apis/openapi/withdrawal_account/getwithdrawalaccounts.md): Returns a list of your Withdrawal accounts. The accounts are returned sorted by creation date, with the most recently created account appearing first. ### Retrieve Withdrawal Account - [GET /withdrawal_accounts/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/withdrawal_account/getwithdrawalaccountbyid.md): Returns the respective Withdrawal account. ## Settlement This resource represents the settlement details. The settlement is the process of transferring funds from your Glomo account to your bank account. ### Create a new settlement - [POST /settlements](https://docs.glomopay.com/api-documentation/apis/openapi/settlement/createsettlement.md) ### List all settlements - [GET /settlements](https://docs.glomopay.com/api-documentation/apis/openapi/settlement/getsettlements.md): Returns a list of your settlements. The settlements are returned sorted by creation date, with the most recent settlement appearing first. ### Retrieve a settlement - [GET /settlements/{id}](https://docs.glomopay.com/api-documentation/apis/openapi/settlement/getsettlementbyid.md): Returns a specific settlement by its unique identifier. ### Retrieve transactions linked to a settlement - [GET /settlements/{id}/transactions](https://docs.glomopay.com/api-documentation/apis/openapi/settlement/gettransactionslinkedtosettlement.md): Returns a list of transactions that are linked to a specific settlement by its unique identifier. ## 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. ### Create a Virtual Account - [POST /virtual-accounts](https://docs.glomopay.com/api-documentation/apis/openapi/virtual_account/createvirtualaccount.md): Creates a new virtual account with the specified payment type and currency. Virtual accounts provide unique account numbers that can be used to receive payments for customers. ### List all Virtual Accounts - [GET /virtual-accounts](https://docs.glomopay.com/api-documentation/apis/openapi/virtual_account/getvirtualaccounts.md): Returns the customer's virtual accounts, sorted by creation date (newest first), using the customer's JWT token for access. ## Platform This resource provides platform functionality that enables platforms to onboard merchants onto Glomo, with each merchant having their own dedicated Virtual Accounts (VA). ### Onboard a merchant - [POST /platform/merchants](https://docs.glomopay.com/api-documentation/apis/openapi/platform/onboardmerchant.md): Allows platforms to onboard a new merchant onto Glomo. ### Retrieve a merchant - [GET /platform/merchants/{merchant_id}](https://docs.glomopay.com/api-documentation/apis/openapi/platform/getmerchant.md): Retrieves details of a specific merchant by their merchant ID.