APIs Home

API Listings

Documentation

Fexco Corporate Payments WEB API is a suite of Restful APIs designed to facilitate a clean flow of payment data

View Global Payment Codes View Product List and Codes View API Code Samples

Streamline & simplify your payment processes with our payable APIs

Return to API Listings

Get Cost Centres.

GET api/CostCentre/GetCostCentres?clientID={clientID}&costCentreCode={costCentreCode}&name={name}&active={active}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client Reference ID - issued by Fexco Corporate Payments (1234)	integer	Required
costCentreCode	Cost Centre Code - uniquely identifies the client's cost centre to search for (123). Optional.	integer	Optional
name	Cost Centre Name - the name of the cost centre to search for ('Accounts'). Optional.	string	Optional
active	Cost Centre Status - the status of the cost centre to search, active ('Y') or inactive ('N'). Optional.	string	Optional

Response Information

Resource Description

Returns cost centres that match the search criteria.

CostCentre

Name	Description	Type	Additional information
clientID	Client unique identifier.	integer	None.
costCentreCode	A code to identify the client's cost centre.	integer	None.
costCentreName	The name of the Cost Centre..	string	None.
active	A flag to indicate if the cost centre is active or not (Y/N).	string	None.
email	An email address for the cost centre.	string	None.
costCentreFullName	The full name of the cost centre.	string	None.
addr1	Cost centre first address line.	string	None.
addr2	Cost centre second address line.	string	None.
addr3	Cost centre third address line.	string	None.
city	Cost centre city.	string	None.
state	Cost centre state.	string	None.
postCode	Cost centre post code or zip.	string	None.
countryCode	Cost centre ISO numeric country code.	integer	None.
country	Cost centre country	string	None.
contactName	A contact name for the cost centre.	string	None.
natureOfBusiness	Cost centre nature of business.	string	None.
customerNumber	The client's own identifier for their cost centre.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "clientID": 1,
  "costCentreCode": 2,
  "costCentreName": "sample string 3",
  "active": "sample string 4",
  "email": "sample string 5",
  "costCentreFullName": "sample string 6",
  "addr1": "sample string 7",
  "addr2": "sample string 8",
  "addr3": "sample string 9",
  "city": "sample string 10",
  "state": "sample string 11",
  "postCode": "sample string 12",
  "countryCode": 13,
  "country": "sample string 14",
  "contactName": "sample string 15",
  "natureOfBusiness": "sample string 16",
  "customerNumber": "sample string 17"
}

application/xml, text/xml

Sample:

<CostCentre xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BanksApp.Models">
  <active>sample string 4</active>
  <addr1>sample string 7</addr1>
  <addr2>sample string 8</addr2>
  <addr3>sample string 9</addr3>
  <city>sample string 10</city>
  <clientID>1</clientID>
  <contactName>sample string 15</contactName>
  <costCentreCode>2</costCentreCode>
  <costCentreFullName>sample string 6</costCentreFullName>
  <costCentreName>sample string 3</costCentreName>
  <country>sample string 14</country>
  <countryCode>13</countryCode>
  <customerNumber>sample string 17</customerNumber>
  <email>sample string 5</email>
  <natureOfBusiness>sample string 16</natureOfBusiness>
  <postCode>sample string 12</postCode>
  <state>sample string 11</state>
</CostCentre>