This REST Api endpoint allows you to create an ACH Works billing schedule through the API.  You will need the gateway id from MCA Suite as a required parameter.  This API has the same basic inputs and validations as the front end interface.  


Format:
 
The API will only accept JSON in the body.


Function:
Name: achworks/addSchedule

Type: POST
Parameters: 


NameRequired
Type
Description
gatewayId
YesInteger
The payment gateway id in MCA Suite.  Please ask for assistance.
dealId
IntegerThe MCA Suite deal iid.  Either dealId or dealName are required.  
dealName
StringThe name of the deal in MCA Suite. If you using deal name, you must have unique deal names in MCA Suite.
customerName
YesString - Max 22The customer name passed to ACH Works.
originatorName
String - Max 16Originator name passed to ACH Works.  Use "DEFAULT" to use the default set in MCA Suite.
typeYesStringType of transaction.  Acceptable value should be 'Debit' or 'Credit'
opCodeYesString'Single' or 'Recurring' transactions.  This should almost always be "Recurring". 
frequency
YesStringFrequency of the schedule.  Acceptable values include 'Daily','Weekly','Monthly'
startDateYesStringDate to start the billing schedule.  Format will be MM/DD/YYYY
continuous
YesbooleanIf you would like to schedule this indefinitely, pass in true, otherwise false.  We recommend false and use numInstallments.
numInstallments

IntegerNumber of payments. Required if continuous
 is false.
routingNumber
YesStringBank routing number.
accountNumber
YesStringBank account number.
amount
YesDecimalAmount of the transaction.  Ex: 33.42 or 1000
accountType
Yes
StringBank account type, 'Checking' or 'Savings'.
memo

String - Max 10Shows up on bank statement, 10 characters max.
accountSet
YesString - Max 3ACH Works account set.


Response:


The api will return a success or false in JSON.  If successful, the billing schedule id will be returned.  If not, an error will be returned.



Example JSON:


{

    

    "gatewayId": 6,

    "dealId":"312312",

    "customerName":"John Truck Rentals",

   "originatorName":"DEFAULT"

    "transactionType":"Debit",

    "opCode":"Recurring",

    "frequency":"Daily",

    "continuous": false,

    "startDate":"09/20/2021",

    "accountType":"Checking",

    "numInstallments":5,

    "amount":100.25,

    "memo":"MCA Daily",

    "routingNumber":"123456789",

    "accountNumber":"123456705",

    "accountSet":"01",

}


Example Response


{

  "success": true,

  "id": 80

}