client/v1/cancelach

[POST] /client/v1/cancelach

Client admin cancel ACH transaction

The client admin cancel ACH transaction endpoint will allow clients to cancel individual ACH ODFI transactions while they are in PENDING status and before they have been added to a daily batch file. Avenu places transactions into batch files at four times throughout the business day: 8am, 12pm, 2pm, and 5pm Eastern Time. This means if an ACH transaction is made at 10am, the cancel request would need to be made before the batch file generation at 12pm. This endpoint is only authorized for client access tokens.

Example [POST] Request

{{avenu_base_url}}/client/v1/cancelach

{
  customerAccountNumber: "1234561234567890",
  sourceTransactionId: "a.transactionId",
  amount: 12345,
  memoDescription: "cancel reason"
}

Input Parameters

Parameter	Length Restrictions	Format Restrictions	Required (Y/N)	Type
customerAccountNumber	Exactly 16 digits	Numeric characters only (0-9)	Y	String
sourceTransactionId	36-45 (up-to)	No special characters EXCEPT: ., - (Period), (Dash)	Y	String
amount	per current standards in Avenu	Numbers only, can be negative or positive. Must match the original transaction amount.	Y	Number
memoDescription	200 (up-to)	No special characters	Y	String

Example Response

{
  customerAccountNumber: "1234561234567890",
  sourceTransactionId: "a.transactionId",
  amount: 12345,
  memoDescription: "cancel reason"
}

Error Codes

Category	Response Code	Error Message
Format	CG3059	<Field Name> : Invalid Format.
Size	CG3060	<Field Name> : Invalid Length.
Required	CG3061	<Field Name> : Missing Required Field.
Business	CG3062	<Field Name> : Customer does not belong to this organization.
Business	CG3063	<Field Name> : Transaction does not match customer.
Business	CG3064	<Field Name> : This transaction does not qualify for cancellation. Please contact Avenu support.
Business	CG3065	<Field Name> : The amount does not match the original payment.