Hipay Integration

Hipay processes card payments and handles refunds. The integration communicates with the Hipay API for transaction management.

Components

Component	File	Role
HipayApi	src/CoreBundle/Api/HipayApi.php	Hipay API client

Configuration

Required parameters in parameters.yml:

hipay:
  api_url: "https://..."
  username: "..."
  password: "..."
  entity: "..."

Data Flow

View diagram source

sequenceDiagram
    participant CUST as Customer
    participant MAG as Magento Checkout
    participant HIP as Hipay API
    participant API as HipayApi
    participant DB as Database

    CUST->>MAG: Submit payment
    MAG->>HIP: Create transaction
    HIP-->>MAG: Payment confirmation
    HIP->>API: Notification callback
    API->>DB: Record transaction

Diagram

Transaction Flow

1. The customer initiates payment through the Magento checkout
2. Magento redirects to or calls the Hipay payment gateway
3. Hipay processes the card transaction
4. A server-to-server notification is sent to Logidav
5. HipayApi validates and records the transaction

Refund Flow

Refunds are initiated from Logidav and processed through the Hipay API:

1. An operator triggers a refund from the back-office
2. HipayApi sends the refund request to Hipay
3. Hipay processes the refund and returns a confirmation
4. The transaction status is updated in the database

Error Handling

Scenario	Behavior
Transaction declined	Status recorded; customer notified via Magento
Notification delivery failure	Hipay retries; Logidav handles idempotently
Refund rejected	Alert raised; operator must review
API timeout	Retry with backoff

Notification URL

Hipay sends transaction notifications to a configured callback URL. Ensure this URL is accessible from Hipay's servers and that the route is properly configured in Logidav.