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

# Get Payment Status

> Retrieve the current status and settlement details of a specific payment.



## OpenAPI

````yaml /api-reference/openapi.json get /service/payments/{paymentId}/status
openapi: 3.1.0
info:
  title: Payra API
  version: 1.0.0
  description: Documentação da API para Backoffice e Service
servers: []
security: []
paths:
  /service/payments/{paymentId}/status:
    get:
      tags:
        - Payments
      summary: Get Payment Status
      description: >-
        Retrieve the current status and settlement details of a specific
        payment.
      operationId: getPaymentStatus
      parameters:
        - schema:
            type: string
          required: true
          description: Unique identifier of the payment to retrieve
          name: paymentId
          in: path
      responses:
        '200':
          description: Payment status retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - health_status_ok
                      - health_status_error
                      - validation_error
                      - bad_request
                      - unauthorized
                      - forbidden
                      - not_found
                      - method_not_allowed
                      - internal_server_error
                      - organization_not_found
                      - cannot_access_organization
                      - api_key_not_found
                      - resource_already_exists
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      invoiceId:
                        type: string
                      customerId:
                        type: string
                      status:
                        type: string
                        enum:
                          - pending
                          - processing
                          - succeeded
                          - failed
                          - refunded
                          - cancelled
                      amount:
                        type: number
                        description: >-
                          Payment amount in the smallest currency unit (e.g.
                          cents)
                      currency:
                        type: string
                        description: ISO 4217 currency code
                      paymentMethod:
                        type: string
                        enum:
                          - card
                          - bank_transfer
                          - ach
                          - pix
                          - wallet
                      failureReason:
                        type:
                          - string
                          - 'null'
                        description: Reason for failure when the payment did not succeed
                      settledAt:
                        type:
                          - string
                          - 'null'
                        description: Timestamp when the payment was settled
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                      - id
                      - status
                      - amount
                      - currency
                      - createdAt
                      - updatedAt
                required:
                  - data
        '401':
          description: >-
            Unauthorized. The provided authentication token is invalid or
            expired.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - health_status_ok
                      - health_status_error
                      - validation_error
                      - bad_request
                      - unauthorized
                      - forbidden
                      - not_found
                      - method_not_allowed
                      - internal_server_error
                      - organization_not_found
                      - cannot_access_organization
                      - api_key_not_found
                      - resource_already_exists
                    default: unauthorized
                  message:
                    type: string
                  data: {}
        '404':
          description: Payment not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - health_status_ok
                      - health_status_error
                      - validation_error
                      - bad_request
                      - unauthorized
                      - forbidden
                      - not_found
                      - method_not_allowed
                      - internal_server_error
                      - organization_not_found
                      - cannot_access_organization
                      - api_key_not_found
                      - resource_already_exists
                    default: not_found
                  message:
                    type: string
                  data: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - health_status_ok
                      - health_status_error
                      - validation_error
                      - bad_request
                      - unauthorized
                      - forbidden
                      - not_found
                      - method_not_allowed
                      - internal_server_error
                      - organization_not_found
                      - cannot_access_organization
                      - api_key_not_found
                      - resource_already_exists
                    default: internal_server_error
                  message:
                    type: string
                  data: {}
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````