POST api/repay/account/{customerId}/schedule-payment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

integer

Required

Body Parameters

CreateSchedulePaymentRequest
NameDescriptionTypeAdditional information
RepayRequest

RepayRequest

None.

PromiseToPay

PromiseToPay

None.

Request Formats

application/json, text/json

Sample:
{
  "RepayRequest": null,
  "PromiseToPay": {
    "Id": 1,
    "AccountNumber": 2,
    "BHPHAccountNumber": 3,
    "Type": "sample string 4",
    "ReferenceBalanceId": 1,
    "BalanceType": "sample string 5",
    "DeliveryMethod": "sample string 6",
    "Note": "sample string 7",
    "Amount": 8.0,
    "AmountPaid": 9.0,
    "Status": "sample string 10",
    "PaymentMethod": "sample string 11",
    "Date": "2025-07-05T07:52:45.9517606+00:00",
    "DatePaid": "2025-07-05T07:52:45.9517606+00:00",
    "CreatedBy": 13,
    "CreatedOn": "2025-07-05T07:52:45.9517606+00:00",
    "ModifiedBy": 1,
    "ModifiedOn": "2025-07-05T07:52:45.9517606+00:00",
    "ScheduleAmountDue": 15.0
  }
}

application/xml, text/xml

Sample:
<CreateSchedulePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Automatrix.DMS.Business.Entities.Entities">
  <PromiseToPay xmlns:d2p1="http://schemas.datacontract.org/2004/07/Automatrix.DMS.Business.Entities.Models">
    <d2p1:AccountNumber>2</d2p1:AccountNumber>
    <d2p1:Amount>8</d2p1:Amount>
    <d2p1:AmountPaid>9</d2p1:AmountPaid>
    <d2p1:BHPHAccountNumber>3</d2p1:BHPHAccountNumber>
    <d2p1:BalanceType>sample string 5</d2p1:BalanceType>
    <d2p1:CreatedBy>13</d2p1:CreatedBy>
    <d2p1:CreatedOn>2025-07-05T07:52:45.9517606+00:00</d2p1:CreatedOn>
    <d2p1:Date>2025-07-05T07:52:45.9517606+00:00</d2p1:Date>
    <d2p1:DatePaid>2025-07-05T07:52:45.9517606+00:00</d2p1:DatePaid>
    <d2p1:DeliveryMethod>sample string 6</d2p1:DeliveryMethod>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:ModifiedBy>1</d2p1:ModifiedBy>
    <d2p1:ModifiedOn>2025-07-05T07:52:45.9517606+00:00</d2p1:ModifiedOn>
    <d2p1:Note>sample string 7</d2p1:Note>
    <d2p1:PaymentMethod>sample string 11</d2p1:PaymentMethod>
    <d2p1:ReferenceBalanceId>1</d2p1:ReferenceBalanceId>
    <d2p1:ScheduleAmountDue>15</d2p1:ScheduleAmountDue>
    <d2p1:Status>sample string 10</d2p1:Status>
    <d2p1:Type>sample string 4</d2p1:Type>
  </PromiseToPay>
  <RepayRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/Automatrix.DMS.Business.Entities.Models" i:nil="true" />
</CreateSchedulePaymentRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateSchedulePaymentRequest'

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.