Page tree
Skip to end of metadata
Go to start of metadata

You are able to set up to 10 of your own custom fields on the Bank Account Transaction object. These fields are then persisted to our database with all the other transaction's information. Custom Fields can be made required if you would like for all transactions via SDK and/or Virtual Terminal. They would be required for both ACH and Bank Card if required.

To set custom field's names, which it is not required to set the fields name to be able to set the custom field in the SDK when processing a transaction, you will want to login to the merchant portal. On the Settings tab from the Custom Field Settings you can set what you want names and requirements you want.

Custom Fields will show in GUI only if the custom field has a field name set on it in the merchant's custom field settings.






SDK example of setting the 10 custom fields then getting them after processing the transaction:

BankAccountTransaction o_ach_transaction = new BankAccountTransaction();
o_ach_transaction.setType(BankAccountTransaction.XS_BAT_TYPE_DEBIT);
o_ach_transaction.setMethod(BankAccountTransaction.XS_BAT_METHOD_CCD);
o_ach_transaction.setRoutingNumber("021000021");
o_ach_transaction.setAmount(10.99);
o_ach_transaction.setAccountType(BankAccountTransaction.XS_BAT_ACCOUNT_TYPE_CHECKING);
o_ach_transaction.setAccountName("Sample ACH Transaction");
o_ach_transaction.setAccountNumber("12345678");
o_ach_transaction.setCustomField1("field 1");
o_ach_transaction.setCustomField2("field 2");
o_ach_transaction.setCustomField3("field 3");
o_ach_transaction.setCustomField4("field 4");
o_ach_transaction.setCustomField5("field 5");
o_ach_transaction.setCustomField6("field 6");
o_ach_transaction.setCustomField7("field 7");
o_ach_transaction.setCustomField8("field 8");
o_ach_transaction.setCustomField9("field 9");
o_ach_transaction.setCustomField10("field 10");


BaseCommerceClient o_client = new BaseCommerceClient(XS_USERNAME, XS_PASSWORD, XS_KEY);
o_client.setSandbox(true);
o_ach_transaction = o_client.processBankAccountTransaction(o_ach_transaction);
        
System.out.println( o_ach_transaction.getCustomField1() );
System.out.println( o_ach_transaction.getCustomField2() );
System.out.println( o_ach_transaction.getCustomField3() );
System.out.println( o_ach_transaction.getCustomField4() );
System.out.println( o_ach_transaction.getCustomField5() );
System.out.println( o_ach_transaction.getCustomField6() );
System.out.println( o_ach_transaction.getCustomField7() );
System.out.println( o_ach_transaction.getCustomField8() );
System.out.println( o_ach_transaction.getCustomField9() );
System.out.println( o_ach_transaction.getCustomField10() );


  • No labels