# Finogates API Documentation

## Docs

- [Generate Token](https://developer.finogates.com/api-reference/authentication/auth-token.md): Exchange client credentials for a short-lived JWT access token.
- [Create Card Request](https://developer.finogates.com/api-reference/cards/create-card-request.md): Creates a new card request for an end user.
- [Freeze or Unfreeze Card](https://developer.finogates.com/api-reference/cards/freeze-or-unfreeze-card.md): Change a card's operational status.
- [Get Card Balance](https://developer.finogates.com/api-reference/cards/get-card-balance.md): Returns the current balance snapshot for a card including available balance, authorization holds, and posted spend.
- [Get Card Detail](https://developer.finogates.com/api-reference/cards/get-card-detail.md): Returns detailed information for a specific card including cardholder name, address, balance, and card metadata.
- [Get Card Request](https://developer.finogates.com/api-reference/cards/get-card-request.md): Retrieve the status of a card request.
- [List Card Transactions](https://developer.finogates.com/api-reference/cards/list-card-transactions.md): Returns a paginated list of transactions for a card, ordered by creation date (newest first).
- [List Cards for User](https://developer.finogates.com/api-reference/cards/list-cards-for-user.md): Returns a paginated list of cards issued to a specific end user.
- [Reload Card](https://developer.finogates.com/api-reference/cards/reload-card.md): Top up a card with funds from the user's primary wallet.
- [Sync Card Transactions](https://developer.finogates.com/api-reference/cards/sync-card-transactions.md): Synchronize card transactions with the card provider and reconcile balances.
- [Transfer Card to Wallet](https://developer.finogates.com/api-reference/cards/transfer-card-to-wallet.md): Transfer funds from a card back to the user's primary wallet.
- [Branches](https://developer.finogates.com/api-reference/international-payouts-payins/branches.md)
- [Catalogue Account Types](https://developer.finogates.com/api-reference/international-payouts-payins/catalogue-account-types.md)
- [Catalogue Business Types](https://developer.finogates.com/api-reference/international-payouts-payins/catalogue-business-types.md)
- [Catalogue Cities](https://developer.finogates.com/api-reference/international-payouts-payins/catalogue-cities.md)
- [Catalogue Countries](https://developer.finogates.com/api-reference/international-payouts-payins/catalogue-countries.md): Return Payout destination countries enabled for the caller's tenant.
- [Catalogue Currencies](https://developer.finogates.com/api-reference/international-payouts-payins/catalogue-currencies.md)
- [Catalogue Document Types](https://developer.finogates.com/api-reference/international-payouts-payins/catalogue-document-types.md)
- [Catalogue States](https://developer.finogates.com/api-reference/international-payouts-payins/catalogue-states.md)
- [Create Beneficiary](https://developer.finogates.com/api-reference/international-payouts-payins/create-beneficiary.md)
- [Create Payin](https://developer.finogates.com/api-reference/international-payouts-payins/create-payin.md)
- [Create Sender](https://developer.finogates.com/api-reference/international-payouts-payins/create-sender.md)
- [List Beneficiaries](https://developer.finogates.com/api-reference/international-payouts-payins/list-beneficiaries.md)
- [List Senders](https://developer.finogates.com/api-reference/international-payouts-payins/list-senders.md)
- [Payer Rules](https://developer.finogates.com/api-reference/international-payouts-payins/payer-rules.md)
- [Payers](https://developer.finogates.com/api-reference/international-payouts-payins/payers.md)
- [Payin Catalogue Countries](https://developer.finogates.com/api-reference/international-payouts-payins/payin-catalogue-countries.md): Return active PayIn countries enabled for the caller's tenant.
- [Payin Catalogue Merchant Countries](https://developer.finogates.com/api-reference/international-payouts-payins/payin-catalogue-merchant-countries.md): Return active merchant countries (origin countries for PayIn).
- [Payin Choose Method](https://developer.finogates.com/api-reference/international-payouts-payins/payin-choose-method.md)
- [Payin Payment Methods](https://developer.finogates.com/api-reference/international-payouts-payins/payin-payment-methods.md)
- [Payin Refund](https://developer.finogates.com/api-reference/international-payouts-payins/payin-refund.md)
- [Payin Status](https://developer.finogates.com/api-reference/international-payouts-payins/payin-status.md)
- [Payout Status](https://developer.finogates.com/api-reference/international-payouts-payins/payout-status.md)
- [Process Payout](https://developer.finogates.com/api-reference/international-payouts-payins/process-payout.md): **Deprecated** — use ``POST /v1/tenant/international/payouts`` instead.
- [Rates](https://developer.finogates.com/api-reference/international-payouts-payins/rates.md)
- [Retry Payout](https://developer.finogates.com/api-reference/international-payouts-payins/retry-payout.md)
- [Archive Payee](https://developer.finogates.com/api-reference/payees/archive-payee.md)
- [Create Destination](https://developer.finogates.com/api-reference/payees/create-destination.md)
- [Create Payee](https://developer.finogates.com/api-reference/payees/create-payee.md)
- [Get Payee](https://developer.finogates.com/api-reference/payees/get-payee.md)
- [List Destinations](https://developer.finogates.com/api-reference/payees/list-destinations.md)
- [List Payees](https://developer.finogates.com/api-reference/payees/list-payees.md)
- [Revoke Destination](https://developer.finogates.com/api-reference/payees/revoke-destination.md)
- [Update Payee](https://developer.finogates.com/api-reference/payees/update-payee.md)
- [Add Bank Account](https://developer.finogates.com/api-reference/payments-methods/add-bank-account.md): Register a bank account as a payment method for a user.
- [Add Card](https://developer.finogates.com/api-reference/payments-methods/add-card.md): Register a card as a payment method for a user.
- [List Bank Payment Methods](https://developer.finogates.com/api-reference/payments-methods/list-bank-payment-methods.md): Returns only **bank account** payment methods for a user.
- [List Card Payment Methods](https://developer.finogates.com/api-reference/payments-methods/list-card-payment-methods.md): Returns only **card** payment methods for a user.
- [List Payment Methods](https://developer.finogates.com/api-reference/payments-methods/list-payment-methods.md): Returns all payment methods (bank accounts and cards) for a user.
- [Remove Payment Method](https://developer.finogates.com/api-reference/payments-methods/remove-payment-method.md): Disables a payment method so it can no longer be used for transactions.
- [Create Payment](https://developer.finogates.com/api-reference/payments/create-payment.md): Submit a payment on the platform — creates the intent **and** executes it against the resolved provider in a single call (one-shot submit).
- [Get Payment](https://developer.finogates.com/api-reference/payments/get-payment.md): Returns details for a single payment identified by its UUID.
- [List Payments](https://developer.finogates.com/api-reference/payments/list-payments.md): Returns a paginated list of payments belonging to the authenticated platform.
- [Evaluate ACH Risk via Plaid Signal](https://developer.finogates.com/api-reference/plaid-bank-linking/evaluate-ach-risk-via-plaid-signal.md): Evaluates the risk of an ACH transaction using Plaid Signal.
- [Exchange Plaid Public Token](https://developer.finogates.com/api-reference/plaid-bank-linking/exchange-plaid-public-token.md): Exchanges a one-time Plaid public_token (returned by Plaid Link after the user selects a bank) for permanent bank account records.
- [Generate Plaid Link Token](https://developer.finogates.com/api-reference/plaid-bank-linking/generate-plaid-link-token.md): Generates a Plaid Link token that the platform's frontend uses to open the Plaid bank-selection UI for an end user.
- [Get Plaid Account Balances](https://developer.finogates.com/api-reference/plaid-bank-linking/get-plaid-account-balances.md): Fetches real-time account balances for a Plaid-linked bank account.
- [Get Plaid Account Identity](https://developer.finogates.com/api-reference/plaid-bank-linking/get-plaid-account-identity.md): Fetches account holder identity information for a Plaid-linked bank account.
- [List Users](https://developer.finogates.com/api-reference/users/create-user.md): Creates a new user account on the platform.
- [Delete User](https://developer.finogates.com/api-reference/users/delete-user.md): Soft-deletes an end user by marking their tenant membership as deleted.
- [Get User](https://developer.finogates.com/api-reference/users/get-user.md): Returns details for a single user identified by their UUID.
- [List Users](https://developer.finogates.com/api-reference/users/list-users.md): Returns a paginated list of end users belonging to the authenticated platform.
- [Create or Resume KYC Inquiry](https://developer.finogates.com/api-reference/verification/create-or-resume-kyc-inq.md): Retrieve a verification link to initiate or resume identity verification for a specific user.
- [Get KYC Status](https://developer.finogates.com/api-reference/verification/get-kyb-status.md): Returns all KYB compliance checks for a user, ordered by most recent first.
- [Get KYC Status](https://developer.finogates.com/api-reference/verification/get-kyc-status.md): Returns all KYC compliance checks for a user, ordered by most recent first.
- [Submit KYB Check](https://developer.finogates.com/api-reference/verification/submit-kyb.md): Submits a KYB (Know Your Business) compliance check for a user.
- [Submit KYC Check](https://developer.finogates.com/api-reference/verification/submit-kyc.md): Submits a KYC (Know Your Customer) compliance check for an end user.
- [Sync KYC Check with Persona](https://developer.finogates.com/api-reference/verification/sync-kyc-with-persona.md): Force-sync a KYC check's status with the Persona API.
- [Get Wallet](https://developer.finogates.com/api-reference/wallets/get-wallet.md): Returns the primary wallet for a user, including real-time balance breakdown.
- [Get Wallet Activity](https://developer.finogates.com/api-reference/wallets/get-wallet-activity.md): Returns the transaction activity for a user's primary wallet.
- [Create Webhook](https://developer.finogates.com/api-reference/webhooks/create-webhook.md): Creates a new webhook endpoint for the authenticated platform.
- [Delete Webhook](https://developer.finogates.com/api-reference/webhooks/delete-webhook.md): Deactivates a webhook endpoint identified by its UUID.
- [List Webhook Event Types](https://developer.finogates.com/api-reference/webhooks/list-webhook-event-types.md): Returns available webhook event groups and their individual event types.
- [List Webhooks](https://developer.finogates.com/api-reference/webhooks/list-webhooks.md): Returns a paginated list of webhook endpoints belonging to the authenticated platform.
- [Replay Failed Webhook Deliveries](https://developer.finogates.com/api-reference/webhooks/replay-failed-webhook-deliveries.md): Replays failed webhook deliveries for the authenticated platform.
- [Authentication](https://developer.finogates.com/get-started/authentication.md): Authenticate requests to the Finogates API using API keys.
- [Dashboards](https://developer.finogates.com/get-started/dashboards.md): We offer Sandbox and Production dashboards to streamline your development and go-live process.
- [Environments](https://developer.finogates.com/get-started/environments.md): Accelerate your development cycle using Finogates’s separate environments for testing and live deployment.
- [Overview](https://developer.finogates.com/get-started/overview.md): Build secure, scalable payment workflows using the finogates API.
- [Quickstart](https://developer.finogates.com/get-started/quickstart.md): Start building with the Finogates API — from user creation to payments.
- [Basic URL Requirements](https://developer.finogates.com/guidelines/url-standards/basic-requirements.md): Core rules every document URL must follow before being submitted to Finogates APIs.
- [Cloud Storage Guidelines](https://developer.finogates.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.finogates.com/guidelines/url-standards/examples.md): Examples of URLs that pass and fail Finogates's URL validation checks.
- [File Requirements](https://developer.finogates.com/guidelines/url-standards/file-rules.md): File size, type, and validation rules for uploaded documents.
- [URL Standards Overview](https://developer.finogates.com/guidelines/url-standards/overview.md): Overview of URL requirements and validation rules for submitting documents through the Finogates API.
- [Security Rules](https://developer.finogates.com/guidelines/url-standards/security-rules.md): Security restrictions for document URLs.
- [Troubleshooting URL Issues](https://developer.finogates.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.finogates.com/industry-entity-available-values.md)
- [Event Types](https://developer.finogates.com/webhooks/event-types.md): Complete list of webhook event types sent by Finogates.
- [Events](https://developer.finogates.com/webhooks/events.md): Understand how Finogates webhook events work and what they represent.
- [card.added](https://developer.finogates.com/webhooks/events/card/added.md): Sent when a new card is added by a user.
- [card.images_uploaded](https://developer.finogates.com/webhooks/events/card/images_uploaded.md): Sent when required card images have been successfully uploaded.
- [kyb.approved](https://developer.finogates.com/webhooks/events/kyb/approved.md): Sent when KYB verification is successfully approved.
- [kyb.deleted](https://developer.finogates.com/webhooks/events/kyb/deleted.md): Sent when a business KYB record is deleted or reset.
- [kyb.rejected](https://developer.finogates.com/webhooks/events/kyb/rejected.md): Sent when KYB verification is rejected.
- [kyc.applied](https://developer.finogates.com/webhooks/events/kyc/applied.md): Sent when a user submits KYC details.
- [kyc.approved](https://developer.finogates.com/webhooks/events/kyc/approved.md): Sent when KYC verification is successfully approved.
- [kyc.completed](https://developer.finogates.com/webhooks/events/kyc/completed.md): Sent when the KYC process has completed.
- [kyc.deleted](https://developer.finogates.com/webhooks/events/kyc/deleted.md): Sent when a user's KYC record is deleted or reset.
- [kyc.failed](https://developer.finogates.com/webhooks/events/kyc/failed.md): Sent when the KYC process fails due to an unrecoverable error.
- [kyc.rejected](https://developer.finogates.com/webhooks/events/kyc/rejected.md): Sent when KYC verification is rejected.
- [payment.failed](https://developer.finogates.com/webhooks/events/payment/failed.md): Sent when a payment fails.
- [payment.fee_refunded](https://developer.finogates.com/webhooks/events/payment/fee-refunded.md): Sent when a payment fee has been successfully refunded.
- [payment.initiated](https://developer.finogates.com/webhooks/events/payment/initiated.md): Sent when a payment attempt is initiated.
- [payment.mailed](https://developer.finogates.com/webhooks/events/payment/mailed.md): Sent when a check payment has been mailed.
- [payment.opened](https://developer.finogates.com/webhooks/events/payment/opened.md): Sent when a payment is created and awaiting further action.
- [payment.processing](https://developer.finogates.com/webhooks/events/payment/processing.md): Sent when a payment is being processed.
- [payment.refund](https://developer.finogates.com/webhooks/events/payment/refunded.md): Sent when a payment amount is successfully refunded.
- [payment.rejected](https://developer.finogates.com/webhooks/events/payment/rejected.md): Sent when a payment is rejected before processing begins.
- [payment.settling](https://developer.finogates.com/webhooks/events/payment/settling.md): Sent when a payment is in the process of being settled.
- [payment.success](https://developer.finogates.com/webhooks/events/payment/success.md): Sent when a payment is successfully completed.
- [wallet.funding.failed](https://developer.finogates.com/webhooks/events/wallet-funding/failed.md): Sent when a wallet funding request fails.
- [wallet.funding.initiated](https://developer.finogates.com/webhooks/events/wallet-funding/initiated.md): Sent when a wallet funding request is initiated.
- [wallet.funding.processing](https://developer.finogates.com/webhooks/events/wallet-funding/processing.md): Sent when a wallet funding request enters processing.
- [wallet.funding.rejected](https://developer.finogates.com/webhooks/events/wallet-funding/rejected.md): Sent when a wallet funding request is rejected.
- [wallet.funding.success](https://developer.finogates.com/webhooks/events/wallet-funding/success.md): Sent when a wallet funding request completes successfully.
- [wallet.withdrawal.failed](https://developer.finogates.com/webhooks/events/wallet-withdrawal/failed.md): Sent when a wallet withdrawal request fails.
- [wallet.withdrawal.initiated](https://developer.finogates.com/webhooks/events/wallet-withdrawal/initiated.md): Sent when a wallet withdrawal request is initiated.
- [wallet.withdrawal.processing](https://developer.finogates.com/webhooks/events/wallet-withdrawal/processing.md): Sent when a wallet withdrawal enters processing.
- [wallet.withdrawal.rejected](https://developer.finogates.com/webhooks/events/wallet-withdrawal/rejected.md): Sent when a wallet withdrawal request is rejected.
- [wallet.withdrawal.settling](https://developer.finogates.com/webhooks/events/wallet-withdrawal/settling.md): Sent when a wallet withdrawal enters the settling phase.
- [wallet.withdrawal.success](https://developer.finogates.com/webhooks/events/wallet-withdrawal/success.md): Sent when a wallet withdrawal completes successfully.
- [Overview](https://developer.finogates.com/webhooks/overview.md): Learn how Finogates uses webhooks to deliver real-time event notifications.
- [Retry Behavior](https://developer.finogates.com/webhooks/retry-behavior.md): Understand Finogates webhook delivery and retry logic.
- [Webhook Setup](https://developer.finogates.com/webhooks/setup.md): Configure webhook URLs in Sandbox and Production environments.
- [Webhook Signature Verification](https://developer.finogates.com/webhooks/signature-verification.md): Verify that incoming webhooks are securely sent by Finogates using HMAC-SHA256 signatures.
- [Webhook Responses](https://developer.finogates.com/webhooks/webhook-response.md): Learn how to receive and handle Finogates webhook events.

## OpenAPI Specs

- [openapi-platform](https://api-sandbox.fg.wintpay.com/openapi-platform.json)
- [openapi](https://developer.finogates.com/api-reference/openapi.json)