customer/v1/cancelach
[POST] /customer/v1/cancelach
Customer cancel ACH transaction
The customer cancel ACH transaction endpoint will allow customers 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 customer access tokens.
Example [POST] Request
{{avenu_base_url}}/customer/v1/cancelach
{
sourceTransactionId: "a.transactionId",
amount: 12345,
memoDescription: "cancel reason"
}
Input Parameters
Parameter | Length Restrictions | Format Restrictions | Required (Y/N) | Type |
---|---|---|---|---|
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
{
sourceTransactionId: "a.transactionId",
amount: 12345,
memoDescription: "cancel reason"
}
Error Codes
Category | Response Code | Error Message |
---|---|---|
Format | AB3066 | <Field Name> : Invalid Format. |
Size | AB3067 | <Field Name> : Invalid Length. |
Required | AB3068 | <Field Name> : Missing Required Field. |
Business | AB3069 | <Field Name> : Transaction does not match customer. |
Business | AB3070 | <Field Name> : This transaction does not qualify for cancellation. Please contact Avenu support. |
Business | AB3071 | <Field Name> : The amount does not match the original payment. |
Updated 19 days ago