Transaction Fields

This page is a complete reference of all fields that can be included when submitting a transaction to FraudShield, whether via Batch Upload or the API.

note

Most fields are optional. However, if a rule you have created references a specific field, that field must be provided for the rule to evaluate correctly.

Each submission has three parts:

• transaction — the transaction details. Always required.
• originAcct — the account the funds are coming from.
• destAcct — the account the funds are going to.

You must include at least one account (originAcct or destAcct), but providing both is recommended. If you include an account, all of its Required fields must be provided.

---

Transaction Fields

API

Field	Required	Description
transDate	Required	DateTime - Date and time when the transaction occurred. Must follow ISO 8601 format: YYYY-MM-DDThh:mm:ss[.mmm]TZD.
transType	Required	Enum - Type of transaction. Accepted values: Deposit, Withdrawal, Transfer, Payment, ATMDeposit, ATMWithdrawal, LoanRepayment, LoanDeposit, InsuranceSurrender, InsurancePurchase, InsuranceCancellation, CurrencyConversion, Bet, CryptoPurchase, CryptoSale, AssetPurchase, AssetSale, Dividends, FeesCharges, RefundReversal, StandingOrder, SalaryPayroll, TaxPayment, Remittance, InternalTransfer, Donation, LoanDisbursement, Other.
transMethod	Required	Enum - Method used to conduct the transaction. Accepted values: Cash, Cheque, CreditCard, CryptoCurrency, SWIFT, DomesticWire, EFTACH, DirectDebit, PrepaidCard, DebitCard, MobileWallet, Other.
amount	Required	Decimal - Monetary amount involved in the transaction, in your local base currency.
transId	Optional	String, ≤200 chars - Unique identifier for the transaction. If not provided, a UUID is automatically generated.
industry	Optional	Enum - Industry associated with the transaction. Accepted values: Accounting, Insurance, Gambling, RealEstate, Crypto, Legal, Fintech, Banking, Superannuation, RetailEcommerce, FinancialServicesNonBank, SecuritiesFirm, GeneralDealer, Education, ReligiousActivity, ProfessionalServices, ImportExport, Construction, Healthcare, LogisticsTransport, PublicSector, NonProfitNGO, PreciousMetalsDPMS, Pharmaceuticals, ArmsDealer.
currency	Optional	ISO 4217 - Currency used for the transaction (e.g. USD, AUD, EUR).
purpose	Optional	String, ≤500 chars - Purpose of the transaction, provided by you. Use description for customer-provided information.
location	Optional	ISO 3166 - Physical location of the transaction as a country code (e.g. AUS, USA).
chqNumber	Optional	String, ≤200 chars - Cheque number associated with the transaction, if applicable.
assetType	Optional	String, ≤200 chars - Type of asset involved in the transaction, if applicable.
convRate	Optional	Decimal - Conversion rate applied to the transaction.
description	Optional	String, ≤500 chars - Description of the transaction provided by the customer. Use purpose for information provided by you.
extraInfo	Optional	Object - Additional key-value pairs for any information not covered by the standard fields. Example: {"Key1": "Value", "Key2": "Value"}.
Insurance Policy		Nested under insurancePolicy. Only include these fields if the transaction involves an insurance policy.
insurancePolicy.value	Optional	Decimal - Monetary value of the insurance policy.
insurancePolicy.purchaseDate	Optional	DateTime - Date and time when the policy was purchased. Must follow ISO 8601 format.
insurancePolicy.insuranceType	Optional	Enum - Type of insurance policy. Accepted values: LifeInsurance, HomeInsurance, HealthInsurance, AutoInsurance.
insurancePolicy.premiumAmount	Optional	Decimal - Amount paid regularly to maintain the policy.
insurancePolicy.surrenderPeriod	Optional	Decimal - Duration after which the policy can be surrendered.
insurancePolicy.surrenderPenalty	Optional	Decimal - Penalty amount applied if the policy is surrendered early.

Batch CSV

