POST api/beneficiaries

Send beneficiary account details

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
intermediary	intermediary swift of the bank	string	Max length: 50
account_name	beneficiary name	string	Required
account_number	account number or iban	string	Required
address	bank address	string	None.
bankname	instructed bank name	string	None.
currency	3 letters currency code	string	Required String length: inclusive between 3 and 3
notes	payment notes	string	None.
sort_code	for uk payments	string	String length: inclusive between 6 and 6
swift	swift or bic code	string	None.
routing_number	Routing Number	string	None.
country_code	2 letters iso country code	string	Required
email	beneficiary email	string	None.
ben_address	address of beneficiary	string	None.
ben_city		string	None.
ben_postcode		string	None.
ben_country_code		string	None.
cnaps	for payment to china only	string	None.
id	payment id	string	None.
nickname	nickname	string	None.
client_ref	client_ref	string	None.
default_charge		string	None.

Request Formats

application/json, text/json

Sample:

{
  "intermediary": "sample string 1",
  "account_name": "sample string 2",
  "account_number": "sample string 3",
  "address": "sample string 4",
  "bankname": "sample string 5",
  "currency": "sample string 6",
  "notes": "sample string 7",
  "sort_code": "sample string 8",
  "swift": "sample string 9",
  "routing_number": "sample string 10",
  "country_code": "sample string 11",
  "email": "sample string 12",
  "ben_address": "sample string 13",
  "ben_city": "sample string 14",
  "ben_postcode": "sample string 15",
  "ben_country_code": "sample string 16",
  "cnaps": "sample string 17",
  "id": "sample string 18",
  "nickname": "sample string 19",
  "client_ref": "sample string 20",
  "default_charge": "sample string 21"
}

application/xml, text/xml

Sample:

<beneficiary_obj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FXOPS_API">
  <account_name>sample string 2</account_name>
  <account_number>sample string 3</account_number>
  <address>sample string 4</address>
  <bankname>sample string 5</bankname>
  <ben_address>sample string 13</ben_address>
  <ben_city>sample string 14</ben_city>
  <ben_country_code>sample string 16</ben_country_code>
  <ben_postcode>sample string 15</ben_postcode>
  <client_ref>sample string 20</client_ref>
  <cnaps>sample string 17</cnaps>
  <country_code>sample string 11</country_code>
  <currency>sample string 6</currency>
  <default_charge>sample string 21</default_charge>
  <email>sample string 12</email>
  <id>sample string 18</id>
  <intermediary>sample string 1</intermediary>
  <nickname>sample string 19</nickname>
  <notes>sample string 7</notes>
  <routing_number>sample string 10</routing_number>
  <sort_code>sample string 8</sort_code>
  <swift>sample string 9</swift>
</beneficiary_obj>

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

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.