Sign in

v1

latestOpenAPI 3.0.22026-08-04530309.0 KB
Transactions

Get a single Transaction Event

Retrieves a single Transaction Event resource, including its status, timestamps, and associated Transaction details.

get/transaction_events/{uid}

Response

A single Transaction Event is returned

uidstring

Newline-generated unique id resource specific to the current endpoint

settled_indexinteger

A unique index that indicates the order in which Transaction Events were settled

transaction_uidsstring[]

A list of UIDS referring to Transactions this Transaction Event belongs to.

source_custodial_account_uidstring

Custodial Account from which the asset is pulled

destination_custodial_account_uidstring

Custodial Account where the asset lands

custodial_line_item_uidsstring[]

A list of UIDS referring to Custodial Line Items belonging to this event. There are always at least two line items if the status is settled.

status'settled'

Transaction Events will always have a status of settled

us_dollar_amountstring

The amount will never be negative

type'odfi_ach_deposit' | 'odfi_ach_withdrawal' | 'rdfi_ach_deposit' | 'rdfi_ach_withdrawal'
debit_card_uidstring

If this Transaction Event represents a Debit Card purchase or refund, the UID of the Debit Card used for the purchase/refund. Otherwise not provided.

net_asset'positive' | 'negative' | 'neutral'

Indicates whether the Customer's asset has gone up (positive), gone down (negative) or stayed the same (neutral) as a result of this Transaction Event. This value is determined by type.

descriptionstring
created_atstring date-time

The date and time when the event is first recognized by Newline. This may be when the Transfer is initiated if the event is associated with one.

settled_atstring date-time

The date and time when the event is settled

Example response

{
  "uid": "EhrQZJNjCd79LLYq",
  "settled_index": 9,
  "source_custodial_account_uid": "dmRtw1xkS9ghrntB",
  "destination_custodial_account_uid": "W55zKgvAk3zkpGM3",
  "us_dollar_amount": "12.34",
  "type": "odfi_ach_deposit",
  "debit_card_uid": "oPeppbFTE9FvYKq5",
  "net_asset": "positive",
  "description": "Transfer from Bank ABC 123 to Newline 999",
  "created_at": "2019-10-15T15:53:13.591Z",
  "settled_at": "2019-10-16T12:51:12.673Z"
}