Return payment

Payment Token

• payment_token: uuid (required)
  Request to return an ACH payment

• financial_account_token: uuid (required)
  Globally unique identifier for the financial account

• return_reason_code: string (required)
  ^R(0[1-9]|[1-4][0-9]|5[0-3]|8[0-5])$
  ACH return reason code indicating the reason for returning the payment. Supported codes include R01-R53 and R80-R85. For a complete list of return codes and their meanings, see ACH Return Reasons

• memo: string | null
  Optional memo for the return. Limited to 10 characters

• addenda: string | null
  Optional additional information about the return. Limited to 44 characters

• date_of_death: date | null
  Date of death in YYYY-MM-DD format. Required when using return codes R14 (representative payee deceased) or R15 (beneficiary or account holder deceased)

202 Accepted

• status: string (enum, required)
  The status of the transaction
  PENDING, SETTLED, DECLINED, REVERSED, CANCELED, RETURNED

• token: uuid (required)
  Unique identifier for the transaction

• created: date-time (required)
  ISO 8601 timestamp of when the transaction was created

• updated: date-time (required)
  ISO 8601 timestamp of when the transaction was last updated

• family: const (enum, required)
  PAYMENT - Payment Transaction

• category: string (enum, required)
  Transaction category
  ACH, WIRE, BALANCE_OR_FUNDING, FEE, REWARD, ADJUSTMENT, DERECOGNITION, DISPUTE, CARD, EXTERNAL_ACH, EXTERNAL_CHECK, EXTERNAL_FEDNOW, EXTERNAL_RTP, EXTERNAL_TRANSFER, EXTERNAL_WIRE, MANAGEMENT_ADJUSTMENT, MANAGEMENT_DISPUTE, MANAGEMENT_FEE, MANAGEMENT_REWARD, MANAGEMENT_DISBURSEMENT, HOLD, PROGRAM_FUNDING

• currency: string
  Currency of the transaction in ISO 4217 format

• result: string (enum, required)
  Transaction result
  APPROVED, DECLINED

• method_attributes: (required)
  Method-specific attributes

AchMethodAttributes

• financial_account_token: uuid (required)
  Financial account token

• external_bank_account_token: uuid | null
  External bank account token

• direction: string (enum, required)
  Transfer direction
  CREDIT, DEBIT

• source: string (enum, required)
  Transaction source
  LITHIC, EXTERNAL, CUSTOMER

• method: string (enum, required)
  Transfer method
  ACH_NEXT_DAY, ACH_SAME_DAY, WIRE

• settled_amount: integer (required)
  Settled amount in cents

• pending_amount: integer (required)
  Pending amount in cents

• events: array of objects (required)
  List of transaction events

Payment Event

• amount: integer (required)
  Amount of the financial event that has been settled in the currency's smallest unit (e.g., cents).

• created: date-time (required)
  Date and time when the financial event occurred. UTC time zone.

• detailed_results: array of strings
  More detailed reasons for the event
  APPROVED, DECLINED, FUNDS_INSUFFICIENT, ACCOUNT_INVALID, PROGRAM_TRANSACTION_LIMIT_EXCEEDED, PROGRAM_DAILY_LIMIT_EXCEEDED, PROGRAM_MONTHLY_LIMIT_EXCEEDED

• result: string (enum, required)
  Approved financial events were successful while declined financial events were declined by user, Lithic, or the network.

• token: uuid (required)
  Globally unique identifier.

• type: string (enum, required)

Event types:

ACH events:

• ACH_ORIGINATION_INITIATED
  ACH origination received and pending approval/release from an ACH hold.
• ACH_ORIGINATION_REVIEWED
  ACH origination has completed the review process.
• ACH_ORIGINATION_CANCELLED
  ACH origination has been cancelled.
• ACH_ORIGINATION_PROCESSED
  ACH origination has been processed and sent to the Federal Reserve.
• ACH_ORIGINATION_SETTLED
  ACH origination has settled.
• ACH_ORIGINATION_RELEASED
  ACH origination released from pending to available balance.
• ACH_ORIGINATION_REJECTED
  ACH origination was rejected and not sent to the Federal Reserve.
• ACH_RECEIPT_PROCESSED
  ACH receipt pending release from an ACH holder.
• ACH_RECEIPT_SETTLED
  ACH receipt funds have settled.
• ACH_RECEIPT_RELEASED
  ACH receipt released from pending to available balance.
• ACH_RECEIPT_RELEASED_EARLY
  ACH receipt released early from pending to available balance.
• ACH_RETURN_INITIATED
  ACH initiated return for an ACH receipt.
• ACH_RETURN_PROCESSED
  ACH receipt returned by the Receiving Depository Financial Institution.
• ACH_RETURN_SETTLED
  ACH return settled by the Receiving Depository Financial Institution.
• ACH_RETURN_REJECTED
  ACH return was rejected by the Receiving Depository Financial Institution.

Wire transfer events:

• WIRE_TRANSFER_INBOUND_RECEIVED
  Inbound wire transfer received from the Federal Reserve and pending release to available balance.
• WIRE_TRANSFER_INBOUND_SETTLED
  Inbound wire transfer funds released from pending to available balance.
• WIRE_TRANSFER_INBOUND_BLOCKED
  Inbound wire transfer blocked and funds frozen for regulatory review.

Wire return events:

• WIRE_RETURN_OUTBOUND_INITIATED
  Outbound wire return initiated to return funds from an inbound wire transfer.
• WIRE_RETURN_OUTBOUND_SENT
  Outbound wire return sent to the Federal Reserve and pending acceptance.
• WIRE_RETURN_OUTBOUND_SETTLED
  Outbound wire return accepted by the Federal Reserve and funds returned to sender.
• WIRE_RETURN_OUTBOUND_REJECTED
  Outbound wire return rejected by the Federal Reserve.

External ID

• external_id: string | null
  Payment event external ID. For ACH transactions, this is the ACH trace number.

• For inbound wire transfers, this is the IMAD (Input Message Accountability Data).

• descriptor: string (required)
  Transaction descriptor

• user_defined_id: string | null
  User-defined identifier

• expected_release_date: date | null
  Expected release date for the transaction

• related_account_tokens: (required)
  Related account tokens for the transaction

Related Account Tokens

• business_account_token: 3fa85f64-5717-4562-b3fc-2c963f66afa6

• account_token: 3fa85f64-5717-4562-b3fc-2c963f66afa6

• type: string (enum)
  ORIGINATION_CREDIT, ORIGINATION_DEBIT, RECEIPT_CREDIT, RECEIPT_DEBIT, WIRE_INBOUND_PAYMENT, WIRE_INBOUND_ADMIN, WIRE_OUTBOUND_PAYMENT, WIRE_OUTBOUND_ADMIN, WIRE_INBOUND_DRAWDOWN_REQUEST

• tags: (object)
  Key-value pairs for tagging resources. Tags allow you to associate arbitrary metadata with a resource for your own purposes.