Holds an ACH transaction

Request

POST {{baseURL}}/pay-api/v1/transactions/ach/{{transactionId}}/hold

This endpoint places an ACH (automated clearing house) transaction payment on hold.

This is temporarily paused in processing. It is prevented from being processed or submitted to the ACH network until it is released.

See Also:
To create an ACH debit payment, see POST /pay-api/v1/transactions/ach/payment.
To create an ACH credit payment, see POST /pay-api/v1/transactions/ach/payment/credit.
To release a held ACH transaction, see POST /pay-api/v1/transactions/ach/{transactionId}/unhold.
To void an ACH transaction, see POST /pay-api/v1/transactions/ach/{transactionId}/void.

Security

Bearer

Path

transactionIdstring, (uuid)required

Specifies the ACH (automated clearing house) transaction identifier.

This value is returned as transactionId from either of the following endpoints:

POST /pay-api/v1/transactions/ach/payment
GET /pay-api/v1/transactions/ach/payment/credit

Example:004db5a8-a153-4334-a0b4-1aa22fbffb3e

curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-api/v1/transactions/ach/004db5a8-a153-4334-a0b4-1aa22fbffb3e/hold \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

transactionIdstring, (uuid)

Indicates the transaction identifier.

Example: bf5a1dc7-57b7-4fec-ab09-52c47c1acaff

Example:"bf5a1dc7-57b7-4fec-ab09-52c47c1acaff"

typeIdinteger, (int32)

Indicates the Flute ACH (automated clearing house) transaction type code.

Example: 6

Example:6

typestring or null

Indicates the Flute ACH transaction type.

Example: CardAuthentication

Example:"CardAuthentication"

statusIdinteger, (int32)

Indicates the Flute ACH transaction status code.

Example: 1

Example:1

statusstring or null

Indicates the Flute ACH transaction status type.

Example: Authorized

Example:"Authorized"

responseDescriptionstring or null

Indicates a free-formed description regarding the transaction.

Example: Command Successful. Approved.

Example:"Command Successful. Approved."

responseCodestring or null

Indicates a response code regarding the transaction.

Example: 000

Example:"000"

Response

{
  "transactionId": "857757f3-9d2b-4204-abe6-c9d95bd41ec0",
  "typeId": 13,
  "type": "AchHold",
  "statusId": 26,
  "status": "Held",
  "responseDescription": null,
  "responseCode": null
}