Cancel ACH client batches

/ach/v1/client-batches/{id}/cancel

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.

Path parameters

id

string

The unique ID of the batch payment, received in the batch origination request as the id attribute. This ID is in the GUID format.

Required  
Copy
Sample request
curl -X POST
--header 'Accept: application/json'
--header 'Authorization: Bearer '<token>'

https://sandbox.crbcos.com/ACH/v1/client-batches/fcb7188f-e051-4f5b-addd-afaa00eadb3a/cancel'

Response attributes

id

string

Unique ID for the client batch request. This ID is in the GUID format.

referenceId

string

Unique CR reference ID for the payment. The reference ID always begins with the first letter of the rail. For ACH the reference ID starts with 'A'.

status

string

Status of the transaction:

  • Processing

  • Imported

  • Canceling

accountNumber

string

The account number from which the batch payments originate

paymentCount

integer

The number of unique payments in the batch (up to 5000)

debitTotal

integer

The total amount to be credited to the originator account

creditTotal

integer

The total amount to be debited from the originator account

importCount

integer

Indicates how many payments have been processed at the time of the response

productId

string

ID in GUID format of your specific product type on which the account is based. Provided by CR. In this case, the CR account involved in the batch payment. See also here.

partnerId

string

Your ID in the CR system. This ID is in GUID format.

createdAt

string

When the client batch was created after the request was received

importedAt

string

The time when the import count matches the total number of payments in the batch

lastModifiedAt

string

Internal CR value. Date and time the database entry was last modified.

paymentIdentifiers

array

Unique identifier for each payment in the batch, in GUID format.
Copy

Sample response

{
  "id": "fc0d501d-c36b-45b4-a0d5-afaa00eb6c74",
  "referenceId": "CB0460UJR6DNA",
  "status": "Canceling",
  "accountNumber": "2207975570",
  "paymentCount": 5,
  "debitTotal": 258641,
  "creditTotal": 2863,
  "importCount": 5,
  "productId": "cc62e17f-5912-483e-9e42-aed30112fbb6",
  "partnerId": "1e5d3f04-ae24-4af6-9e30-aecf012b99dd",
  "createdAt": "2023-02-15T09:17:09.077-05:00",
  "importedAt": "2023-02-15T09:17:19.123-05:00",
  "lastModifiedAt": "2023-02-15T09:17:26.8406542-05:00",
  "paymentIdentifiers": [
    "6ed9ea59-2522-4550-8e5d-afaa00eb6c74",
    "dbe36253-06d1-462a-9117-afaa00eb6c74"
  ]
}