ACH banks are used for making automated clearing house (ACH) transactions.


List ACH Bank Configurations

readByQuery

<readByQuery>
    <object>ACHBANK</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use ACHBANK
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

Get ACH Bank Configuration

read

<read>
    <object>ACHBANK</object>
    <keys>40</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use ACHBANK
keys Required string The object RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Get ACH Bank Configuration by Name

readByName

<readByName>
    <object>ACHBANK</object>
    <keys>BOFAACH</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use ACHBANK
keys Required string The config ACHBANKID to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create ACH Bank Configuration (Legacy)

create_achbankconfiguration

<create_achbankconfiguration>
    <achbankid>BOFI1234</achbankid>
    <destinationid>DEST</destinationid>
    <destinationname></destinationname>
    <originid>12345</originid>
    <originname></originname>
    <referencecode></referencecode>
    <status>active</status>
    <eofmarker></eofmarker>
</create_achbankconfiguration>

Parameters

Name Required Type Description
achbankid Required string ACH Bank ID
destinationid Required string Immediate destination ID. The bank’s routing number.
destinationname Optional string Immediate destination name. The bank’s name as specified by your bank.
originid Required string Immediate origin ID. Your 10-digit company number including hyphens as specified by your bank.
originname Optional string Immediate origin name. Your company’s name, as specified by your bank.
referencecode Optional string Reference code.
status Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
eofmarker Optional boolean Include EOF marker. Use true for Yes otherwise use false for No (Default: false)

Update ACH Bank Configuration (Legacy)

update_achbankconfiguration

<create_achbankconfiguration achbankid="BOFI1234">
    <destinationid>DEST</destinationid>
    <destinationname></destinationname>
    <originid>12345</originid>
    <originname></originname>
    <referencecode></referencecode>
    <status>active</status>
    <eofmarker></eofmarker>
</create_achbankconfiguration>

Parameters

Name Required Type Description
achbankid Required string ACH Bank ID
destinationid Optional string Immediate destination ID. The bank’s routing number.
destinationname Optional string Immediate destination name. The bank’s name as specified by your bank.
originid Optional string Immediate origin ID. Your 10-digit company number including hyphens as specified by your bank.
originname Optional string Immediate origin name. Your company’s name, as specified by your bank.
referencecode Optional string Reference code.
status Optional string Status. Use active for Active otherwise use inactive for Inactive.
eofmarker Optional boolean Include EOF marker. Use true for Yes otherwise use false for No.

Delete ACH Bank Configuration (Legacy)

delete_achbankconfiguration

<delete_achbankconfiguration achbankid="BOFI1234"></delete_achbankconfiguration>

Parameters

Name Required Type Description
achbankid Required string Record number of bank configuration

Provide feedback