Modify Electronic Biller

patch

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

Use /billpay/modifyElectronicBiller to modify an existing electronic (RPPS) biller linked to an account. You can update the payment frequency, scheduled dates, and default amount.

Body Params

PATCH /v1/billpay/modifyElectronicBiller 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

billerId

string

required

The biller ID

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

nickname

string

A user-friendly nickname for the biller

Responses

200PATCH /v1/billpay/modifyElectronicBiller Positive response

400PATCH /v1/billpay/modifyElectronicBiller Negative response