v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

ACH Recurring Update

post/?achUpdate

Request body

appidstring required

Merchant APP ID (Alphanumeric - Length of 32 chars)

appkeystring required

Merchant APP KEY (Alphanumeric - Length of 32 chars and special chars $@%#)

epistring required

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

txn_typestring required

Message type for sale transaction request achediterecurring

uidstring required

Reference Number for the ACH sale API

account_numberstring required

Customer account number should be numeric

routing_numberstring required

Routing number is a nine-digit code used to identify a financial institution within the ACH

payee_namestring required

Name of the payee - Alphabet (Max length of 30 chars)

account_typestring required

Account type should be C => Checking, S =>Savings, G => GeneralLedger

entry_classstring required

Customer entry class should be present ( Business or Personal)

amountstring required

Transaction amount - Maximum amount $999999.99 (Ex: 0.01 to 999999.99)

recurring_typestring required

Default set as 1

subscription_starts_fromstring required

Subscription start payment date accepted expiry YYYYMMDD

number_subscriptionstring required

The number of subscriptions should be set between 1 and 6. If the subscription is set to never expire, please use -1

frequency_typestring required

1 – Daily 2 – Weekly 3 – Bi-Weekly 4 – Monthly

state_taxstring

State tax amount - Currency $ (Eg. 00.00)

city_taxstring

City tax amount - Currency $ (Eg. 00.00)

reduced_taxstring

Reduced tax amount - Currency $ (Eg. 00.00)

card_typestring required

Credit or Debit

invoicenumberstring
email_idstring

Customer email id - Varchar 255 (Ex: test@domain.com). For ACH banking email or phone required

phone_numberstring

Customer phone number- 10 digit Numeric (Ex: 5247896523)

day_of_monthstring required

For frequency types 1 (Daily) and 4 (Monthly), the day of the month should be set between 1 and 30. For frequency types 2 (Weekly) and 3 (Bi-Weekly), the day of the week should be set between 0 and 6

sync_to_qbstring

If the transaction can be sent to the QB account, set the value to 1; otherwise, set it to 0.

qb_email_invoicestring

Set to 1 if the QuickBooks invoice email is sent, otherwise set to 0.

Response

200

object required