The object is everything inside data. The field names below are relative to it: attributes.direction is data.attributes.direction in the response.
Fields
string
required
Resource type. Always ach.
string
required
ACH payment ID (ach_*).
object
required
The payment’s details.
Hide attributes
string
required
Direction of the payment.
integer
required
Amount in cents.
string
required
Currency code. Always USD.
object | null
required
Fee added to your cost as the sender. Null when no fee applies, the fee was voided, or your party is not the fee payer.
Hide fee
integer
required
Fee amount in cents.
string
required
Currency of the fee. Always USD.
string
required
Party role charged the fee. Always sender.
string
required
The fee is added to the sender’s cost without reducing the principal amount. Always on_top.
string
required
ACH payment status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, SETTLED; APPROVAL_DENIED, FAILED, RETURNED, or CANCELED end it. One of: CREATED, AWAITING_APPROVAL, APPROVAL_DENIED, PROCESSING, SETTLED, FAILED, RETURNED, CANCELED. See Statuses.
string
required
The company entry description requested at creation. Echoes the create input verbatim; see submittedDescriptor for what was sent to the bank.
string | null
required
Description for your internal reference, or null. Never shared with the counterparty or the banking network.
string | null
required
Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided.
string
required
ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. One of: WEB, PPD, TEL, CCD.
object
required
What Natural sent to the bank as the payment’s descriptor.
Hide submittedDescriptor
string
required
Company name submitted on the ACH payment.
string
required
Company entry description submitted on the ACH payment.
string | null
required
ACH trace number assigned at submission, or null before submission.
object | null
required
Failure details when the payment failed, or null.
Hide failure
string | null
required
Failure reason, or null.
string | null
required
Failure code, or null.
object | null
required
Return details when the payment was returned, or null.
Hide return
string
required
ACH return code, such as R01.
string | null
required
Return reason, or null.
string
required
RFC 3339 timestamp when the return was received.
string | null
required
RFC 3339 timestamp when the return was dishonored, or null.
string | null
required
RFC 3339 timestamp when the dishonor was contested, or null.
string | null
required
RFC 3339 timestamp when the returned funds were released, or null.
string | null
required
RFC 3339 timestamp when the payment was submitted to the bank, or null.
string | null
required
RFC 3339 timestamp when the ACH payment settled, or null. A return can still arrive after settlement.
string | null
required
RFC 3339 timestamp when the funds are expected to be available, or null when unknown.
string | null
required
RFC 3339 timestamp when the payment reached its current end status, or null. It changes if a settled payment is later returned.
string
required
RFC 3339 timestamp when the ACH payment was created.
string
required
RFC 3339 timestamp when the ACH payment was last updated.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Agent that initiated this resource, or null when no agent can be reliably attributed.
Hide initiatorAgent
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always agent.
string
required
Agent ID (agt_*).
object
required
Party the payment was created for.
Hide customerParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
object
required
Wallet used for this payment.
Hide wallet
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always wallet.
string
required
Wallet ID (wal_*).
object
required
External party the payment is with.
Hide externalParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always externalParty.
string
required
External party ID (epty_*).
object
required
External party account used.
Hide externalPartyAccount
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always externalPartyAccount.
string
required
External party account ID (epa_*).
Statuses
Status
Meaning
Can become
CREATED
Natural saved the payment and hasn’t sent it to the bank yet.
Your approval policy or an approver denied the payment before it was sent.
Final
PROCESSING
Sent to the bank and not settled yet.
SETTLED, FAILED, RETURNED
SETTLED
The payment settled. The receiving bank can still return it.
RETURNED
FAILED
The payment didn’t go through. failure says why.
Final
RETURNED
The receiving bank returned the payment. return says why.
Final
CANCELED
Canceled before it was sent, for example by you or when its approval was canceled.
Final
Events
ach.created: An ACH transfer resource was created. The fee is assessed when the transfer is submitted, so it’s always null on ach.created. Read it from ach.processing.
ach.processing: An ACH transfer was submitted to money movement processing.
ach.settled: An ACH transfer settled at the receiving bank. Settlement is the resting state; a return can still arrive afterward.
ach.failed: An ACH transfer failed before completion.
ach.returned: An ACH transfer was returned or reversed.