POST 17.0/app/accounts/reveivepaymentforcharge

Description

Receives a payment for the specified charge, validating essential parameters before invoking the tenancy manager to process the payment application.

URI Parameters

None.

The request containing ChargeId, DateReceived, AmountReceived, PaymentMethodId, and PaymentReference.

PaymentRequest
Name Description Type Additional information
ChargeId

integer

None.
DateReceived

date

None.
PaymentMethodId

integer

None.
AmountReceived

decimal number

None.
PaymentReference

string

None.
ReceivedFromContactId

integer

None.
LandlordStatementNotes

string

None.
BankAccount

integer

None.
PayAdvanceRentToLandlordNow

boolean

None.

application/json, text/json
Sample: 
{
  "chargeId": 1,
  "dateReceived": "2026-01-27T09:57",
  "paymentMethodId": 3,
  "amountReceived": 4.1,
  "paymentReference": "sample string 5",
  "receivedFromContactId": 6,
  "landlordStatementNotes": "sample string 7",
  "bankAccount": 8,
  "payAdvanceRentToLandlordNow": true
}

application/xml, text/xml
Sample: 
<PaymentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChargeId>1</ChargeId>
  <DateReceived>2026-01-27T09:57:42.7306393+00:00</DateReceived>
  <PaymentMethodId>3</PaymentMethodId>
  <AmountReceived>4.1</AmountReceived>
  <PaymentReference>sample string 5</PaymentReference>
  <ReceivedFromContactId>6</ReceivedFromContactId>
  <LandlordStatementNotes>sample string 7</LandlordStatementNotes>
  <BankAccount>8</BankAccount>
  <PayAdvanceRentToLandlordNow>true</PayAdvanceRentToLandlordNow>
</PaymentRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

ReceivePaymentItem object from the payment processing operation.

ReceivePaymentItem
Name Description Type Additional information
TransactionId

integer

None.
OverpaymentTransactionId

integer

None.

application/json, text/json
Sample: 
{
  "transactionId": 1,
  "overpaymentTransactionId": 2
}

application/xml, text/xml
Sample: 
<ReceivePaymentItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TransactionId>1</TransactionId>
  <OverpaymentTransactionId>2</OverpaymentTransactionId>
</ReceivePaymentItem>