Skip to content
NexumAPI Docs

TransactionsService⁠

Perform transactions.

Operations⁠

stopCheckPayment⁠

POST

Stops a check payment transaction.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringrequiredIdentifies the account affected by the transaction.
DonorIdstringrequiredThe donor ID.
DonorTypestringrequiredThe donor type.
TotalAmountnumber · floatrequiredThe total amount.
CommentstringoptionalThe text of a comment transaction.
CommentCodeintegeroptionalWhether the transaction includes a comment.
EffectiveDatestring · daterequiredThe effective date of the transaction.
SourceCodestringoptionalThe source of the transaction.
RecurrenceRequestedbooleanoptionalWhether recurrence was requested.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalTransaction status.
CheckNumberstringoptionalThe check number.
CheckAccountCodeintegeroptionalThe check account code.
POST/nexum/{sym}/2022.01/transactions/stopCheckPayment
POST /nexum/627/2022.01/transactions/stopCheckPayment HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "DonorId": "0",
  "DonorType": "string",
  "TotalAmount": "string",
  "DraftNumbers": {
    "CheckNumber": "0"
  },
  "Payee": {
    "PayeeLine": [
      {
        "PayeeLineNumber": 0,
        "LineValue": "string"
      }
    ]
  },
  "Comment": "string",
  "SourceCode": "string",
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

loanAddon⁠

POST

Adds an addon to an existing loan.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptionalIdentifies the account affected by the transaction.
IdTypestringoptionalWhether the transaction affected a Share or Loan record.
LoanIdstringoptionalThe loan ID.
CheckNumberstringoptionalThe check number.
CheckIssuerstringoptionalThe check issuer type.
CommentstringoptionalThe text of a comment transaction.
CommentCodeintegeroptionalWhether the transaction includes a comment.
EffectiveDatestring · dateoptionalThe effective date of the transaction.
AuthorizationTypestringoptionalThe transaction authorization type.
ForcePostRequestedbooleanoptionalWhether the transaction should be force posted.
SourceCodestringoptionalThe source of the transaction.
RecurrenceRequestedbooleanoptionalWhether recurrence was requested.
TracerNumberstringoptionalThe tracer number.
DraftNumberstringoptionalThe draft number.
CalculateCheckbooleanoptionalWhether to calculate a check.
GLCommentstringoptionalThe text of a GL transaction.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalTransaction status.
CheckNumberstringoptionalThe check number.
CheckAccountCodeintegeroptionalThe check account code.
TransactionFeesobject[]optionalList of transaction fees.
POST/nexum/{sym}/2022.01/transactions/loanAddon
POST /nexum/627/2022.01/transactions/loanAddon HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "IdType": "string",
  "LoanId": "string",
  "CheckNumber": "string",
  "CheckIssuer": "string",
  "Amounts": {
    "TotalAmount": 0,
    "CheckAmount": 0,
    "CashAmount": 0
  },
  "Comment": "string",
  "CommentCode": 0,
  "EffectiveDate": "string",
  "GLAccounts": {
    "ClearingAccount": "string",
    "CheckDisbursedAccount": "string",
    "ExternalAccount": "string"
  },
  "GLCodes": {
    "ClearingCode": 0,
    "CheckDisbursedCode": 0,
    "ExternalCode": 0
  },
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "string"
      }
    ]
  },
  "AuthorizationType": "string",
  "ForcePostRequested": true,
  "SourceCode": "string",
  "RecurrenceRequested": true,
  "TracerNumber": "string",
  "DraftNumber": "string",
  "Printer": {
    "PrinterId": 0,
    "Amount": 0
  }
}

payLoan⁠

POST

Perform a loan repayment transaction.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
RecipientAccountNumberstringoptionalThe recipient account number.
RecipientIdstringoptionalThe recipient ID.
RecipientIdTypestringoptionalThe recipient ID type.
CommentstringoptionalThe text of a comment transaction.
AuthorizationTypestringoptionalThe transaction authorization type.
ForcePostRequestedbooleanoptionalWhether the transaction should be force posted.
PrincipalAmountnumber · floatoptionalThe principal amount.
SourceCodestringoptionalThe source of the transaction.
EffectiveDatestring · dateoptionalThe effective date of the transaction.
CommentCodeintegeroptionalWhether the transaction includes a comment.
LoanPaymentTypestringoptionalThe loan payment type.
RecurrenceRequestedbooleanoptionalWhether recurrence was requested.
GLCommentstringoptionalThe text of a GL transaction.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalTransaction status.
CheckNumberstringoptionalThe check number.
CheckAccountCodeintegeroptionalThe check account code.
TransactionFeesobject[]optionalList of transaction fees.
POST/nexum/{sym}/2022.01/transactions/payLoan
POST /nexum/627/2022.01/transactions/payLoan HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RecipientAccountNumber": "0000000000",
  "RecipientId": "0",
  "RecipientIdType": "string",
  "PaymentAmounts": {
    "TotalAmount": "string"
  },
  "Comment": "string",
  "SourceCode": "string",
  "ForcePostRequested": true,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

reverseDeposit⁠

POST

Reverses a deposit transaction.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringrequiredIdentifies the account affected by the transaction.
ShareIdstringrequiredThe share ID.
CommentstringoptionalThe text of a comment transaction.
EffectiveDatestring · dateoptionalThe effective date of the transaction.
CommentCodeintegeroptionalWhether the transaction includes a comment.
TaxDeferredContributionCodestringoptionalThe tax deferred contribution code.
SourceCodestringoptionalThe source of the transaction.
RecurrenceRequestedbooleanoptionalWhether recurrence was requested.
GLCommentstringoptionalThe text of a GL transaction.
PartialReversalRequestedbooleanoptionalWhether a partial reversal was requested.
OriginalTotalAmountnumber · floatoptionalThe original total amount.
OriginalConfirmationstringoptionalThe original confirmation.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalTransaction status.
CheckNumberstringoptionalThe check number.
CheckAccountCodeintegeroptionalThe check account code.
POST/nexum/{sym}/2022.01/transactions/reverseDeposit
POST /nexum/627/2022.01/transactions/reverseDeposit HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ShareId": "0",
  "DepositAmounts": {
    "TotalAmount": "string"
  },
  "Comment": "string",
  "SourceCode": "string",
  "PartialReversalRequested": false,
  "OriginalTotalAmount": "string",
  "OriginalConfirmation": "0",
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

