> ## Documentation Index > Fetch the complete documentation index at: https://developer.paywint.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Payment Details > Fetch the details of a specific payment using its unique ID. This endpoint: - Retrieves a payment record by its `id` - Ensures the request is made by an authenticated platform via API key - Returns the payment data in a standardized format ## OpenAPI ````yaml GET /api/platform/payment/get-payment/{payment_id} openapi: 3.1.0 info: title: paywint version: 0.1.0 servers: - url: http://localhost:8001 - url: https://api.pw.wintpay.com - url: https://test.pw.wintpay.com - url: https://api.sandbox.paywint.com security: [] paths: /api/platform/payment/get-payment/{payment_id}: get: tags: - Platform payment summary: Retrieve a specific payment by ID description: |- Fetch the details of a specific payment using its unique ID. This endpoint: - Retrieves a payment record by its `id` - Ensures the request is made by an authenticated platform via API key - Returns the payment data in a standardized format operationId: get_payment_api_platform_payment_get_payment__payment_id__get parameters: - name: payment_id in: path required: true schema: type: string format: uuid description: Unique identifier (UUID) of the payment to be retrieved. title: Payment Id description: Unique identifier (UUID) of the payment to be retrieved. example: f47ac10b-****-****-****-0e02b2c3d479 - name: X-Platform-ID in: header required: true schema: type: string format: uuid description: >- Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request. title: X-Platform-Id description: >- Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request. - name: X-Signature in: header required: true schema: type: string description: >- HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`. title: X-Signature description: >- HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CommonResponse_PlatformPaymentRead_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: CommonResponse_PlatformPaymentRead_: properties: success: type: boolean title: Success description: Indicates whether the request was processed successfully. default: true example: true message: type: string title: Message description: >- A short, human-readable message describing the result of the request. default: Success example: Operation completed. data: anyOf: - $ref: '#/components/schemas/PlatformPaymentRead' - type: 'null' description: The main response payload, if applicable queryGeneratedTime: anyOf: - type: number - type: 'null' title: Querygeneratedtime description: >- The Unix timestamp (in seconds) indicating when the response was generated. default: 1782303609.673092 example: 1718006400 type: object title: CommonResponse[PlatformPaymentRead] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PlatformPaymentRead: properties: payment_id: anyOf: - type: string format: uuid - type: 'null' title: Payment Id description: Unique identifier (UUID) of the payment transaction. example: f47ac10b-****-****-****-0e02b2c3d479 transaction_id: anyOf: - type: integer - type: 'null' title: Transaction Id description: Integer ID of the payment example: 1501 payer_id: anyOf: - type: string format: uuid - type: 'null' title: Payer Id description: Unique identifier (UUID) of the user who initiated the payment. example: f47ac10b-****-****-****-0e02b2c3d479 payee_id: anyOf: - type: string format: uuid - type: 'null' title: Payee Id description: Unique identifier (UUID) of the recipient who received the payment example: f47ac10b-****-****-****-0e02b2c3d479 amount: anyOf: - type: number - type: 'null' title: Amount description: Total amount transferred in the transaction. example: 100 processing_fee: anyOf: - type: number - type: 'null' title: Processing Fee description: Processing fee charged on payment. example: 1.5 delivery_fee: anyOf: - type: number - type: 'null' title: Delivery Fee description: Delivery fee charged on payment. example: 0.5 invoice_no: anyOf: - type: string - type: 'null' title: Invoice No description: >- Invoice or transaction reference number for tracking and record-keeping purposes. example: INV-2024-001234 currency: anyOf: - type: string - type: 'null' title: Currency description: Three-letter ISO currency code for the transaction (e.g., USD). example: USD description: anyOf: - type: string - type: 'null' title: Description description: Optional note or description attached to the payment. example: June invoice for services created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: Timestamp when the payment record was initially created. example: '2025-06-16T10:04:51.739761Z' payment_date: anyOf: - type: string format: date-time - type: 'null' title: Payment Date description: Timestamp when the payment was successfully processed or completed. example: '2025-06-16T10:13:16.749655Z' status: $ref: '#/components/schemas/PlatformPaymentStatus' description: The current status of the payment (e.g., success, failed, pending). example: success card_id: anyOf: - type: string format: uuid - type: 'null' title: Card Id description: UUID of the payer's card. example: f47ac10b-****-****-****-0e02b2c3d479 bank_id: anyOf: - type: string format: uuid - type: 'null' title: Bank Id description: UUID of the payer's bank account. example: f47ac10b-****-****-****-0e02b2c3d479 payee_card_id: anyOf: - type: string format: uuid - type: 'null' title: Payee Card Id description: UUID of the payee's card where funds are received. example: f47ac10b-****-****-****-0e02b2c3d479 payee_bank_id: anyOf: - type: string format: uuid - type: 'null' title: Payee Bank Id description: UUID of the payee's bank account where funds are received. example: f47ac10b-****-****-****-0e02b2c3d479 failure_reason: anyOf: - type: string - type: 'null' title: Failure Reason description: Explanation for why the payment failed, if applicable. example: Insufficient wallet balance payment_method: anyOf: - $ref: '#/components/schemas/PlatformPaymentMethodRead' - type: 'null' description: The method used to send the payment (e.g., WALLET, CARD, PW_BANK). example: WALLET receiving_method: anyOf: - $ref: '#/components/schemas/PlatformPaymentMethodRead' - type: 'null' description: >- The destination method where the payment was received (e.g., WALLET, CARD, ACH, PW_BANK, RTP, FEDNOW) example: WALLET type: object title: PlatformPaymentRead ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError PlatformPaymentStatus: type: string enum: - requested - initiated - check_pending - processing - SETTLING - approved - success - failed - request_failed - rejected - declined - mailed - expired title: PlatformPaymentStatus PlatformPaymentMethodRead: type: string enum: - WALLET - CARD - ACH - CHECK_MAIL - PW_BANK - RTP - FEDNOW title: PlatformPaymentMethodRead ````