APIs Home

API Listings

Documentation

Fexco International 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

Or Contact Us

Ireland: 1800 246 800
UK: 0800 840 2887
fipsupport@fexco.com

Return to API Listings

Get a list of Payees by using client identifier and/or a combination of any of the following payee id/name/currencyCode/productCode/includeInactive

GET api/Payee/Find?clientID={clientID}&id={id}&name={name}&currencyCode={currencyCode}&productCode={productCode}&includeInactive={includeInactive}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client Unique Identifier - a numeric code that uniquely identifies the client	integer	Required
id	Payee Unique Identifier - a numeric code that uniquely identifies the payee	integer	Optional
name	Payee Name	string	Optional
currencyCode	Curreny Code of the Payee	string	Optional
productCode	Product Code assigned to Payee	string	Optional
includeInactive	Include active or inactive Payees	boolean	Optional

Response Information

Resource Description

A List of Payee Objects

Payee

Name	Description	Type	Additional information
id	Payee Unique Identifier - a numeric code that uniquely identifies the payee	integer	None.
clientID	Client Reference ID issued by Fexco Corporate Payments	integer	None.
name	Payee name	string	None.
productID	ID for specific beneficiary product.	integer	None.
currency	Currency in which money is held in the beneficiary's bank account. Three-digit currency code.	string	None.
bankCountry	ISO 2 alpha Country Code for the payee’s bank country OR ISO 2 numeric Country Code for the payee’s country.	integer	None.
email	Payee email address	string	None.
payeeAddress1	The first address line of the payee address.	string	None.
payeeCity	The city portion of the payee’s address.	string	None.
payeePostcode	Payee PostCode	string	None.
payeeState	Payee County/State	string	None.
payeeCountry	ISO 2 alpha Country Code for the payee’s country OR ISO 2 numeric Country Code for the payee’s country.	integer	None.
contact	Payee Contact Name	string	None.
accountNumber	Payee Bank Account Number	string	None.
sortCode	Payee Bank Sort Code	string	None.
bic	Payee BIC	string	None.
iban	Payee IBAN	string	None.
bankName	Payee Bank Name	string	None.
bankAddress1	First line of bank address.	string	None.
bankCity	Payee Bank City	string	None.
bankPostcode	Payee Bank PostCode	string	None.
bankState	Payee Bank County/State	string	None.
intermediaryBICCode	Intermediary Bank BIC/SWIFT code.	string	None.
intermediaryCountry	ISO 2 alpha Country Code for the payee’s country OR ISO 2 numeric Country Code for the payee’s country.	integer	None.
operatorId	ID of Operator who is creating the payee	integer	None.
active	Payee is active or inactive	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "clientID": 2,
  "name": "sample string 3",
  "productID": 4,
  "currency": "sample string 5",
  "bankCountry": 6,
  "email": "sample string 7",
  "payeeAddress1": "sample string 8",
  "payeeCity": "sample string 9",
  "payeePostcode": "sample string 10",
  "payeeState": "sample string 11",
  "payeeCountry": 12,
  "contact": "sample string 13",
  "accountNumber": "sample string 14",
  "sortCode": "sample string 15",
  "bic": "sample string 16",
  "iban": "sample string 17",
  "bankName": "sample string 18",
  "bankAddress1": "sample string 19",
  "bankCity": "sample string 20",
  "bankPostcode": "sample string 21",
  "bankState": "sample string 22",
  "intermediaryBICCode": "sample string 23",
  "intermediaryCountry": 24,
  "operatorId": 25,
  "active": true
}

application/xml, text/xml

Sample:

<Payee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BanksApp.Models">
  <accountNumber>sample string 14</accountNumber>
  <active>true</active>
  <bankAddress1>sample string 19</bankAddress1>
  <bankCity>sample string 20</bankCity>
  <bankCountry>6</bankCountry>
  <bankName>sample string 18</bankName>
  <bankPostcode>sample string 21</bankPostcode>
  <bankState>sample string 22</bankState>
  <bic>sample string 16</bic>
  <clientID>2</clientID>
  <contact>sample string 13</contact>
  <currency>sample string 5</currency>
  <email>sample string 7</email>
  <iban>sample string 17</iban>
  <id>1</id>
  <intermediaryBICCode>sample string 23</intermediaryBICCode>
  <intermediaryCountry>24</intermediaryCountry>
  <name>sample string 3</name>
  <operatorId>25</operatorId>
  <payeeAddress1>sample string 8</payeeAddress1>
  <payeeCity>sample string 9</payeeCity>
  <payeeCountry>12</payeeCountry>
  <payeePostcode>sample string 10</payeePostcode>
  <payeeState>sample string 11</payeeState>
  <productID>4</productID>
  <sortCode>sample string 15</sortCode>
</Payee>