ACH
The Cross River ACH API allows you to both originate and receive payments through the Federal Reserve ACH network.
ACH APIs are found in the ACH module of our COS sandbox.
Get started with Cross River APIs.
This table presents ACH APIs we that describe in detail.
Action | API Call | Description |
|---|---|---|
POST /ach/v1/payments | Sends a single payment using ACH | |
POST /ach/v1/client-batches | Originates several payments together in a batch | |
GET /ach/v1/client-batches/{id}/cancel | Cancels any incomplete payments and stops further processing of any remaining payments in the batch |
Use an ACH prenotification (prenote) to verify and validate account details. A prenote simply means originating a payment of $0.00. If you don't receive an error response, the details are correct.
Submits 2 or more payments as a batch. Note that each batch payment must be originated from the same CR account number. If originating from multiple CR accounts, the payments from each account must be submitted as separate batches. For each payment, include the request attributes in the payments object of the request as shown in the code snippet.
Cancels any incomplete payments and stops further processing of any remaining payments in the batch. If you need to cancel many payments in a client batch, it's most efficient to cancel a client batch before all the payments have imported rather than try to cancel a large number of payments individually.
Response attributes
The response attributes for this call are the same as for Originate ACH client batches.
Event Name | Description |
|---|---|
Ach.Batch.Canceled | Any pending or on-hold payments in an ACH client batch canceled |
Ach.Batch.Imported | Entire ACH client batch import process into the CR system complete |
Ach.Payment.Canceled | ACH payment canceled at partner request |
Ach.Payment.Rejected | ACH payment rejected due to a compliance failure or fail to fund |
Ach.Payment.Sent | ACH payment sent to the Federal Reserve |
Ach.Payment.Received | ACH inbound payment received |
Ach.Payment.ReceivedEarly | ACH early direct deposit payment received |
Ach.Return.Received | ACH payment was returned from the receiving bank and has been marked as received |
Ach.Noc.Received | A Notification of Change was sent from the receiving bank regarding a previous origination |
Ach.Hold.Escalated | ACH inbound or outbound payment is on hold and it's status was escalated. This is often used to indicate that additional actions are needed |
