---
title: "Retrieve a PayID"
method: GET
path: "/pay_ids/{id}"
tags: ["PayIDs"]
---

# Retrieve a PayID

`GET /pay_ids/{id}`

## Request

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

Retrieve the details of a specific _PayID_ using the unique id parameter `id`. Only one _PayID_ record is returned.

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

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