GET api/Template

Get a list of Beneficiary Templates

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
client_ref		string	None.

Request Formats

application/json, text/json

Sample:

{
  "client_ref": "sample string 1"
}

application/xml, text/xml

Sample:

<templateParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FXOPS_API.Controllers">
  <client_ref>sample string 1</client_ref>
</templateParam>

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

Response Information

Resource Description

Collection of tbl_payment_instruction

Name	Type	Additional information
pin_id	integer	None.
pin_link_id	integer	None.
pin_link_type	integer	None.
pin_ccy	string	None.
pin_bank_name	string	None.
pin_address	string	None.
pin_account_name	string	None.
pin_account_number	string	None.
pin_sort_code	string	None.
pin_iban	string	None.
pin_swift_bic	string	None.
pin_fedwire_bank_code	string	None.
pin_details	string	None.
pin_notes	string	None.
pin_country_code	string	None.
pin_intermediary	string	None.
pin_email	string	None.
pin_alert_date	string	None.
pin_archived	boolean	None.
pin_ben_name	string	None.
pin_ben_contact_name	string	None.
pin_ben_address	string	None.
pin_ben_activity	string	None.
pin_ben_post_code	string	None.
pin_ben_Town	string	None.
pin_bank_post_code	string	None.
pin_bank_Town	string	None.
pin_bank_code	string	None.
pin_bank_branch	string	None.
pin_CPF	string	None.
pin_account_type	string	None.
pin_cnaps	string	None.
pin_purpose	string	None.
pin_validate_date	string	None.
pin_last_external_check_date	string	None.
pin_low_risk	integer	None.
pin_recurrent	integer	None.
pin_partner	integer	None.
pin_check_count	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "pin_id": 1,
    "pin_link_id": 2,
    "pin_link_type": 3,
    "pin_ccy": "sample string 4",
    "pin_bank_name": "sample string 5",
    "pin_address": "sample string 6",
    "pin_account_name": "sample string 7",
    "pin_account_number": "sample string 8",
    "pin_sort_code": "sample string 9",
    "pin_iban": "sample string 10",
    "pin_swift_bic": "sample string 11",
    "pin_fedwire_bank_code": "sample string 12",
    "pin_details": "sample string 13",
    "pin_notes": "sample string 14",
    "pin_country_code": "sample string 15",
    "pin_intermediary": "sample string 16",
    "pin_email": "sample string 17",
    "pin_alert_date": "sample string 18",
    "pin_archived": true,
    "pin_ben_name": "sample string 20",
    "pin_ben_contact_name": "sample string 21",
    "pin_ben_address": "sample string 22",
    "pin_ben_activity": "sample string 23",
    "pin_ben_post_code": "sample string 24",
    "pin_ben_Town": "sample string 25",
    "pin_bank_post_code": "sample string 26",
    "pin_bank_Town": "sample string 27",
    "pin_bank_code": "sample string 28",
    "pin_bank_branch": "sample string 29",
    "pin_CPF": "sample string 30",
    "pin_account_type": "sample string 31",
    "pin_cnaps": "sample string 32",
    "pin_purpose": "sample string 33",
    "pin_validate_date": "sample string 34",
    "pin_last_external_check_date": "sample string 35",
    "pin_low_risk": 1,
    "pin_recurrent": 1,
    "pin_partner": 1,
    "pin_check_count": 1
  },
  {
    "pin_id": 1,
    "pin_link_id": 2,
    "pin_link_type": 3,
    "pin_ccy": "sample string 4",
    "pin_bank_name": "sample string 5",
    "pin_address": "sample string 6",
    "pin_account_name": "sample string 7",
    "pin_account_number": "sample string 8",
    "pin_sort_code": "sample string 9",
    "pin_iban": "sample string 10",
    "pin_swift_bic": "sample string 11",
    "pin_fedwire_bank_code": "sample string 12",
    "pin_details": "sample string 13",
    "pin_notes": "sample string 14",
    "pin_country_code": "sample string 15",
    "pin_intermediary": "sample string 16",
    "pin_email": "sample string 17",
    "pin_alert_date": "sample string 18",
    "pin_archived": true,
    "pin_ben_name": "sample string 20",
    "pin_ben_contact_name": "sample string 21",
    "pin_ben_address": "sample string 22",
    "pin_ben_activity": "sample string 23",
    "pin_ben_post_code": "sample string 24",
    "pin_ben_Town": "sample string 25",
    "pin_bank_post_code": "sample string 26",
    "pin_bank_Town": "sample string 27",
    "pin_bank_code": "sample string 28",
    "pin_bank_branch": "sample string 29",
    "pin_CPF": "sample string 30",
    "pin_account_type": "sample string 31",
    "pin_cnaps": "sample string 32",
    "pin_purpose": "sample string 33",
    "pin_validate_date": "sample string 34",
    "pin_last_external_check_date": "sample string 35",
    "pin_low_risk": 1,
    "pin_recurrent": 1,
    "pin_partner": 1,
    "pin_check_count": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOftbl_payment_instruction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FXOPS_API">
  <tbl_payment_instruction>
    <pin_CPF>sample string 30</pin_CPF>
    <pin_account_name>sample string 7</pin_account_name>
    <pin_account_number>sample string 8</pin_account_number>
    <pin_account_type>sample string 31</pin_account_type>
    <pin_address>sample string 6</pin_address>
    <pin_alert_date>sample string 18</pin_alert_date>
    <pin_archived>true</pin_archived>
    <pin_bank_Town>sample string 27</pin_bank_Town>
    <pin_bank_branch>sample string 29</pin_bank_branch>
    <pin_bank_code>sample string 28</pin_bank_code>
    <pin_bank_name>sample string 5</pin_bank_name>
    <pin_bank_post_code>sample string 26</pin_bank_post_code>
    <pin_ben_Town>sample string 25</pin_ben_Town>
    <pin_ben_activity>sample string 23</pin_ben_activity>
    <pin_ben_address>sample string 22</pin_ben_address>
    <pin_ben_contact_name>sample string 21</pin_ben_contact_name>
    <pin_ben_name>sample string 20</pin_ben_name>
    <pin_ben_post_code>sample string 24</pin_ben_post_code>
    <pin_ccy>sample string 4</pin_ccy>
    <pin_check_count>1</pin_check_count>
    <pin_cnaps>sample string 32</pin_cnaps>
    <pin_country_code>sample string 15</pin_country_code>
    <pin_details>sample string 13</pin_details>
    <pin_email>sample string 17</pin_email>
    <pin_fedwire_bank_code>sample string 12</pin_fedwire_bank_code>
    <pin_iban>sample string 10</pin_iban>
    <pin_id>1</pin_id>
    <pin_intermediary>sample string 16</pin_intermediary>
    <pin_last_external_check_date>sample string 35</pin_last_external_check_date>
    <pin_link_id>2</pin_link_id>
    <pin_link_type>3</pin_link_type>
    <pin_low_risk>1</pin_low_risk>
    <pin_notes>sample string 14</pin_notes>
    <pin_partner>1</pin_partner>
    <pin_purpose>sample string 33</pin_purpose>
    <pin_recurrent>1</pin_recurrent>
    <pin_sort_code>sample string 9</pin_sort_code>
    <pin_swift_bic>sample string 11</pin_swift_bic>
    <pin_validate_date>sample string 34</pin_validate_date>
  </tbl_payment_instruction>
  <tbl_payment_instruction>
    <pin_CPF>sample string 30</pin_CPF>
    <pin_account_name>sample string 7</pin_account_name>
    <pin_account_number>sample string 8</pin_account_number>
    <pin_account_type>sample string 31</pin_account_type>
    <pin_address>sample string 6</pin_address>
    <pin_alert_date>sample string 18</pin_alert_date>
    <pin_archived>true</pin_archived>
    <pin_bank_Town>sample string 27</pin_bank_Town>
    <pin_bank_branch>sample string 29</pin_bank_branch>
    <pin_bank_code>sample string 28</pin_bank_code>
    <pin_bank_name>sample string 5</pin_bank_name>
    <pin_bank_post_code>sample string 26</pin_bank_post_code>
    <pin_ben_Town>sample string 25</pin_ben_Town>
    <pin_ben_activity>sample string 23</pin_ben_activity>
    <pin_ben_address>sample string 22</pin_ben_address>
    <pin_ben_contact_name>sample string 21</pin_ben_contact_name>
    <pin_ben_name>sample string 20</pin_ben_name>
    <pin_ben_post_code>sample string 24</pin_ben_post_code>
    <pin_ccy>sample string 4</pin_ccy>
    <pin_check_count>1</pin_check_count>
    <pin_cnaps>sample string 32</pin_cnaps>
    <pin_country_code>sample string 15</pin_country_code>
    <pin_details>sample string 13</pin_details>
    <pin_email>sample string 17</pin_email>
    <pin_fedwire_bank_code>sample string 12</pin_fedwire_bank_code>
    <pin_iban>sample string 10</pin_iban>
    <pin_id>1</pin_id>
    <pin_intermediary>sample string 16</pin_intermediary>
    <pin_last_external_check_date>sample string 35</pin_last_external_check_date>
    <pin_link_id>2</pin_link_id>
    <pin_link_type>3</pin_link_type>
    <pin_low_risk>1</pin_low_risk>
    <pin_notes>sample string 14</pin_notes>
    <pin_partner>1</pin_partner>
    <pin_purpose>sample string 33</pin_purpose>
    <pin_recurrent>1</pin_recurrent>
    <pin_sort_code>sample string 9</pin_sort_code>
    <pin_swift_bic>sample string 11</pin_swift_bic>
    <pin_validate_date>sample string 34</pin_validate_date>
  </tbl_payment_instruction>
</ArrayOftbl_payment_instruction>