Sign in
latestOpenAPI 3.0.22026-08-21530310.0 KB

54f4fe726d8f

Transactions

List Transactions

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

get/transactions

Query parameters

source_synthetic_account_uidstring
Example:4XkJnsfHsuqrxmeX

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

destination_synthetic_account_uidstring
Example:exMDShw6yM3NHLYV

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

synthetic_account_uidstring
Example:4XkJnsfHsuqrxmeX

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

type'ach' | 'ach_return' | 'atm_withdrawal' | 'book_transfer' | 'card_load' | 'card_purchase' | 'card_refund' | 'cash_load' | 'corporate_action' | 'credit' | 'denied_authorization' | 'dispute' | 'fee' | 'instant_payment' | 'interest' | 'other' | 'peer_to_peer_transfer' | 'reversal' | 'reversed_transfer' | 'wire'
Example:ach

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

has_returnboolean
Example:true

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

show_denied_authsboolean
Example:true

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

show_expiredboolean
Example:true

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

status'canceled' | 'queued' | 'pending' | 'settled' | 'failed' | 'expired' | 'denied'

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

search_descriptionstring
Example:Transfer*

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_zeroboolean
Example:true

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

sort'created_at_asc' | 'created_at_desc' | 'description_asc' | 'description_desc' | 'id_asc' | 'id_desc' | 'settled_index_asc' | 'settled_index_desc' | 'us_dollar_amount_asc' | 'us_dollar_amount_desc'
created_at_afterSchema — unresolved $ref

Return only results with created_at after the provided ISO 8601 date or timestamp

created_at_beforeSchema — unresolved $ref

Return only results with created_at before the provided ISO 8601 date or timestamp

settled_at_afterstring date-time
Example:2020-01-01T00:00:00Z

Return only transactions with settled_at after the provided ISO 8601 timestamp

settled_at_beforeSchema — unresolved $ref

Return only transactions with settled_at before the provided ISO 8601 timestamp

initial_action_at_afterSchema — unresolved $ref

Return only transactions with initial_action_at after the provided ISO 8601 timestamp

initial_action_at_beforeSchema — unresolved $ref

Return only transactions with initial_action_at before the provided ISO 8601 timestamp

settled_index_afterinteger
Example:123

Return only transactions with settled_index after the provided value

settled_index_beforeinteger
Example:123

Return only transactions with settled_index before the provided value

id_afterinteger
Example:123

Return only transactions with id after the provided value

id_beforeinteger
Example:123

Return only transactions with id before the provided value

Parameters

#/paths/~1pools/get/parameters/0 — unresolved $ref
#/paths/~1transfers/get/parameters/2 — unresolved $ref
#/paths/~1pools/get/parameters/1 — unresolved $ref
#/paths/~1pools/get/parameters/2 — unresolved $ref