GET REST/Payments/Batch/{id}/Status

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

PaymentBatchViewModel

Name	Type	Additional information
Id	integer	None.
BatchRef	string	None.
Items	Collection of PaymentItemViewModel	None.
FromAccountNumber	string	None.
FromBankCode	string	None.
Narration	string	None.
CorporateID	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "BatchRef": "sample string 2",
  "Items": [
    {
      "Id": 1,
      "ItemRef": "sample string 2",
      "Status": {
        "Code": "sample string 1",
        "Description": "sample string 2"
      },
      "AccountName": "sample string 3",
      "Amount": 4.0,
      "Narration": "sample string 5",
      "PaymentProfile": "sample string 6",
      "AccountNumber": "sample string 7",
      "BankCode": "sample string 8"
    },
    {
      "Id": 1,
      "ItemRef": "sample string 2",
      "Status": {
        "Code": "sample string 1",
        "Description": "sample string 2"
      },
      "AccountName": "sample string 3",
      "Amount": 4.0,
      "Narration": "sample string 5",
      "PaymentProfile": "sample string 6",
      "AccountNumber": "sample string 7",
      "BankCode": "sample string 8"
    }
  ],
  "FromAccountNumber": "sample string 3",
  "FromBankCode": "sample string 4",
  "Narration": "sample string 5",
  "CorporateID": 6
}

application/xml, text/xml

Sample:

<PaymentBatchViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bank3D.IBridge.Models">
  <CorporateID>6</CorporateID>
  <FromAccountNumber>sample string 3</FromAccountNumber>
  <FromBankCode>sample string 4</FromBankCode>
  <Narration>sample string 5</Narration>
  <BatchRef>sample string 2</BatchRef>
  <Id>1</Id>
  <Items>
    <PaymentItemViewModel>
      <AccountNumber>sample string 7</AccountNumber>
      <BankCode>sample string 8</BankCode>
      <Amount>4</Amount>
      <Narration>sample string 5</Narration>
      <PaymentProfile>sample string 6</PaymentProfile>
      <AccountName>sample string 3</AccountName>
      <Id>1</Id>
      <ItemRef>sample string 2</ItemRef>
      <Status>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
      </Status>
    </PaymentItemViewModel>
    <PaymentItemViewModel>
      <AccountNumber>sample string 7</AccountNumber>
      <BankCode>sample string 8</BankCode>
      <Amount>4</Amount>
      <Narration>sample string 5</Narration>
      <PaymentProfile>sample string 6</PaymentProfile>
      <AccountName>sample string 3</AccountName>
      <Id>1</Id>
      <ItemRef>sample string 2</ItemRef>
      <Status>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
      </Status>
    </PaymentItemViewModel>
  </Items>
</PaymentBatchViewModel>