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.

application/json, text/json
Sample: 
{
  "chargeId": 1,
  "dateReceived": "2025-12-12T18:54",
  "paymentMethodId": 3,
  "amountReceived": 4.1,
  "paymentReference": "sample string 5",
  "receivedFromContactId": 6
}

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>2025-12-12T18:54:26.1160831+00:00</DateReceived>
  <PaymentMethodId>3</PaymentMethodId>
  <AmountReceived>4.1</AmountReceived>
  <PaymentReference>sample string 5</PaymentReference>
  <ReceivedFromContactId>6</ReceivedFromContactId>
</PaymentRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

An integer result from the payment processing operation.

integer

application/json, text/json
Sample: 
1

application/xml, text/xml
Sample: 
<int>1</int>