POST api/batch/{batchId}/charge

Request Information

URI Parameters

Name	Description	Type	Additional information
batchId		integer	Required

Body Parameters

CreditChargeRequestViewModel

Name	Description	Type	Additional information
CreditIds		Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "creditIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<CreditChargeRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.CreditChargeLink">
  <CreditIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CreditIds>
</CreditChargeRequestViewModel>

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 'CreditChargeRequestViewModel'.

Response Information

Resource Description

CreditChargeLinkViewModel

Name	Description	Type	Additional information
CreditChargeLinkId	CreditChargeLinkId	integer	None.
CreditId	Credit Id	integer	None.
ChargeId	Charge Id	integer	None.
PayAmount	Pay Amount	decimal number	None.
ApplyDate	Apply Date	date	None.
ApplicationOfPrepayBatchId	Application Of Prepay Batch Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "creditChargeLinkId": 1,
  "creditId": 2,
  "chargeId": 3,
  "payAmount": 4.0,
  "applyDate": "2024-10-13T16:17:54.7179891-04:00",
  "applicationOfPrepayBatchId": 1
}

application/xml, text/xml

Sample:

<CreditChargeLinkViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.CreditChargeLink">
  <ApplicationOfPrepayBatchId>1</ApplicationOfPrepayBatchId>
  <ApplyDate>2024-10-13T16:17:54.7179891-04:00</ApplyDate>
  <ChargeId>3</ChargeId>
  <CreditChargeLinkId>1</CreditChargeLinkId>
  <CreditId>2</CreditId>
  <PayAmount>4</PayAmount>
</CreditChargeLinkViewModel>