Transaction Statuses

Please refer to:

Transaction Object

General & Miscellaneous

KeyTypeDescription
_idstringObject ID of transaction
_links.self.hrefstringHAL-style link for the object
_vintegerStyle version
amount.amountfloatAmount user wishes to send
amount.currencystringCurrency of the transaction amount (e.g. USD for dollars, cUSD for cents)
client.idstringObject ID of client
client.namestringName of the client
fees[]array of objectsList of fees and fee nodes associated with transaction

extra

KeyTypeDescription
extra.created_onintegerDate transaction was created (milliseconds since Unix epoch time).
extra.ipstringSender's IP address
extra.notestringMemo tagged with the transaction
extra.other.attachments[]array of strings[Deprecated]
extra.other.dispute_formstringDispute form link for debit card transactions
extra.other.disputedbooleanFlag for disputed transactions
extra.process_onintegerDate to process transaction (milliseconds since Unix epoch time).
extra.supp_idstringAdditional ID supplied to transaction
extra.tracking_numberstringTracking number provided to transaction

recent_status

KeyTypeDescription
recent_status.codestringIf a transaction is updated with transaction status of queued (QUEUED-BY-SYNAPSE), canceled (CANCELED), or returned (RETURNED) , this field will provide the transaction queue code (e.g. Q02), transaction cancellation code (e.g. C08), or transaction return code (e.g. R01, CR01, IR01, CHR01, or WR01) as appropriate. Both the code and a brief description are provided in the recent_status.note field.
recent_status.dateintegerDate of most recent update (milliseconds since Unix epoch time).
recent_status.notestringAdditional notes about transaction
recent_status.statusstringStatus of transaction
recent_status.status_idstringStatus ID of transaction

from

KeyTypeDescription
from.nicknamestringNickname of sending node
from.typestringType of transaction
from.user._idstringObject ID of sending user
from.user.legal_namesarray of stringsList of sending user legal names

timeline

KeyTypeDescription
dateintegerDate of timeline update (milliseconds since Unix epoch time).
notestringAdditional notes about transaction status update
statusstringStatus of transaction update
status_idstaringStatus ID of transaction update

to.meta

K‌‌ey ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌TypeDescription
conversion_metaobjectDescribes applicable currency conversions from the transaction.
foreign_transactionbooleanInforms if the transaction occurred in a foreign merchant.
fraud_score.reasonstringRisk Reasons provides reason codes for details on the transaction as assigned by Synapse's fraud monitoring service. Refer to Native Card Issuance Risk Reasons for list of codes and descriptions.
fraud_score.scorefloatscore is set from 0.000 - 1.000 as assigned by Synapse's fraud monitoring service.
mccstringMerchant Category Code (MCC) of merchant as assigned by the card processor. Learn more here.
mid ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringUnique Merchant ID (MID) as assigned by the card processor.
merchant_category ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringCategory for the merchant as assigned by Synapse's data enrichment service (e.g. "digital_payment").
merchant_id ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringUnique ID of the merchant as assigned by Synapse's data enrichment service.
merchant_logo ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringLink to image of the logo for the merchant as assigned by Synapse's data enrichment service.
merchant_name ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringCommon (i.e. non-unique), human-readable name for the merchant as assigned by Synapse's data enrichment service.
merchant_official_page ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringLink to the official website for the merchant as assigned by Synapse's data enrichment service.
merchant_phone_number ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringPhone number for the merchant as assigned by Synapse's data enrichment service.
merchant_subcategory ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringSubcategory for the merchant as assigned by Synapse's data enrichment service (e.g. "discretionary_spending").
partial_approval_allowed ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌booleanNotifies if partial approval is allowed for the transaction.
rebates ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌arrayFunctionality being developed. Reference page will be updated when rebates are launched.
revenues ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌arrayInterchange revenues from the transaction. Due to limitations by the card networks revenues will take up to 48 hours to fill in the JSON.
subnet_id ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringID of the card (subnet)
type ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌ ‌‌stringType of transaction. Learn more here

to.meta.revenues

KeyTypeDescription
revenues.amountfloatThe amount of the interchange revenue or fee. Revenues will be positive amounts while fees (either switch fees or fees for ATM withdrawals) will be negative amounts.
revenues.{}.typestringThe type of revenue or fee (e.g. "switch_fee" for network switch fees).
revenues.{}.meta.programstringThe program that applies to the interchange revenue object, that will vary based on the meta.type (e.g. the type of switch fee or the specific interchange revenue program).
revenues.{}.meta.capintegerThe max for meta.amount in cUSD (can be null if there is no max / cap amount).
revenues.{}.meta.fixed_rateintegerFixed value in cUSD that will always be included in amount.
revenues.{}.meta.variable_rateintegerVariable rate for the interchange revenue object representing basis points used to calculate total amount.
revenues.{}.meta.unadjusted_valueintegerUnadjusted interchange revenue for the transaction in cUSD.
revenues.{}.meta.daily_adjustment_rateintegerDaily adjustment rate for the interchange revenue object in cUSD. Synapse adjusts transaction-level interchange revenue based on the total interchange revenue reported back to us. The adjustment rate is calculated by democratizing the difference between the reported total and the total unadjusted values (i.e. by spreading the difference across all relevant transactions).

to (not including to.meta)

KeyTypeDescription
to.idstringObject ID of receiving node
to.nicknamestringNickname of receiving node
to.typestringType of receiving node.
to.user.idstringObject ID of receiving user
to.user.legalarray of stringsList of receiving user legal names
Language