POST api/PaymentInstruction

Instruct a new Payment

Request Information

URI Parameters

None.

Body Parameters

Payment Instruction parameters

Name	Description	Type	Additional information
beneficiary_id	Beneficiary ID	string	None.
currency	CCY	string	None.
purpose	Purpose of payment	string	None.
fee	Charge direction OUR\|SHA\|BEN (default to SHA)	string	None.
amount	Amount instructed	string	Required
payment_reference	Your Reference on payment	string	None.
trade_ref	The trade Reference of the trade used to instruct this payment, set to blank if this Payment is not linked to FX trade, or set to "auto" to attempt to retrieve available trade.	string	None.
payment_guid	A GUID defined by yourself that can be used to retrieve payment	string	None.
client_ref	client reference	string	None.
status	Payment Status (pending \| paid \| ...)	string	None.
created_by_id	The contact that created the OPI	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "beneficiary_id": "sample string 1",
  "currency": "sample string 2",
  "purpose": "sample string 3",
  "fee": "sample string 4",
  "amount": "sample string 5",
  "payment_reference": "sample string 6",
  "trade_ref": "sample string 7",
  "payment_guid": "sample string 8",
  "client_ref": "sample string 9",
  "status": "sample string 10",
  "created_by_id": 1
}

application/xml, text/xml

Sample:

<PaymentInstructionDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FXOPS_API">
  <amount>sample string 5</amount>
  <beneficiary_id>sample string 1</beneficiary_id>
  <client_ref>sample string 9</client_ref>
  <created_by_id>1</created_by_id>
  <currency>sample string 2</currency>
  <fee>sample string 4</fee>
  <payment_guid>sample string 8</payment_guid>
  <payment_reference>sample string 6</payment_reference>
  <purpose>sample string 3</purpose>
  <status>sample string 10</status>
  <trade_ref>sample string 7</trade_ref>
</PaymentInstructionDetail>

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

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.