List Transactions

get https://sandbox.newline53.com/api/v1/transactions

Retrieves a list of Transactions. Transactions representing expired authorizations or expired reversals are suppressed by default.

Query Params

customer_uid

string

Filter by Customer. Multiple values are allowed, e.g. customer_uid[]=uKxmLxUEiSj5h4M3&customer_uid[]=y9reyPMNEWuuYSC1.

pool_uid

string

Filter by pool. Multiple values are allowed, e.g. pool_uid[]=wTSMX1GubP21ev2h&pool_uid[]=7UvkHn3Ss9AbWe2c.

source_synthetic_account_uid

string

Filter by source Synthetic Account. Multiple values are allowed, e.g. source_synthetic_account_uid[]=4XkJnsfHsuqrxmeX&source_synthetic_account_uid[]=aeD4RMVyTKaspEzj.

destination_synthetic_account_uid

string

Filter by destination Synthetic Account. Multiple values are allowed, e.g. destination_synthetic_synthetic_uid[]=exMDShw6yM3NHLYV&destination_synthetic_account_uid[]=1WVbRrp1s1MvTaAe.

synthetic_account_uid

string

Filter by Synthetic Account, source or destination. Multiple values are allowed, e.g. synthetic_account_uid[]=4XkJnsfHsuqrxmeX&synthetic_account_uid[]=exMDShw6yM3NHLYV.

type

string

Filter by type. Multiple values are allowed, e.g. type[]=dispute&type[]=fee.

has_return

boolean

Filter by return. Only transactions that have returns (present or absend) to be included in the results.

show_denied_auths

boolean

Causes transactions with a status of denied (suppressed by default) to be included in the results.

show_expired

boolean

Causes transactions with a status of expired (suppressed by default) to be included in the results.

status

string

Filter by status. Multiple values are allowed, e.g. status[]=queued&status[]=pending.

search_description

string

Attempts to search for the provided string in the description field. '*' can be used as a wildcard at the beginning or end of the string. Any record with a match will be returned.

include_zero

boolean

Causes transactions with a us_dollar_amount = 0 (suppressed by default) to be included in the results.

limit

integer

Defaults to 100

Maximum number of items to retrieve. This filter is automatically applied with the default value if not given.

offset

integer

Defaults to 0

Index of the items to start retrieving from

sort

string

created_at_after

date-time

Return only transactions with created_at after the provided ISO 8601 timestamp

created_at_before

date-time

Return only transactions with created_at before the provided ISO 8601 timestamp

settled_at_after

date-time

Return only transactions with settled_at after the provided ISO 8601 timestamp

settled_at_before

date-time

Return only transactions with settled_at before the provided ISO 8601 timestamp

initial_action_at_after

date-time

Return only transactions with initial_action_at after the provided ISO 8601 timestamp

initial_action_at_before

date-time

Return only transactions with initial_action_at before the provided ISO 8601 timestamp

settled_index_after

integer

Return only transactions with settled_index after the provided value

settled_index_before

integer

Return only transactions with settled_index before the provided value

id_after

integer

Return only transactions with id after the provided value

id_before

integer

Return only transactions with id before the provided value

Headers

x-trace-id

string

required

A unique identifier provided for each request. Duplicate values submitted in requests within 7 days of each other will cause the request to be rejected.

Response

Response body

object

total_count

integer

Total count of items available to retrieve

count

integer

Number of items retrieved

limit

integer

Maximum number of items to retrieve

offset

integer

Index of the first item to retrieve

data

array of objects

data

object

uid

string

Newline-generated unique id resource specific to the current endpoint

integer

An index, distinct from a Transaction's uid, that indicates the order in which the Transactions were created.

adjustment_uid

string | null

The UID of the Adjustment this Transaction is associated with, if any.

customer_uid

string

The unique id of the Customer associated with the Transaction.

created_at

date-time

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

custodial_account_uids

array of strings

A list of unique ids referring to Custodial Accounts that are currently involved in this Transaction. An empty array will be returned if there are no Custodial Accounts involved. The array may contain more values as the Transaction progresses and will no longer grow when its status becomes settled. The array may still be empty by the time the Transaction is settled if there is no custodial asset movement as a result of this Transaction.

custodial_account_uids

description

string

Description provided to the Transaction during origination

destination_synthetic_account_uid

string

Synthetic Account where the asset has landed

initial_action_at

date-time

The date and time of some action (e.g. a debit authorization) that resulted in this Transaction's creation. When relevant and available, this value is a timestamp received by and generated externally to Newline; otherwise, this value will be when a transaction request was received and virtually identical to created_at

net_asset

string

Indicates whether the Customer's asset has gone up (positive), gone down (negative) or stayed the same (neutral) as a result of this Transaction.

positive negative neutral

return_uid

string | null

The uid of a related Return, when applicable.

settled_at

date-time

The date and time when the Transaction is settled

settled_index

integer | null

Another unique index that indicates the order in which the Transactions were settled. Null if the Transaction's status is queued or pending.

source_synthetic_account_uid

string

Synthetic Account from where the asset is pulled

status

string

When a Transfer is created via POST /transfers, an associated Transaction is created with status queued. If it involves at least one custodial transfer, once the custodial transfer is initiated, the status will transition to pending.

Once a Transaction is settled, whether it has asset movement in custodial level, or is synthetic-only, or is RDFI (Receiving Depository Financial Institution, meaning no Newline Transfer was associated), it will have a settled status.

canceled queued pending settled failed denied expired

transaction_event_uids

array of strings

A list of unique ids referring to Transaction Events belonging to this Transaction. An empty array will be returned if there is no event involved. The array may contain more values as the Transaction progresses and will no longer grow when its status becomes settled. The array may still be empty at the time the Transaction is settled if there is no custodial asset movement as a result of this Transaction.

transaction_event_uids

transfer_uid

string | null

The unique id of the Transfer this Transaction is associated with, if any.

type

string

Transactions are categorized by Type. See the Transaction Statuses and Transaction Types section below for a list and definition of each Transaction Type that Newline supports.

ach ach_return atm_withdrawal book_transfer card_load card_purchase card_refund cash_load corporate_action credit denied_authorization dispute fee initiated_ach_return initiated_ach_reversal initiated_wire_return instant_payment interest other peer_to_peer_transfer reversal reversed_transfer set_account_balance wire

us_dollar_amount

string

The amount of the Transaction in question. The amount will never be negative, please refer to the net_asset field for direction (i.e., credit or debit).

virtual_reference_number_uid

string

The VRN uid, when the transaction was processed using a VRN.

instant_payment

object

Instant payment information. Only present if the Transaction is an instant payment.

wire

object

Wire-specific information. Only present if the Transaction is a wire.

ach

object

ACH-specific information. Only present if the Transaction is an ACH.

authorization

object

Transaction Authorization information. Only present if authorization was required for a given transaction.

Headers

object

x-trace-id

string

The unique identifier provided with the request.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.newline53.com/api/v1/transactions \
3
     --header 'accept: application/json'

Choose an example:

application/json

200A list of Transactions is returned