PUT /schedules/{scheduleId}

Update a Schedule

Send the parameters that you want to update. All other parameters will remain the same.

Parameters

Payment Updates

Updates the payment information that the schedule will use.

ACH
required name format description
* achRoutingNumber Valid Check Routing Number ACH Routing Number
* achAccountNumber Valid Check Account Number, Max Length 17 ACH Account Number
* achAccountType SAVINGS | CHECKING SAVINGS - Savings Account
CHECKING - Checking Account
* achType PPD | CCD

PPD - Consumer Account

CCD - Business Account

Keyed Card
Please consider the PCI Implications of transmitting full card number data.
required name format description
* cardNumber Valid Credit Card Number.

Credit/Debit Card Number

NOTE: Please consider the PCI Implications of transmitting full card number data.

* cardExpMonth 1-12, Ex: 8 Expiration Month.
* cardExpYear 4 Digit Format. Ex: 2015 Expiration Year.
Transaction ID
required name format description
* transactionId Valid Transaction ID A Transaction ID from a previously charged transaction. The schedule will be updated to use the same payment from this transaction.
Vault ID
required name format description
* vaultId Valid Vault ID A Vault ID from a previously stored account. The schedule will be updated to use the same payment from this customer vault.

Schedule Fields

 
required name format description
  amountBase Money,
Format: X.XX
Ex: 1000.00 or $1,000.00
Base amount to charge.
  amountShipping Money,
Format: X.XX
Ex: 1000.00 or $1,000.00
If you want to track separate shipping amounts use this parameter.
  amountSurcharge Money,
Format: X.XX
Ex: 1000.00 or $1,000.00
If you want to add a surcharge to the schedule then use this parameter.
  amountTax Money,
Format: X.XX
Ex: 1000.00 or $1,000.00
If you are billing tax then use this parameter.
  amountTip Money,
Format: X.XX
Ex: 1000.00 or $1,000.00
If you want to add a tip to the schedule then use this parameter.

Schedule Type Fields

 
required name format description
  intervalCap Numeric Only applicable for scheduleType=PERIODIC. Can not be updated lower than the current number of approved transactions for schedule.

Billing Contact

required name format description
  billingIdentifier Max Length 64 Billing customer id. If you have your own customer ID you want to associate with the schedule.
  billingFirstName Max Length 16 Billing first name.
  billingMiddleName Max Length 32 Billing middle name.
  billingLastName Max Length 32 Billing last name.
  billingCompanyName Max Length 64 Billing company name.
  billingJobTitle Max Length 32 Billing job title. Ex: President
  billingPhone Max Length 24 Billing phone number.
  billingPhone2 Max Length 24 Billing alternate phone number.
  billingAddress Max Length 128 Billing street address.
  billingCity Max Length 32 Billing city.
  billingState Max Length 32 Billing state.
  billingZip Max Length 12 Billing zip.
  billingCountry Max Length 32 Billing country.
  billingEmail Max Length 128 Billing email.
  billingWebsite Max Length 128 Billing website.

Shipping Contact

required name format description
  shippingIdentifier Max Length 64 Shipping customer id. If you have your own customer ID you want to associate with the schedule.
  shippingFirstName Max Length 16 Shipping first name.
  shippingMiddleName Max Length 32 Shipping middle name.
  shippingLastName Max Length 32 Shipping last name.
  shippingCompanyName Max Length 64 Shipping company name.
  shippingJobTitle Max Length 32 Shipping job title. Ex: President
  shippingPhone Max Length 24 Shipping phone number
  shippingPhone2 Max Length 24 Shipping alternate phone number.
  shippingAddress Max Length 128 Shipping street address.
  shippingCity Max Length 32 Shipping city.
  shippingState Max Length 32 Shipping state
  shippingZip Max Length 12 Shipping zip
  shippingCountry Max Length 32 shippingCountry
  shippingEmail Max Length 128 shippingEmail
  shippingWebsite Max Length 129 shippingWebsite

Other Fields

required name format description
  invoiceNumber Max Length 32 Invoice number. If would would like to mark this schedule with your own invoice number for accounting.
  purchaseOrderNumber Max Length 32 Purchase order number. If you would like to mark this schedule with your own PO for accounting.