Customer Payment Option

Customer payment option including payment type, amount, frequency, schedule, and notification method.

bPayDetail object

BPAY details.

billerCodestring

BPAY Biller Code.

billerReferencestring

BPAY Biller Reference.

nextPaymentDatestring<date-time>required

Payment start date.

notificationMethodinteger<int32>required

Notification method used to indicate the communication channel when payment successful or failed.

Enum Value	Description
0	None
1	Sms
2	Email

payIdDetail object

PayID details.

payIdstring

PayID.

payIdNamestring

PayID Name.

referencestring

Reference.

paymentAmountnumber<double>required

Payment amount. Set the default amount for auto payments or amount for one-off payment.

paymentEndDatestring<date-time>

Payment end date.

paymentFrequencyinteger<int32>required

Payment frequency. Applicable to auto pay, email reminder and sms reminder. Returns monthly if frequency is not available.

Enum Value	Description
32	Weekly
33	Fortnightly
34	Quarterly
35	HalfYearly
36	Yearly
37	FourWeeks
38	Monthly

paymentOptioninteger<int32>required

Payment option. Use the correct payment option which is supported by the merchant.

Enum Value	Description
22	AutoPay
23	EmailReminder
24	SmsReminder
25	FixedTerm
26	BatchPay
27	ScheduledPay
28	OneOff
148	PayID
149	BPAY

Customer Payment Option

{
  "bPayDetail": {
    "billerCode": "string",
    "billerReference": "string"
  },
  "nextPaymentDate": "2024-07-29T15:51:28.071Z",
  "notificationMethod": 0,
  "payIdDetail": {
    "payId": "string",
    "payIdName": "string",
    "reference": "string"
  },
  "paymentAmount": 0,
  "paymentEndDate": "2024-07-29T15:51:28.071Z",
  "paymentFrequency": 32,
  "paymentOption": 22
}