Onboarding & registration
Registration is a short exchange with the Quikkred integration team. Here is the complete list — gather these before your kickoff call and onboarding typically completes the same day.
What you provide
1. Organisation identity
| Item | Notes |
|---|---|
| Organisation code | Short uppercase identifier (e.g. LENDER_X). Immutable — it tags every case, payment, and event of yours. |
| Display name & short name | Shown to borrowers in the partner app and on receipts. |
| Logo (PNG/SVG) + brand colour | Borrower-facing screens re-skin per lender. |
| Registered address & support phone | Printed on receipts. |
2. Compliance
| Item | Notes |
|---|---|
| RBI regulatory disclosure text | The fair-practices line printed on every borrower receipt, e.g. "Payment collected by Quikkred Financial Services on behalf of <you> for loan {{loan}}." Have your legal team approve the wording. |
| Receipt footer note (optional) | Refund/dispute contact wording. |
3. Technical
| Item | Notes |
|---|---|
| Integration mode | Push / pull / CSV — see integration paths. |
| Webhook endpoint | One HTTPS URL. Plus which event types you want (default: money + terminal events). |
| Payment mode + artefacts | Mode A: static QR image, UPI ID, bank details. Mode B: your mint-link API spec + auth header. |
| (Pull mode) your read API | URL, auth header we should send, desired schedule. |
| (Optional) IP allowlist | Restrict your API keys to your egress IPs. |
| Technical contact | Email + phone — receives delivery-failure alerts and coordinates key rotation. |
What you receive
| Item | Notes |
|---|---|
| Sandbox credentials | apiKeyId (e.g. pk_yourorg_test_…) + HMAC secret — delivered over a secure channel, shown once. Work only against the sandbox host. |
| Production credentials | Issued after the go-live checklist passes. Live keys work only against production. |
| Base URLs | Sandbox: https://alpha-gig.quikkred.in (test keys) · Production: https://gig.quikkred.in (live keys, after go-live). |
| This documentation + OpenAPI spec | The spec is also served by the API itself at GET /api/v1/partner/openapi.json. |
| The reference implementation | Runnable example of every contract. |
Credentials are shown once
The HMAC secret cannot be re-displayed — store it in your secrets manager on receipt. If lost, request a rotation: a new secret is issued while the old one keeps working until you confirm cutover (key security).