POST REST/Payments/Batch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BatchRef	string	None.
PaymentType	string	None.
DebitMode	string	None.
Items	Collection of PaymentItemInputBaseModel	None.
ProcessDate	string	None.
FromAccountNumber	string	None.
FromBankCode	string	None.
Narration	string	None.
CorporateID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "BatchRef": "sample string 1",
  "PaymentType": "sample string 2",
  "DebitMode": "sample string 3",
  "Items": [
    {
      "BeneficiaryName": "sample string 1",
      "BeneficiaryRef": "sample string 2",
      "ItemRef": "sample string 3",
      "Amount": 4.0,
      "Narration": "sample string 5",
      "PaymentProfile": "sample string 6",
      "AccountNumber": "sample string 7",
      "BankCode": "sample string 8"
    },
    {
      "BeneficiaryName": "sample string 1",
      "BeneficiaryRef": "sample string 2",
      "ItemRef": "sample string 3",
      "Amount": 4.0,
      "Narration": "sample string 5",
      "PaymentProfile": "sample string 6",
      "AccountNumber": "sample string 7",
      "BankCode": "sample string 8"
    }
  ],
  "ProcessDate": "sample string 4",
  "FromAccountNumber": "sample string 5",
  "FromBankCode": "sample string 6",
  "Narration": "sample string 7",
  "CorporateID": 8
}

application/xml, text/xml

Sample:

<PaymentBatchInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bank3D.IBridge.Models">
  <CorporateID>8</CorporateID>
  <FromAccountNumber>sample string 5</FromAccountNumber>
  <FromBankCode>sample string 6</FromBankCode>
  <Narration>sample string 7</Narration>
  <BatchRef>sample string 1</BatchRef>
  <DebitMode>sample string 3</DebitMode>
  <Items>
    <PaymentItemInputBaseModel>
      <AccountNumber>sample string 7</AccountNumber>
      <BankCode>sample string 8</BankCode>
      <Amount>4</Amount>
      <Narration>sample string 5</Narration>
      <PaymentProfile>sample string 6</PaymentProfile>
      <BeneficiaryName>sample string 1</BeneficiaryName>
      <BeneficiaryRef>sample string 2</BeneficiaryRef>
      <ItemRef>sample string 3</ItemRef>
    </PaymentItemInputBaseModel>
    <PaymentItemInputBaseModel>
      <AccountNumber>sample string 7</AccountNumber>
      <BankCode>sample string 8</BankCode>
      <Amount>4</Amount>
      <Narration>sample string 5</Narration>
      <PaymentProfile>sample string 6</PaymentProfile>
      <BeneficiaryName>sample string 1</BeneficiaryName>
      <BeneficiaryRef>sample string 2</BeneficiaryRef>
      <ItemRef>sample string 3</ItemRef>
    </PaymentItemInputBaseModel>
  </Items>
  <PaymentType>sample string 2</PaymentType>
  <ProcessDate>sample string 4</ProcessDate>
</PaymentBatchInputModel>

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

Response Information

Resource Description

PaymentBatchResponseModel

Name	Type	Additional information
BatchRef	string	None.
Items	Collection of PaymentItemResponseModel	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "BatchRef": "sample string 1",
  "Items": [
    {
      "ItemRef": "sample string 1",
      "Status": {
        "Code": "sample string 1",
        "Description": "sample string 2"
      },
      "Id": 2
    },
    {
      "ItemRef": "sample string 1",
      "Status": {
        "Code": "sample string 1",
        "Description": "sample string 2"
      },
      "Id": 2
    }
  ],
  "Id": 2
}

application/xml, text/xml

Sample:

<PaymentBatchResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bank3D.IBridge.Models">
  <Id>2</Id>
  <BatchRef>sample string 1</BatchRef>
  <Items>
    <PaymentItemResponseModel>
      <Id>2</Id>
      <ItemRef>sample string 1</ItemRef>
      <Status>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
      </Status>
    </PaymentItemResponseModel>
    <PaymentItemResponseModel>
      <Id>2</Id>
      <ItemRef>sample string 1</ItemRef>
      <Status>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
      </Status>
    </PaymentItemResponseModel>
  </Items>
</PaymentBatchResponseModel>