CSV Column	Required	Description
transaction_transdate	Required	DateTime - Date and time when the transaction occurred. Must follow ISO 8601 format: YYYY-MM-DDThh:mm:ss[.mmm]TZD.
transaction_transtype	Required	Enum - Type of transaction. Accepted values: Deposit, Withdrawal, Transfer, Payment, ATMDeposit, ATMWithdrawal, LoanRepayment, LoanDeposit, InsuranceSurrender, InsurancePurchase, InsuranceCancellation, CurrencyConversion, Bet, CryptoPurchase, CryptoSale, AssetPurchase, AssetSale, Dividends, FeesCharges, RefundReversal, StandingOrder, SalaryPayroll, TaxPayment, Remittance, InternalTransfer, Donation, LoanDisbursement, Other.
transaction_transmethod	Required	Enum - Method used to conduct the transaction. Accepted values: Cash, Cheque, CreditCard, CryptoCurrency, SWIFT, DomesticWire, EFTACH, DirectDebit, PrepaidCard, DebitCard, MobileWallet, Other.
transaction_amount	Required	Decimal - Monetary amount involved in the transaction, in your local base currency.
transaction_transid	Optional	String, ≤200 chars - Unique identifier for the transaction. If not provided, a UUID is automatically generated.
transaction_industry	Optional	Enum - Industry associated with the transaction. Accepted values: Accounting, Insurance, Gambling, RealEstate, Crypto, Legal, Fintech, Banking, Superannuation, RetailEcommerce, FinancialServicesNonBank, SecuritiesFirm, GeneralDealer, Education, ReligiousActivity, ProfessionalServices, ImportExport, Construction, Healthcare, LogisticsTransport, PublicSector, NonProfitNGO, PreciousMetalsDPMS, Pharmaceuticals, ArmsDealer.
transaction_currency	Optional	ISO 4217 - Currency used for the transaction (e.g. USD, AUD, EUR).
transaction_purpose	Optional	String, ≤500 chars - Purpose of the transaction, provided by you. Use transaction_description for customer-provided information.
transaction_location	Optional	ISO 3166 - Physical location of the transaction as a country code (e.g. AUS, USA).
transaction_chqnumber	Optional	String, ≤200 chars - Cheque number associated with the transaction, if applicable.
transaction_assettype	Optional	String, ≤200 chars - Type of asset involved in the transaction, if applicable.
transaction_convrate	Optional	Decimal - Conversion rate applied to the transaction.
transaction_description	Optional	String, ≤500 chars - Description of the transaction provided by the customer. Use transaction_purpose for information provided by you.
transaction_extrainfo	Optional	Object - Additional key-value pairs for any information not covered by the standard fields. Example: {"Key1": "Value", "Key2": "Value"}.
Insurance Policy		Only include these columns if the transaction involves an insurance policy.
transaction_insurancepolicy_value	Optional	Decimal - Monetary value of the insurance policy.
transaction_insurancepolicy_purchasedate	Optional	DateTime - Date and time when the policy was purchased. Must follow ISO 8601 format.
transaction_insurancepolicy_insurancetype	Optional	Enum - Type of insurance policy. Accepted values: LifeInsurance, HomeInsurance, HealthInsurance, AutoInsurance.
transaction_insurancepolicy_premiumamount	Optional	Decimal - Amount paid regularly to maintain the policy.
transaction_insurancepolicy_surrenderperiod	Optional	Decimal - Duration after which the policy can be surrendered.
transaction_insurancepolicy_surrenderpenalty	Optional	Decimal - Penalty amount applied if the policy is surrendered early.

---

Account Fields

The following fields apply to both originAcct and destAcct. At least one account object must be included in each submission.

API

Field	Required	Description
acctId	Required	String, ≤200 chars - Identifier for the account used in the transaction. Used to build a customer profile if reference is not provided.
acctType	Required	Enum - Type of account. Accepted values: BankAcct, WalletAddr, InsurPolicy, GamblingAcct, SuperPolicy, LoanAcct, Other.
reference	Optional	String, ≤200 chars - Unique customer reference from your own systems. Links multiple accounts to a single customer profile. If not provided, acctId is used instead.
fullName	Optional	String, ≤200 chars - Full name of the account holder. If provided, takes precedence over firstName, middleName, and lastName for display purposes.
firstName	Optional	String, ≤200 chars - First name of the account holder.
middleName	Optional	String, ≤200 chars - Middle name of the account holder.
lastName	Optional	String, ≤200 chars - Last name of the account holder.
businessType	Optional	String, ≤200 chars - Type of business activity, if applicable.
entityType	Optional	Enum - Nature of the account entity. Accepted values: Business, Private.
riskLevel	Optional	Enum - Assessed risk level for the account. Accepted values: Low, Medium, High.
email	Optional	String, ≤200 chars - Email address of the account holder. Must be a valid email format.
phoneNumber	Optional	String, ≤200 chars - Phone number of the account holder.
dob	Optional	Date - Date of birth of the account holder. Must follow ISO 8601 format: YYYY-MM-DD.
acctOpenIp	Optional	String, ≤200 chars - IP address recorded when the account was opened.
transIp	Optional	String, ≤200 chars - IP address recorded during this transaction.
creationDate	Optional	DateTime - Date and time when the account was created. Must follow ISO 8601 format.
modifiedDate	Optional	DateTime - Date and time when the account details were last modified. Must follow ISO 8601 format.
emplStatus	Optional	Enum - Employment status of the account holder. Accepted values: Employed, SelfEmployed, Unemployed.
initialFundingAmount	Optional	Decimal - Amount initially deposited into the account.
acctBal	Optional	Decimal - Current balance of the account.
loanBal	Optional	Decimal - Outstanding loan balance associated with the account.
initialLoanAmount	Optional	Decimal - Initial loan amount taken out against the account.
taxLocation	Optional	ISO 3166 - Country of tax residency as a country code (e.g. AUS, USA).
sourceFunds	Optional	Enum - Origin of the funds. Accepted values: SaleOfAssets, Income, Inheritance, Gambling, Insurance.
relatedParties	Optional	Array - List of related account IDs (acctId) associated with this account. Items separated by ,.
extraInfo	Optional	Object - Additional key-value pairs for any information not covered by the standard fields. Example: {"Key1": "Value", "Key2": "Value"}.
Address		Nested under address. All fields are optional.
address.city	Optional	String, ≤200 chars - City where the address is located.
address.country	Optional	ISO 3166 - Country code (e.g. AUS, USA).
address.line1	Optional	String, ≤500 chars - Primary address line.
address.line2	Optional	String, ≤500 chars - Secondary address line.
address.line3	Optional	String, ≤500 chars - Third address line.
address.postCode	Optional	String, ≤10 chars - Postal code for the address.
address.state	Optional	String, ≤200 chars - State or region within the country.

