POST card/batch/deposit

Request Information

URI Parameters

None.

Body Parameters

CardSaveEarningsRequest
NameDescriptionTypeAdditional information
RequestorIdent

string

None.

ProgramIdent

string

None.

Earnings

Collection of CardSaveEarning

None.

Request Formats

application/json, text/json

Sample:
{
  "RequestorIdent": "sample string 1",
  "ProgramIdent": "sample string 2",
  "Earnings": [
    {
      "$id": "2",
      "ParticipantIdent": "sample string 1",
      "ActivityID": 2,
      "BatchNum": 3,
      "MerchantDesc": "sample string 4",
      "TransactionDate": "sample string 5",
      "DepositAmt": 6.0,
      "GroupID": 7
    },
    {
      "$ref": "2"
    }
  ]
}

application/xml, text/xml

Sample:
<CardSaveEarningsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain.Model.Request">
  <Earnings>
    <CardSaveEarning>
      <ActivityID>2</ActivityID>
      <BatchNum>3</BatchNum>
      <DepositAmt>6</DepositAmt>
      <GroupID>7</GroupID>
      <MerchantDesc>sample string 4</MerchantDesc>
      <ParticipantIdent>sample string 1</ParticipantIdent>
      <TransactionDate>sample string 5</TransactionDate>
    </CardSaveEarning>
    <CardSaveEarning>
      <ActivityID>2</ActivityID>
      <BatchNum>3</BatchNum>
      <DepositAmt>6</DepositAmt>
      <GroupID>7</GroupID>
      <MerchantDesc>sample string 4</MerchantDesc>
      <ParticipantIdent>sample string 1</ParticipantIdent>
      <TransactionDate>sample string 5</TransactionDate>
    </CardSaveEarning>
  </Earnings>
  <ProgramIdent>sample string 2</ProgramIdent>
  <RequestorIdent>sample string 1</RequestorIdent>
</CardSaveEarningsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CardSaveEarningResponse
NameDescriptionTypeAdditional information
HasErrors

boolean

None.

EarningErrors

Collection of CardSaveEarningError

None.

Response Formats

application/json, text/json

Sample:
{
  "HasErrors": true,
  "EarningErrors": [
    {
      "$id": "1",
      "ParticipantIdent": "sample string 1",
      "ActivityID": 2,
      "ErrorMessage": "sample string 3"
    },
    {
      "$ref": "1"
    }
  ]
}

application/xml, text/xml

Sample:
<CardSaveEarningResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain.Model.Response">
  <EarningErrors>
    <CardSaveEarningError>
      <ActivityID>2</ActivityID>
      <ErrorMessage>sample string 3</ErrorMessage>
      <ParticipantIdent>sample string 1</ParticipantIdent>
    </CardSaveEarningError>
    <CardSaveEarningError>
      <ActivityID>2</ActivityID>
      <ErrorMessage>sample string 3</ErrorMessage>
      <ParticipantIdent>sample string 1</ParticipantIdent>
    </CardSaveEarningError>
  </EarningErrors>
  <HasErrors>true</HasErrors>
</CardSaveEarningResponse>