# Revaly Documentation

> Documentation for Revaly

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Overview](https://docs.revaly.co/docs/overview.md): Engineering payments that perform to prevent declines, protect revenue, and power growth.
- [Integration Overview](https://docs.revaly.co/docs/integration-overview.md): Learn about the integration methods that connect your CRM with Revaly’s Payment Performance Management platform.
- [Enterprise](https://docs.revaly.co/docs/enterprise-2.md): Integrating Revaly into your payment flow to improve authorization outcomes and payment performance
- [Enterprise with Scheduler](https://docs.revaly.co/docs/enterprise-with-scheduler.md)
- [Quick Start Recovery](https://docs.revaly.co/docs/quick-start-recovery.md): Leverage Revaly’s Payment Performance platform using batch file uploads via SFTP to optimize transaction recovery and streamline processing.
- [Migrate to API v2.0](https://docs.revaly.co/docs/migrate-to-api-v20.md)
- [Pagination](https://docs.revaly.co/docs/pagination-1.md)
- [Sandbox Guide](https://docs.revaly.co/docs/sandbox-guide.md): Step-by-step instructions for simulating transactions and validating your integration with Revaly
- [Test Cards](https://docs.revaly.co/docs/testing-guide.md)
- [Project Considerations](https://docs.revaly.co/docs/project-considerations.md)
- [Introduction](https://docs.revaly.co/docs/client-portal-introduction.md): Gain a detailed overview of Revaly’s client portal, covering essential features such as reporting, payment gateway setup, user management, and more.
- [Dashboard](https://docs.revaly.co/docs/dashboard.md): View key metrics that highlight your retained revenue, customer value, and long-term payment performance at a glance.
- [Treatments](https://docs.revaly.co/docs/treatments.md)
- [Total Revaly Value](https://docs.revaly.co/docs/total-revaly-value.md)
- [Customer Retention](https://docs.revaly.co/docs/recovered-customer-retention.md)
- [Repeat Recovery](https://docs.revaly.co/docs/repeat-recovery.md): See how recovery activity is distributed across your customer base and identify patterns that extend beyond a single successful recovery.
- [Data Gap Analysis](https://docs.revaly.co/docs/data-gap-analysis.md): Identify missing payment data, understand its impact on approvals, and prioritize the improvements that can unlock stronger payment performance.
- [Overview](https://docs.revaly.co/docs/reconciliation-overview.md)
- [Batches](https://docs.revaly.co/docs/batches.md)
- [Currencies](https://docs.revaly.co/docs/currencies.md)
- [Gateways](https://docs.revaly.co/docs/gateways.md)
- [Response Codes](https://docs.revaly.co/docs/response-codes-2.md)
- [Transaction Types](https://docs.revaly.co/docs/transaction-types.md)
- [Invoice Reconciliation](https://docs.revaly.co/docs/invoice-reconciliation.md): Track your monthly gross and net recovery totals alongside refunds to validate billing and reconcile invoices with confidence.
- [Transactions](https://docs.revaly.co/docs/transactions-1.md): Search, filter, and analyze all your payment transactions in one place.
- [Customers](https://docs.revaly.co/docs/customers.md): View and search customer records, including their latest transactions and payment details.
- [Exporting Data](https://docs.revaly.co/docs/exporting-reports-transactions.md)
- [Payment Gateways](https://docs.revaly.co/docs/payment-gateways.md): Manage, route, and optimize payments across your connected gateways to maximize approvals.
- [Integrations](https://docs.revaly.co/docs/integrations.md): Manage and configure your API keys for secure access to Revaly’s services.
- [Manage Users](https://docs.revaly.co/docs/manage-users.md): This guide explains how to manage user accounts in Revaly, including adding, updating, disabling, and deleting users.
- [Client Portal Access Setup](https://docs.revaly.co/docs/client-portal-access-setup.md): Guide for configuring user accounts in Revaly, including password resets, and MFA setup.
- [Companies](https://docs.revaly.co/docs/companies.md): Learn how Revaly's Companies feature enables you to segment your data, customize recovery strategies, and streamline reporting across various areas of your business.
- [Configurations](https://docs.revaly.co/docs/platform-configurations.md)
- [Connected CRMs](https://docs.revaly.co/docs/crm-setup-guides.md): Explore the CRMs currently integrated with Revaly
- [Stripe Billing](https://docs.revaly.co/docs/stripe-billing.md)
- [Maxio](https://docs.revaly.co/docs/maxio.md)
- [Recurly](https://docs.revaly.co/docs/recurly.md): Enable Recurly to work with Revaly’s approval engine to optimize subscription payment outcomes.
- [OrderGroove](https://docs.revaly.co/docs/ordergroove.md): Integrate OrderGroove with Revaly to automate failed payment recovery and optimize subscription retention.
- [Zuora](https://docs.revaly.co/docs/zuora.md): Learn how to integrate Zuora with Revaly to optimize subscription payment approvals
- [How to Read Your Invoice](https://docs.revaly.co/docs/how-to-read-your-invoice.md)

## API Reference
- [Introduction](https://docs.revaly.co/reference/introduction.md)
- [Authentication](https://docs.revaly.co/reference/authentication.md)
- [API Health Check](https://docs.revaly.co/reference/api-health-check.md)
- [Response Codes](https://docs.revaly.co/reference/response-codes.md)
- [Supported Gateways](https://docs.revaly.co/reference/supported-gateways.md): Explore Revaly's extensive list of supported payment gateways, complete with integration details, supported operations, and customization options.
- [OpenAPI Specification](https://docs.revaly.co/reference/openapi-specification.md)
- [Webhooks](https://docs.revaly.co/reference/webhooks.md): Learn how Revaly webhooks deliver event notifications to your application.
- [Configure a Webhook Endpoint](https://docs.revaly.co/reference/configure-a-webhook-endpoint.md): Set up a webhook endpoint, subscribe to events, and prepare your integration for production deliveries.
- [Verify Webhook Signatures](https://docs.revaly.co/reference/verify-webhook-signatures.md): Verify that webhook requests originated from Revaly and have not been modified in transit.
- [Webhook Events Reference](https://docs.revaly.co/reference/webhook-events-reference.md): Reference documentation for Revaly webhook event formats, attributes, and supported event types.
- [Delivery & Reliability](https://docs.revaly.co/reference/delivery-reliability.md): Understand webhook delivery behavior, retry policies, and duplicate event handling.
- [Process a payment (charge)](https://docs.revaly.co/reference/chargepayment.md): Process a direct payment charge against a payment method.  This endpoint performs an immediate charge and settlement of funds. Unlike authorization, the funds are immediately captured and transferred.  **Payment Method Types:** - **creditCard**: Process using raw credit card details - **gatewayPaymentMethodId**: Process using an existing gateway payment method id  To charge a previously stored payment method, omit `paymentMethodType` and supply `paymentMethod.paymentMethodId`.
- [Authorize a payment](https://docs.revaly.co/reference/authorizepayment.md): Authorize a payment without immediately capturing funds.  This endpoint creates an authorization hold on the customer's payment method. The authorized amount can later be captured using the capture endpoint.  **Payment Method Types:** - **creditCard**: Process using raw credit card details - **gatewayPaymentMethodId**: Process using an existing gateway payment method id  To charge a previously stored payment method, omit `paymentMethodType` and supply `paymentMethod.paymentMethodId`.
- [Capture an authorized payment](https://docs.revaly.co/reference/capturepayment.md): Capture funds from a previously authorized payment transaction.  This endpoint captures the full or partial amount from an authorization. Once captured, the funds will be settled to your account.
- [Void a payment transaction](https://docs.revaly.co/reference/voidpayment.md): Void (cancel) a payment transaction that has not yet been settled.  This endpoint cancels an authorization or unsettled sale transaction. Voided transactions cannot be captured or refunded.
- [Refund a payment transaction by TransactionId](https://docs.revaly.co/reference/refundpayment.md): Refund a previously settled payment transaction using the Revaly transactionId.  This endpoint processes full or partial refunds for completed payments. Refunded amounts will be returned to the customer's payment method.
- [Refund or cancel a payment transaction by merchant transaction ID](https://docs.revaly.co/reference/refundcancelpaymentbymerchanttransactionid.md): Refund a previously settled payment transaction using Merchant Transaction ID.  This endpoint processes full or partial refunds for completed payments. Refunded amounts will be returned to the customer's payment method.  This endpoint also cancels payments that are currently in the Revaly approvals flow using MerchantTransactionId.
- [Create a payment method](https://docs.revaly.co/reference/createpaymentmethod.md): Create and store a payment method in the vault. Supports both credit card details  and gatewayPaymentMethodIds from supported payment processors.  **Payment Method Types:** - **creditCard**: Credit card details that will be tokenized and stored - **gatewayPaymentMethodId**: Pre-existing gatewayPaymentMethodId from a supported payment gateway
- [List payment methods](https://docs.revaly.co/reference/listpaymentmethods.md): Retrieve a paginated list of stored payment methods.  Returns payment methods with sensitive information masked for security. Use pagination parameters to navigate through large result sets.
- [Get payment method details](https://docs.revaly.co/reference/getpaymentmethod.md): Retrieve detailed information about a specific payment method.  Returns payment method data with sensitive information masked for security.
- [Update payment method](https://docs.revaly.co/reference/updatepaymentmethod.md): Update an existing payment method's information.  Allows updating billing information, expiration dates, and other non-sensitive data. Sensitive card data cannot be updated directly.
- [Redact payment method](https://docs.revaly.co/reference/redactpaymentmethod.md): Redact sensitive payment method information for compliance purposes.  This operation permanently removes sensitive data while keeping the payment method record for historical and reporting purposes. This action cannot be undone.
- [Recache payment method](https://docs.revaly.co/reference/recachepaymentmethod.md): Update a credit card verification value (CVV) so the card can be transacted against
- [List transactions](https://docs.revaly.co/reference/listtransactions.md): Retrieve a paginated list of transactions for the authenticated account.  This endpoint returns transaction data with optional filtering and pagination support. Transactions are returned based on the specified order and count parameters.
- [Get transaction details](https://docs.revaly.co/reference/gettransactionbyid.md): Retrieve detailed information about a specific transaction by its ID.  This endpoint returns complete transaction data including payment method details, gateway response information, recovery data and status of transaction.
- [Get transaction details by merchant transaction ID](https://docs.revaly.co/reference/gettransactionbymerchanttransactionid.md): Retrieve detailed information about a specific transaction by its merchant transaction ID.  This endpoint returns complete transaction data including payment method details, gateway response information, recovery data and status of transaction using the merchant-provided transaction identifier.
- [Notify Revaly of payment events](https://docs.revaly.co/reference/notifyrevaly.md): Notify Revaly of payment-related events and status changes.  This endpoint allows external systems to notify Revaly about specific business events related to payments, refunds, customer recovery, and customer updates.

## Pages
- [8-digit BIN](https://docs.revaly.co/page/extra-info.md)

## Changelog
- [Outreach Repeat Recovery: Spot the customers who keep entering Outreach](https://docs.revaly.co/changelog/spot-the-customers-who-keep-entering-outreach.md)
- [Outreach Pipeline Report: Follow what happened to the customers who entered Outreach](https://docs.revaly.co/changelog/follow-what-happened-to-the-customers-who-entered-outreach.md)
- [Outreach Entry Report: See who entered Outreach, and what they owed](https://docs.revaly.co/changelog/see-who-entered-outreach-and-what-they-owed.md)
- [Webhook Health Report: See whether your webhooks are actually arriving](https://docs.revaly.co/changelog/see-whether-your-webhooks-are-actually-arriving.md)
- [Official Revaly SDKs for six languages](https://docs.revaly.co/changelog/official-revaly-sdks-for-six-languages.md)
- [Faster, more resilient payment processing](https://docs.revaly.co/changelog/faster-more-resilient-payment-processing.md)
- [Approval by Gateway report](https://docs.revaly.co/changelog/approval-by-gateway-report.md)
- [Accurate recovery intake for Maxio (Chargify) carried-balance billing](https://docs.revaly.co/changelog/accurate-recovery-intake-for-maxio-chargify-carried-balance-billing.md)
- [Hosted Fields: secure card vaulting, configured from the Client Portal](https://docs.revaly.co/changelog/hosted-fields-secure-card-vaulting-configured-from-the-client-portal.md)
- [Payment Lineage report in the Client Portal](https://docs.revaly.co/changelog/payment-lineage-report-in-the-client-portal.md)