POST banking/paymentorders

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OrganizationalUnitID	integer	None.
CategoryID	integer	None.
Priority	integer	None.
Overdue	integer	None.
Scheduled	date	None.
Due	date	None.
Authorized	date	None.
Date	date	None.
DocumentDate	date	None.
IsProcessed	boolean	None.
IsOverdue	boolean	None.
IsAuthorized	boolean	None.
IsEditable	boolean	None.
IsValid	boolean	None.
PartnerID	integer	None.
COA	string	None.
CostCenterID	integer	None.
AccountIBAN	string	None.
CurrencyCode	string	None.
PartnerName	string	None.
Audit	Audit	None.
Year	integer	None.
ID	integer	None.
AccountID	integer	None.
Account	CompanyAccount	None.
PRN	ReferenceNumber	None.
RRN	ReferenceNumber	None.
Amount	decimal number	None.
Description	string	None.
ISO20022	string	None.
CurrencyID	integer	None.
Currency	Currency	None.
Partner	TransactionPartner	None.

Request Formats

application/json, text/json

Sample:

{
  "OrganizationalUnitID": 1,
  "CategoryID": 1,
  "Priority": 2,
  "Overdue": 3,
  "Scheduled": "2025-12-13T20:51:20.1226445+00:00",
  "Due": "2025-12-13T20:51:20.1226445+00:00",
  "Authorized": "2025-12-13T20:51:20.1226445+00:00",
  "Date": "2025-12-13T20:51:20.1226445+00:00",
  "DocumentDate": "2025-12-13T20:51:20.1226445+00:00",
  "IsProcessed": true,
  "IsOverdue": true,
  "IsAuthorized": true,
  "IsEditable": true,
  "IsValid": true,
  "PartnerID": 1,
  "COA": "sample string 11",
  "CostCenterID": 1,
  "AccountIBAN": "sample string 6",
  "CurrencyCode": "sample string 2",
  "PartnerName": "sample string 1",
  "Audit": {
    "AddUser": 1,
    "AddTime": "2025-12-13T20:51:20.1226445+00:00",
    "EditUser": 1,
    "EditTime": "2025-12-13T20:51:20.1226445+00:00"
  },
  "Year": 15,
  "ID": 16,
  "AccountID": 17,
  "Account": {
    "ID": 1,
    "OrganizationalUnitID": 1,
    "LookupText": "sample string 5",
    "Settings": [
      {
        "ID": 1,
        "AccountID": 2,
        "CurrencyID": 1,
        "LinkDocument_CategoryID": 1,
        "COA": "sample string 3",
        "Description": "sample string 4",
        "AutomaticFetching": true
      },
      {
        "ID": 1,
        "AccountID": 2,
        "CurrencyID": 1,
        "LinkDocument_CategoryID": 1,
        "COA": "sample string 3",
        "Description": "sample string 4",
        "AutomaticFetching": true
      }
    ],
    "Audit": {
      "AddUser": 1,
      "AddTime": "2025-12-13T20:51:20.1226445+00:00",
      "EditUser": 1,
      "EditTime": "2025-12-13T20:51:20.1226445+00:00"
    },
    "CountryID": 3,
    "Country": {
      "ID": 1,
      "Name": "sample string 2",
      "CurrencyID": 1,
      "Currency": {
        "ID": 1,
        "Code": "sample string 2",
        "Name": "sample string 3",
        "Sign": "sample string 4",
        "Lookup": "sample string 5"
      },
      "ISO31661": 1,
      "Alpha2": "sample string 3",
      "Alpha3": "sample string 4",
      "Audit": {
        "AddUser": 1,
        "AddTime": "2025-12-13T20:51:20.1226445+00:00",
        "EditUser": 1,
        "EditTime": "2025-12-13T20:51:20.1226445+00:00"
      }
    },
    "BankID": 4,
    "Bank": {
      "ID": 1,
      "CountryID": 2,
      "Name": "sample string 3",
      "Code": "sample string 4",
      "NBC": "sample string 5",
      "SWIFT": "sample string 6",
      "BankingUrl": "sample string 7"
    },
    "BBAN": "sample string 5",
    "IBAN": "sample string 6",
    "Closed": "2025-12-13T20:51:20.1226445+00:00"
  },
  "PRN": {
    "Model": "sample string 1",
    "Number": "sample string 2"
  },
  "RRN": {
    "Model": "sample string 1",
    "Number": "sample string 2"
  },
  "Amount": 18.0,
  "Description": "sample string 19",
  "ISO20022": "sample string 20",
  "CurrencyID": 21,
  "Currency": {
    "ID": 1,
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Sign": "sample string 4",
    "Lookup": "sample string 5"
  },
  "Partner": {
    "Name": "sample string 1",
    "Address": {
      "Street": "sample string 1",
      "Postcode": "sample string 2",
      "City": "sample string 3",
      "CountryID": 4,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "CurrencyID": 1,
        "Currency": {
          "ID": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "Sign": "sample string 4",
          "Lookup": "sample string 5"
        },
        "ISO31661": 1,
        "Alpha2": "sample string 3",
        "Alpha3": "sample string 4",
        "Audit": {
          "AddUser": 1,
          "AddTime": "2025-12-13T20:51:20.1226445+00:00",
          "EditUser": 1,
          "EditTime": "2025-12-13T20:51:20.1226445+00:00"
        }
      }
    },
    "Account": "sample string 2"
  }
}

