Type Alias NSWGovPayPayment

Type declaration

• paymentTransaction: {
      agencyCompletionPayment?: {
          accountToken?: string;
          agencyTransactionId: string;
          amount: number;
          bankReference: string;
          bPay?: { billerCode: string; crn: string; processingDate: string };
          card?: { cardPresent: boolean; cardType: string; last4Digits: string };
          emailAddress?: string;
          paymentCompletionReference: string;
          paymentMethod: "CARD" | "PAYPAL" | "PAYID" | "BPAY";
          paymentReference: string;
          surcharge: number;
          surchargeGst: number;
      };
      integrationPrimaryAgencyId: string;
      nswGovPayPaymentReference: string;
      redirectUrl: string;
  }

  Payment details specific to NSW GovPay payments

  • OptionalagencyCompletionPayment?: {
        accountToken?: string;
        agencyTransactionId: string;
        amount: number;
        bankReference: string;
        bPay?: { billerCode: string; crn: string; processingDate: string };
        card?: { cardPresent: boolean; cardType: string; last4Digits: string };
        emailAddress?: string;
        paymentCompletionReference: string;
        paymentMethod: "CARD" | "PAYPAL" | "PAYID" | "BPAY";
        paymentReference: string;
        surcharge: number;
        surchargeGst: number;
    }

    The fields returned in the payment completion notification, will be undefined until the payment is successfully completed

    • OptionalaccountToken?: string

      Account token for making recurring payment (if it was requested)

    • agencyTransactionId: string

      Transaction ID given to CPP by the agency when the request is made

    • amount: number

      Amount collected

    • bankReference: string

      Reference generated by the gateway for this payment

    • OptionalbPay?: { billerCode: string; crn: string; processingDate: string }

      Only for BPAY payments

      • billerCode: string

        Biller Code for BPAY

      • crn: string

        CRN which was used to make the payment

      • processingDate: string

        Date on which the payment was processed

    • Optionalcard?: { cardPresent: boolean; cardType: string; last4Digits: string }

      Only for card payments

    • OptionalemailAddress?: string

      Email of the customer for PayID and BPAY payments

    • paymentCompletionReference: string

      Receipt Number generated by CPP to confirm successful payment

    • paymentMethod: "CARD" | "PAYPAL" | "PAYID" | "BPAY"

      Payment Method used (CARD, PAYPAL, PAYID, BPAY)

    • paymentReference: string

      Payment Reference shared with the agency

    • surcharge: number

      Surcharge collected

    • surchargeGst: number

      GST collected for the surcharge

  • integrationPrimaryAgencyId: string

    The id of the OneBlink -> NSW_GOV_PAY integration primary agency to be used.

  • nswGovPayPaymentReference: string

    The Payment Reference created when the requesting a payment from NSW GovPay

  • redirectUrl: string

    The URL to redirect the user back to after a payment attempt

• type: NSWGovPaySubmissionEvent["type"]