TransactionsService

Perform transactions.

Symitar eDocs References: Coming soon.

Operations

deposit

post

Perform a deposit transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/deposit HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 718

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "ShareId": "text",
  "DepositAmounts": {
    "TotalAmount": 1,
    "CheckAmount": 1,
    "CashAmount": 1
  },
  "GLAccounts": {
    "ClearingAccount": "text",
    "CheckDisbursedAccount": "text",
    "ExternalAccount": "text"
  },
  "GLCodes": {
    "ClearingCode": 1,
    "CheckDisbursedCode": 1,
    "ExternalCode": 1
  },
  "Comment": "text",
  "EffectiveDate": "2025-05-21",
  "CommentCode": 1,
  "TaxDeferredContributionCode": "text",
  "SourceCode": "text",
  "RecurrenceRequested": true,
  "CashDevice": {
    "Denominations": {
      "Denomination": [
        {
          "Unit": 1,
          "Count": 1,
          "Status": "text"
        }
      ]
    },
    "Coin": {
      "Value": 1,
      "Status": "text"
    },
    "Orientation": "text"
  },
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

withdraw

post

Perform a withdrawal transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/withdraw HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1038

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "ShareId": "text",
  "WithdrawalAmounts": {
    "TotalAmount": 1,
    "CheckAmount": 1,
    "CashAmount": 1
  },
  "GLAccounts": {
    "ClearingAccount": "text",
    "CheckDisbursedAccount": "text",
    "ExternalAccount": "text"
  },
  "GLCodes": {
    "ClearingCode": 1,
    "CheckDisbursedCode": 1,
    "ExternalCode": 1
  },
  "AuthorizationType": "text",
  "SourceCode": "text",
  "CheckNumber": "text",
  "CheckIssuer": "text",
  "CheckAccountCode": 1,
  "CheckReference": "text",
  "CommentCode": 1,
  "Comment": "text",
  "EffectiveDate": "2025-05-21",
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "text"
      }
    ]
  },
  "RegulationDLimited": true,
  "ForcePostRequested": true,
  "RecurrenceRequested": true,
  "TracerNumber": "text",
  "DraftNumber": "text",
  "Printer": {
    "PrinterId": 1,
    "Amount": 1
  },
  "Dispenser": {
    "DispenserId": 1,
    "Amount": 1
  },
  "CashDevice": {
    "Denominations": {
      "Denomination": [
        {
          "Unit": 1,
          "Count": 1,
          "Status": "text"
        }
      ]
    },
    "Coin": {
      "Value": 1,
      "Status": "text"
    },
    "Orientation": "text"
  },
  "CalculateCheck": true,
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

newLoan

post

Creates a new loan transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/newLoan HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 862

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "LoanId": "text",
  "LoanAmounts": {
    "TotalAmount": 1,
    "CheckAmount": 1,
    "CashAmount": 1
  },
  "CheckNumber": "text",
  "CheckIssuer": "text",
  "Comment": "text",
  "CheckAccountCode": 1,
  "GLAccounts": {
    "ClearingAccount": "text",
    "CheckDisbursedAccount": "text",
    "ExternalAccount": "text"
  },
  "GLCodes": {
    "ClearingCode": 1,
    "CheckDisbursedCode": 1,
    "ExternalCode": 1
  },
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "text"
      }
    ]
  },
  "AuthorizationType": "text",
  "SourceCode": "text",
  "EffectiveDate": "2025-05-21",
  "CommentCode": 1,
  "CheckReference": "text",
  "RecurrenceRequested": true,
  "ForcePostRequested": true,
  "TracerNumber": "text",
  "DraftNumber": "text",
  "Printer": {
    "PrinterId": 1,
    "Amount": 1
  },
  "Dispenser": {
    "DispenserId": 1,
    "Amount": 1
  },
  "CalculateCheck": true,
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

payBill

post

Perform a bill payment transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/payBill HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 601

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "Id": "text",
  "IdType": "text",
  "PaymentAmount": 1,
  "CheckIssuer": "text",
  "Comment": "text",
  "GLAccounts": {
    "ClearingAccount": "text",
    "CheckDisbursedAccount": "text",
    "ExternalAccount": "text"
  },
  "GLCodes": {
    "ClearingCode": 1,
    "CheckDisbursedCode": 1,
    "ExternalCode": 1
  },
  "AuthorizationType": "text",
  "ForcePostRequested": true,
  "SourceCode": "text",
  "EffectiveDate": "2025-05-21",
  "CommentCode": 1,
  "RegulationDLimited": true,
  "RecurrenceRequested": true,
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

withdrawFee

post

Perform a withdrawal fee transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/withdrawFee HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 572

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "DonorId": "text",
  "DonorType": "text",
  "TotalAmount": 1,
  "AuthorizationType": "text",
  "FeeCode": 1,
  "Comment": "text",
  "CommentCode": 1,
  "EffectiveDate": "2025-05-21",
  "GLAccounts": {
    "ClearingAccount": "text",
    "CheckDisbursedAccount": "text",
    "ExternalAccount": "text"
  },
  "GLCodes": {
    "ClearingCode": 1,
    "CheckDisbursedCode": 1,
    "ExternalCode": 1
  },
  "SourceCode": "text",
  "ForcePostRequested": true,
  "RecurrenceRequested": true,
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

transfer

post