text/xml

Sample:

<PaymentOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Banking">
  <Account>
    <BBAN>sample string 5</BBAN>
    <Bank>
      <BankingUrl>sample string 7</BankingUrl>
      <Code>sample string 4</Code>
      <CountryID>2</CountryID>
      <ID>1</ID>
      <NBC>sample string 5</NBC>
      <Name>sample string 3</Name>
      <SWIFT>sample string 6</SWIFT>
    </Bank>
    <BankID>4</BankID>
    <Closed>2025-12-13T20:51:20.1226445+00:00</Closed>
    <Country xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
      <d3p1:Alpha2>sample string 3</d3p1:Alpha2>
      <d3p1:Alpha3>sample string 4</d3p1:Alpha3>
      <d3p1:Audit xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
        <d4p1:AddTime>2025-12-13T20:51:20.1226445+00:00</d4p1:AddTime>
        <d4p1:AddUser>1</d4p1:AddUser>
        <d4p1:EditTime>2025-12-13T20:51:20.1226445+00:00</d4p1:EditTime>
        <d4p1:EditUser>1</d4p1:EditUser>
      </d3p1:Audit>
      <d3p1:Currency>
        <d3p1:Code>sample string 2</d3p1:Code>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:Lookup>sample string 5</d3p1:Lookup>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:Sign>sample string 4</d3p1:Sign>
      </d3p1:Currency>
      <d3p1:CurrencyID>1</d3p1:CurrencyID>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:ISO31661>1</d3p1:ISO31661>
      <d3p1:Name>sample string 2</d3p1:Name>
    </Country>
    <CountryID>3</CountryID>
    <IBAN>sample string 6</IBAN>
    <Audit xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
      <d3p1:AddTime>2025-12-13T20:51:20.1226445+00:00</d3p1:AddTime>
      <d3p1:AddUser>1</d3p1:AddUser>
      <d3p1:EditTime>2025-12-13T20:51:20.1226445+00:00</d3p1:EditTime>
      <d3p1:EditUser>1</d3p1:EditUser>
    </Audit>
    <ID>1</ID>
    <LookupText>sample string 5</LookupText>
    <OrganizationalUnitID>1</OrganizationalUnitID>
    <Settings>
      <CompanyAccountSetting>
        <AccountID>2</AccountID>
        <AutomaticFetching>true</AutomaticFetching>
        <COA>sample string 3</COA>
        <CurrencyID>1</CurrencyID>
        <Description>sample string 4</Description>
        <ID>1</ID>
        <LinkDocument_CategoryID>1</LinkDocument_CategoryID>
      </CompanyAccountSetting>
      <CompanyAccountSetting>
        <AccountID>2</AccountID>
        <AutomaticFetching>true</AutomaticFetching>
        <COA>sample string 3</COA>
        <CurrencyID>1</CurrencyID>
        <Description>sample string 4</Description>
        <ID>1</ID>
        <LinkDocument_CategoryID>1</LinkDocument_CategoryID>
      </CompanyAccountSetting>
    </Settings>
  </Account>
  <AccountID>17</AccountID>
  <Amount>18</Amount>
  <Currency xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
    <d2p1:Code>sample string 2</d2p1:Code>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Lookup>sample string 5</d2p1:Lookup>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Sign>sample string 4</d2p1:Sign>
  </Currency>
  <CurrencyID>21</CurrencyID>
  <Description>sample string 19</Description>
  <ID>16</ID>
  <ISO20022>sample string 20</ISO20022>
  <PRN>
    <Model>sample string 1</Model>
    <Number>sample string 2</Number>
  </PRN>
  <Partner>
    <Account>sample string 2</Account>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>
        <d3p1:Alpha2>sample string 3</d3p1:Alpha2>
        <d3p1:Alpha3>sample string 4</d3p1:Alpha3>
        <d3p1:Audit xmlns:d5p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
          <d5p1:AddTime>2025-12-13T20:51:20.1226445+00:00</d5p1:AddTime>
          <d5p1:AddUser>1</d5p1:AddUser>
          <d5p1:EditTime>2025-12-13T20:51:20.1226445+00:00</d5p1:EditTime>
          <d5p1:EditUser>1</d5p1:EditUser>
        </d3p1:Audit>
        <d3p1:Currency>
          <d3p1:Code>sample string 2</d3p1:Code>
          <d3p1:ID>1</d3p1:ID>
          <d3p1:Lookup>sample string 5</d3p1:Lookup>
          <d3p1:Name>sample string 3</d3p1:Name>
          <d3p1:Sign>sample string 4</d3p1:Sign>
        </d3p1:Currency>
        <d3p1:CurrencyID>1</d3p1:CurrencyID>
        <d3p1:ID>1</d3p1:ID>
        <d3p1:ISO31661>1</d3p1:ISO31661>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Country>
      <d3p1:CountryID>4</d3p1:CountryID>
      <d3p1:Postcode>sample string 2</d3p1:Postcode>
      <d3p1:Street>sample string 1</d3p1:Street>
    </Address>
    <Name>sample string 1</Name>
  </Partner>
  <RRN>
    <Model>sample string 1</Model>
    <Number>sample string 2</Number>
  </RRN>
  <Year>15</Year>
  <AccountIBAN>sample string 6</AccountIBAN>
  <Audit xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
    <d2p1:AddTime>2025-12-13T20:51:20.1226445+00:00</d2p1:AddTime>
    <d2p1:AddUser>1</d2p1:AddUser>
    <d2p1:EditTime>2025-12-13T20:51:20.1226445+00:00</d2p1:EditTime>
    <d2p1:EditUser>1</d2p1:EditUser>
  </Audit>
  <Authorized>2025-12-13T20:51:20.1226445+00:00</Authorized>
  <COA>sample string 11</COA>
  <CategoryID>1</CategoryID>
  <CostCenterID>1</CostCenterID>
  <CurrencyCode>sample string 2</CurrencyCode>
  <Date>2025-12-13T20:51:20.1226445+00:00</Date>
  <DocumentDate>2025-12-13T20:51:20.1226445+00:00</DocumentDate>
  <Due>2025-12-13T20:51:20.1226445+00:00</Due>
  <IsAuthorized>true</IsAuthorized>
  <IsEditable>true</IsEditable>
  <IsOverdue>true</IsOverdue>
  <IsProcessed>true</IsProcessed>
  <IsValid>true</IsValid>
  <OrganizationalUnitID>1</OrganizationalUnitID>
  <Overdue>3</Overdue>
  <PartnerID>1</PartnerID>
  <PartnerName>sample string 1</PartnerName>
  <Priority>2</Priority>
  <Scheduled>2025-12-13T20:51:20.1226445+00:00</Scheduled>
</PaymentOrder>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.