> ## 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.

# Obter status da transação

Receba atualizações de status em tempo real de qualquer transação associada à sua conta Localpayment para acompanhar seu progresso atual.


## OpenAPI

````yaml openapi/pt-br/localpayment.json GET /api/transactions/{externalId}/status
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/transactions/{externalId}/status:
    get:
      summary: Obter status da transação
      operationId: get-transaction-status
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
        - name: externalId
          in: path
          description: >-
            ID gerado internamente para rastreabilidade da transação. Deve ser
            único e aceita apenas caracteres alfanuméricos e hífens (UUID4, por
            exemplo). Você também pode recuperar o status de uma transação
            usando seu ID interno.
          required: true
          schema:
            type: string
            pattern: '[a-zA-Z0-9\- ]+'
            examples:
              - 53025bf4-4c87-4b4f-8fea-b47004440f37
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  internalId:
                    type: string
                    description: Identificador de transação da Localpayment.
                  externalId:
                    type: string
                    description: >-
                      Um identificador único gerado pelo seu sistema para
                      rastrear a transação (alfanumérico e com hífens).
                      Recomendamos o uso do UUID4 para garantir a unicidade.
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                required:
                  - internalId
                  - externalId
                x-examples:
                  Example 1:
                    internalId: c948f6de-3082-4e64-bd30-916799cc56ea
                    externalId: '123456'
                    status:
                      code: '200'
                      description: COMPLETED
                      detail: INTERNAL TRANSFER
              examples:
                200 - COMPLETED:
                  value:
                    internalId: c948f6de-3082-4e64-bd30-916799cc56ea
                    externalId: '123456'
                    status:
                      code: '200'
                      description: COMPLETED
                      detail: INTERNAL TRANSFER
                716 - REJECTED:
                  value:
                    internalId: 383a29f4-5ed2-4596-89d6-f383923a1433
                    externalId: tw-000001
                    status:
                      code: '716'
                      description: REJECTED
                      detail: TransactionNotSupported
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                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
        '404':
          description: Não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
              examples:
                404 - Transaction not found:
                  value:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Transaction not found
      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.