Modify Paper Biller

post

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

Use /billpay/modifyPaperBiller to modify an existing paper (check) biller linked to an account. You can update the payment frequency, scheduled dates, default amount, and address details.

Body Params

POST /v1/billpay/modifyPaperBiller 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

billerAddress1

string

The biller address line 1

billerAddress2

string

The biller address line 2

billerCity

string

The biller city

billerState

string

The biller state (US only)

billerZip

string

The biller zip code

Responses

200POST /v1/billpay/modifyPaperBiller Positive response

400POST /v1/billpay/modifyPaperBiller Negative response