Cancel a payment link

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

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.

Operations

Update an existing payment link

Request

Security

JWT

Path

idstringrequired

The unique identifier of the payment link to update.

Example: e092be15-e614-4401-8cea-7ca3df7da987

Bodyapplication/jsonrequired

reminder_frequencynumber

The frequency at which you want to remind customers, valid values are 1 (remind every day), 2 (remind every alternate day), 7 (remind every week), 14 (remind every alternate week).

Example: 1

expires_atstring(timestamp)

The new expiry date for the payin. Expiry cannot be less than or equal to the current date and can be up to 6 months in the future.

Example: "2025-02-15T00:00:00.000Z"

curl -i -X PATCH \
  https://api.glomopay.com/api/v1/payin/e092be15-e614-4401-8cea-7ca3df7da987 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reminder_frequency": 1,
    "expires_at": "2025-02-15T00:00:00.000Z"
  }'

Responses

Payment link updated successfully

Bodyapplication/json

idstring(string)read-only

The unique identifier for the payment link.

Example: "payin_678a4c88hpAjf"

customer_idstring

The unique identifier of customer linked to payment_link.

Example: "cust_E602dMzgjpDC"

document_idstring

The unique identifier of document linked to payment_link. This document entity should contain the required documents to process incoming payments. Refer this Document entity for more details.

Example: "doc_nYUqLpuYQ0M8"

statusstringread-only

The status of the payment_link.

Enum"active""paid""failed""action_required""cancelled""partially_paid""under_review""expired"

Example: "success"

currencystring(iso-4217)

The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.

Example: "USD"

amountnumber>= 1

The amount you want to receive, a positive integer representing the smallest currency unit. For example, if the amount is $299.00, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.

Example: 1000

purpose_codestring

Purpose code for why you want to receive this payment

Example: "P1401"

invoice_numberstring

Number/Id of the invoice submitted with payment_link.

Example: "RG12FF590"

invoice_descriptionstring

Description about the invoice submitted with payment_link

Example: "Payment requested for services provided"

expires_atstring(timestamp)

Date when the payment_link will expire. Expiry can not be less than or equal to current date and can be upto 6 months in future.

Example: "2025-02-15T00:00:00.000Z"

last_reminder_sent_atstring(timestamp)read-only

Last time when the customer was reminded to complete the payment by visiting the link

Example: "2024-09-13T06:32:34.340Z"

invoice_amountnumber

The amount in cents for which invoice was generated. It can be more than the amount requested in this payment_link

Example: 1000

payment_linkstringread-only

Sharable link which should be shared with customer you want to receive money from. This link gets generated only after the payin has been reviewed and moved to in_progress

Example: "https://staging-api.glomopay-eng.com/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0"

reminder_frequencynumber

The frequency at which you want to remind customers, valid values are 1(remind everyday), 2(remind every alternate day), 7(remind every week), 14(remind every alternate week).

Example: 7

price_idstring

The price_id of the price to be used for the payment link. Note: If you are a platform user then price_id is a required field.

Example: "price_E602dMzgjpDC"

productobject(Product)

Details of the product that the payment is related to.

created_atstring(timestamp)read-only

Timestamp representing when the payment_link was created

Example: "2021-06-01T12:00:00Z"

updated_atstring(timestamp)read-only

Timestamp representing when the payment_link was last updated

Example: "2021-06-01T12:00:00Z"

Response

application/json

