TransactionsService

Perform transactions.

Symitar eDocs References: Coming soon.

Operations

deposit

post

Perform a deposit transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringRequired

Identifies the account affected by the transaction.

ShareIdstringRequired

The share ID.

CommentstringOptional

The text of a comment transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

TaxDeferredContributionCodestringOptional

The tax deferred contribution code.

SourceCodestringOptional

The source of the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/deposit
200

Successful operation.

withdraw

post

Perform a withdrawal transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringRequired

Identifies the account affected by the transaction.

ShareIdstringRequired

The share ID.

AuthorizationTypestringOptional

The transaction authorization type.

SourceCodestringOptional

The source of the transaction.

CheckNumberstringOptional

The check number.

CheckIssuerstringOptional

The check issuer type.

CheckAccountCodeintegerOptional

The check account code.

CheckReferencestringOptional

The check reference for the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

CommentstringOptional

The text of a comment transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

RegulationDLimitedbooleanOptional

Whether transaction is limited to Reg D.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

TracerNumberstringOptional

The tracer number.

DraftNumberstringOptional

The draft number.

CalculateCheckbooleanOptional

Whether to calculate a check.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/withdraw
200

Successful operation.

newLoan

post

Creates a new loan transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional

Identifies the account affected by the transaction.

LoanIdstringOptional

The loan ID.

CheckNumberstringOptional

The check number.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

CheckAccountCodeintegerOptional

The check account code.

AuthorizationTypestringOptional

The transaction authorization type.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

CheckReferencestringOptional

The check reference for the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

TracerNumberstringOptional

The tracer number.

DraftNumberstringOptional

The draft number.

CalculateCheckbooleanOptional

Whether to calculate a check.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/newLoan
200

Successful operation.

payBill

post

Perform a bill payment transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional

Identifies the account affected by the transaction.

IdstringOptional

The ID of the Share record (if the ID Type field is set to 0) or the Loan record (if the ID Type field is set to 1) affected by the transaction.

IdTypestringOptional

Whether the transaction affected a Share or Loan record.

PaymentAmountnumber · floatOptional

The payment amount.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

RegulationDLimitedbooleanOptional

Whether transaction is limited to Reg D.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/payBill
200

Successful operation.

withdrawFee

post

Perform a withdrawal fee transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringRequired

Identifies the account affected by the transaction.

DonorIdstringOptional

The donor ID.

DonorTypestringOptional

The donor type.

TotalAmountnumber · floatOptional

The total amount.

AuthorizationTypestringOptional

The transaction authorization type.

FeeCodeintegerOptional

The fee code for a transaction.

CommentstringOptional

The text of a comment transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

EffectiveDatestring · dateOptional

The effective date of the transaction.

SourceCodestringOptional

The source of the transaction.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/withdrawFee
200

Successful operation.

transfer

post

Perform a funds transfer transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
DonorAccountNumberstringRequired

The donor account number.

DonorIdstringRequired

The donor ID.

DonorTypestringRequired

The donor type.

RecipientAccountNumberstringRequired

The recipient account number.

RecipientIdstringRequired

The recipient ID.

RecipientTypestringRequired

The recipient type.

TransferAmountnumber · floatOptional

The transfer amount.

CommentstringOptional

The text of a comment transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

PrincipalAmountnumber · floatOptional

The principal amount.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

LoanPaymentTypestringOptional

The loan payment type.

RegulationDLimitedbooleanOptional

Whether transaction is limited to Reg D.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/transfer
200

Successful operation.

stopCheckPayment

post

Stops a check payment transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringRequired

Identifies the account affected by the transaction.

DonorIdstringRequired

The donor ID.

DonorTypestringRequired

The donor type.

TotalAmountnumber · floatRequired

The total amount.

CommentstringOptional

The text of a comment transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

EffectiveDatestring · dateRequired

The effective date of the transaction.

SourceCodestringOptional

The source of the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

Responses
200

Successful operation.

application/json
post
/stopCheckPayment
200

Successful operation.

loanAddon

post

Adds an addon to an existing loan.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional

Identifies the account affected by the transaction.

IdTypestringOptional

Whether the transaction affected a Share or Loan record.

LoanIdstringOptional

The loan ID.

CheckNumberstringOptional

The check number.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

EffectiveDatestring · dateOptional

The effective date of the transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

SourceCodestringOptional

The source of the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

TracerNumberstringOptional

The tracer number.

DraftNumberstringOptional

The draft number.

CalculateCheckbooleanOptional

Whether to calculate a check.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/loanAddon
200

Successful operation.

payLoan

post

Perform a loan repayment transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
RecipientAccountNumberstringOptional

The recipient account number.

RecipientIdstringOptional

The recipient ID.

RecipientIdTypestringOptional

The recipient ID type.

CommentstringOptional

The text of a comment transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

PrincipalAmountnumber · floatOptional

The principal amount.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

LoanPaymentTypestringOptional

The loan payment type.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

Responses
200

Successful operation.

application/json
post
/payLoan
200

Successful operation.

reverseDeposit

post

Reverses a deposit transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringRequired

Identifies the account affected by the transaction.

ShareIdstringRequired

The share ID.

CommentstringOptional

The text of a comment transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

TaxDeferredContributionCodestringOptional

The tax deferred contribution code.

SourceCodestringOptional

The source of the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reverseDeposit
200

Successful operation.

reverseWithdraw

post

Reverses a withdrawal transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringRequired

Identifies the account affected by the transaction.

ShareIdstringRequired

The share ID.

AuthorizationTypestringOptional

The transaction authorization type.

SourceCodestringOptional

The source of the transaction.

CheckNumberstringOptional

The check number.

CheckIssuerstringOptional

The check issuer type.

CheckAccountCodeintegerOptional

