> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取别名详情

请在付款前检查付款别名是否已激活，并查看隐藏的付款人详细信息。目前仅限哥伦比亚地区使用。

有关完整的响应字段参考、掩码规则、错误处理指南和交互式演示，请参阅[验证付款别名](https://docs.localpayment.com/zh/docs/verify-a-payout-alias.md)。


## OpenAPI

````yaml openapi/zh/localpayment.json POST /api/payment/alias-detail
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/payment/alias-detail:
    post:
      summary: 获取别名详情
      operationId: get-alias-detail
      parameters:
        - name: Authorization
          in: header
          description: >-
            用于身份验证的 Bearer
            访问令牌。该令牌可从[获取访问令牌](/zh/reference/get-token)或[刷新访问令牌](/zh/reference/refresh-token)endpoint
            获取。
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                countryISOCode:
                  type: string
                  description: >-
                    别名所在国家/地区，采用 ISO 3166-1 alpha-2 格式（而非 alpha-3，这与其他大多数本地支付
                    endpoint 不同）。目前仅 `CO` （哥伦比亚）获得支持。
                  enum:
                    - CO
                aliasClassification:
                  type: string
                  description: 别名分类。目前仅 `Breb` 支持（哥伦比亚的 Bre-B 即时支付系统）。
                  enum:
                    - Breb
                aliasValue:
                  type: string
                  description: 要验证的别名（电话号码、文档、电子邮件、商户代码或字母数字密钥）。
              required:
                - countryISOCode
                - aliasClassification
                - aliasValue
              x-examples:
                Example 1:
                  countryISOCode: CO
                  aliasClassification: Breb
                  aliasValue: '3668933567'
            examples:
              Example 1:
                value:
                  countryISOCode: CO
                  aliasClassification: Breb
                  aliasValue: '3668933567'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  firstName:
                    type: string
                    description: 别名所有者的注册名字。
                  lastName:
                    type: string
                    description: 别名所有者的注册姓氏。已屏蔽：显示前两个字母，其余字母替换为星号（`Doe` 变成 `Do**`）。
                  status:
                    type: string
                    description: 别名的当前状态。
                    examples:
                      - ACTIVE
                  idType:
                    type: string
                    description: >-
                      所有者身份证明文件的类型。请参阅[支持的证件类型](/zh/docs/colombia#supported-document-types)。
                  idValue:
                    type: string
                    description: >-
                      所有者的身份证件号码。已做掩码处理：仅显示最后 4 位数字，其余替换为星号（`20304050` 变为
                      `****4050`）。
                  aliasType:
                    type: string
                    description: >-
                      已解析别名的分类（身份证明文件、商户代码、手机号码、电子邮件地址或字母数字密钥）。已确认的有效值以大写字母表示，例如：
                      `PHONE` ；其他各类别的具体字符串尚未确定。
                  aliasValue:
                    type: string
                    description: 您查询的别名已完整返回。
                  bankName:
                    type: string
                    description: 别名注册银行的名称。
                x-examples:
                  Example 1:
                    aliasType: PHONE
                    aliasValue: '3668933567'
                    bankName: KAMIN S.A
                    firstName: John
                    idType: CC
                    idValue: '******0695'
                    lastName: Do**
                    status: ACTIVE
              examples:
                200 - Phone alias resolved.:
                  value:
                    aliasType: PHONE
                    aliasValue: '3668933567'
                    bankName: KAMIN S.A
                    firstName: John
                    idType: CC
                    idValue: '******0695'
                    lastName: Do**
                    status: ACTIVE
        '400':
          description: 错误请求。该别名无法解析到已注册的所有者，或已失效。
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: 易于理解的错误信息。
                  errorCode:
                    type: string
                    description: 应用级错误代码。
              examples:
                400 - Alias not found or inactive.:
                  value:
                    error: 'DICE error: Keys not found or inactive'
                    errorCode: '408'
        '401':
          description: 未经授权。访问令牌缺失、无效或已过期。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 回复的补充信息。
                  code:
                    type: string
                    description: 状态码。
                  messages:
                    type: array
                    description: 消息列表。
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Token 类。
                        token_type:
                          type: string
                          description: 令牌类型。
                        message:
                          type: string
                          description: 包含补充信息的消息。
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
        '422':
          description: 无法处理的实体。不支持此国家/地区或分类组合。
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: 易于理解的错误信息。
              examples:
                422 - Service not available.:
                  value:
                    error: Service not available for Breb in COL
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.