POST 17.0/app/payments/payconsolidatedaccounts

Description

Processing consolidated payments across multiple accounts

URI Parameters

None.

The payment request details including bank account, payment method, and accounts to process

PayAccountRequest
Name Description Type Additional information
BankAccountId

integer

None.
BankAccountName

string

None.
PaymentDate

date

None.
ProcessingDate

date

None.
PaymentExportFormat

byte

None.
PaymentMethodId

integer

None.
Accounts

Collection of AccountItem

None.

application/json, text/json
Sample: 
{
  "bankAccountId": 1,
  "bankAccountName": "sample string 2",
  "paymentDate": "2026-03-13T12:39",
  "processingDate": "2026-03-13T12:39",
  "paymentExportFormat": 64,
  "paymentMethodId": 6,
  "accounts": [
    {
      "contactId": 1,
      "taxDeduction": 2.0,
      "referenceChequeNo": "sample string 3",
      "amountToPay": 4.0,
      "balance": 5.0,
      "invoiceFeesSeparately": true,
      "invoiceFeesTotal": 7.0
    },
    {
      "contactId": 1,
      "taxDeduction": 2.0,
      "referenceChequeNo": "sample string 3",
      "amountToPay": 4.0,
      "balance": 5.0,
      "invoiceFeesSeparately": true,
      "invoiceFeesTotal": 7.0
    }
  ]
}

application/xml, text/xml
Sample: 
<PayAccountRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BankAccountId>1</BankAccountId>
  <BankAccountName>sample string 2</BankAccountName>
  <PaymentDate>2026-03-13T12:39:57.2661974+00:00</PaymentDate>
  <ProcessingDate>2026-03-13T12:39:57.2661974+00:00</ProcessingDate>
  <PaymentExportFormat>64</PaymentExportFormat>
  <PaymentMethodId>6</PaymentMethodId>
  <Accounts>
    <AccountItem>
      <ContactId>1</ContactId>
      <TaxDeduction>2</TaxDeduction>
      <ReferenceChequeNo>sample string 3</ReferenceChequeNo>
      <AmountToPay>4</AmountToPay>
      <Balance>5</Balance>
      <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
      <InvoiceFeesTotal>7</InvoiceFeesTotal>
    </AccountItem>
    <AccountItem>
      <ContactId>1</ContactId>
      <TaxDeduction>2</TaxDeduction>
      <ReferenceChequeNo>sample string 3</ReferenceChequeNo>
      <AmountToPay>4</AmountToPay>
      <Balance>5</Balance>
      <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
      <InvoiceFeesTotal>7</InvoiceFeesTotal>
    </AccountItem>
  </Accounts>
</PayAccountRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

The payment processing results with payment run ID and processed payment details

PayAcountItem
Name Description Type Additional information
PaymentRunId

integer

None.
PaymentRunExportFileName

string

None.
AccountStatements

Collection of AccountStatement

None.

application/json, text/json
Sample: 
{
  "paymentRunId": 1,
  "paymentRunExportFileName": "sample string 2",
  "accountStatements": [
    {
      "contactId": 1,
      "statementId": 2
    },
    {
      "contactId": 1,
      "statementId": 2
    }
  ]
}

application/xml, text/xml
Sample: 
<PayAcountItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentRunId>1</PaymentRunId>
  <PaymentRunExportFileName>sample string 2</PaymentRunExportFileName>
  <AccountStatements>
    <AccountStatement>
      <ContactId>1</ContactId>
      <StatementId>2</StatementId>
    </AccountStatement>
    <AccountStatement>
      <ContactId>1</ContactId>
      <StatementId>2</StatementId>
    </AccountStatement>
  </AccountStatements>
</PayAcountItem>