The check account code.

CheckReferencestringOptional

The check reference for the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

CommentstringOptional

The text of a comment transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

RegulationDLimitedbooleanOptional

Whether transaction is limited to Reg D.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

TracerNumberstringOptional

The tracer number.

DraftNumberstringOptional

The draft number.

CalculateCheckbooleanOptional

Whether to calculate a check.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reverseWithdraw
200

Successful operation.

reverseNewLoan

post

Reverses a new loan transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional

Identifies the account affected by the transaction.

LoanIdstringOptional

The loan ID.

CheckNumberstringOptional

The check number.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

CheckAccountCodeintegerOptional

The check account code.

AuthorizationTypestringOptional

The transaction authorization type.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

CheckReferencestringOptional

The check reference for the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

TracerNumberstringOptional

The tracer number.

DraftNumberstringOptional

The draft number.

CalculateCheckbooleanOptional

Whether to calculate a check.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reverseNewLoan
200

Successful operation.

reversePayBill

post

Reverses a bill payment transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional

Identifies the account affected by the transaction.

IdstringOptional

The ID of the Share record (if the ID Type field is set to 0) or the Loan record (if the ID Type field is set to 1) affected by the transaction.

IdTypestringOptional

Whether the transaction affected a Share or Loan record.

PaymentAmountnumber · floatOptional

The payment amount.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

RegulationDLimitedbooleanOptional

Whether transaction is limited to Reg D.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reversePayBill
200

Successful operation.

reverseWithdrawFee

post

Reverses a withdrawal fee transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringRequired

Identifies the account affected by the transaction.

DonorIdstringOptional

The donor ID.

DonorTypestringOptional

The donor type.

TotalAmountnumber · floatOptional

The total amount.

AuthorizationTypestringOptional

The transaction authorization type.

FeeCodeintegerOptional

The fee code for a transaction.

CommentstringOptional

The text of a comment transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

EffectiveDatestring · dateOptional

The effective date of the transaction.

SourceCodestringOptional

The source of the transaction.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reverseWithdrawFee
200

Successful operation.

reverseTransfer

post

Reverses a funds transfer transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
DonorAccountNumberstringRequired

The donor account number.

DonorIdstringRequired

The donor ID.

DonorTypestringRequired

The donor type.

RecipientAccountNumberstringRequired

The recipient account number.

RecipientIdstringRequired

The recipient ID.

RecipientTypestringRequired

The recipient type.

TransferAmountnumber · floatOptional

The transfer amount.

CommentstringOptional

The text of a comment transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

PrincipalAmountnumber · floatOptional

The principal amount.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

LoanPaymentTypestringOptional

The loan payment type.

RegulationDLimitedbooleanOptional

Whether transaction is limited to Reg D.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reverseTransfer
200

Successful operation.

reverseLoanAddon

post

Reverses a loan addon transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional

Identifies the account affected by the transaction.

IdTypestringOptional

Whether the transaction affected a Share or Loan record.

LoanIdstringOptional

The loan ID.

CheckNumberstringOptional

The check number.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

EffectiveDatestring · dateOptional

The effective date of the transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

SourceCodestringOptional

The source of the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

TracerNumberstringOptional

The tracer number.

DraftNumberstringOptional

The draft number.

CalculateCheckbooleanOptional

Whether to calculate a check.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reverseLoanAddon
200

Successful operation.

reversePayLoan

post

Reverses a loan repayment transaction.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
RecipientAccountNumberstringOptional

The recipient account number.

RecipientIdstringOptional

The recipient ID.

RecipientIdTypestringOptional

The recipient ID type.

CommentstringOptional

The text of a comment transaction.

AuthorizationTypestringOptional

The transaction authorization type.

ForcePostRequestedbooleanOptional

Whether the transaction should be force posted.

PrincipalAmountnumber · floatOptional

The principal amount.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

LoanPaymentTypestringOptional

The loan payment type.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

GLCommentstringOptional

The text of a GL transaction.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reversePayLoan
200

Successful operation.

GLToGLPost

post

Transfer funds between GL accounts.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
DonorAccountNumberstringOptional

The donor account number.

DonorGLCodestringOptional

The donor GL code.

RecipientAccountNumberstringOptional

The recipient account number.

RecipientGLCodestringOptional

The recipient GL code.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

CheckReferencestringOptional

The check reference for the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

CalculateCheckbooleanOptional

Whether to calculate a check.

Responses
200

Successful operation.

application/json
post
/GLToGLPost
200

Successful operation.

reverseGLToGLPost

post

Reverses a GL to GL funds transfer.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
DonorAccountNumberstringOptional

The donor account number.

DonorGLCodestringOptional

The donor GL code.

RecipientAccountNumberstringOptional

The recipient account number.

RecipientGLCodestringOptional

The recipient GL code.

CheckIssuerstringOptional

The check issuer type.

CommentstringOptional

The text of a comment transaction.

SourceCodestringOptional

The source of the transaction.

EffectiveDatestring · dateOptional

The effective date of the transaction.

CommentCodeintegerOptional

Whether the transaction includes a comment.

CheckReferencestringOptional

The check reference for the transaction.

RecurrenceRequestedbooleanOptional

Whether recurrence was requested.

CalculateCheckbooleanOptional

Whether to calculate a check.

PartialReversalRequestedbooleanOptional

Whether a partial reversal was requested.

OriginalTotalAmountnumber · floatOptional

The original total amount.

OriginalConfirmationstringOptional

The original confirmation.

Responses
200

Successful operation.

application/json
post
/reverseGLToGLPost
200

Successful operation.

getDonorRecipientAccounts

post

Retrieves donor and recipient accounts for transactions.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

application/json
post
/getDonorRecipientAccounts
200

Successful operation.

Last updated

Was this helpful?