POST REST/Payments/Single

Request Information

URI Parameters

None.

Body Parameters

PaymentItemInputModel
NameDescriptionTypeAdditional information
FromAccountNumber

string

None.

FromBankCode

string

None.

PaymentType

string

None.

CorporateID

integer

None.

ProcessDate

string

None.

BeneficiaryName

string

None.

BeneficiaryRef

string

None.

ItemRef

string

None.

Amount

decimal number

None.

Narration

string

None.

PaymentProfile

string

None.

AccountNumber

string

None.

BankCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FromAccountNumber": "sample string 1",
  "FromBankCode": "sample string 2",
  "PaymentType": "sample string 3",
  "CorporateID": 4,
  "ProcessDate": "sample string 5",
  "BeneficiaryName": "sample string 6",
  "BeneficiaryRef": "sample string 7",
  "ItemRef": "sample string 8",
  "Amount": 9.0,
  "Narration": "sample string 10",
  "PaymentProfile": "sample string 11",
  "AccountNumber": "sample string 12",
  "BankCode": "sample string 13"
}

application/xml, text/xml

Sample:
<PaymentItemInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bank3D.IBridge.Models">
  <AccountNumber>sample string 12</AccountNumber>
  <BankCode>sample string 13</BankCode>
  <Amount>9</Amount>
  <Narration>sample string 10</Narration>
  <PaymentProfile>sample string 11</PaymentProfile>
  <BeneficiaryName>sample string 6</BeneficiaryName>
  <BeneficiaryRef>sample string 7</BeneficiaryRef>
  <ItemRef>sample string 8</ItemRef>
  <CorporateID>4</CorporateID>
  <FromAccountNumber>sample string 1</FromAccountNumber>
  <FromBankCode>sample string 2</FromBankCode>
  <PaymentType>sample string 3</PaymentType>
  <ProcessDate>sample string 5</ProcessDate>
</PaymentItemInputModel>

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

Response Information

Resource Description

PaymentItemResponseModel
NameDescriptionTypeAdditional information
ItemRef

string

None.

Status

Status

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ItemRef": "sample string 1",
  "Status": {
    "Code": "sample string 1",
    "Description": "sample string 2"
  },
  "Id": 2
}

application/xml, text/xml

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