Add Electronic Biller

post

https://api.sb.spidrsrv.com/v1/billpay/addElectronicBiller

Use /billpay/addElectronicBiller to add an electronic (RPPS) biller to an account. The rppsBillerId must be obtained from the Search Biller Directory endpoint. The account must be active to add a biller.

Body Params

POST /v1/billpay/addElectronicBiller Request body

sessionKey

string

The session key for the user. Created via Create ZTM Session and used for ZTM checks if your program is configured for ZTM.

bypassZtm

boolean

Indicates whether to bypass the ZTM checks if your program is configured for ZTM.

accountId

string

required

The account ID

rppsBillerId

string

required

^\d{10}$

The RPPS biller ID (10 digits)

billerAccountNo

string

required

The biller account number

frequencyType

string

enum

The payment frequency type

Allowed:

nextDate

The next payment date in YYYY-MM-DD format; must be null when frequencyType is ONE_TIME

endDate

The end date for recurring payments in YYYY-MM-DD format; must be null when frequencyType is ONE_TIME

amount

double

≤ 1.7976931348623157e+308

The default payment amount

Responses

200POST /v1/billpay/addElectronicBiller Positive response

400POST /v1/billpay/addElectronicBiller Negative response