Getting Started/Authentication

Authentication

Kuickpay uses header-based authentication across all APIs. The exact headers depend on your integration type. There is no OAuth flow or token exchange — credentials are passed directly on each request.

All requests must use HTTPS. HTTP requests will be rejected. Additionally, your server IP must be whitelisted in the Business Portal — a request from an unknown IP returns HTTP 401 regardless of correct credentials.

Institution — End-to-End

Kuickpay calls your APIs. You authenticate incoming requests from Kuickpay using username and password in the HTTP headers.

usernameYour API username — provided during institution onboarding.

passwordYour API password — provided during institution onboarding.

POST /api/v1/BillInquiry HTTP/1.1
Host: api.yourcompany.com
username: your_api_username
password: your_api_password
Content-Type: application/json

You supply these credentials to Kuickpay. Kuickpay sends them on every Bill Inquiry and Bill Payment call to your endpoint.

Institution — Hybrid

You call Kuickpay's APIs. Authenticate using X-API-KEY and IN-ID headers, obtained from the Kuickpay Business Portal.

X-API-KEYYour institution API key from the Business Portal.

IN-IDYour Institution Initiator ID from the Business Portal.

POST /api/insertPPMVoucher HTTP/1.1
Host: uat-adminapi.kuickpay.com
X-API-KEY: your_api_key
IN-ID: your_initiator_id
Content-Type: application/json

Get your X-API-KEY and IN-ID from business.kuickpay.com. Pass them on every request to https://uat-adminapi.kuickpay.com.

Bill Initiators

You call Kuickpay's V3 APIs. Authenticate using X-API-KEY and IN-ID headers from the Business Portal.

X-API-KEYYour Bill Initiator API key from the Business Portal.

IN-IDYour Bill Initiator ID from the Business Portal.

POST /api/BillInquiryV3 HTTP/1.1
Host: sandbox-kpcore.kuickpay.com
X-API-KEY: your_api_key
IN-ID: your_initiator_id
Content-Type: application/json

Get your credentials from business.kuickpay.com. Pass them on every request to https://sandbox-kpcore.kuickpay.com.

401 Unauthorized — Causes

✕Incorrect X-API-KEY or IN-ID header value

✕Request originating from an IP not whitelisted in the Business Portal

✕Header is missing or misspelled (e.g. X-Api-Key instead of X-API-KEY)

✕Account disabled or suspended