PayID Examples

This page contains copy-paste ready examples for common PayID Payment Request operations.

Create a PayID Payment Request

Request

POST /paymentrequests
x-api-key: {your-api-key}
Content-Type: application/json

{
  "reference": "HVolqMiv1kikVDL_pqtlMA",
  "externalReference": "INV-0000001",
  "expiryDateTime": "2026-12-31T23:59:59Z",
  "payment": {
    "amount": 1000,
    "description": "Payment for INV-0000001",
    "instrument": {
      "payId": {
        "type": "single",
        "value": "INV-0000001"
      }
    }
  }
}

Response

{
  "reference": "HVolqMiv1kikVDL_pqtlMA",
  "externalReference": "INV-0000001",
  "id": "E1HKfn68Pkms5zsZsvKONwNw",
  "createdDateTime": "2026-01-27T10:15:00Z",
  "updatedDateTime": "2026-01-27T10:15:00Z",
  "expiryDateTime": "2026-12-31T23:59:59Z",
  "paymentRequestStatus": "created",
  "payment": {
    "description": "Payment for INV-0000001",
    "amount": 1000,
    "currencyCode": "AUD",
    "instrument": {
      "payId": {
        "type": "single",
        "email": "INV-0000001@pay.gpaunz.com"
      }
    }
  },
  "result": {
    "mode": "live",
    "status": "ok"
  }
}

Share payment.instrument.payId.email with the customer. They enter this in their banking app to send the payment.

---

Retrieve a PayID Payment Request

Request

GET /paymentrequests/{id}
x-api-key: {your-api-key}

Response — Awaiting Payment

{
  "reference": "HVolqMiv1kikVDL_pqtlMA",
  "externalReference": "INV-0000001",
  "id": "E1HKfn68Pkms5zsZsvKONwNw",
  "createdDateTime": "2026-01-27T10:15:00Z",
  "updatedDateTime": "2026-01-27T10:15:00Z",
  "expiryDateTime": "2026-12-31T23:59:59Z",
  "paymentRequestStatus": "created",
  "payment": {
    "description": "Payment for INV-0000001",
    "amount": 1000,
    "currencyCode": "AUD",
    "instrument": {
      "payId": {
        "type": "single",
        "email": "INV-0000001@pay.gpaunz.com"
      }
    }
  },
  "result": {
    "mode": "live",
    "status": "ok"
  }
}

Response — Payment Completed

{
  "reference": "HVolqMiv1kikVDL_pqtlMA",
  "externalReference": "INV-0000001",
  "id": "E1HKfn68Pkms5zsZsvKONwNw",
  "createdDateTime": "2026-01-27T10:15:00Z",
  "updatedDateTime": "2026-01-27T10:20:00Z",
  "expiryDateTime": "2026-12-31T23:59:59Z",
  "paymentRequestStatus": "completed",
  "payment": {
    "description": "Payment for INV-0000001",
    "amount": 1000,
    "currencyCode": "AUD",
    "instrument": {
      "payId": {
        "type": "single",
        "email": "INV-0000001@pay.gpaunz.com"
      }
    }
  },
  "result": {
    "mode": "live",
    "status": "ok"
  }
}

---

Cancel a PayID Payment Request

Request

PATCH /paymentrequests/{id}
x-api-key: {your-api-key}

{
  "paymentRequestStatus": "cancelled"
}

Response

{
  "reference": "HVolqMiv1kikVDL_pqtlMA",
  "externalReference": "INV-0000001",
  "id": "E1HKfn68Pkms5zsZsvKONwNw",
  "createdDateTime": "2026-01-27T10:15:00Z",
  "updatedDateTime": "2026-01-27T10:20:00Z",
  "expiryDateTime": "2026-12-31T23:59:59Z",
  "paymentRequestStatus": "cancelled",
  "payment": {
    "description": "Payment for INV-0000001",
    "amount": 1000,
    "currencyCode": "AUD",
    "instrument": {
      "payId": {
        "type": "single",
        "email": "INV-0000001@pay.gpaunz.com"
      }
    }
  },
  "result": {
    "mode": "live",
    "status": "ok"
  }
}

---

Refund a PayID Transaction

Request

POST /transactions/{transactionId}/refunds
x-api-key: {your-api-key}
Content-Type: application/json

{
  "reference": "qhTPKI_P8E-EtvuEqCeQ5g",
  "amount": 1000,
  "description": "Full client refund"
}

Response — Refund Initiated

{
  "reference": "qhTPKI_P8E-EtvuEqCeQ5g",
  "id": "w8o8PRBwx02icHwcsLk5Pg",
  "createdDateTime": "2026-07-14T05:20:02Z",
  "updatedDateTime": "2026-07-14T05:20:13Z",
  "originalTransactionId": "TeILBZOOuUGYnUbbBWTuGw",
  "category": {
    "source": "pay_id",
    "method": "refund",
    "frequency": "single"
  },
  "payment": {
    "amount": 1000,
    "currencyCode": "AUD",
    "instrument": {
        "account": {
            "bsb": "820001",
            "number": "XXXXXXX01"
        }
    }
  },
  "result": {
    "mode": "live",
    "status": "pending"
  }
}

The refund status transitions asynchronously via webhook notification (pending → approved).