> ## Documentation Index > Fetch the complete documentation index at: https://docs.paywint.com/llms.txt > Use this file to discover all available pages before exploring further. # List Received Payments > Get a list of all payments received by your account. This endpoint: - Returns all incoming payments along with payer details ## OpenAPI ````yaml POST /api/user-api/payment/list/payment-received openapi: 3.1.0 info: title: paywint version: 0.1.0 servers: - url: https://api.sandbox.paywint.com - url: https://api.paywint.com security: [] paths: /api/user-api/payment/list/payment-received: post: tags: - Developer API payment summary: List received payments description: |- Get a list of all payments received by your account. This endpoint: - Returns all incoming payments along with payer details operationId: list_received_payment_api_user_api_payment_list_payment_received_post parameters: - name: X-Api-Key in: header required: true schema: type: string description: >- Your API Key (UUID format). Required to identify and authorize each request title: X-Api-Key description: >- Your API Key (UUID format). Required to identify and authorize each request - name: X-Api-Secret in: header required: true schema: type: string description: >- Secret associated with your API Key. Used for authenticating requests. Keep this secure. title: X-Api-Secret description: >- Secret associated with your API Key. Used for authenticating requests. Keep this secure. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExternalPaginationRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExternalListResponse_UserApiPaymentRead_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: ExternalPaginationRequest: properties: rows_per_page: $ref: '#/components/schemas/RowsPerPage' description: >- Number of records to return per page. Accepted values are 10, 20, 50, or 100. example: 50 page_no: type: integer minimum: 1 title: Page No description: >- Page number to retrieve, starting from 1. For example, page_no=1 returns the first page of results. example: 1 type: object required: - rows_per_page - page_no title: ExternalPaginationRequest ExternalListResponse_UserApiPaymentRead_: properties: success: type: boolean title: Success description: Indicates whether the request was processed successfully. default: true example: true status_code: anyOf: - type: integer - type: 'null' title: Status Code description: HTTP status code representing the result of the request. default: 200 message: anyOf: - type: string - type: 'null' title: Message description: Short, human-readable message describing the outcome of the request. default: Success records: anyOf: - items: $ref: '#/components/schemas/UserApiPaymentRead' type: array - type: 'null' title: Records description: List of result items returned for the current page. totalRecords: anyOf: - type: integer - type: 'null' title: Totalrecords description: >- Total number of matching records in the database, useful for paginating the full dataset. default: 0 queryGeneratedTime: anyOf: - type: integer - type: 'null' title: Querygeneratedtime description: >- Unix timestamp (in seconds) indicating when this response was generated. default: 1778161546 type: object title: ExternalListResponse[UserApiPaymentRead] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError RowsPerPage: type: integer enum: - 10 - 20 - 50 - 100 title: RowsPerPage UserApiPaymentRead: properties: payment_id: anyOf: - type: string format: uuid - type: 'null' title: Payment Id description: Unique ID of the payment example: d4211545-cfc9-4aa0-8fcc-e4c2639e8052 payer_id: anyOf: - type: string format: uuid - type: 'null' title: Payer Id description: ID of the payer payer_name: anyOf: - type: string - type: 'null' title: Payer Name description: Name of the payer payee_id: anyOf: - type: string format: uuid - type: 'null' title: Payee Id description: ID of the payee payee_name: anyOf: - type: string - type: 'null' title: Payee Name description: Name of the payee amount: anyOf: - type: string - type: 'null' title: Amount description: Payment amount example: 100 currency: anyOf: - type: string - type: 'null' title: Currency description: Currency of the transaction example: USD description: anyOf: - type: string - type: 'null' title: Description description: Description or note attached to the payment example: June invoice for services payment_method: anyOf: - $ref: '#/components/schemas/PaymentMethod' - type: 'null' description: Payment method used example: WALLET receiving_method: anyOf: - $ref: '#/components/schemas/PaymentMethod' - type: 'null' description: Destination method example: WALLET created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: Timestamp when the payment record was created example: '2025-06-16T10:04:51.739761Z' payment_date: anyOf: - type: string format: date-time - type: 'null' title: Payment Date description: Actual date when the payment was made or processed example: '2025-06-16T10:13:16.749655Z' status: anyOf: - $ref: '#/components/schemas/PaymentStatus' - type: 'null' description: Current status of the payment example: success failure_reason: anyOf: - type: string - type: 'null' title: Failure Reason description: If payment failed, this field provides the reason or context example: Insufficient wallet balance type: object title: UserApiPaymentRead 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 PaymentMethod: type: string enum: - CARD - ACH - RTP - WALLET - POINT - PAYMENT_LINK - PW_BANK - PW_CARD - CHECK_MAIL - CHECK_EMAIL - CHECK_PRINT - BLANK_CHECK - BANK - CRYPTO title: PaymentMethod PaymentStatus: type: string enum: - pending - qb_pending - requested - initiated - check_pending - emailed - approved - failed - request_failed - rejected - success - processing - SETTLING - provider_failure - declined - disputed - mailed - printed - reprinted - expired title: PaymentStatus ````