Request an ACH Direct Debit
Overview
From time to time, you may need to recover funds from a recipient that were previously paid out. In these cases, you must use an ACH direct debit transaction. This type of payment allows funds that were previously paid out to be recovered from a recipient's account and returned to the original account. You may need to do this in cases of erroneous transactions, fraud, or to correct over-payments.
An ACH direct debit payment does not have to be connected to a previous payment by ID. You must make sure you communicate to your client the details and reasons for this direct debit.
How it works
To request a direct debit transaction, use POST /api/ef/v2/transactions
.
In your request, you need to include:
amount (decimal)
: The amount of money to be paid in the transaction. e.g:100.50
.creditorAccountId (string)
: The ID of the account where the funds are to be credited. e.g:bc820aacb56c46d8a64ffec2a8320bfd
.recipientId (string)
: The recipient ID of the recipient who originally received the funds, and is now paying back. e.g:dea21834-f876-404b-a240-9977e598da5e
.type (string)
: The type of transaction. This must always be ACH for these transactions.currency (string)
: Should be set to USD if provided. e.g:USD
.transactionReferenceId (string)
: Supply this ID that you'll use to track this payment in downstream systems. e.g:hajTudnonebMKlY8H
.
Sample request
Json
POST /api/ef/v2/transactions
Content-Type: application/json
{
"transactionReferenceId": "HADLhGLoo1aA123",
"type": "ACH",
"creditorAccountId": "dc2eda9084bf40b7a1d8baa8c5e0ea0ax",
"recipientId": "828be449-8507-4a5e-ad3f-62202af0f2b3",
"amount": 20.02,
"currency": "USD"
}
Sample response
Json
{
"id": "M9JLhGLoo1aAaT4",
"transactionReferenceId": "HADLhGLoo1aA123",
"originatingId": null,
"status": "PENDING",
"type": "ACH",
"originatingTransactionType": null,
"ledgerBalance": 30.02,
"debtorClientId": null,
"debtorAccountId": null,
"debtorAccountNumber": "...0521",
"debtorName": "Philip Banks",
"creditorClientId": "0030000132",
"creditorAccountId": "dc2eda9084bf40b7a1d8baa8c5e0ea0ax",
"creditorAccountNumber": "...8882",
"creditorName": "CntrlPrk",
"recipientId": "828be449-8507-4a5e-ad3f-62202af0f2b3",
"amount": 20.02,
"currency": "USD",
"paymentDate": "2024-08-12",
"createdAt": "2024-08-12T10:40:41.007Z",
"effectiveDate": null,
"postingVersion": null
}