---
title: "ach/withdraw"
method: POST
path: "/ach/withdraw"
tags: ["ACH Endpoints"]
---

# ach/withdraw

`POST /ach/withdraw`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/ach/withdraw`
- Auth: none declared

This endpoint is used to send funds to a specified customer's US Bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.

 If a ClientAccountID is provided, the client account's first/last name, address, phone number, identification number and default bank account will be used for the transaction.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `ClientAccountID` string: Client Account ID
  - `ContactID` string: The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.
  - `FirstName` string, required: Customer's first name
  - `LastName` string, required: Customer's last name
  - `CompanyName` string, required: Company's name
  - `IdentificationNumber` string, required: Customer's driver's licence (individuals) or federal tax ID (companies).
  - `EmailAddress` string, required: Customer's email address
  - `PhoneNumber` string, required: Customer's phone number. Digits only - no parentheses or dashes allowed.
  - `Address1` string, required: Customer's address line 1
  - `Address2` string: Customer's address line 2
  - `City` string, required: Customer's city
  - `State` string, required: Customer's state specified using two character abbreviations (eg. CA, AZ)
  - `Country` string, required: Customer's country specified using full country name or ISO 3166-1 alpha-2 code.
  - `ZipCode` string, required: Customer's zip code.
  - `IPAddress` string: Customer's IP address.
  - `ABARoutingNumber` integer, required: ABA routing transit number for customer's US bank account.
  - `AccountNumber` integer, required: Account number for the customer's US bank account
  - `Amount` number, required: The amount to credit to the customer's bank account.
  - `Token` string: Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.
  - `PlaidProcessorToken` string: Used by clients with a Plaid account. When this is provided, the routing number and account number are not required.
  - `Notes` string: An optional note to associate with the transaction.
  - `IdempotencyKey` string: A unique key which the server can use to recognize and reject subsequent retries of the same request.
  - `ClientReferenceNumber` string: A reference number to use to search the transaction. Must provide either a TransactionID or ClientReferenceNumber.
  - `ParentTransactionID` string: The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.
  - `GLCode` string: An optional unique identification general ledger code.
  - `TransactionTypeCode` string: CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).
  - `SecCode` string: The ACH Standard Entry Class (SEC) code. Defaults to PPD if not specified.
  - `TransactionLabel` string: TransactionLabel overrides originator short name

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `TransactionID` integer, required: This ID should be saved as it is required in order to look up status information on the transaction.
  - `Flagged` string: Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

---

[API](https://skmtc.dev/vopay/apis/payment-rails.md) - [All operations](https://skmtc.dev/vopay/apis/payment-rails/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-rails/revisions/d6fe8969ddcf?raw)