Overview

Whether you're building a lightweight checkout or a fully customised payment platform, PayGate offers flexible integration options backed by enterprise-grade security and global payment support.

---

Choose Your Integration

Each API is designed for a specific use case. Use the guide below to determine which integration best suits your needs.

PayWeb3 (Hosted Payment Page)

Best for: Quick integration with minimal PCI scope

• Redirect customers to a secure, PayGate-hosted payment page

• No handling of card data on your server

• Built-in fraud protection and 3D Secure support

• Ideal for merchants who want a fast, low-risk setup

Use PayWeb3 if you want simplicity and speed

---

PayHost (Server-to-Server / Advanced Integration)

Best for: Full control over the payment experience

• Direct API integration using SOAP

• Supports card payments, tokenisation, vaulting, and payouts

• Enables custom checkout flows and backend processing

• Requires handling of sensitive payment data (PCI considerations apply)

Use PayHost if you need flexibility and control

---

PayBatch (Bulk Processing)

Best for: High-volume transaction processing

• Submit batches of transactions (Auth, Settle, Refund)

• Ideal for recurring billing, settlements, or operational workflows

• Uses SOAP with Basic Authentication

• Supports asynchronous processing with confirmation and query steps

Use PayBatch if you manage large-scale or backend-driven payments

---

Security & Compliance

PayGate APIs are designed with security at their core:

• PCI DSS compliant infrastructure

• 3D Secure authentication for cardholder verification

• Tokenisation and vaulting to reduce card data exposure

• Checksum and encryption mechanisms to protect requests

---

Typical Payment Flows

Hosted Flow (PayWeb3)

1. Initiate transaction

2. Redirect customer to PayGate

3. Customer completes payment

4. Receive redirect + notification

sequenceDiagram
    participant Merchant
    participant Customer
    participant PayGate

    Merchant->>PayGate: Initiate Transaction
    PayGate-->>Merchant: PAY_REQUEST_ID + CHECKSUM

    Merchant->>Customer: Redirect to PayGate
    Customer->>PayGate: Enter Payment Details

    PayGate-->>Customer: Payment Result
    PayGate-->>Merchant: Notification (Webhook)

    Customer->>Merchant: Redirect Return

---

Direct API Flow (PayHost)

1. Submit payment request

2. Handle response (Completed / Redirect / Error)

3. Redirect if 3D Secure is required

4. Receive final transaction result

sequenceDiagram
    participant Merchant
    participant Customer
    participant PayGate

    Merchant->>PayGate: Submit Payment Request

    alt Payment Completed
        PayGate-->>Merchant: Completed Response
    else 3D Secure Required
        PayGate-->>Merchant: Redirect Required
        Merchant->>Customer: Redirect to ACS
        Customer->>PayGate: Complete Authentication
        PayGate-->>Merchant: Final Result
    else Error
        PayGate-->>Merchant: Error Response
    end

---

Batch Processing Flow (PayBatch)

1. Submit batch (Auth / Settle / Refund)

2. Receive UploadID

3. Confirm batch

4. Query status or receive notification

sequenceDiagram
    participant Merchant
    participant PayGate

    Merchant->>PayGate: Submit Batch (Auth / Settle / Refund)
    PayGate-->>Merchant: UploadID

    Merchant->>PayGate: Confirm Batch (UploadID)

    alt Processing Complete
        PayGate-->>Merchant: Notification (Webhook)
    else Manual Check
        Merchant->>PayGate: Query (UploadID)
        PayGate-->>Merchant: Batch Status
    end

Test PayBatch SOAP Integration End-to-End

Use this step-by-step guide to test the PayGate PayBatch SOAP API using real-world request flows.

---

Getting Started

To begin integrating:

1. Obtain your PayGate credentials (PayGate ID, Encryption Key, etc.)

2. Choose your preferred API based on your use case

3. Use the sandbox environment to test your integration

4. Follow the Go-live checklist before moving to production

---

Additional Resources

• Transaction Status Codes

• Error Codes

• Payment Method Codes

• Country & Locale Codes