GET
/
transactions
/
{id}
Get a transaction by ID
curl --request GET \
  --url https://api.synctera.com/v1/transactions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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": 123,
        "categorized_by": 123,
        "category": "<string>",
        "category_guid": "<string>",
        "described_by": 123,
        "description": "<string>",
        "extended_transaction_type": "<string>",
        "id": 123,
        "is_bill_pay": true,
        "is_direct_deposit": true,
        "is_expense": true,
        "is_fee": true,
        "is_income": true,
        "is_international": true,
        "is_overdraft_fee": true,
        "is_payroll_advance": true,
        "is_subscription": true,
        "memo": "<string>",
        "merchant_category_code": 123,
        "merchant_guid": "<string>",
        "merchant_location_guid": "<string>",
        "original_description": "<string>",
        "type": "<string>"
      }
    ]
  },
  "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.

Path Parameters

​
id
string<uuid>
required

Transaction ID

Example:

"472341e0-ea3e-41a1-96bc-fd0185e1eac8"

Query Parameters

​
show_partial_clearings
boolean

Include a transaction for each clearing of an authorization.

Response

Transaction

​
card_transaction
object
required

Transaction metadata specific to transactions with type CARD

​
subtype
enum<string>
required

The set of valid CARD transaction subtypes

Available options:
ATM_WITHDRAWAL,
ATM_WITHDRAWAL_REVERSAL,
BALANCE_INQUIRY,
CARD_NETWORK_FINAL_CHARGEBACK,
CARD_NETWORK_FINAL_CHARGEBACK_REVERSAL,
CARD_NETWORK_FIRST_CHARGEBACK,
CARD_NETWORK_FIRST_CHARGEBACK_REVERSAL,
CARD_NETWORK_REPRESENTMENT,
CARD_NETWORK_REPRESENTMENT_REVERSAL,
CARD_TRANSACTION,
CARD_TRANSACTION_REVERSAL,
CHARGEBACK,
CHARGEBACK_REVERSAL,
CREDIT,
CREDIT_REVERSAL,
DIRECTPOST,
DIRECTPOST_REVERSAL,
POS_CASHBACK,
POS_CASHBACK_REVERSAL,
POS_PURCHASE,
POS_PURCHASE_REFUND,
POS_PURCHASE_REFUND_REVERSAL,
POS_PURCHASE_REVERSAL,
POS_REFUND,
POS_REFUND_REVERSAL,
PROVISIONAL_CREDIT,
PROVISIONAL_CREDIT_REVERSAL
​
amount
integer
required

The total amount of the transaction including both pending and already posted amounts. The value is represented as the smallest denomination of the applicable currency.

​
creation_time
string<date-time>
required

The exact time the transaction was recorded in the ledger

​
currency
string
required

ISO 4217 alphabetic currency code of the transfer amount

​
dc_sign
enum<string>
required

The dc_sign represents the direction money was moved. A value of DEBIT is money moving out of an account, a value of CREDIT is money moving into an account

Available options:
CREDIT,
DEBIT
​
effective_date
string<date>
required

The effective date of the transaction. This usually aligns with network settlement date, which differs between transaction types. The effective date is also used to determine effective daily balances for the purposes of interest calculation.

​
force_post
boolean
required

Determines whether or not a transaction or auth was "forced" or not. A forced transaction skips any account balance checks

​
group_id
string
required

The group id of the transaction. Every transaction in the ledger is one entry in a double-entry system and the primary and offset transactions share the same group_id

​
id
string<uuid>
required

The unique identifier of the transaction

​
last_updated_time
string<date-time>
required

The date and time the transaction was last modified

​
partial_hold
boolean
required

Determines whether or not the funds on hold were the result of a partial auth or not. If true the pending_amount of the transaction will be less than the requested amount. This is primarily used for certain types of card transactions.

​
pending_amount
integer
required

The amount amount of the transaction currently authorized or on hold

​
posted_amount
integer
required

The amount of the transaction that has been fully posted to the account

​
status
enum<string>
required

The status of the transaction

Available options:
COMPLETE,
DECLINED,
PENDING
​
transaction_time
string<date-time>
required

The time the transaction occurred. In most cases this will be roughly identical to creation_time, but it can differ in some situations if the payment doesn't appear in the ledger in real-time.

​
type
enum<string>
required

The type of the transaction. This typically represents the "payment" rail that is used. For example, for ACH payments this will be ach, while debit card transactions will use card.

Available options:
ACH,
CARD,
CASH,
CHECK,
EXTERNAL_CARD,
FEDNOW,
FEE,
INTERNAL_TRANSFER,
REWARD,
SYNCTERA_PAY,
WIRE
​
account_id
string

The account uuid associated with the transaction. account_id and internal_account_id are mutually exclusive

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
customer_id
string

The uuid of the customer that initiated the transaction (if any)

​
decline
object

The decline object provides information explaining why a declined transaction was declined.

​
description
string

A human-friendly description of the transaction, provided by the integrator

​
enhanced_transaction
object

Enriched transaction metadata

​
fraud_risk
object

Transaction fraud risk evaluation result

​
hold_expiration_time
string<date-time>

The date and time any pending amount is expected to be released back to the account.

​
internal_account_id
string

The internal account uuid associated with the transaction. account_id and internal_account_id are mutually exclusive

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
metadata
object | null

an unstructured json blob representing additional transaction information supplied by the integrator.

​
posted_date
string<date>

The date the transaction was posted (based on the bank calendar and end-of-day). For transaction with multiple postings, this is the date of the earliest posting. This will be omitted for transactions with a posted_amount of 0.

​
reference_id
string

An external ID provided by the payment network to represent this transaction. This is not guaranteed to be globally unique. This will always be omitted for internal transfers.

​
settlement_date
string<date>

The date the transaction was settled according to Synctera's platform. Generally, this can be interpretted the date the transaction was actually processed and settlement by the payment network.

​
system_description
string

A human-friendly description of the transaction, provided by the Synctera platform