v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

ACH Payment

Process an ACH withdraw.

put/ach/withdraw

Headers

idempotency-keystring uuid required

A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').

Request body

bankAccountIdinteger required

The bank account ID to withdraw from.

customerIdinteger required

The customer ID associated with the bank account.

orderIdinteger

An optional invoice ID to process the withdrawal with. If provided, the withdrawal action will perform invoice and inventory management.

amountnumber float required

The amount to withdraw.

currencyId1 | 2 required

The currency of the transaction:

1 - CAD
2 - USD

Example request

{
  "bankAccountId": 1182342,
  "customerId": 389829,
  "orderId": 12083,
  "amount": 79.99,
  "currencyId": 1
}

Response

An ACH withdrawal was successfully processed. This does not guarantee that all necessary sub-objects were updated, only a guarantee that the payments action was successful.