Add Paper Biller

post

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

Use /billpay/addPaperBiller to add a paper (check) biller to an account. Paper billers require full payee address information. The account must be active to add a biller.

Body Params

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

billerName

string

required

The biller name

billerAddress1

string

The biller address line 1

billerAddress2

string

The biller address line 2

billerCity

string

required

The biller city

billerState

string

required

The biller state (US only)

billerZip

string

required

The biller zip code

billerPhone

string

The biller phone number

billerAccountNo

string

required

The biller account number

frequencyType

string

enum

The payment frequency type

Allowed:

nextDate

string

The next payment date in YYYY-MM-DD format

endDate

string

The end date for recurring payments in YYYY-MM-DD format

amount

double

≤ 1.7976931348623157e+308

The default payment amount

Responses

200POST /v1/billpay/addPaperBiller Positive response

400POST /v1/billpay/addPaperBiller Negative response