{
  "id": "payin_678a4c88hpAjf",
  "customer_id": "cust_E602dMzgjpDC",
  "document_id": "doc_nYUqLpuYQ0M8",
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "purpose_code": "P1401",
  "invoice_number": "RG12FF590",
  "invoice_description": "Payment requested for services provided",
  "expires_at": "2025-02-15T00:00:00.000Z",
  "last_reminder_sent_at": "2024-09-13T06:32:34.340Z",
  "invoice_amount": 1000,
  "payment_link": "https://staging-api.glomopay-eng.com/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0",
  "reminder_frequency": 7,
  "price_id": "price_E602dMzgjpDC",
  "product": {
    "name": "ShieldGuard Insurance",
    "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage"
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

Cancel a payment link

Request

Invalidate payment link and prevent further transactions

Security

JWT

Path

idstringrequired

The ID of the payment link to cancel

Example: e092be15-e614-4401-8cea-7ca3df7da987

curl -i -X PATCH \
  https://api.glomopay.com/api/v1/payin/e092be15-e614-4401-8cea-7ca3df7da987/cancel \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Payment link canceled successfully

Bodyapplication/json

idstring(string)read-only

The unique identifier for the payment link.

Example: "payin_678a4c88hpAjf"

customer_idstring

The unique identifier of customer linked to payment_link.

Example: "cust_E602dMzgjpDC"

document_idstring

The unique identifier of document linked to payment_link. This document entity should contain the required documents to process incoming payments. Refer this Document entity for more details.

Example: "doc_nYUqLpuYQ0M8"

statusstringread-only

The status of the payment_link.

Enum"active""paid""failed""action_required""cancelled""partially_paid""under_review""expired"

Example: "success"

currencystring(iso-4217)

The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.

Example: "USD"

amountnumber>= 1

The amount you want to receive, a positive integer representing the smallest currency unit. For example, if the amount is $299.00, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.

Example: 1000

purpose_codestring

Purpose code for why you want to receive this payment

Example: "P1401"

invoice_numberstring

Number/Id of the invoice submitted with payment_link.

Example: "RG12FF590"

invoice_descriptionstring

Description about the invoice submitted with payment_link

Example: "Payment requested for services provided"

expires_atstring(timestamp)

Date when the payment_link will expire. Expiry can not be less than or equal to current date and can be upto 6 months in future.

Example: "2025-02-15T00:00:00.000Z"

last_reminder_sent_atstring(timestamp)read-only

Last time when the customer was reminded to complete the payment by visiting the link

Example: "2024-09-13T06:32:34.340Z"

invoice_amountnumber

The amount in cents for which invoice was generated. It can be more than the amount requested in this payment_link

Example: 1000

payment_linkstringread-only

Sharable link which should be shared with customer you want to receive money from. This link gets generated only after the payin has been reviewed and moved to in_progress

Example: "https://staging-api.glomopay-eng.com/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0"

reminder_frequencynumber

The frequency at which you want to remind customers, valid values are 1(remind everyday), 2(remind every alternate day), 7(remind every week), 14(remind every alternate week).

Example: 7

price_idstring

The price_id of the price to be used for the payment link. Note: If you are a platform user then price_id is a required field.

Example: "price_E602dMzgjpDC"

productobject(Product)

Details of the product that the payment is related to.

created_atstring(timestamp)read-only

Timestamp representing when the payment_link was created

Example: "2021-06-01T12:00:00Z"

updated_atstring(timestamp)read-only

Timestamp representing when the payment_link was last updated

Example: "2021-06-01T12:00:00Z"

Response

application/json

{
  "id": "payin_678a4c88hpAjf",
  "customer_id": "cust_E602dMzgjpDC",
  "document_id": "doc_nYUqLpuYQ0M8",
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "purpose_code": "P1401",
  "invoice_number": "RG12FF590",
  "invoice_description": "Payment requested for services provided",
  "expires_at": "2025-02-15T00:00:00.000Z",
  "last_reminder_sent_at": "2024-09-13T06:32:34.340Z",
  "invoice_amount": 1000,
  "payment_link": "https://staging-api.glomopay-eng.com/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0",
  "reminder_frequency": 7,
  "price_id": "price_E602dMzgjpDC",
  "product": {
    "name": "ShieldGuard Insurance",
    "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage"
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

Mock review a payment link

Request

Mark an under_review payment link reviewed

Security

JWT

Path

idstringrequired

The ID of the payment link to review

Example: payin_E602dMzgjpDC

curl -i -X PATCH \
  https://api.glomopay.com/api/v1/payin/payin_E602dMzgjpDC/mock_mark_reviewed \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Payment link successfully marked reviewed

Bodyapplication/json

idstring(string)read-only

The unique identifier for the payment link.

Example: "payin_678a4c88hpAjf"

customer_idstring

The unique identifier of customer linked to payment_link.

Example: "cust_E602dMzgjpDC"

document_idstring

The unique identifier of document linked to payment_link. This document entity should contain the required documents to process incoming payments. Refer this Document entity for more details.

Example: "doc_nYUqLpuYQ0M8"

statusstringread-only

The status of the payment_link.

Enum"active""paid""failed""action_required""cancelled""partially_paid""under_review""expired"

Example: "success"

currencystring(iso-4217)

The currency code in ISO 4217 format. Supported currencies: USD,EUR and GBP.

Example: "USD"

amountnumber>= 1

The amount you want to receive, a positive integer representing the smallest currency unit. For example, if the amount is $299.00, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.

Example: 1000

purpose_codestring

Purpose code for why you want to receive this payment

Example: "P1401"

invoice_numberstring

Number/Id of the invoice submitted with payment_link.

Example: "RG12FF590"

invoice_descriptionstring

Description about the invoice submitted with payment_link

Example: "Payment requested for services provided"

expires_atstring(timestamp)

Date when the payment_link will expire. Expiry can not be less than or equal to current date and can be upto 6 months in future.

Example: "2025-02-15T00:00:00.000Z"

last_reminder_sent_atstring(timestamp)read-only

Last time when the customer was reminded to complete the payment by visiting the link

Example: "2024-09-13T06:32:34.340Z"

invoice_amountnumber

The amount in cents for which invoice was generated. It can be more than the amount requested in this payment_link

Example: 1000

payment_linkstringread-only

Sharable link which should be shared with customer you want to receive money from. This link gets generated only after the payin has been reviewed and moved to in_progress

Example: "https://staging-api.glomopay-eng.com/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0"

reminder_frequencynumber

The frequency at which you want to remind customers, valid values are 1(remind everyday), 2(remind every alternate day), 7(remind every week), 14(remind every alternate week).

Example: 7

price_idstring

The price_id of the price to be used for the payment link. Note: If you are a platform user then price_id is a required field.

Example: "price_E602dMzgjpDC"

productobject(Product)

Details of the product that the payment is related to.

created_atstring(timestamp)read-only

Timestamp representing when the payment_link was created

Example: "2021-06-01T12:00:00Z"

updated_atstring(timestamp)read-only

Timestamp representing when the payment_link was last updated

Example: "2021-06-01T12:00:00Z"

Response

application/json

{
  "id": "payin_678a4c88hpAjf",
  "customer_id": "cust_E602dMzgjpDC",
  "document_id": "doc_nYUqLpuYQ0M8",
  "status": "success",
  "currency": "USD",
  "amount": 1000,
  "purpose_code": "P1401",
  "invoice_number": "RG12FF590",
  "invoice_description": "Payment requested for services provided",
  "expires_at": "2025-02-15T00:00:00.000Z",
  "last_reminder_sent_at": "2024-09-13T06:32:34.340Z",
  "invoice_amount": 1000,
  "payment_link": "https://staging-api.glomopay-eng.com/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0",
  "reminder_frequency": 7,
  "price_id": "price_E602dMzgjpDC",
  "product": {
    "name": "ShieldGuard Insurance",
    "description": "Flexible insurance for belongings, travel, and digital assets; easy to manage"
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

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

API specification for Glomo (1.0.0)

Balance

Balance Conversions

Payment Link

Update an existing payment link

Request

Responses

Was this helpful?

Cancel a payment link

Request

Responses

Was this helpful?

Mock review a payment link

Request

Responses

Was this helpful?

Orders

Customer

Document

Payment

Refund

Price

Subscription

Payout

Beneficiary

Bank Account Validation

Withdrawal

Withdrawal Account

Settlement