Account Autopay Create V1

Set up an autopay for an account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
Defaults to customer-account

customer-account

string
Defaults to account-autopay

account-autopay

string
Defaults to create

create

int32
Defaults to 1

1

string

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

string

Identifier for tracking this API call

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

string

If accountReferenceNumber has not been provided, accountUuid must be provided

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

string

If accountUuid has not been provied, accountReferenceNumber must be provided

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 12
Max: 16

string

ABA routing number of the external checking or savings account

Data type: string
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 9
Max: 9

string

Account number of the external checking or savings account and will come in from the processor as the plain account number

Data type: string
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 5
Max: 20

string
enum



Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 1
Max: 100

Allowed:
string
enum
Defaults to ACH



Data type: string
Required: yes
Letters: yes
Numbers: no
Special: no
Min: 1
Max: 100

Allowed:
string



Data type: string
Required: yes
Letters: yes
Numbers: no
Special: yes
Min: 1
Max: 100

date

Special character allowed: hyphen (-)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

string

Name of the originating bank for the checking or savings account entered

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 1
Max: 50

string



Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 1
Max: 100

string
enum



Data type: string
Required: yes
Letters: yes
Numbers: no
Special: no
Min: 3
Max: 20

Allowed:
float

Permitted and required only when the payment amount type is 'Fixed Amount'

Data type: money
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 4
Max: 20

boolean
Defaults to false

0 = debug off
1 = debug on
Default is set to 0 when nothing is passed in

Data type: boolean
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

Response

Language
LoadingLoading…
Response
Choose an example:
application/json