---
title: "Register PayID"
method: POST
path: "/virtual_accounts/{id}/pay_ids"
tags: ["PayIDs"]
---

# Register PayID

`POST /virtual_accounts/{id}/pay_ids`

## Request

- Base URL: `https://sandbox.au-0000.api.assemblypay.com`
- URL: `https://sandbox.au-0000.api.assemblypay.com/virtual_accounts/{id}/pay_ids`
- Auth: none declared

Register a _PayID_ for a given _Virtual Account_.

## Path parameters

- `id` string, uuid, required

## Request body

- PayIdRequest
  - `pay_id` string, email, required: The PayID that is being registered.
  - `type` 'EMAIL', required: The type of PayID being registered.
  - `details` object, required
    - `pay_id_name` string: Name that can be used to identify the entity registering the PayID.
    - `owner_legal_name` string: The full legal account name.

## Response `202`

Accepted

- PayId
  - `id` string, uuid
  - `pay_id` string, email
  - `type` 'EMAIL'
  - `status` 'active' | 'activation_failed' | 'pending_activation' | 'deregistered'
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `details` object
    - `pay_id_name` string
    - `owner_legal_name` string
  - `links` object
    - `self` string
    - `virtual_accounts` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/hellozai/apis/virtual-accounts-and-payids.md) - [All operations](https://skmtc.dev/hellozai/apis/virtual-accounts-and-payids/llms.txt) - [OpenAPI document](https://skmtc.dev/hellozai/apis/virtual-accounts-and-payids/revisions/2c9e638dc4f4?raw)