One interface for every
Iranian payment gateway

Why

Payment code should outlive the payment provider.

Quick start

Create the payment, send the payer, verify what comes back.

// 1. Initialise once, with the settings shared by the application.
pv := payvand.Init(payvand.WithTimeout(20 * time.Second))

// 2. Build the gateway of the terminal you charge on.
gw, err := pv.Gateway(payvand.Zarinpal, payvand.Config{
    MerchantKey: merchantID,
})

// 3. Create the payment and send the payer to the bank.
purchase, err := gw.Purchase(ctx, payvand.PurchaseRequest{
    Amount:      payvand.Toman(15_000),
    OrderID:     "1001",
    CallbackURL: "https://shop.example/payments/callback",
})
purchase.Redirect.Send(w, r)  // 303, or an auto-posting form — the gateway decides

// 4. The payer returns. This handler never changes when the provider does.
cb, err := gw.ParseCallback(r)
if err != nil || !cb.Succeeded {
    http.Error(w, "payment canceled", http.StatusPaymentRequired)
    return
}

order := orders.ByToken(cb.Token)

// The amount comes from your records, never from the browser.
verified, err := gw.Verify(ctx, cb.VerifyRequest(order.Amount))

Swapping payvand.Zarinpal for payvand.Mellat, payvand.Parsian or payvand.Virtual changes the first call and nothing else. Full guide →

Supported gateways

All twenty-five are implemented and covered by tests.

— means the provider offers no such API to merchants; the call returns ErrNotSupported and Capabilities() says so up front.

The flow

Identical for every provider, including the ones that need an extra settlement call.

1. Purchase — the provider issues a token; persist it next to the order.
2. Redirect — Redirect.Send emits a 303 or an auto-submitting form, whichever the bank requires.
3. Callback — ParseCallback normalises whatever the bank posts or appends.
4. Verify — mandatory: an unverified transaction is reversed by most Iranian gateways. Mellat, AsanPardakht, Vandar and Pasargad need several calls here, and Payvand makes them for you.
5. Refund or inquiry — where the provider supports them, behind the same interface.

Documentation

Guides in the wiki, the full reference on pkg.go.dev.