Gateway PayIn API Reference (v3)

The v3 Gateway PayIn API lets you generate hosted checkout links that customers complete in their browser. You call GET /v3/payin_methods to retrieve available payment methods, then POST /v3/payin_links to create a payment link. Redirect your customer to the returned payment_link URL — Hello Clever handles the checkout UI. Status changes are delivered to your webhook endpoint.

All v3 endpoints require app-id and secret-key headers. See Authentication for details.

Endpoints

GET /v3/payin_methods — Get PayIn Methods

Retrieve all available payment methods for a given currency and country.

app-id

string

required

Your application ID from the Merchant Portal.

secret-key

string

required

Your secret key from the Merchant Portal.

currency

string

required

ISO 4217 currency code (e.g. AUD, USD, SGD).

country

string

ISO 3166-1 alpha-2 country code to filter methods by country.

curl https://api.helloclever.co/v3/payin_methods \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key" \
  -G --data-urlencode "currency=AUD"

{
  "data": [
    {
      "method": "payid",
      "name": "PayID",
      "currencies": ["AUD"],
      "required_fields": ["email", "amount"]
    },
    {
      "method": "card",
      "name": "Credit / Debit Card",
      "currencies": ["AUD", "USD"],
      "required_fields": ["amount", "return_url"]
    }
  ]
}

POST /v3/payin_links — Create PayIn

Generate a hosted checkout link for the customer to complete payment.

app-id

string

required

Your application ID.

secret-key

string

required

Your secret key.

method

string

required

Payment method from GET /v3/payin_methods (e.g. payid, card).

amount

number

required

Payment amount in the smallest currency unit (e.g. cents for AUD).

currency

string

required

ISO 4217 currency code.

external_id

string

required

Your internal reference ID for the payment.

return_url

string

required

URL to redirect the customer after payment completes or fails.

sender_name

string

Customer’s name.

sender_email

string

Customer’s email address.

webhook_notification

object

Optional. Override the default webhook endpoint for this payment.

Show webhook_notification fields

endpoint_url

string

URL to receive webhook events for this payment.

authorization_header

string

Optional authorization header value sent with each webhook.

curl -X POST https://api.helloclever.co/v3/payin_links \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "card",
    "amount": 5000,
    "currency": "AUD",
    "external_id": "order-123",
    "return_url": "https://yourstore.com/thank-you",
    "sender_name": "Jane Smith",
    "sender_email": "jane@example.com"
  }'

{
  "uuid": "QVABPPC7",
  "payment_link": "https://checkout.helloclever.co/pay/QVABPPC7",
  "status": "pending",
  "amount": "50.00",
  "currency": "AUD",
  "external_id": "order-123",
  "expired_at": "2026-04-18T10:00:00Z"
}

Redirect your customer to payment_link. Hello Clever sends a webhook when the status changes.

GET /v3/payin_links/ — Get PayIn Details

Retrieve the current status and details of a specific payment.

uuid

string

required

The payment UUID returned by Create PayIn.

curl https://api.helloclever.co/v3/payin_links/QVABPPC7 \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key"

{
  "uuid": "QVABPPC7",
  "status": "received",
  "amount": "50.00",
  "paid_amount": "50.00",
  "currency": "AUD",
  "external_id": "order-123"
}

GET /v3/payin_links — List PayIns

List payment links within a date range.

from_date

string

required

Start date in ISO 8601 format (e.g. 2026-01-01).

to_date

string

required

End date in ISO 8601 format.

status

string

Filter by payment status (e.g. received, pending, failed).

page

integer

Page number for pagination. Defaults to 1.

curl "https://api.helloclever.co/v3/payin_links?from_date=2026-04-01&to_date=2026-04-17" \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key"

POST /v3/payin_links//refund — Refund PayIn

Issue a full or partial refund for a completed payment.

uuid

string

required

The payment UUID to refund.

amount

number

required

Refund amount. Must not exceed the original paid amount.

description

string

Reason for the refund (included in webhook and merchant records).

curl -X POST https://api.helloclever.co/v3/payin_links/QVABPPC7/refund \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{"amount": 5000, "description": "Customer requested refund"}'

{
  "uuid": "QVABPPC7",
  "status": "return_pending",
  "refund_amount": "50.00"
}

Subscribe to return_received and return_rejected webhook events to track refund outcomes. See Webhooks for the full status reference.

Overview

Payment Gateway (AUD)

Multi-currency Payment APIs

Multi-currency Gateway

Card API

Cashback API

Gateway PayIn API Reference (v3)

Endpoints

GET /v3/payin_methods — Get PayIn Methods

POST /v3/payin_links — Create PayIn

GET /v3/payin_links/ — Get PayIn Details

GET /v3/payin_links — List PayIns

POST /v3/payin_links//refund — Refund PayIn

​Endpoints

​GET /v3/payin_methods — Get PayIn Methods

​POST /v3/payin_links — Create PayIn

​GET /v3/payin_links/ — Get PayIn Details

​GET /v3/payin_links — List PayIns

​POST /v3/payin_links//refund — Refund PayIn

Endpoints

GET /v3/payin_methods — Get PayIn Methods

POST /v3/payin_links — Create PayIn

GET /v3/payin_links/ — Get PayIn Details

GET /v3/payin_links — List PayIns

POST /v3/payin_links//refund — Refund PayIn