Perform a funds transfer transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/transfer HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 623

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "DonorAccountNumber": "text",
  "DonorId": "text",
  "DonorType": "text",
  "RecipientAccountNumber": "text",
  "RecipientId": "text",
  "RecipientType": "text",
  "TransferAmount": 1,
  "Comment": "text",
  "AuthorizationType": "text",
  "RemitInformation": {
    "RemitCode": "text",
    "FundType": "text",
    "Payer": "text"
  },
  "ForcePostRequested": true,
  "PrincipalAmount": 1,
  "SourceCode": "text",
  "EffectiveDate": "2025-05-21",
  "CommentCode": 1,
  "LoanPaymentType": "text",
  "RegulationDLimited": true,
  "RecurrenceRequested": true,
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

stopCheckPayment

post

Stops a check payment transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/stopCheckPayment HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 484

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "DonorId": "text",
  "DonorType": "text",
  "TotalAmount": 1,
  "Comment": "text",
  "CommentCode": 1,
  "EffectiveDate": "2025-05-21",
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "text"
      }
    ]
  },
  "DraftNumbers": {
    "CheckNumber": "text",
    "CheckNumberRange": {
      "BeginningCheckNumber": "text",
      "EndingCheckNumber": "text"
    }
  },
  "SourceCode": "text",
  "RecurrenceRequested": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

loanAddon

post

Adds an addon to an existing loan.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/loanAddon HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 829

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "IdType": "text",
  "LoanId": "text",
  "CheckNumber": "text",
  "CheckIssuer": "text",
  "Amounts": {
    "TotalAmount": 1,
    "CheckAmount": 1,
    "CashAmount": 1
  },
  "Comment": "text",
  "CommentCode": 1,
  "EffectiveDate": "2025-05-21",
  "GLAccounts": {
    "ClearingAccount": "text",
    "CheckDisbursedAccount": "text",
    "ExternalAccount": "text"
  },
  "GLCodes": {
    "ClearingCode": 1,
    "CheckDisbursedCode": 1,
    "ExternalCode": 1
  },
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "text"
      }
    ]
  },
  "AuthorizationType": "text",
  "ForcePostRequested": true,
  "SourceCode": "text",
  "RecurrenceRequested": true,
  "TracerNumber": "text",
  "DraftNumber": "text",
  "Printer": {
    "PrinterId": 1,
    "Amount": 1
  },
  "Dispenser": {
    "DispenserId": 1,
    "Amount": 1
  },
  "CalculateCheck": true,
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

payLoan

post

Perform a loan repayment transaction.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/payLoan HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 747

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "RecipientAccountNumber": "text",
  "RecipientId": "text",
  "RecipientIdType": "text",
  "PaymentAmounts": {
    "TotalAmount": 1,
    "CheckAmount": 1,
    "CashAmount": 1
  },
  "Comment": "text",
  "GLAccounts": {
    "ClearingAccount": "text",
    "CheckDisbursedAccount": "text",
    "ExternalAccount": "text"
  },
  "GLCodes": {
    "ClearingCode": 1,
    "CheckDisbursedCode": 1,
    "ExternalCode": 1
  },
  "AuthorizationType": "text",
  "RemitInformation": {
    "RemitCode": "text",
    "FundType": "text",
    "Payer": "text"
  },
  "ForcePostRequested": true,
  "PrincipalAmount": 1,
  "SourceCode": "text",
  "EffectiveDate": "2025-05-21",
  "CommentCode": 1,
  "LoanPaymentType": "text",
  "RecurrenceRequested": true,
  "GLComment": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

glToGlPost

post

Transfer funds between GL accounts.

Authorizations

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

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/glToGlPost HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 525

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "DonorAccountNumber": "text",
  "DonorGLCode": "text",
  "RecipientAccountNumber": "text",
  "RecipientGLCode": "text",
  "Amounts": {
    "TotalAmount": 1,
    "CheckAmount": 1,
    "CashAmount": 1
  },
  "CheckIssuer": "text",
  "Comment": "text",
  "Payee": {
    "PayeeLine": [
      {
        "LineValue": "text"
      }
    ]
  },
  "SourceCode": "text",
  "EffectiveDate": "2025-05-21",
  "CommentCode": 1,
  "CheckReference": "text",
  "RecurrenceRequested": true,
  "CalculateCheck": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckNumber": "text",
  "CheckAccountCode": 1,
  "TransactionFees": [
    {}
  ],
  "OverdrawInformation": {
    "OverdrawProtectionEntry": [
      {
        "SourceAccount": "text",
        "SourceId": "text",
        "SourceType": "text",
        "SourceAmount": 1
      }
    ],
    "OverdrawToleranceAmount": 1
  }
}

getDonorRecipientAccounts

post

Retrieves donor and recipient accounts for transactions.

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/transactions/getDonorRecipientAccounts HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "Donor": [
    {
      "Id": "text",
      "IdType": "text",
      "Balance": 1,
      "AvailableBalance": 1,
      "Description": "text",
      "AccountNumber": "text",
      "Name": "text",
      "AccountTrackingType": 1
    }
  ],
  "Recipient": [
    {
      "Id": "text",
      "IdType": "text",
      "Balance": 1,
      "AvailableBalance": 1,
      "Description": "text",
      "AccountNumber": "text",
      "Name": "text",
      "AccountTrackingType": 1
    }
  ],
  "TransferToAnyAccount": true
}