Batch CSV

note

The columns below are for the origin account (originacct_ prefix). For the destination account, replace originacct_ with destacct_ — for example, originacct_acctid becomes destacct_acctid.

CSV Column	Required	Description
originacct_acctid	Required	String, ≤200 chars - Identifier for the account used in the transaction. Used to build a customer profile if originacct_reference is not provided.
originacct_accttype	Required	Enum - Type of account. Accepted values: BankAcct, WalletAddr, InsurPolicy, GamblingAcct, SuperPolicy, LoanAcct, Other.
originacct_reference	Optional	String, ≤200 chars - Unique customer reference from your own systems. Links multiple accounts to a single customer profile. If not provided, originacct_acctid is used instead.
originacct_fullname	Optional	String, ≤200 chars - Full name of the account holder. If provided, takes precedence over originacct_firstname, originacct_middlename, and originacct_lastname for display purposes.
originacct_firstname	Optional	String, ≤200 chars - First name of the account holder.
originacct_middlename	Optional	String, ≤200 chars - Middle name of the account holder.
originacct_lastname	Optional	String, ≤200 chars - Last name of the account holder.
originacct_businesstype	Optional	String, ≤200 chars - Type of business activity, if applicable.
originacct_entitytype	Optional	Enum - Nature of the account entity. Accepted values: Business, Private.
originacct_risklevel	Optional	Enum - Assessed risk level for the account. Accepted values: Low, Medium, High.
originacct_email	Optional	String, ≤200 chars - Email address of the account holder. Must be a valid email format.
originacct_phonenumber	Optional	String, ≤200 chars - Phone number of the account holder.
originacct_dob	Optional	Date - Date of birth of the account holder. Must follow ISO 8601 format: YYYY-MM-DD.
originacct_acctopenip	Optional	String, ≤200 chars - IP address recorded when the account was opened.
originacct_transip	Optional	String, ≤200 chars - IP address recorded during this transaction.
originacct_creationdate	Optional	DateTime - Date and time when the account was created. Must follow ISO 8601 format.
originacct_modifieddate	Optional	DateTime - Date and time when the account details were last modified. Must follow ISO 8601 format.
originacct_emplstatus	Optional	Enum - Employment status of the account holder. Accepted values: Employed, SelfEmployed, Unemployed.
originacct_initialfundingamount	Optional	Decimal - Amount initially deposited into the account.
originacct_acctbal	Optional	Decimal - Current balance of the account.
originacct_loanbal	Optional	Decimal - Outstanding loan balance associated with the account.
originacct_initialloanamount	Optional	Decimal - Initial loan amount taken out against the account.
originacct_taxlocation	Optional	ISO 3166 - Country of tax residency as a country code (e.g. AUS, USA).
originacct_sourcefunds	Optional	Enum - Origin of the funds. Accepted values: SaleOfAssets, Income, Inheritance, Gambling, Insurance.
originacct_relatedparties	Optional	Array - List of related account IDs associated with this account. Items separated by ,.
originacct_extrainfo	Optional	Object - Additional key-value pairs for any information not covered by the standard fields. Example: {"Key1": "Value", "Key2": "Value"}.
Address		Only include these columns if providing address information.
originacct_address_city	Optional	String, ≤200 chars - City where the address is located.
originacct_address_country	Optional	ISO 3166 - Country code (e.g. AUS, USA).
originacct_address_line1	Optional	String, ≤500 chars - Primary address line.
originacct_address_line2	Optional	String, ≤500 chars - Secondary address line.
originacct_address_line3	Optional	String, ≤500 chars - Third address line.
originacct_address_postcode	Optional	String, ≤10 chars - Postal code for the address.
originacct_address_state	Optional	String, ≤200 chars - State or region within the country.

What's next?

Move on to Going Live when you're ready to move from testing to production.