POST v1/EarningSchedules

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Post.EarningSchedule
NameDescriptionTypeAdditional information
chargeId

integer

None.
scheduledType

string

None.
scheduledAmount

decimal number

None.
scheduledTimestamp

date

None.
reference

string

Required

String length: inclusive between 0 and 500

Request Formats

application/json, text/json

Sample: 
{
  "chargeId": 1,
  "scheduledType": "sample string 2",
  "scheduledAmount": 1.0,
  "scheduledTimestamp": "2025-11-03T19:45:11.715239+00:00",
  "reference": "sample string 3"
}

Response Information

Resource Description

Common.Dto.Get.EarningSchedule
NameDescriptionTypeAdditional information
chargeId

integer

None.
scheduledType

string

None.
scheduledAmount

decimal number

None.
scheduledTimestamp

date

None.
reference

string

None.
id

integer

None.
uri

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "chargeId": 1,
  "scheduledType": "sample string 2",
  "scheduledAmount": 3.0,
  "scheduledTimestamp": "2025-11-03T19:45:11.715239+00:00",
  "reference": "sample string 4",
  "id": 5,
  "uri": "sample string 6"
}