Refund Service

Overview

The Refund Service helps you track and synchronize refund statuses across payment processors using the PHP SDK. While the Payment Service handles initiating refunds, this service provides dedicated operations for retrieving refund information.

Business Use Cases:

• Refund status tracking - Check the current status of pending refunds to inform customers

• Financial reconciliation - Synchronize refund states with your internal accounting systems

• Webhook processing - Handle asynchronous refund notifications from payment processors

• Customer service - Provide accurate refund status information to support teams

Operations

Operation	Description	Use When
get	Retrieve refund status from the payment processor. Tracks refund progress through processor settlement for accurate customer communication.	Checking refund status, reconciling refund states, customer inquiries

SDK Setup

use HyperswitchPrism\PaymentClient;

$paymentClient = new PaymentClient([
    'connector' => 'stripe',
    'apiKey' => 'YOUR_API_KEY',
    'environment' => 'SANDBOX'
]);

Common Patterns

Refund Status Tracking Flow

Flow Explanation:

1. Initiate refund - First, call the Payment Service's refund method to initiate the refund.

2. Check status - Call the Refund Service's get method with the connectorRefundId.

3. Poll for updates - For refunds that start as PENDING, periodically call get to check for status updates.

Next Steps

• Payment Service - Initiate refunds and process payments

• Dispute Service - Handle chargebacks that may result in refunds

• Event Service - Process asynchronous refund notifications