BPAY Flow

Steps

To accept a BPAY payment, create a payment request with the bpay payment instrument. The response includes a BPAY Biller Code and Customer Reference Number (CRN). Provide these details to the customer, who submits the payment through their participating financial institution.

Our domains for different environments:

• Sandbox URL: https://sandbox.api.gpaunz.com
• Production URL: https://api.gpaunz.com

Step 1: Create Payment Request

Endpoint: POST /paymentrequests For complete field documentation, see Create a Payment Request.

Request fields:

Field	Required	Note
Reference	N	Your own unique reference. When left blank, a reference will be generated and returned by the gateway.
externalReference	N	Your own external reference. An optional non-unique identifier that can be used to aggregate resources when querying.
payment.currencyCode	N	The three letter ISO Currency Code. Default is AUD
payment.description	N	A brief description of the payment.
payment.instrument.bpay.type	Y	The type of BPAY payment. Only static BPAY payments are supported.

Example Request:

{
    "reference": "2ca4a84c-57fe-1b5f-f30b-76b5",
    "externalReference": "INV-0000001",
    "payment": {
        "currencyCode": "AUD",
        "description": "This is a bpay payment request for INV-0000001",
        "instrument": {
            "bpay": {
                "type": "static"
            }
        }
    }
}

Minimal Request:

{
    "payment": {
        "instrument": {
            "bpay": {
                "type": "static"
            }
        }
    }
}

Response:

{
    "id": "wz00LY2w1kSmTcy9d_63ag",
    "reference": "2ca4a84c-57fe-1b5f-f30b-76b5",
    "externalReference": "INV-0000001",
    "createdDateTime": "2026-09-16T08:00:00Z",
    "updatedDateTime": "2026-09-16T08:00:01Z",
    "paymentRequestStatus": "created",
    "payment": {
        "description": "This is a bpay payment request for INV-0000001",
        "currencyCode": "AUD",
        "instrument": {
            "bpay": {
                "customerReferenceNumber": "876045099787810",
                "billerCode": "197715"
            }
        }
    },
    "result": {
        "status": "ok"
    }
}

Step 2: Provide the Biller Code and Customer Reference Number (CRN) to the Customer

Provide the returned Biller Code and CRN on the customer’s invoice or payment instructions. The customer uses these details to submit the payment through their online or mobile banking service.

Step 3: Monitor Payment Processing and Settlement

BPAY is not a real-time payment method. After the transaction has been settled, a notification will be sent to merchant via a webhook confirming the transaction is completed.

Retrieve Transaction

Transaction can be queried using transaction id, see Retrieve Transaction by Transaction Id.

Endpoint: GET /transactions/{id} Example Response:

{
    "id": "fmX9J8E8GE2bcMPRbkrWRg",
    "reference": "UnftwjiU0E2dO_m8WFB8kQ",
    "externalReference": "INV-0000001",
    "createdDateTime": "2026-09-17T08:00:46Z",
    "updatedDateTime": "2026-09-17T08:00:46Z",
    "category": {
        "source": "bpay"
    },
    "payment": {
        "amount": 522,
        "currencyCode": "AUD",
        "instrument": {
            "bpay": {
                "customerReferenceNumber": "876045099787810",
                "billerCode": "197715"
            }
        }
    },
    "result": {
        "status": "approved"
    }
}

Query Transaction

Transactions can be queried using the standard parameters, and the Payment Request Id. See Query Transactions

Endpoint: GET /transactions?from={start_datetime}&to={end_datetime}&paymentrequestid={payment_request_id}

Example request path: /transactions?From=2026-09-16T00:00:00Z&To=2026-09-18T00:00:00Z&paymentrequestid=wz00LY2w1kSmTcy9d_63ag

Example response:

{
    "count": 1,
    "transactions": [
        {
            "id": "fmX9J8E8GE2bcMPRbkrWRg",
            "reference": "UnftwjiU0E2dO_m8WFB8kQ",
            "externalReference": "INV-0000001",
            "createdDateTime": "2026-09-17T08:00:46Z",
            "updatedDateTime": "2026-09-17T08:00:46Z",
            "category": {
                "source": "bpay"
            },
            "payment": {
                "amount": 522,
                "currencyCode": "AUD",
                "instrument": {
                    "bpay": {
                        "billerCode": "197715",
                        "customerReferenceNumber": "876045099787810"
                    }
                }
            },
            "result": {
                "status": "approved"
            }
        }
    ],
    "result": {
        "status": "ok"
    }
}

Reports

Once the payment is processed and settled, the transaction will also be displayed in the report. See Create a Report.

Example transaction report content:

"Id","Created Date Time","Updated Date Time","Original Transaction Id","Category Source","Category Method","Category Origin","Category Frequency","Category Capture Type","Category Authorisation Type","Reference","External Reference","Payment Terminal Id","Payment Amount","Payment Tip Amount","Payment Surcharge Amount","Payment Total Amount","Payment Currency Code","Payment Instrument Customer Id","Payment Instrument Customer Payment Instrument Id","Payment Instrument Card Name","Payment Instrument Card Last4","Payment Instrument Card CardType","Payment Instrument Card Expiry Month","Payment Instrument Card Expiry Year","Payment Instrument Bpay Biller Code","Payment Instrument Bpay Customer Reference Number","Result Codes","Result Status"
"fmX9J8E8GE2bcMPRbkrWRg","2026-09-16T07:09:46Z","2026-09-16T07:09:46Z",,"bpay",,,,,,"UnftwjiU0E2dO_m8WFB8kQ","INV-0000001",,"5.22",,,,"AUD",,,,,,,,"197715","876045099787810",,"approved"

Example settlement report content:

"Payment Date","Transaction ID","Reference","Amount","Transaction Type","Settlement Date"
"2026-09-16T07:09:46Z","fmX9J8E8GE2bcMPRbkrWRg","UnftwjiU0E2dO_m8WFB8kQ","5.22","bpay","2026-09-16T07:09:49Z"
"2026-09-16T07:09:46Z","fmX9J8E8GE2bcMPRbkrWRg","UnftwjiU0E2dO_m8WFB8kQ","-0.05","fee","2026-09-16T07:09:49Z"