> ## Documentation Index > Fetch the complete documentation index at: https://ownpay.org/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees. > Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown. > OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis. > MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries. > Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix. > Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests. # Retrieve Payment Details > Lookup a payment intent and its associated transaction state by its unique payment intent UUID. If a transaction has already been established/completed against the intent, the response returns details of that transaction. Otherwise, it returns the details of the pending intent. ## OpenAPI ````yaml /api/merchant_api.yaml get /payments/{payment_id} openapi: 3.1.0 info: title: OwnPay Merchant API description: > The OwnPay Merchant API enables merchants to programmatically interface with their white-labeled payment gateway. It exposes endpoints to initiate payments (creating payment intents), query transaction statuses, issue full or partial refunds, manage customer profiles securely in compliance with GDPR and OWASP, generate and revoke API keys, and test/audit webhook delivery attempts. ### Authentication Authentication is performed via HTTP Bearer token in the `Authorization` header. ```http Authorization: Bearer your_api_key_here ``` API keys carry specific privilege scopes (e.g., `read`, `write`, `admin`). Some administrative operations (like listing/generating API keys) require **both** `write` and `admin` scopes, as well as passing a valid platform super-administrator's email address in the `X-Super-Admin-Email` header for safety. version: 1.0.0 servers: - url: https://{brand_domain}/api/v1 description: Sandbox or Production white-labeled brand gateway API server. variables: brand_domain: default: ownpay.org description: The custom domain configured for your white-labeled brand. security: - BearerAuth: [] paths: /payments/{payment_id}: get: summary: Retrieve Payment Details description: > Lookup a payment intent and its associated transaction state by its unique payment intent UUID. If a transaction has already been established/completed against the intent, the response returns details of that transaction. Otherwise, it returns the details of the pending intent. operationId: retrievePayment parameters: - name: payment_id in: path required: true description: The unique UUID string of the payment intent. schema: type: string format: uuid responses: '200': description: Detailed payment status retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/PaymentDetailsResponse' '404': description: Payment intent not found or belongs to another merchant. content: application/json: schema: $ref: '#/components/schemas/ApiSingleErrorResponse' '422': description: Invalid payment ID format. content: application/json: schema: $ref: '#/components/schemas/ApiSingleErrorResponse' components: schemas: PaymentDetailsResponse: type: object properties: success: type: boolean example: true data: type: object properties: id: type: integer nullable: true description: Transaction primary key ID if completed, else null. example: 45 trx_id: type: string nullable: true description: OwnPay transaction reference string if completed, else null. example: OP-481029304 gateway_trx_id: type: string nullable: true description: Gateway provider transaction identifier reference string. example: A8K9D2J3S amount: type: string example: '500.00' currency: type: string example: BDT fee: type: string example: '7.50' status: type: string example: completed gateway: type: string nullable: true example: bkash method: type: string nullable: true example: app reference: type: string nullable: true example: INV-10029 created_at: type: string format: date-time example: '2026-06-23T14:15:45Z' completed_at: type: string format: date-time nullable: true example: '2026-06-23T14:17:12Z' customer: type: object properties: name: type: string example: John Doe email: type: string example: customer@example.com ApiSingleErrorResponse: type: object properties: success: type: boolean example: false error: type: string example: Payment not found errors: type: array items: type: object properties: code: type: string example: PAYMENT_NOT_FOUND message: type: string example: Payment not found field: type: string nullable: true example: null request_id: type: string example: 8f5a2e9b0c7d4e5f securitySchemes: BearerAuth: type: http scheme: bearer description: Provide the Bearer API Key generated for your brand. ```` ## Related topics - [Retrieve Transaction](/docs/api-reference/retrieve-transaction.md) - [Retrieve Customer](/docs/api-reference/retrieve-customer.md) - [Retrieve Device Connection Status](/docs/api-reference/retrieve-device-connection-status.md) - [Retrieve Refund](/docs/api-reference/retrieve-refund.md) - [Developer Quickstart - Build Your First Payment Integration](/docs/developer/quickstart.md)