Skip to main content
GET
/
transactions
List Transactions
curl --request GET \
  --url https://api.synctera.com/v1/transactions \
  --header 'Authorization: Bearer <token>'
{
  "next_page_token": "<string>",
  "transactions": [
    {
      "card_transaction": {
        "card_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
        "currency_code": "<string>",
        "currency_conversion": {
          "conversion_rate": 123,
          "original_amount": 123,
          "original_currency_code": "<string>"
        },
        "merchant": {
          "address": "<string>",
          "city": "<string>",
          "country_code": "<string>",
          "independent_sales_organization_id": "<string>",
          "mcc": "<string>",
          "mid": "<string>",
          "name": "<string>",
          "payment_facilitator_id": "<string>",
          "postal_code": "<string>",
          "state": "<string>",
          "sub_merchant_id": "<string>"
        },
        "network": "<string>",
        "network_reference_id": "<string>",
        "pos": {
          "card_data_input_capability": "<string>",
          "card_holder_presence": true,
          "card_presence": true,
          "cardholder_authentication_method": "<string>",
          "country_code": "<string>",
          "is_installment": true,
          "is_recurring": true,
          "pan_entry_mode": "<string>",
          "partial_approval_capable": true,
          "pin_entry_mode": "<string>",
          "pin_present": true,
          "purchase_amount_only": true,
          "terminal_attendance": "<string>",
          "terminal_id": "<string>",
          "terminal_location": "<string>",
          "terminal_type": "<string>",
          "zip": "<string>"
        }
      },
      "subtype": "ATM_WITHDRAWAL",
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "amount": 123,
      "creation_time": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "customer_id": "<string>",
      "dc_sign": "CREDIT",
      "decline": {
        "decline_details": "<string>",
        "reason": "ACH_RETURN"
      },
      "description": "<string>",
      "effective_date": "2023-12-25",
      "enhanced_transaction": {
        "category": "<string>",
        "enhanced_description": "<string>",
        "enhanced_raw": [
          {
            "amount": "<any>",
            "categorized_by": "<any>",
            "category": "<any>",
            "category_guid": "<any>",
            "described_by": "<any>",
            "description": "<any>",
            "extended_transaction_type": "<any>",
            "id": "<any>",
            "is_bill_pay": "<any>",
            "is_direct_deposit": "<any>",
            "is_expense": "<any>",
            "is_fee": "<any>",
            "is_income": "<any>",
            "is_international": "<any>",
            "is_overdraft_fee": "<any>",
            "is_payroll_advance": "<any>",
            "is_subscription": "<any>",
            "memo": "<any>",
            "merchant_category_code": "<any>",
            "merchant_guid": "<any>",
            "merchant_location_guid": "<any>",
            "original_description": "<any>",
            "type": "<any>"
          }
        ]
      },
      "force_post": true,
      "fraud_risk": {
        "decision": "ACCEPT",
        "reasons": [
          "SUSPECTED_FRAUD"
        ],
        "vendor": "FEEDZAI",
        "vendor_reasons": [
          "<string>"
        ]
      },
      "group_id": "<string>",
      "hold_expiration_time": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "internal_account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "metadata": {},
      "partial_hold": true,
      "pending_amount": 123,
      "posted_amount": 123,
      "posted_date": "2023-12-25",
      "reference_id": "<string>",
      "settlement_date": "2023-12-25",
      "status": "COMPLETE",
      "system_description": "<string>",
      "transaction_time": "2023-11-07T05:31:56Z",
      "type": "ACH"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
posted_amount
integer

Only return transactions equal to the given posted_amount

​
include_child_transactions
boolean

Include transactions from sub-accounts when listing transactions for a given account

​
amount
integer

Only return transactions equal to the given amount

​
posted_date
string<date>

Only return transactions matching the given posted_date

​
amount_lt
integer

Only return transactions with amount less than amount_lt

​
type
enum<string>[]

Only return transactions matching the given type

Example:

"ACH,CARD"

​
posted_amount_gte
integer

Only return transactions with posted_amount greater than or equal to posted_amount_gte

​
posted_amount_lt
integer

Only return transactions with posted_amount less than posted_amount_lt

​
posted_amount_lte
integer

Only return transactions with posted_amount less than or equal to posted_amount_lte

​
status
enum<string>[]

Only return transactions with the given status or statuses

Example:

"PENDING,DECLINED"

​
internal_account_id
string<uid>

Only return transactions matching the given internal_account_id

​
pending_amount_lte
integer

Only return transactions with pending_amount less than or equal to pending_amount_lte

​
amount_gte
integer

Only return transactions with amount greater than or equal to amount_gte

​
account_id
string<uuid>[]

Account ID

​
show_partial_clearings
boolean

Include a transaction for each clearing of an authorization.

​
group_id
string<uuid>

Only return transactions matching the given group_id

​
pending_amount_gte
integer

Only return transactions with pending_amount greater than or equal to pending_amount_gte

​
exclude_jit_transactions
boolean

Hide "JIT funding" transactions from results

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
card_id
string<uuid>

Card ID

Example:

"6dc0397d-1aba-4be9-9582-895a7a887d49"

​
pending_amount
integer

Only return transactions equal to the given pending_amount

​
account_source
enum<string>

Determines whether to return only transactions against customer accounts (CUSTOMER) vs internal accounts (INTERNAL). The default is to return all transactions if no account_source is specified.

Available options:
CUSTOMER,
INTERNAL
​
posted_date_from
string<date>

Only return transactions later than the given posted_date

​
posted_amount_gt
integer

only return transactions with posted_amount greater than posted_amount_gt

​
pending_amount_gt
integer

only return transactions with pending_amount greater than pending_amount_gt

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
amount_gt
integer

Only return transactions with amount greater than amount_gt

​
posted_date_to
string<date>

Only return transactions up to the given posted_date

​
amount_lte
integer

Only return transactions with amount less than or equal to amount_lte

​
subtype
enum<string>[]

Only return transactions matching the given subtype

Example:

"OUTGOING_DEBIT,INCOMING_CREDIT"

​
pending_amount_lt
integer

Only return transactions with pending_amount less than pending_amount_lt

Response

Paginated list of transactions

​
next_page_token
string | null
required

If returned, use the value of next_page_token in the page_token query parameter to query for the next page of results. This will be null if there are no more pages.

​
transactions
(Card Transaction · object | Fee Transaction · object | External Card Transaction · object | FedNow Transaction · object | Synctera Pay Transaction · object | Check Transaction · object | Wire Transaction · object | Cash Transaction · object | ACH Transaction · object | Reward Transaction · object | Internal Transfer Transaction · object)[]
required

List of transactions

  • Card Transaction
  • Fee Transaction
  • External Card Transaction
  • FedNow Transaction
  • Synctera Pay Transaction
  • Check Transaction
  • Wire Transaction
  • Cash Transaction
  • ACH Transaction
  • Reward Transaction
  • Internal Transfer Transaction