The Transaction Type sub-object

A description of the possible transaction types and their sub-objects
Transactions
The Transaction Type sub-object
 last updated: 
September 28, 2022

ACH Transaction sub-object

Field Type Description
transferId string unique id of the transfer info object created.
contactId string contact id of individual or business for the transfer.
name string contact name of individual or business for the transfer.
routingNumber string routing number of the contact's account.
type enum type of ach, sameDay or nextDay.
bankName string name of bank where the ACH originated
traceNumber string unique identifier within the ACH batch file
authId string ACH authorization ID number
returnReasonMessage string reason code given in case of ACH reversal

Card Transaction sub-object

Field Type Description
id string unique id of card transaction info sub object created.
transferId string unique id of transfer object created.
label string label of the card used.
merchant object merchant the card was used at, for example:
"merchant": {
  "merchantName": "CVS PHARMACY",
  "merchantCity": "SAN JOSE",
  "merchantState": "CA",
  "merchantCountry": "US",
  "postalCode": "95129",
  "merchantCategory": "Drug Stores and Pharmacies"
  "merchantCategoryCode": "5912"
  "merchantId": "824743298982361"
}
authMethod enum method of use for the card transaction:
- keyedIn
- swipe
- chip
- online
- contactless
- other
wallet enum digital wallet type:
- applePay
- googlePay
- samsungPay
authId string card authorization ID
localTransactionAmount int local currency transaction amount
localTransactionCurrency string local currency code (eg. USD)
currencyConversionRate int local currency conversion rate

Intrabank Transaction sub-object

Field Type Description
accountNumber string intrabank account number of the contact

The Domestic Wire sub-object

Field Type Description
accountNumber string bank account number of the contact
routingNumber string ACH routing number of the contact's bank
imad string IMAD (Input Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.
omad string OMAD (Output Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.
accountType string type of the contact's bank account with possible values:
- businessChecking
- personalChecking
- businessSavings
- personalSavings
bankName string bank name of contact's bank
address object see the Address sub-object

The International Wire sub-object

Field Type Description
bankIdentifierType enum Bank identifier type possible values:
- swift
bankIdentifierCode string bank's SWIFT/BIC code
imad string IMAD (Input Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.
accountType string type of the contact's bank account with possible values:
- business
- personal
beneficiaryBank string name of the beneficiary bank
beneficiaryAddress object see The Address sub-object
beneficiaryBankAddress object see The Address sub-object
correspondentBank string name of the correspondent bank, if aaplicable
correspondentBankIdentifierCode string correspondent bank's SWIFT/BIC code
correspondentBankAddress object see The Address sub-object


The Debit Card sub-object

Field Type Description
transferId string unique ID of the transfer
contactId string unique ID of the contact
name string name of the contact


The Solid Card sub-object

Field Type Description
transferId string unique ID of the transfer
contactId string unique ID of the contact
name string name of the contact

The Physical Check sub-object

Field Type Description
transferId string unique ID of the transfer
contactId string unique ID of the contact
name string name of the contact
checkNumber string check number
shipping object the shipping object contains the following:
- shippingAddress sub-object (required)
- eta is the estimated time of arrival
- deliveryStatus has possible values of mailed, transit, processed, rerouted


More Info about deliveryStatus:

mailed - The mail piece was handed off from our printer network to the USPS and was confirmed to be in USPS custody. It is currently en route to its delivery destination.

transit - The mail piece is being processed at the USPS entry/origin facility.

processed - The mail piece has been green-lit for delivery at the recipient's nearest USPS postal facility. The mail piece should reach the mailbox within 1 business day of this tracking event.

If it cannot be delivered, then:

rerouted - The mail piece is re-routed due to recipient change of address, address errors, or USPS relabeling of barcode/ID tag area.