reverseWithdraw⁠

POST

Reverses a withdrawal transaction.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringrequiredIdentifies the account affected by the transaction.
ShareIdstringrequiredThe share ID.
AuthorizationTypestringoptionalThe transaction authorization type.
SourceCodestringoptionalThe source of the transaction.
CheckNumberstringoptionalThe check number.
CheckIssuerstringoptionalThe check issuer type.
CheckAccountCodeintegeroptionalThe check account code.
CheckReferencestringoptionalThe check reference for the transaction.
CommentCodeintegeroptionalWhether the transaction includes a comment.
CommentstringoptionalThe text of a comment transaction.
EffectiveDatestring · dateoptionalThe effective date of the transaction.
RegulationDLimitedbooleanoptionalWhether transaction is limited to Reg D.
ForcePostRequestedbooleanoptionalWhether the transaction should be force posted.
RecurrenceRequestedbooleanoptionalWhether recurrence was requested.
TracerNumberstringoptionalThe tracer number.
DraftNumberstringoptionalThe draft number.
CalculateCheckbooleanoptionalWhether to calculate a check.
GLCommentstringoptionalThe text of a GL transaction.
PartialReversalRequestedbooleanoptionalWhether a partial reversal was requested.
OriginalTotalAmountnumber · floatoptionalThe original total amount.
OriginalConfirmationstringoptionalThe original confirmation.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalTransaction status.
CheckNumberstringoptionalThe check number.
CheckAccountCodeintegeroptionalThe check account code.
POST/nexum/{sym}/2022.01/transactions/reverseWithdraw
POST /nexum/627/2022.01/transactions/reverseWithdraw HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ShareId": "string",
  "WithdrawalAmounts": {
    "TotalAmount": 0,
    "CheckAmount": 0,
    "CashAmount": 0
  },
  "GLAccounts": {
    "ClearingAccount": "string",
    "CheckDisbursedAccount": "string",
    "ExternalAccount": "string"
  },
  "GLCodes": {
    "ClearingCode": 0,
    "CheckDisbursedCode": 0,
    "ExternalCode": 0
  },
  "AuthorizationType": "string",
  "SourceCode": "string",
  "CheckNumber": "string",
  "CheckIssuer": "string",
  "CheckAccountCode": 0,
  "CheckReference": "string",
  "CommentCode": 0,
  "Comment": "string",
  "EffectiveDate": "string",
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "string"
      }
    ]
  },
  "RegulationDLimited": true,
  "ForcePostRequested": true,
  "RecurrenceRequested": true,
  "TracerNumber": "string"
}

reverseNewLoan⁠

POST

Reverses a new loan transaction.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptionalIdentifies the account affected by the transaction.
LoanIdstringoptionalThe loan ID.
CheckNumberstringoptionalThe check number.
CheckIssuerstringoptionalThe check issuer type.
CommentstringoptionalThe text of a comment transaction.
CheckAccountCodeintegeroptionalThe check account code.
AuthorizationTypestringoptionalThe transaction authorization type.
SourceCodestringoptionalThe source of the transaction.
EffectiveDatestring · dateoptionalThe effective date of the transaction.
CommentCodeintegeroptionalWhether the transaction includes a comment.
CheckReferencestringoptionalThe check reference for the transaction.
RecurrenceRequestedbooleanoptionalWhether recurrence was requested.
ForcePostRequestedbooleanoptionalWhether the transaction should be force posted.
TracerNumberstringoptionalThe tracer number.
DraftNumberstringoptionalThe draft number.
CalculateCheckbooleanoptionalWhether to calculate a check.
GLCommentstringoptionalThe text of a GL transaction.
PartialReversalRequestedbooleanoptionalWhether a partial reversal was requested.
OriginalTotalAmountnumber · floatoptionalThe original total amount.
OriginalConfirmationstringoptionalThe original confirmation.
Path Parameters
symstringrequired
Sym number
Responses
StatusMessagestringoptionalTransaction status.
CheckNumberstringoptionalThe check number.
CheckAccountCodeintegeroptionalThe check account code.
POST/nexum/{sym}/2022.01/transactions/reverseNewLoan
POST /nexum/627/2022.01/transactions/reverseNewLoan HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "LoanId": "string",
  "LoanAmounts": {
    "TotalAmount": 0,
    "CheckAmount": 0,
    "CashAmount": 0
  },
  "CheckNumber": "string",
  "CheckIssuer": "string",
  "Comment": "string",
  "CheckAccountCode": 0,
  "GLAccounts": {
    "ClearingAccount": "string",
    "CheckDisbursedAccount": "string",
    "ExternalAccount": "string"
  },
  "GLCodes": {
    "ClearingCode": 0,
    "CheckDisbursedCode": 0,
    "ExternalCode": 0
  },
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "string"
      }
    ]
  },
  "AuthorizationType": "string",
  "SourceCode": "string",
  "EffectiveDate": "string",
  "CommentCode": 0,
  "CheckReference": "string",
  "RecurrenceRequested": true,
  "ForcePostRequested": true,
  "TracerNumber": "string",
  "DraftNumber": "string"
}