---
title: "resolve"
method: POST
path: "/payto/alias_resolution"
tags: ["Alias Resolution"]
---

# resolve

`POST /payto/alias_resolution`

This endpoint is used to resolve an alias to a display name. It is possible for this endpoint to return a 503 service unavailable error if the addressing service is not available.

## Request body

- union
  - object
    - `type` 'alias_phone' | 'alias_email' | 'alias_abn' | 'alias_organisation_identifier', required
    - `value` string, required — A PayID phone alias. e.g. +61-411222333
    - `requester` object, required — Details of the end-user requesting this resolution.
      - `id` string, required — Integrator's unique identifier for the end-user requesting this resolution. Maximum 64 characters containing only unreserved characters as defined in RFC3986.
      - `remote_ip` union, required — IP address of the end-user requesting this resolution. (IPv4 or IPv6)
        - string, ipv4
        - string, ipv6
    - `sandbox` object — SANDBOX ONLY: Parameter that allows you to simulate certain alias lookup scenarios to aid integrators while testing their control flows.
      - `simulate` 'alias_found' | 'alias_not_found' | 'service_unavailable', required
      - `display_name` string — Display name to be returned when simulating an `alias_found` response. Will be ignored for other simulations. Defaults to `Sandbox User`.
  - object
    - `type` 'alias_phone' | 'alias_email' | 'alias_abn' | 'alias_organisation_identifier', required
    - `value` string, required — A PayID email alias
    - `requester` object, required — Details of the end-user requesting this resolution.
      - `id` string, required — Integrator's unique identifier for the end-user requesting this resolution. Maximum 64 characters containing only unreserved characters as defined in RFC3986.
      - `remote_ip` union, required — IP address of the end-user requesting this resolution. (IPv4 or IPv6)
        - string, ipv4
        - string, ipv6
    - `sandbox` object — SANDBOX ONLY: Parameter that allows you to simulate certain alias lookup scenarios to aid integrators while testing their control flows.
      - `simulate` 'alias_found' | 'alias_not_found' | 'service_unavailable', required
      - `display_name` string — Display name to be returned when simulating an `alias_found` response. Will be ignored for other simulations. Defaults to `Sandbox User`.
  - object
    - `type` 'alias_phone' | 'alias_email' | 'alias_abn' | 'alias_organisation_identifier', required
    - `value` string, required — A PayID ABN alias
    - `requester` object, required — Details of the end-user requesting this resolution.
      - `id` string, required — Integrator's unique identifier for the end-user requesting this resolution. Maximum 64 characters containing only unreserved characters as defined in RFC3986.
      - `remote_ip` union, required — IP address of the end-user requesting this resolution. (IPv4 or IPv6)
        - string, ipv4
        - string, ipv6
    - `sandbox` object — SANDBOX ONLY: Parameter that allows you to simulate certain alias lookup scenarios to aid integrators while testing their control flows.
      - `simulate` 'alias_found' | 'alias_not_found' | 'service_unavailable', required
      - `display_name` string — Display name to be returned when simulating an `alias_found` response. Will be ignored for other simulations. Defaults to `Sandbox User`.
  - object
    - `type` 'alias_phone' | 'alias_email' | 'alias_abn' | 'alias_organisation_identifier', required
    - `value` string, required — A PayID organisation identifier alias
    - `requester` object, required — Details of the end-user requesting this resolution.
      - `id` string, required — Integrator's unique identifier for the end-user requesting this resolution. Maximum 64 characters containing only unreserved characters as defined in RFC3986.
      - `remote_ip` union, required — IP address of the end-user requesting this resolution. (IPv4 or IPv6)
        - string, ipv4
        - string, ipv6
    - `sandbox` object — SANDBOX ONLY: Parameter that allows you to simulate certain alias lookup scenarios to aid integrators while testing their control flows.
      - `simulate` 'alias_found' | 'alias_not_found' | 'service_unavailable', required
      - `display_name` string — Display name to be returned when simulating an `alias_found` response. Will be ignored for other simulations. Defaults to `Sandbox User`.

## Response `200`

successful

- object
  - `data` PaytoAliasResolution, required
    - `display_name` string, required — The display name associated with the alias.

## Other responses

- `400` — Bad Request
- `401` — unauthorized
- `403` — forbidden
- `404` — not found
- `422` — Unprocessable Entity
- `500` — Internal Server Error
- `503` — service unavailable

---

[API](https://skmtc.net/zeptopayments/apis/zepto-api.md) · [All operations](https://skmtc.net/zeptopayments/apis/zepto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeptopayments/zepto-api/revisions/6353e9b9af6f/schema)