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

# Verificar assinatura



## OpenAPI

````yaml openapi/pt-br/localpayment.json GET /api/subscriptions/{externalId}
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/subscriptions/{externalId}:
    get:
      summary: Verificar assinatura
      operationId: get-api-subscriptions-externalID
      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 da assinatura.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  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.
                  subscriptionId:
                    type: string
                    description: >-
                      O ID foi atribuído no momento em que a assinatura foi
                      criada.
                  status:
                    type: object
                    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.
                  totalPayments:
                    type: integer
                    description: Número total de pagamentos efetuados.
                  pendingPayments:
                    type: integer
                    description: Número de pagamentos que ainda não foram recebidos.
                  creationDate:
                    type: string
                    description: Data em que a assinatura foi criada.
                  nextPaymentDate:
                    type: string
                    description: Data do próximo pagamento.
                  request:
                    type: object
                    properties:
                      payer:
                        type: object
                        description: "Informações do pagador.\r\n\r\n"
                        properties:
                          type:
                            type: string
                            enum:
                              - COMPANY
                              - INDIVIDUAL
                            description: Tipo do pagador.
                          name:
                            type: string
                            description: "Nome do pagador.\r\n\r\n"
                          lastname:
                            type: string
                            description: "Sobrenome do pagador.\r\n\r\n"
                          email:
                            type: string
                            description: "E-mail do pagador.\r\n\r\n"
                          phone:
                            type: object
                            description: "Número de telefone do pagador.\r\n\r\n"
                            properties:
                              number:
                                type: string
                                description: "Código do país do telefone.\r\n\r\n"
                              areaCode:
                                type: string
                                description: "Código de área do país do telefone.\r\n\r\n"
                              countryCode:
                                type: string
                                description: "Número de telefone.\r\n\r\n"
                          address:
                            type: object
                            description: "Endereço do pagador.\r\n\r\n"
                            properties:
                              street:
                                type: string
                                description: Nome da rua.
                                examples:
                                  - Independencia
                              number:
                                type: string
                                description: Número da rua.
                                examples:
                                  - '123'
                              city:
                                type: string
                                description: Cidade
                                examples:
                                  - Cordoba
                              state:
                                type: string
                                description: Estado.
                                examples:
                                  - Cordoba
                              country:
                                type: string
                                description: País do endereço.
                                examples:
                                  - Argentina
                              zipCode:
                                type: string
                                description: "CEP.\r\n\r\n"
                                examples:
                                  - X5000IUO
                              comment:
                                type: string
                                description: Informações adicionais sobre o endereço.
                                examples:
                                  - Sucursal 123
                          document:
                            type: object
                            description: "Informações do documento de identidade.\r\n\r\n"
                            properties:
                              id:
                                type: string
                                description: >-
                                  O tipo de [documento de
                                  identidade](/pt-br/reference/identity-document-types),
                                  como Número de Identidade Nacional, Número de
                                  Seguro Social ou Carteira de Motorista,
                                  dependendo do país de emissão.
                              type:
                                type: string
                                description: >-
                                  Número do documento de identidade (geralmente
                                  um número). Este número deve ser válido de
                                  acordo com as regras para o tipo específico de
                                  documento.
                          birthdate:
                            type: string
                            description: "Data de nascimento do pagador no formato yyyy-mm-dd.\r\n\r\n"
                          nationality:
                            type: string
                            description: "Nacionalidade do pagador.\r\n\r\n"
                          userReference:
                            type: string
                            description: "Nome de usuário ou ID do pagador na sua plataforma.\r\n\r\n"
                        required:
                          - type
                      amount:
                        type: number
                        description: "Valor da transação.\r\n\r\n"
                      device:
                        type: object
                        properties:
                          id:
                            type: string
                            description: >-
                              Opcional. ID do dispositivo Android / iPhone. Pode
                              ficar em branco para outros tipos de dispositivo,
                              como PC / Mac.
                          ip:
                            type: string
                            description: "Endereço IP do dispositivo\r\n\r\n"
                          browser:
                            type: string
                            description: Navegador
                      comment:
                        type: string
                        description: "Informações adicionais\r\n\r\n"
                      country:
                        type: string
                        enum:
                          - COL
                          - MEX
                          - PER
                        description: >-
                          [País do documento](/pt-br/reference/country-codes).
                          ISO 3166-1 alfa-3.
                      currency:
                        type: string
                        enum:
                          - COP
                          - MXN
                          - PEN
                          - USD
                        description: '[Códigos de moeda](/pt-br/reference/currency-codes)'
                      metaData:
                        type: string
                        description: "Objeto não estruturado para registrar quaisquer metadados que sejam significativos para você.\r\n\r\n"
                      accountNumber:
                        type: string
                        description: Número da conta 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.\r\n\r\n"
                      beneficiary:
                        type: object
                        description: "Informações do beneficiário da conta.\r\n\r\n"
                        properties:
                          type:
                            type: string
                            enum:
                              - INDIVIDUAL
                              - COMPANY
                            description: "Tipo de beneficiário.\r\n\r\n"
                          name:
                            type: string
                            description: "Nome do beneficiário.\r\n\r\n"
                          email:
                            type: string
                            description: "E-mail do beneficiário.\r\n\r\n"
                          phone:
                            type: object
                            description: "Número de telefone do beneficiário.\r\n\r\n"
                            properties:
                              countryCode:
                                type: string
                                description: "Código do país do telefone.\r\n\r\n"
                              areaCode:
                                type: string
                                description: "Código de área do país do telefone.\r\n\r\n"
                              number:
                                type: string
                                description: "Número de telefone.\r\n\r\n\r\n"
                          address:
                            type: object
                            description: Endereço do beneficiário.
                            properties:
                              city:
                                type: string
                                description: Cidade
                              state:
                                type: string
                                description: Estado/Província
                              number:
                                type: string
                                description: " Número do endereço.\r\n\r\n"
                              street:
                                type: string
                                description: Rua do endereço.
                              country:
                                type: string
                                description: País
                              zipCode:
                                type: string
                                description: "CEP\r\n\r\n"
                              comment:
                                type: string
                                description: "Informações adicionais\r\n\r\n"
                          document:
                            type: object
                            description: >-
                              Informações do documento de identidade do
                              beneficiário.
                            properties:
                              id:
                                type: string
                                description: "O tipo de [documento de identidade](/pt-br/reference/identity-document-types), como Número de Identidade Nacional, Número de Seguro Social ou Carteira de Motorista, dependendo do país de emissão.\r\n\r\n"
                              type:
                                type: string
                                description: >-
                                  Número do documento de identidade (geralmente
                                  um número). Este número deve ser válido de
                                  acordo com as regras para o tipo específico de
                                  documento.
                          lastname:
                            type: string
                            description: "Sobrenome do beneficiário.\r\n\r\n"
                          merchant:
                            type: string
                            description: Nome comercial do beneficiário.
                          birthdate:
                            type: string
                            description: >-
                              Data de nascimento do beneficiário no formato
                              `yyyy-mm-dd`.
                          nationality:
                            type: string
                            description: Nacionalidade do beneficiário
                      conceptCode:
                        type: string
                        description: >-
                          Motivo do pagamento
                          ([código](/pt-br/reference/concept-codes)).
                      autoRecurring:
                        type: object
                        description: Propriedades da assinatura
                        properties:
                          nextPayment:
                            type: string
                            description: Data do próximo pagamento.
                          repetitions:
                            type: integer
                            description: "Quantas vezes este pagamento será cobrado. **Para recorrência sob demanda, envie o parâmetro com value=0**.\r\n\r\n"
                      paymentMethod:
                        type: object
                        properties:
                          type:
                            type: string
                            description: >-
                              Método de pagamento disponível na
                              [propriedade](/pt-br/reference/get-available-payment-methods)
                              `payinPaymentMethods.paymentMethodType`.
                          code:
                            type: string
                            description: >-
                              Método de pagamento disponível na
                              [propriedade](/pt-br/reference/get-available-payment-methods)
                              `payinPaymentMethods.paymentMethodType`.
                          flow:
                            type: string
                            description: >-
                              Define como os dados de pagamento são coletados:
                              `DIRECT` (dentro da requisição da API) ou
                              `REDIRECT` (formulário externo). Atualmente,
                              somente `DIRECT` é suportado.
                      commercialData:
                        type: object
                        properties:
                          items:
                            type: array
                            description: "Lista de itens vendidos.\r\n\r\n"
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  description: "ID do item.\r\n\r\n"
                                title:
                                  type: string
                                  description: "Título do item.\r\n\r\n"
                                quantity:
                                  type: string
                                  description: "ID do item.\r\n\r\n"
                                unitPrice:
                                  type: number
                                  description: "Preço unitário\r\n\r\n"
                                categoryId:
                                  type: string
                                  description: "Categoria do item.\r\n\r\n"
                                pictureUrl:
                                  type: string
                                  description: "Preço unitário\r\n\r\n"
                                description:
                                  type: string
                                  description: "Descrição do item.\r\n\r\n"
                          invoice:
                            type: string
                            description: Referência da fatura.
                          shipments:
                            type: array
                            description: "Lista de endereços de entrega\r\n\r\n"
                            items:
                              type: object
                              properties:
                                street:
                                  type: string
                                  description: 'Rua '
                                number:
                                  type: string
                                  description: 'Número '
                                city:
                                  type: string
                                  description: Cidade
                                state:
                                  type: string
                                  description: Estado
                                country:
                                  type: string
                                  description: País
                                zipCode:
                                  type: string
                                  description: "CEP\r\n\r\n"
                                comment:
                                  type: string
                                  description: "Informações adicionais\r\n\r\n"
                      intermediaries:
                        type: array
                        description: >-
                          Matriz de objetos Party. Representa outras partes na
                          cadeia de pagamento, visto que o usuário final não é
                          seu cliente direto. Considere a sequência da matriz:
                          seu cliente deve ser o primeiro elemento, o cliente do
                          seu cliente deve ser o segundo e assim por diante, até
                          que não haja mais intermediários.
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - COMPANY
                                - INDIVIDUAL
                              description: Tipo de intermediários.
                            name:
                              type: string
                              description: Nome dos intermediários.
                            lastname:
                              type: string
                              description: Sobrenome dos intermediários.
                            email:
                              type: string
                              description: E-mail dos intermediários.
                            phone:
                              type: object
                              description: Número de telefone dos intermediários.
                              properties:
                                countryCode:
                                  type: string
                                  description: "Código do país do telefone.\r\n\r\n"
                                areaCode:
                                  type: string
                                  description: "Código de área do país do telefone.\r\n\r\n"
                                number:
                                  type: string
                                  description: "Número de telefone.\r\n\r\n"
                            address:
                              type: object
                              description: Endereço dos intermediários.
                              properties:
                                street:
                                  type: string
                                  description: Nome da rua.
                                number:
                                  type: string
                                  description: Número da rua.
                                city:
                                  type: string
                                  description: Cidade
                                state:
                                  type: string
                                  description: Estado
                                country:
                                  type: string
                                  description: "País do endereço.\r\n\r\n"
                                zipCode:
                                  type: string
                                  description: "CEP.\r\n\r\n"
                                comment:
                                  type: string
                                  description: "Informações adicionais sobre o endereço.\r\n\r\n"
                            document:
                              type: object
                              description: Documento de identidade dos intermediários.
                              properties:
                                type:
                                  type: string
                                  description: >-
                                    O tipo de [documento de
                                    identidade](/pt-br/reference/identity-document-types),
                                    como Número de Identidade Nacional, Número
                                    de Seguro Social ou Carteira de Motorista,
                                    dependendo do país de emissão.
                                id:
                                  type: string
                                  description: >-
                                    Número do documento de identidade
                                    (geralmente um número). Este número deve ser
                                    válido de acordo com as regras para o tipo
                                    específico de documento.
                            birthdate:
                              type: string
                              description: Data de nascimento dos intermediários.
                            nationality:
                              type: string
                              description: Nacionalidade dos intermediários.
                      exchangeRateToken:
                        type: string
                        description: >-
                          Token fornecido pelo [serviço de
                          câmbio](/pt-br/reference/currency-exchange-quote) para
                          utilizar uma taxa de câmbio previamente acordada.
                    required:
                      - payer
                      - amount
                  payments:
                    type: array
                    items:
                      type: object
                      properties:
                        internalId:
                          type: string
                          description: Identificador de transação da Localpayment.
                        status:
                          type: object
                          description: Status da operação.
                          properties:
                            code:
                              type: string
                              description: >-
                                [Código de
                                status](/pt-br/reference/transaction-status-error-codes).
                            description:
                              description: >-
                                [Descrição do
                                status](/pt-br/reference/transaction-status-error-codes).
                            detail:
                              type: string
                              description: Informações adicionais sobre o status.
                  retries:
                    type: integer
                    description: Número de tentativas.
                required:
                  - externalId
                  - subscriptionId
                  - status
                  - totalPayments
                  - pendingPayments
                  - creationDate
                  - nextPaymentDate
                  - request
                  - payments
                x-examples:
                  Example 1:
                    externalId: '1623540689'
                    subscriptionId: ad5bb089-1095-446f-88ca-3bf2fae3610d
                    status:
                      code: '202'
                      description: COMPLETED
                      detail: The subscription was completed
                    totalPayments: 2
                    pendingPayments: 0
                    creationDate: '2021-06-12T23:31:29.869+00:00'
                    nextPaymentDate: '2021-03-14T03:00:00.000+00:00'
                    request:
                      payer:
                        name: Fernando
                        type: INDIVIDUAL
                        email: jane.doe@example.com
                        phone:
                          number: '98789632'
                          areaCode: '11'
                          countryCode: '1'
                        address:
                          city: Temperley
                          state: state
                          number: '1234'
                          street: Siempre viva
                          comment: timbre roto, llamar
                          country: ARG
                          zipCode: '1686'
                        document:
                          id: '37993830'
                          type: DNI
                        lastname: Gomez
                        birthdate: 01/01/1990
                        nationality: Argentino
                        userReference: identificador del pagador
                      amount: 150
                      device:
                        id: Android 9
                        ip: 127.111.142
                        browser: Google Chrome
                      comment: Primer pago
                      country: ARG
                      currency: ARS
                      metaData:
                        algoDelCliente: informacion adicional del cliente
                      clientCode: '0002'
                      externalId: '1623540689'
                      beneficiary:
                        name: Example Company S.A.
                        type: COMPANY
                        email: company@example.com
                        phone:
                          number: '98789632'
                          areaCode: '11'
                          countryCode: '1'
                        address:
                          city: Hurlingham
                          state: state
                          number: '938'
                          street: Charruas
                          comment: portero 801
                          country: ARG
                          zipCode: '1688'
                        document:
                          id: '30558251405'
                          type: CUIT
                        lastname: Solo si es type INDIVIDUAL
                        merchant: EXAMPLE001
                        birthdate: '1994-02-20'
                        nationality: Argentino
                      conceptCode: String
                      accountNumber: '{{accountNumber}}'
                      autoRecurring:
                        nextPayment: '2021-01-13'
                        repetitions: 2
                      paymentMethod:
                        code: '1000'
                        flow: DIRECT
                        type: CreditCard
                      commercialData:
                        items:
                          - id: PR0001
                            title: Point Mini
                            quantity: '1'
                            unitPrice: 58.8
                            categoryId: electronics
                            pictureUrl: >-
                              https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium@2x.png
                            description: >-
                              Producto Point para cobros con tarjetas mediante
                              bluetooth
                        invoice: Refencia a una factura
                        shipments:
                          - city: Temperley
                            state: state
                            number: '1234'
                            street: Siempre viva
                            comment: timbre roto, llamar
                            country: ARG
                            zipCode: '1686'
                      intermediaries:
                        - name: Fernando
                          type: INDIVIDUAL
                          email: jane.doe@example.com
                          phone:
                            number: '98789632'
                            areaCode: '11'
                            countryCode: '1'
                          address:
                            city: Temperley
                            state: state
                            number: '1234'
                            street: Siempre viva
                            comment: timbre roto, llamar
                            country: ARG
                            zipCode: '1686'
                          document:
                            id: '37993830'
                            type: DNI
                          lastname: Gomez
                          birthdate: 01/01/1990
                          nationality: Argentino
                      exchangeRateToken: String
                    payments:
                      - internalId: 9341125e-6f24-4141-adb5-b2e555d58558
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                      - internalId: 887517fe-d052-4634-8d85-f1e632d3357e
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                    retries: 0
              examples:
                202 - Completed:
                  value:
                    externalId: '1623540689'
                    subscriptionId: ad5bb089-1095-446f-88ca-3bf2fae3610d
                    status:
                      code: '202'
                      description: COMPLETED
                      detail: The subscription was completed
                    totalPayments: 2
                    pendingPayments: 0
                    creationDate: '2021-06-12T23:31:29.869+00:00'
                    nextPaymentDate: '2021-03-14T03:00:00.000+00:00'
                    request:
                      payer:
                        name: Fernando
                        type: INDIVIDUAL
                        email: jane.doe@example.com
                        phone:
                          number: '98789632'
                          areaCode: '11'
                          countryCode: '1'
                        address:
                          city: Temperley
                          state: state
                          number: '1234'
                          street: Siempre viva
                          comment: timbre roto, llamar
                          country: ARG
                          zipCode: '1686'
                        document:
                          id: '37993830'
                          type: DNI
                        lastname: Gomez
                        birthdate: 01/01/1990
                        nationality: Argentino
                        userReference: identificador del pagador
                      amount: 150
                      device:
                        id: Android 9
                        ip: 127.111.142
                        browser: Google Chrome
                      comment: Primer pago
                      country: ARG
                      currency: ARS
                      metaData:
                        algoDelCliente: informacion adicional del cliente
                      clientCode: '0002'
                      externalId: '1623540689'
                      beneficiary:
                        name: Example Company S.A.
                        type: COMPANY
                        email: company@example.com
                        phone:
                          number: '98789632'
                          areaCode: '11'
                          countryCode: '1'
                        address:
                          city: Hurlingham
                          state: state
                          number: '938'
                          street: Charruas
                          comment: portero 801
                          country: ARG
                          zipCode: '1688'
                        document:
                          id: '30558251405'
                          type: CUIT
                        lastname: Solo si es type INDIVIDUAL
                        merchant: EXAMPLE001
                        birthdate: '1994-02-20'
                        nationality: Argentino
                      conceptCode: String
                      accountNumber: '{{accountNumber}}'
                      autoRecurring:
                        nextPayment: '2021-01-13'
                        repetitions: 2
                      paymentMethod:
                        code: '1000'
                        flow: DIRECT
                        type: CreditCard
                      commercialData:
                        items:
                          - id: PR0001
                            title: Point Mini
                            quantity: '1'
                            unitPrice: 58.8
                            categoryId: electronics
                            pictureUrl: >-
                              https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium@2x.png
                            description: >-
                              Producto Point para cobros con tarjetas mediante
                              bluetooth
                        invoice: Refencia a una factura
                        shipments:
                          - city: Temperley
                            state: state
                            number: '1234'
                            street: Siempre viva
                            comment: timbre roto, llamar
                            country: ARG
                            zipCode: '1686'
                      intermediaries:
                        - name: Fernando
                          type: INDIVIDUAL
                          email: jane.doe@example.com
                          phone:
                            number: '98789632'
                            areaCode: '11'
                            countryCode: '1'
                          address:
                            city: Temperley
                            state: state
                            number: '1234'
                            street: Siempre viva
                            comment: timbre roto, llamar
                            country: ARG
                            zipCode: '1686'
                          document:
                            id: '37993830'
                            type: DNI
                          lastname: Gomez
                          birthdate: 01/01/1990
                          nationality: Argentino
                      exchangeRateToken: String
                    payments:
                      - internalId: 9341125e-6f24-4141-adb5-b2e555d58558
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                      - internalId: 887517fe-d052-4634-8d85-f1e632d3357e
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                    retries: 0
        '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.
                required:
                  - detail
                  - code
                  - messages
                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
                    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.
                x-examples:
                  Example 1:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Subscription not found
              examples:
                404 - Subscription not found:
                  value:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Subscription 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.