Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
ACH

Update a sent ACH transaction

Update a sent ACH transaction (either status or funds availability)

patch/ach/{transaction_id}

Path parameters

transaction_idstring uuid required
Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

Transaction ID in the ledger

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

funds_availability_timestring date-time nullable
status'CANCELED' nullable

Example request

{
  "funds_availability_time": "2010-05-06T12:23:34.321Z"
}

Response

Sent ACH transaction representation.

account_idstring uuid

Receiving account uuid. This links to the external account resource (represented by 'receiving_account_id' in the request to send outgoing ACH).

account_namestring

Receiving account name

account_nostring required

Receiving account number

amountinteger required

Transaction amount in cents

bank_idinteger required
company_entry_descriptionstring

Company Entry Description field in ACH batch header. Originator inserts this field's value to provide the Receiver with a description of the entry's purpose. NACHA Operating Rules dictate that Payroll or E-Commerce Purchase ACH transactions require setting this field to PAYROLL or PURCHASE respectively.

company_namestring

Company Name field in ACH batch header.

effective_datestring date required

Effective date of the transaction

external_idstring uuid required

Transaction ID in the ledger

idstring uuid required
incoming_ach_idstring uuid

ID of the linked incoming ACH entry. This is filled only for outgoing ACH entries that are returns and links to the originally received incoming entry.

is_same_dayboolean required

Was initiated as same-day ACH transaction

memostring required
partner_idinteger required
reference_infostring

Transaction reference info

source_account_idstring uuid

Originating account uuid. This links to the customer account on Synctera platform (represented by 'originating_account_id' in the request to send outgoing ACH).

source_account_namestring

Originating account name

source_account_nostring required

Originating account number

status'CANCELED' | 'COMPLETE' | 'DECLINED' | 'INIT' | 'PENDING' required
trace_nostring required

Trace number of the transaction

Example response

{
  "account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "account_name": "Bruce Wayne",
  "account_no": "122455799",
  "amount": 1560,
  "bank_id": 1,
  "company_entry_description": "PAYROLL",
  "company_name": "Asdf Finance",
  "effective_date": "2022-03-25",
  "external_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "hold": {
    "availability_time": "2010-05-06T12:23:34.321Z"
  },
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "incoming_ach_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "partner_id": 2,
  "return_data": {
    "code": "R01",
    "dishonored_return_code": "69",
    "dishonored_return_settlement_date": "256",
    "dishonored_return_trace": "123456780000069",
    "field_errors": "05",
    "original_dfi_no": "364275034",
    "original_trace": "123456780000069",
    "return_code": "13",
    "return_settlement_date": "256",
    "return_trace": "123456780000069"
  },
  "source_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "source_account_name": "Thomas Anderson",
  "source_account_no": "123638791329",
  "trace_no": "123456780000069"
}