Partner Lead API

The Partner Lead API lets software partners create merchant leads programmatically, so a prospective merchant can be referred and onboarded without leaving your application. It exists to streamline partner-driven acquisition by capturing the business and contact details up front and, where supported, returning a self-serve signup URL the merchant can use to complete their application.

Use the Partner Lead API when you want a single server-to-server call that registers a lead against your partner configuration, validates the submitted details, and returns a lead identifier you can track through to conversion.

Requirements

Before You Start

To integrate the Partner Lead API, you need:

• Server-side access to the API — calls are authenticated with your API Key and must be made from your backend, never the browser.
• A configured partner — the software you submit must match a partner configuration provisioned during onboarding (for example, ACME).
• A price tier code — provided during onboarding and supplied on every lead.

Authentication

All requests are authenticated with your API Key, passed in the x-api-key header. A unique x-idempotency-key is required on each create request to safely prevent duplicate submissions.

Header	Required	Description
x-api-key	Yes	Your unique API Key to authenticate against the API.
x-idempotency-key	Yes	A unique value used to ensure idempotency and prevent retries of the same request.

Endpoints

Environment	Base URL
Sandbox	https://sandbox.api.gpaunz.com
Production	https://api.gpaunz.com

Integration Summary

Integrating the Partner Lead API involves one main step.

Steps (quick reference)

Step	Where	What	API	Output
1	Backend	Create a Lead	POST https://sandbox.api.gpaunz.com/leads	id, csaUrl

For the full step-by-step integration, request/response examples, and error handling, see the Integration Guide: Partner Lead API Integration.

Request Fields

Field	Required	Type	Notes
reference	Yes	string	Your own unique reference for the lead. Must be unique; a duplicate is rejected.
externalReference	No	string	Your external reference (e.g. an invoice number) stored against the lead.
firstName	No	string	Contact first name. Max 40 characters.
lastName	Yes	string	Contact last name. Max 40 characters.
phoneNumber	Yes	string	Contact phone number. Validated against the format for the supplied country.
company	Yes	string	Business name. Max 255 characters.
email	Yes	string	Contact email address.
country	Yes	string	australia or new_zealand.
postcode	No	string	Business postcode.
priceTierCode	Yes	string	The price tier code provided during onboarding. Max 255 characters.
servicesRequested	Yes	string[]	One or more requested services. See Services.
businessRegistration	No	object	Business registration { value, type }. See Business Registration.
website	No	string	Business website URL.
software	Yes	string	The partner/software name, must match a configured partner (e.g. ACME).

Services

servicesRequested accepts one or more of the following values.

Value	Description
direct_debit	Direct Debit
ecommerce	eCommerce
bpay	BPAY
online_payments	Online Payments
eftpos	EFTPOS

Business Registration

businessRegistration is optional. When supplied, the value is validated against the digit length for the given type.

Type	Description	Expected length
abn	Australian Business Number	11 digits
nzbn	New Zealand Business Number	13 digits
acn	Australian Company Number	9 digits

Response Overview

A successful create returns the lead id along with a result object indicating the status. When the lead qualifies for self-serve onboarding, a csaUrl is returned that the merchant can use to complete their signup.

For the full response shape, error codes, and worked examples, see Partner Lead API Integration.

Quick links

• Integration Guide: Partner Lead API Integration
• Interactive reference: OpenAPI Reference
• Result object: Result Object