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 Payment Details using a transaction reference.

GET api/Payments/Get?transRef={transRef}

Request Information

URI Parameters

Name	Description	Type	Additional information
transRef	The Transaction Reference - a numeric code that uniquely identifies the payment (47812345)	integer	Required

Response Information

Resource Description

Returns Payment object containing Payment Details

Payment

Name	Description	Type	Additional information
clientName	Client full name	string	None.
payeeName	Payee full name	string	None.
product	Product title	string	None.
transactionDate	Transaction date	date	None.
baseCurrency	Base/home currency for client	string	None.
baseAmount	Base/home currency transaction amount	decimal number	None.
transactionCharge	Transaction charge in base/home currency	decimal number	None.
totalTransactionAmount	Total transaction amount (base amount plus transaction charge)	decimal number	None.
rate	Currency conversion exchange rate	decimal number	None.
foreignCurrency	Foreign currency for conversion	string	None.
foreignAmount	Total transaction amount in the foreign currency	decimal number	None.
valueDate	Transaction value date	date	None.
lodgementDate	Transaction lodgement date	date	None.
reconciledDate	Transaction reconciled date	date	None.
status	Transaction status (U - Payment Created, Q - Payment Awaiting Quote, P - Payment Processed, C - Payment Cancelled)	string	None.
releasedDate	Credit Control Release Date	date	None.
sentDate	Date File Sent	date	None.

Response Formats

application/json, text/json

Sample:

{
  "clientName": "ACME CO",
  "payeeName": "John Murphy",
  "product": "Worldwide Standard Payment",
  "transactionDate": "2016-10-07T10:00:45.72",
  "baseCurrency": "EUR",
  "baseAmount": 4354.05,
  "transactionCharge": 10.0,
  "totalTransactionAmount": 4364.05,
  "rate": 0.8346925,
  "foreignCurrency": "GBP",
  "foreignAmount": 3634.29,
  "valueDate": "0001-01-01T00:00:00",
  "lodgementDate": "0001-01-01T00:00:00",
  "reconciledDate": "0001-01-01T00:00:00",
  "status": "C",
  "releasedDate": "2016-10-07T10:00:45.72",
  "sentDate": "2016-10-07T10:00:45.72"
}

application/xml, text/xml

Sample:

<Payment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BanksApp.Models">
  <baseAmount>4354.05</baseAmount>
  <baseCurrency>EUR</baseCurrency>
  <clientName>ACME CO</clientName>
  <foreignAmount>3634.29</foreignAmount>
  <foreignCurrency>GBP</foreignCurrency>
  <lodgementDate>0001-01-01T00:00:00</lodgementDate>
  <payeeName>John Murphy</payeeName>
  <product>Worldwide Standard Payment</product>
  <rate>0.8346925</rate>
  <reconciledDate>0001-01-01T00:00:00</reconciledDate>
  <releasedDate>2016-10-07T10:00:45.72</releasedDate>
  <sentDate>2016-10-07T10:00:45.72</sentDate>
  <status>C</status>
  <totalTransactionAmount>4364.05</totalTransactionAmount>
  <transactionCharge>10</transactionCharge>
  <transactionDate>2016-10-07T10:00:45.72</transactionDate>
  <valueDate>0001-01-01T00:00:00</valueDate>
</Payment>