v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

ACH Payment

Refund an ACH transaction.

put/ach/transactions/{transactionId}/refund

Path parameters

transactionIdinteger required

The ID of the ACH transaction to refund.

Headers

idempotency-keystring uuid required

A UUID-formatted idempotency key. Accepted format is 25-36 alphanumeric characters (including '-' and '_').

Request body

amountnumber float required

The amount to be refunded.

Example request

{
  "amount": 96.34
}

Response

An ACH refund was successfully processed. This does not guarantee that all necessary sub-objects were updated, only a guarantee that the payments action was successful.

messagestring

Example response

{
  "message": "Successfully refunded transaction ID #1342. Refund transaction ID #1355 created."
}