---
title: PayID
slug: payid
createdAt: 2024-07-24T00:47:43.293Z
---

::Image[]{src="https://api.archbee.com/api/optimize/2YV_jPVRvgDF5hYZgYUKg-_kFG_PvcaKxo9vUwF8UDd-20250107-051651.png" darkSrc="https://archbee-image-uploads.s3.amazonaws.com/2YV_jPVRvgDF5hYZgYUKg-akc3pbg9iAXe6DjKds2Pv-20250107-051718.png" size="30" width="2267" height="1071" darkWidth="2267" darkHeight="1071" position="center" showCaption="false"}

A PayID is an alias for a bank account number, designed to simplify payments and enable confirmation of the person you're paying. 

We issue PayIDs linked to our Virtual Account Numbers, offering your users an easier way to send you money. Once a PayID is registered with a Virtual Account Number or Ledger Account, any payment made to that PayID will be deposited into your mAccount or Ledger Account. Currently, only email-based PayIDs are supported through the API. 

![](https://api.archbee.com/api/optimize/2YV_jPVRvgDF5hYZgYUKg-SNBXkd17cKGKgaJ8LqReM-20250110-033157.png)

## Registering PayIDs

The [Register PayID](docId\:h6TmcvMrqObJHIVzPSTNy) endpoint enables the registration of a PayID linked to a Virtual Account Number. Before registering a PayID, you must first create either a Virtual Account Number or a Ledger Account. We recommend waiting up to 10 minutes after account creation to ensure the account is fully registered with the NPP.

When a customer pays to your PayID, the `payIdName` passed when registering the PayID will be displayed in their online banking.

When registering a PayID, you have the option to provide an email address in the `payId` parameter for a custom PayID name. If no email is provided, a numeric PayID will be automatically generated on the **monoova.me** domain, such as 12345\@monoova.me.

Currently, Monoova PayIDs can only be email addresses.

## Configuring your PayID domain

By default, PayIDs use the **monoova.me** domain, however we can configure PayIDs to use your own domain. Speak to your Monoova Client Success representative to request setup of your domain. Once configured, you can pass an email with your domain in the `payId` parameter when registering a new PayID.

## Maintaining PayIDs

PayIDs can be disabled, deregistered or transferred to a new account through the [Update a PayID's Status](docId:-KdFRTA7JnYgjFZf8V5zd) endpoint. You can also [Update a PayID's Name](docId\:oWZv0_HsyCW9bt-Wj3eMa) if needed.