# ACH Verify

Used to verify an ach bank account prior to sending an ACH sale/refund transaction.


- Host Direct

See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.


Endpoint: POST /ach/verify
Version: 1.7.43
Security: AccessToken

## Header parameters:

  - `InterfaceVersion` (string, required)
    Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~  , ? “ ” ‘ ’ { } [ ] \ + =
    Example: "2.1"

  - `InterfaceName` (string, required)
    Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed:  $ % : ^ - ~ `  , ? “ ” ‘ ’ { } [ ] \ + =
    Example: "ForwardPOS"

  - `CompanyName` (string, required)
    Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed:  $ % : ^ - ~ `  , ? “ ” ‘ ’ { } [ ] \ + =
    Example: "PAWS"

  - `AccessToken` (string, required)
    A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an  and .
    Example: "EA79FB05-3AA7-4500-AF9A-73F986FF2C1D"

## Request fields (application/json):

  - `dateTime` (string, required)
    The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).

Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
    Example: "2023-02-08T09:18:23.283-07:00"

  - `ach` (object, required)
    Example: {"accountNumber":"1234567890","routingNumber":"121000248","accountType":"PC","verificationType":"P","accountHolderName":"John Smith"}

  - `ach.accountNumber` (string, required)
    Bank Account Number. Do not include any dashes, spaces, or additional zeros.
    Example: "1234567890"

  - `ach.routingNumber` (string, required)
    The routing number identifying the bank.
    Example: "121000248"

  - `ach.accountType` (string, required)
    Bank account type

Value | Description 
------|---------------
PC    | Personal Checking
PS    | Personal Savings
CC    | Corporate Checking
CS    | Corporate Savings
    Example: "PC"

  - `ach.verificationType` (string, required)
    The type of verification used to validate the account.

Value | Description 
------|---------------
P     | Prenotification
    Enum: "P"

  - `ach.accountHolderName` (string, required)
    ACH account holder's name
    Example: "John Smith"

  - `sourceIp` (string, required)
    Public source IP Address where the request originates, not the IP Address of the web server.
    Example: "172.110.166.244"

  - `transaction` (object)

  - `transaction.vendorReference` (string)
    Optional field for information that can be searched in the merchant portal.

## Response 200 fields (application/json):

  - `result` (array)
    Example: [{"dateTime":"2023-02-08T09:18:23.283-07:00","merchant":{"mid":15877,"name":"Merchant XYZ"},"token":{"value":"9829283019231234","type":"ACH"},"transaction":{"authSource":"A","responseCode":"P"},"notificationId":"6ca3c55e-1b7c-4cad-8ae2-cac052b5510d","server":{"name":"TM01CE"}}]

  - `result.dateTime` (string)
    The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).

Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00

  - `result.token` (object)

  - `result.token.value` (string, required)
    The token representing the customer's bank account credentials.

  - `result.token.type` (string)
    Specifies the type of token. Value =
    Enum: "ACH"

  - `result.transaction` (object)

  - `result.transaction.authSource` (string)
    In a response, a code returned by the processor to indicate which host issued the response.

Value  | Description       
-------|----------------------------
A      | APM (Online)
    Enum: "A"

  - `result.transaction.responseCode` (string)
    Code indicating the Shift4 host response.        

Value  | Description | Details
-------|-------------|--------
P      | Pending     | The ACH transaction is pending
    Enum: "P"

  - `result.transaction.vendorReference` (string)
    Optional field for information that can be searched in the merchant portal.

  - `result.merchant` (object)

  - `result.merchant.mid` (number)
    The merchant ID associated with the merchant account.

  - `result.merchant.name` (string)
    The merchant’s business name as configured with Shift4.

  - `result.notificationId` (string)
    Notification ID value generated by Shift4 and returned in the response. Used for matching webhook notifications back to their original request.

  - `result.server` (object)

  - `result.server.name` (string)
    The name of the server that processed the request.

## Response 400 fields (application/json):

  - `result` (array)
    Example: [{"dateTime":"2023-02-08T09:18:23.283-07:00","error":{"code":40102,"severity":"Info","shortText":"Invalid Param","longText":"Client request missing field"},"server":{"name":"TM01CE"}}]

  - `result.dateTime` (string)
    The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).

Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00

  - `result.error` (object)

  - `result.error.code` (integer)
    Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.

  - `result.error.severity` (string)
    Severity level of the error.

| Severity | Description                                                       |
| -------- | ----------------------------------------------------------------  |
| Info     | Action not required - Data input/formatting is incorrect          |
| Error    | Action may be required - Communication, timeout or network issue  |
| Alert    | Action required - System issue                                    |
    Enum: "Info", "Error", "Alert"

  - `result.error.shortText` (string)
    Abbreviated error message that is always returned if an error condition exists

  - `result.error.longText` (string)
    Extended error message that is returned if an error condition exists.

  - `result.server` (object)

  - `result.server.name` (string)
    The name of the server that processed the request.

## Response 504 fields (application/json):

  - `result` (array)
    Example: [{"dateTime":"2023-02-08T09:18:23.283-07:00","error":{"code":64002,"severity":"Error","shortText":"Timed Out","longText":"Connection Timeout"},"server":{"name":"TM01CE"}}]

  - `result.dateTime` (string)
    The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).

Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00

  - `result.error` (object)

  - `result.error.code` (integer)
    Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.

  - `result.error.severity` (string)
    Severity level of the error.

| Severity | Description                                                       |
| -------- | ----------------------------------------------------------------  |
| Info     | Action not required - Data input/formatting is incorrect          |
| Error    | Action may be required - Communication, timeout or network issue  |
| Alert    | Action required - System issue                                    |
    Enum: "Info", "Error", "Alert"

  - `result.error.shortText` (string)
    Abbreviated error message that is always returned if an error condition exists

  - `result.error.longText` (string)
    Extended error message that is returned if an error condition exists.

  - `result.server` (object)

  - `result.server.name` (string)
    The name of the server that processed the request.