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

# Overview

> Create and manage wallet-based payment transactions through the Paywint Developer API.

The **Payment API** allows you to create and retrieve payment transactions associated with your account.

This API enables:

* Creating payment links to collect funds
* Retrieving individual payment details
* Listing outgoing payments
* Listing incoming paymentsd

***

## What This API Provides

The Payment API allows your integration to:

* Generate secure payment links for wallet-based collections
* Retrieve a payment record by its unique identifier
* List payments sent from the user account
* List payments received into the user account

Each payment record includes:

* Unique payment ID
* Amount (USD)
* Payment status
* Payer and payee details
* Timestamps
* System-generated metadata

***

## Available APIs

<CardGroup cols={2}>
  <Card title="Create Payment Link" icon="link" href="/api-reference/payment/create-payment" arrow="true">
    Generate a secure payment link to collect funds.
  </Card>

  <Card title="Get Payment" icon="search" href="/api-reference/payment/get-payment" arrow="true">
    Retrieve a specific payment using its ID.
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="List Sent Payments" icon="arrow-up-right" href="/api-reference/payment/list-sent-payments" arrow="true">
    Retrieve all outgoing payments from the user account.
  </Card>

  <Card title="List Received Payments" icon="arrow-down-left" href="/api-reference/payment/list-received-payments" arrow="true">
    Retrieve all incoming payments to the user account.
  </Card>
</CardGroup>

***

## Typical Integration Flow

<Steps>
  <Step title="1. Create a payment link">
    Call <code>Create Payment</code> with the amount and optional description to generate a shareable payment URL.
  </Step>

  <Step title="2. Share the payment link">
    Send the generated URL to the payer for completion.
  </Step>

  <Step title="3. Track payment status">
    Use <code>Get Payment</code> to retrieve transaction details and monitor status updates.
  </Step>

  <Step title="4. Reconcile transactions">
    Use <code>List Sent Payments</code> and <code>List Received Payments</code> for reporting and reconciliation.
  </Step>
</Steps>

***

## Pagination

The list endpoints require:

* `rows_per_page` (10, 20, 50, or 100)
* `page_no` (starting from 1)

Responses include:

* `records`
* `totalRecords`
* `queryGeneratedTime`

Use pagination to efficiently handle large transaction volumes.

***

## Best Practices

* Always validate amounts before submission.
* Store the returned `payment_id` for reconciliation and status tracking.
* Use `Get Payment` to confirm final transaction state.
* Implement proper pagination handling for production environments.
* Securely store API credentials and never expose them client-side.