# Paywint API Documentation

## Docs

- [Add Bank Account](https://developer.paywint.com/api-reference/bank-accounts/add.md): - Create a new bank account for a specified user. - Link the bank account to the user for future transactions. - Use this endpoint to add account details.
- [Delete Bank Account](https://developer.paywint.com/api-reference/bank-accounts/delete.md): Removes a bank account record that belongs to the user.
- [Get Bank Account](https://developer.paywint.com/api-reference/bank-accounts/get.md): Retrieves bank account details if the account exists and belongs to a verified user.
- [List Bank Accounts](https://developer.paywint.com/api-reference/bank-accounts/list.md): Retrieves all bank accounts linked to the specified user, ordered by most recently added.
- [Overview](https://developer.paywint.com/api-reference/bank-accounts/overview.md): Add, verify, and manage bank accounts for users.
- [Release Micro-Deposit](https://developer.paywint.com/api-reference/bank-accounts/release-micro-deposit.md): Starts the micro-deposit verification process for a user’s bank account.
- [Set Bank Account To Default](https://developer.paywint.com/api-reference/bank-accounts/set-default.md): Set a specific bank account as the default account for a user.
- [Verify Micro-Deposit](https://developer.paywint.com/api-reference/bank-accounts/verify-micro-deposit.md): Finalizes the micro-deposit verification process for a user’s bank account.
- [Add Card](https://developer.paywint.com/api-reference/cards/add.md): Returns a short-lived secure link to initiate the Add Card process for a user.
- [Delete Card](https://developer.paywint.com/api-reference/cards/delete.md): Delete a user card associated with the specified card ID.
- [Get Card](https://developer.paywint.com/api-reference/cards/get.md): Retrieves card details if the card exists and belongs to a verified user.
- [List Cards](https://developer.paywint.com/api-reference/cards/list.md): Retrieve a list of all cards associated with the authenticated user.
- [Overview](https://developer.paywint.com/api-reference/cards/overview.md): Link, verify, retrieve, list, and manage user debit and credit cards.
- [Update Card](https://developer.paywint.com/api-reference/cards/update.md): Returns a short-lived secure link to initiate the Update Card process for a user.
- [Add Check Address](https://developer.paywint.com/api-reference/checks/add-address.md): Create and store a mailing address used for sending physical checks on behalf of a specific user.
- [Overview](https://developer.paywint.com/api-reference/checks/overview.md): Manage mailing addresses and check settings used for sending physical checks.
- [Update Check Address](https://developer.paywint.com/api-reference/checks/update-address.md): Update the existing **check mailing address** for a specific user.
- [Update Check Config](https://developer.paywint.com/api-reference/checks/update-config.md): Update the **check settings** for a specific user, including branding and preferences used when mailing checks.
- [Get KYB](https://developer.paywint.com/api-reference/compliance/kyb/get.md): This endpoint: - Verifies the platform and user relationship - Retrieves the KYB record associated with the given user ID - Returns detailed KYB data if found, otherwise raises a 404 error
- [Submit KYB](https://developer.paywint.com/api-reference/compliance/kyb/submit.md): Initiates business verification for a specific user.
- [Submit KYC](https://developer.paywint.com/api-reference/compliance/kyc/create-enquiry-link.md): Retrieve a verification link to initiate or resume identity verification for a specific user.
- [Get KYC](https://developer.paywint.com/api-reference/compliance/kyc/get.md): Retrieve the Know Your Customer (KYC) details for a specific user.
- [Overview](https://developer.paywint.com/api-reference/compliance/overview.md): KYC and KYB verification flows for users and businesses on Paywint.
- [Add Payee Address](https://developer.paywint.com/api-reference/payees/addresses/add.md): Creates a new address for an existing payee contact.
- [Delete Payee Address](https://developer.paywint.com/api-reference/payees/addresses/delete.md): Removes a saved address from an existing payee contact.
- [List Payee Address](https://developer.paywint.com/api-reference/payees/addresses/list.md): Retrieves all saved addresses for an existing payee contact.
- [Overview](https://developer.paywint.com/api-reference/payees/addresses/overview.md): Create, list, update, and delete mailing addresses saved for a user's payees.
- [Update Payee Address](https://developer.paywint.com/api-reference/payees/addresses/update.md)
- [Add Payee Bank Account](https://developer.paywint.com/api-reference/payees/bank-accounts/add.md): Add a bank account for a specific payee.
- [Delete Payee Bank Account](https://developer.paywint.com/api-reference/payees/bank-accounts/delete.md): This endpoint deletes a specific bank account linked to a payee.
- [Get Payee Bank Account](https://developer.paywint.com/api-reference/payees/bank-accounts/get.md): This endpoint retrives details of a specific bank account linked to a payee.
- [List Payee Bank Accounts](https://developer.paywint.com/api-reference/payees/bank-accounts/list.md): This endpoint returns all active bank accounts linked to a specific payee.
- [Overview](https://developer.paywint.com/api-reference/payees/bank-accounts/overview.md): Add, retrieve, list, and delete bank accounts saved for a user's payees.
- [Add Payee Card](https://developer.paywint.com/api-reference/payees/cards/add.md): - Add a new payment card to a specific payee for the user. - Use this to save payee card details for future transactions.
- [Delete Payee Card](https://developer.paywint.com/api-reference/payees/cards/delete.md): This endpoint deletes a specific card linked to a payee.
- [Get Payee Card](https://developer.paywint.com/api-reference/payees/cards/get.md): This endpoint retrieves details of a specific card linked to a payee.
- [List Payee Cards](https://developer.paywint.com/api-reference/payees/cards/list.md): This endpoint returns all cards linked to a specific payee.
- [Overview](https://developer.paywint.com/api-reference/payees/cards/overview.md): Add, retrieve, list, and delete payment cards saved for a user's payees.
- [Create Payee](https://developer.paywint.com/api-reference/payees/create.md): Creates a new payee under the specified user.
- [Delete Payee](https://developer.paywint.com/api-reference/payees/delete.md): Delete a specific payee associated with a user.
- [Get Payee](https://developer.paywint.com/api-reference/payees/get.md): Retrieves the contact details of a specific payee associated with a user.
- [List Payees](https://developer.paywint.com/api-reference/payees/list.md): Retrieve all payees associated with a specific user, ordered by most recently added.
- [Overview](https://developer.paywint.com/api-reference/payees/overview.md): Create, update, retrieve, list, and delete payees linked to a user.
- [Update Payee](https://developer.paywint.com/api-reference/payees/update.md): Update payee name
- [Create Payment Link](https://developer.paywint.com/api-reference/payments/checkout/create-payment-link.md): Generates a secure payment link to collect wallet-based payments from others.
- [Overview](https://developer.paywint.com/api-reference/payments/checkout/overview.md): Securely accept payments online.
- [Create Payment](https://developer.paywint.com/api-reference/payments/create.md): Initiates a payment from a user to one of their registered payees.
- [Get Payment Details](https://developer.paywint.com/api-reference/payments/get.md): Fetch the details of a specific payment using its unique ID.
- [List Payments](https://developer.paywint.com/api-reference/payments/list.md): Retrieve a list of all payments associated with the platform.
- [List User Received Payments](https://developer.paywint.com/api-reference/payments/list-received.md): Retrieve all payment records where the specified user is the payee.
- [List User Payments](https://developer.paywint.com/api-reference/payments/list-sent.md): Retrieve all payment records where the specified user is the payer.
- [Mail Check](https://developer.paywint.com/api-reference/payments/mail-check.md): Sends a physical check payment by mail to a specified payee on behalf of a platform user.
- [Overview](https://developer.paywint.com/api-reference/payments/overview.md): Create, track, and manage payments using wallet, ACH, card, Paywint Bank, or mailed checks.
- [List Paywint Bank Account Transactions](https://developer.paywint.com/api-reference/paywint-bank-accounts/list-transactions.md): Retrieves a paginated list of Paywint bank transactions for a specific user.
- [Open Paywint Bank Account](https://developer.paywint.com/api-reference/paywint-bank-accounts/open.md): Creates a new Paywint bank account for an eligible user.
- [Overview](https://developer.paywint.com/api-reference/paywint-bank-accounts/overview.md): Open and manage Paywint–issued digital bank accounts for your users.
- [Create User](https://developer.paywint.com/api-reference/users/create.md): Creates a new user account into the platform.
- [Get User](https://developer.paywint.com/api-reference/users/get.md): Retrieve user details for a specific user ID within the platform.
- [List Users](https://developer.paywint.com/api-reference/users/list.md): Retrieve a list of users created under the current platform.
- [Overview](https://developer.paywint.com/api-reference/users/overview.md): Register and manage users in Paywint to enable payments, wallets, and other financial services.
- [Fund Wallet / ACH Pull](https://developer.paywint.com/api-reference/wallet/fund.md): Initiates the process of funding a user's wallet via the platform using a specified payment method.
- [Get Wallet](https://developer.paywint.com/api-reference/wallet/get.md): Retrieves the wallet information for a specific user.
- [Overview](https://developer.paywint.com/api-reference/wallet/overview.md): Access, fund, and withdraw from a user’s Paywint wallet.
- [Withdraw Fund](https://developer.paywint.com/api-reference/wallet/withdraw.md): Initiates a withdrawal from a platform user’s wallet using a supported transfer method.
- [Authentication](https://developer.paywint.com/get-started/authentication.md): We use API key based authentication to verify and authorize all requests to the Paywint API.
- [Dashboards](https://developer.paywint.com/get-started/dashboards.md): We offer Sandbox and Production dashboards to streamline your development and go-live process.
- [Environments](https://developer.paywint.com/get-started/environments.md): Accelerate your development cycle using Paywint’s separate environments for testing and live deployment.
- [Overview](https://developer.paywint.com/get-started/overview.md): Welcome to the Paywint API documentation.
- [Quickstart](https://developer.paywint.com/get-started/quickstart.md): Start building with the Paywint API — from user creation to payments.
- [Signature Authentication](https://developer.paywint.com/get-started/signature-auth.md): How to generate HMAC-SHA256 signatures for secure API access in Paywint.
- [Basic URL Requirements](https://developer.paywint.com/guidelines/url-standards/basic-requirements.md): Core rules every document URL must follow before being submitted to Paywint APIs.
- [Cloud Storage Guidelines](https://developer.paywint.com/guidelines/url-standards/cloud-storage.md): How to correctly generate direct-access URLs from popular cloud storage services.
- [Valid & Invalid URL Examples](https://developer.paywint.com/guidelines/url-standards/examples.md): Examples of URLs that pass and fail Paywint's URL validation checks.
- [File Requirements](https://developer.paywint.com/guidelines/url-standards/file-rules.md): File size, type, and validation rules for uploaded documents.
- [URL Standards Overview](https://developer.paywint.com/guidelines/url-standards/overview.md): Overview of URL requirements and validation rules for submitting documents through the Paywint API.
- [Security Rules](https://developer.paywint.com/guidelines/url-standards/security-rules.md): Security restrictions for document URLs.
- [Troubleshooting URL Issues](https://developer.paywint.com/guidelines/url-standards/troubleshooting.md): Common URL validation errors and how to fix them.
- [Available Values for "entityType" and "industryType" in API Payload](https://developer.paywint.com/industry-entity-available-values.md)
- [Changelog](https://developer.paywint.com/resources/changelog.md): Track all improvements, new features, fixes, and updates made to the Paywint API and Documentation.
- [FAQ](https://developer.paywint.com/resources/faq.md): Frequently Asked Questions about the Paywint API.
- [Glossary](https://developer.paywint.com/resources/glossary.md): A list of terms and definitions related to the Paywint API and payment processing.
- [Event Types](https://developer.paywint.com/webhooks/event-types.md): Complete list of webhook event types sent by Paywint.
- [Events](https://developer.paywint.com/webhooks/events.md): Understand how Paywint webhook events work and what they represent.
- [payment.failed](https://developer.paywint.com/webhooks/events/payment/failed.md): Sent when a payment fails.
- [payment.fee_refunded](https://developer.paywint.com/webhooks/events/payment/fee-refunded.md): Sent when a payment fee has been successfully refunded.
- [payment.initiated](https://developer.paywint.com/webhooks/events/payment/initiated.md): Sent when a payment attempt is initiated.
- [payment.opened](https://developer.paywint.com/webhooks/events/payment/opened.md): Sent when a payment is created and awaiting further action.
- [payment.processing](https://developer.paywint.com/webhooks/events/payment/processing.md): Sent when a payment is being processed.
- [payment.refund](https://developer.paywint.com/webhooks/events/payment/refunded.md): Sent when a payment amount is successfully refunded.
- [payment.rejected](https://developer.paywint.com/webhooks/events/payment/rejected.md): Sent when a payment is rejected before processing begins.
- [payment.settling](https://developer.paywint.com/webhooks/events/payment/settling.md): Sent when a payment is in the process of being settled.
- [payment.success](https://developer.paywint.com/webhooks/events/payment/success.md): Sent when a payment is successfully completed.
- [Overview](https://developer.paywint.com/webhooks/overview.md): Learn how Paywint uses webhooks to deliver real-time event notifications.
- [Retry Behavior](https://developer.paywint.com/webhooks/retry-behavior.md): Understand Paywint webhook delivery and retry logic.
- [Webhook Setup](https://developer.paywint.com/webhooks/setup.md): Configure webhook URLs in Sandbox and Production environments.
- [Signature Verification](https://developer.paywint.com/webhooks/signature-verification.md): Verify that webhook payloads are securely delivered by Paywint.
- [Webhook Responses](https://developer.paywint.com/webhooks/webhook-response.md): Learn how to receive and handle Paywint webhook events.

## OpenAPI Specs

- [openapi](https://api.sandbox.paywint.com/openapi.json)