Create beneficiary
curl --request POST \
--url https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-For: <x-forwarded-for>' \
--header 'X-Forwarded-From: <x-forwarded-from>' \
--header 'X-Tenant-ID: <x-tenant-id>' \
--header 'deviceId: <deviceid>' \
--header 'platform: <platform>' \
--data '
{
"partyType": "INDIVIDUAL_CUSTOMER",
"companyName": "Acme Supplier Ltd",
"shortName": "Acme Supplier",
"iban": "LT121000011101001000",
"currency": "EUR",
"country": "LT",
"email": "payments@acme-supplier.test",
"phoneNumber": "+37060012345",
"bicSwiftCode": "HABALT22",
"networkName": "SEPA",
"bankName": "Sample Bank",
"purposeCode": "SUPP",
"accountNumber": "1000011101001000",
"bankCode": "73000",
"addressLine1": "123 Business Avenue",
"addressLine2": "Suite 7",
"city": "Vilnius",
"stateProvince": "Vilnius County",
"postalCode": "LT-01001",
"organizationId": "123e4567-e89b-12d3-a456-426614174010",
"customerId": "123e4567-e89b-12d3-a456-426614174011",
"firstName": "Jane",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"lastName": "Doe",
"name": "Jane Doe",
"targetCustomerId": "123e4567-e89b-12d3-a456-426614174012",
"type": "EXTERNAL",
"bankAddress": "1 Bank Street, Vilnius",
"bic": "HABALT22",
"allowedOperations": [
"SEPA_TRANSFER"
]
}
'import requests
url = "https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries"
payload = {
"partyType": "INDIVIDUAL_CUSTOMER",
"companyName": "Acme Supplier Ltd",
"shortName": "Acme Supplier",
"iban": "LT121000011101001000",
"currency": "EUR",
"country": "LT",
"email": "payments@acme-supplier.test",
"phoneNumber": "+37060012345",
"bicSwiftCode": "HABALT22",
"networkName": "SEPA",
"bankName": "Sample Bank",
"purposeCode": "SUPP",
"accountNumber": "1000011101001000",
"bankCode": "73000",
"addressLine1": "123 Business Avenue",
"addressLine2": "Suite 7",
"city": "Vilnius",
"stateProvince": "Vilnius County",
"postalCode": "LT-01001",
"organizationId": "123e4567-e89b-12d3-a456-426614174010",
"customerId": "123e4567-e89b-12d3-a456-426614174011",
"firstName": "Jane",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"lastName": "Doe",
"name": "Jane Doe",
"targetCustomerId": "123e4567-e89b-12d3-a456-426614174012",
"type": "EXTERNAL",
"bankAddress": "1 Bank Street, Vilnius",
"bic": "HABALT22",
"allowedOperations": ["SEPA_TRANSFER"]
}
headers = {
"X-Tenant-ID": "<x-tenant-id>",
"X-Forwarded-For": "<x-forwarded-for>",
"X-Forwarded-From": "<x-forwarded-from>",
"platform": "<platform>",
"deviceId": "<deviceid>",
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant-ID': '<x-tenant-id>',
'X-Forwarded-For': '<x-forwarded-for>',
'X-Forwarded-From': '<x-forwarded-from>',
platform: '<platform>',
deviceId: '<deviceid>',
Authorization: '<authorization>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
partyType: 'INDIVIDUAL_CUSTOMER',
companyName: 'Acme Supplier Ltd',
shortName: 'Acme Supplier',
iban: 'LT121000011101001000',
currency: 'EUR',
country: 'LT',
email: 'payments@acme-supplier.test',
phoneNumber: '+37060012345',
bicSwiftCode: 'HABALT22',
networkName: 'SEPA',
bankName: 'Sample Bank',
purposeCode: 'SUPP',
accountNumber: '1000011101001000',
bankCode: '73000',
addressLine1: '123 Business Avenue',
addressLine2: 'Suite 7',
city: 'Vilnius',
stateProvince: 'Vilnius County',
postalCode: 'LT-01001',
organizationId: '123e4567-e89b-12d3-a456-426614174010',
customerId: '123e4567-e89b-12d3-a456-426614174011',
firstName: 'Jane',
dateOfBirth: '1990-01-15T00:00:00.000Z',
lastName: 'Doe',
name: 'Jane Doe',
targetCustomerId: '123e4567-e89b-12d3-a456-426614174012',
type: 'EXTERNAL',
bankAddress: '1 Bank Street, Vilnius',
bic: 'HABALT22',
allowedOperations: ['SEPA_TRANSFER']
})
};
fetch('https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'partyType' => 'INDIVIDUAL_CUSTOMER',
'companyName' => 'Acme Supplier Ltd',
'shortName' => 'Acme Supplier',
'iban' => 'LT121000011101001000',
'currency' => 'EUR',
'country' => 'LT',
'email' => 'payments@acme-supplier.test',
'phoneNumber' => '+37060012345',
'bicSwiftCode' => 'HABALT22',
'networkName' => 'SEPA',
'bankName' => 'Sample Bank',
'purposeCode' => 'SUPP',
'accountNumber' => '1000011101001000',
'bankCode' => '73000',
'addressLine1' => '123 Business Avenue',
'addressLine2' => 'Suite 7',
'city' => 'Vilnius',
'stateProvince' => 'Vilnius County',
'postalCode' => 'LT-01001',
'organizationId' => '123e4567-e89b-12d3-a456-426614174010',
'customerId' => '123e4567-e89b-12d3-a456-426614174011',
'firstName' => 'Jane',
'dateOfBirth' => '1990-01-15T00:00:00.000Z',
'lastName' => 'Doe',
'name' => 'Jane Doe',
'targetCustomerId' => '123e4567-e89b-12d3-a456-426614174012',
'type' => 'EXTERNAL',
'bankAddress' => '1 Bank Street, Vilnius',
'bic' => 'HABALT22',
'allowedOperations' => [
'SEPA_TRANSFER'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"X-Forwarded-For: <x-forwarded-for>",
"X-Forwarded-From: <x-forwarded-from>",
"X-Tenant-ID: <x-tenant-id>",
"deviceId: <deviceid>",
"platform: <platform>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries"
payload := strings.NewReader("{\n \"partyType\": \"INDIVIDUAL_CUSTOMER\",\n \"companyName\": \"Acme Supplier Ltd\",\n \"shortName\": \"Acme Supplier\",\n \"iban\": \"LT121000011101001000\",\n \"currency\": \"EUR\",\n \"country\": \"LT\",\n \"email\": \"payments@acme-supplier.test\",\n \"phoneNumber\": \"+37060012345\",\n \"bicSwiftCode\": \"HABALT22\",\n \"networkName\": \"SEPA\",\n \"bankName\": \"Sample Bank\",\n \"purposeCode\": \"SUPP\",\n \"accountNumber\": \"1000011101001000\",\n \"bankCode\": \"73000\",\n \"addressLine1\": \"123 Business Avenue\",\n \"addressLine2\": \"Suite 7\",\n \"city\": \"Vilnius\",\n \"stateProvince\": \"Vilnius County\",\n \"postalCode\": \"LT-01001\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174010\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426614174011\",\n \"firstName\": \"Jane\",\n \"dateOfBirth\": \"1990-01-15T00:00:00.000Z\",\n \"lastName\": \"Doe\",\n \"name\": \"Jane Doe\",\n \"targetCustomerId\": \"123e4567-e89b-12d3-a456-426614174012\",\n \"type\": \"EXTERNAL\",\n \"bankAddress\": \"1 Bank Street, Vilnius\",\n \"bic\": \"HABALT22\",\n \"allowedOperations\": [\n \"SEPA_TRANSFER\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant-ID", "<x-tenant-id>")
req.Header.Add("X-Forwarded-For", "<x-forwarded-for>")
req.Header.Add("X-Forwarded-From", "<x-forwarded-from>")
req.Header.Add("platform", "<platform>")
req.Header.Add("deviceId", "<deviceid>")
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries")
.header("X-Tenant-ID", "<x-tenant-id>")
.header("X-Forwarded-For", "<x-forwarded-for>")
.header("X-Forwarded-From", "<x-forwarded-from>")
.header("platform", "<platform>")
.header("deviceId", "<deviceid>")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"partyType\": \"INDIVIDUAL_CUSTOMER\",\n \"companyName\": \"Acme Supplier Ltd\",\n \"shortName\": \"Acme Supplier\",\n \"iban\": \"LT121000011101001000\",\n \"currency\": \"EUR\",\n \"country\": \"LT\",\n \"email\": \"payments@acme-supplier.test\",\n \"phoneNumber\": \"+37060012345\",\n \"bicSwiftCode\": \"HABALT22\",\n \"networkName\": \"SEPA\",\n \"bankName\": \"Sample Bank\",\n \"purposeCode\": \"SUPP\",\n \"accountNumber\": \"1000011101001000\",\n \"bankCode\": \"73000\",\n \"addressLine1\": \"123 Business Avenue\",\n \"addressLine2\": \"Suite 7\",\n \"city\": \"Vilnius\",\n \"stateProvince\": \"Vilnius County\",\n \"postalCode\": \"LT-01001\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174010\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426614174011\",\n \"firstName\": \"Jane\",\n \"dateOfBirth\": \"1990-01-15T00:00:00.000Z\",\n \"lastName\": \"Doe\",\n \"name\": \"Jane Doe\",\n \"targetCustomerId\": \"123e4567-e89b-12d3-a456-426614174012\",\n \"type\": \"EXTERNAL\",\n \"bankAddress\": \"1 Bank Street, Vilnius\",\n \"bic\": \"HABALT22\",\n \"allowedOperations\": [\n \"SEPA_TRANSFER\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = '<x-tenant-id>'
request["X-Forwarded-For"] = '<x-forwarded-for>'
request["X-Forwarded-From"] = '<x-forwarded-from>'
request["platform"] = '<platform>'
request["deviceId"] = '<deviceid>'
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partyType\": \"INDIVIDUAL_CUSTOMER\",\n \"companyName\": \"Acme Supplier Ltd\",\n \"shortName\": \"Acme Supplier\",\n \"iban\": \"LT121000011101001000\",\n \"currency\": \"EUR\",\n \"country\": \"LT\",\n \"email\": \"payments@acme-supplier.test\",\n \"phoneNumber\": \"+37060012345\",\n \"bicSwiftCode\": \"HABALT22\",\n \"networkName\": \"SEPA\",\n \"bankName\": \"Sample Bank\",\n \"purposeCode\": \"SUPP\",\n \"accountNumber\": \"1000011101001000\",\n \"bankCode\": \"73000\",\n \"addressLine1\": \"123 Business Avenue\",\n \"addressLine2\": \"Suite 7\",\n \"city\": \"Vilnius\",\n \"stateProvince\": \"Vilnius County\",\n \"postalCode\": \"LT-01001\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174010\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426614174011\",\n \"firstName\": \"Jane\",\n \"dateOfBirth\": \"1990-01-15T00:00:00.000Z\",\n \"lastName\": \"Doe\",\n \"name\": \"Jane Doe\",\n \"targetCustomerId\": \"123e4567-e89b-12d3-a456-426614174012\",\n \"type\": \"EXTERNAL\",\n \"bankAddress\": \"1 Bank Street, Vilnius\",\n \"bic\": \"HABALT22\",\n \"allowedOperations\": [\n \"SEPA_TRANSFER\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 201,
"data": {
"id": "<string>",
"name": "<string>",
"iban": "<string>",
"bic": "<string>",
"type": "<string>",
"status": "<string>",
"currency": "<string>",
"country": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"shortName": "<string>",
"networkName": "<string>",
"bankName": "<string>",
"purposeCode": "<string>",
"assetId": "<string>",
"message": "<string>"
},
"message": "Success"
}Create beneficiary
Create a new beneficiary for financial transactions. Returns beneficiaryId used by subsequent transfer operations.
POST
/
api
/
v2.1
/
fintrans
/
{accountId}
/
beneficiaries
Create beneficiary
curl --request POST \
--url https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'X-Forwarded-For: <x-forwarded-for>' \
--header 'X-Forwarded-From: <x-forwarded-from>' \
--header 'X-Tenant-ID: <x-tenant-id>' \
--header 'deviceId: <deviceid>' \
--header 'platform: <platform>' \
--data '
{
"partyType": "INDIVIDUAL_CUSTOMER",
"companyName": "Acme Supplier Ltd",
"shortName": "Acme Supplier",
"iban": "LT121000011101001000",
"currency": "EUR",
"country": "LT",
"email": "payments@acme-supplier.test",
"phoneNumber": "+37060012345",
"bicSwiftCode": "HABALT22",
"networkName": "SEPA",
"bankName": "Sample Bank",
"purposeCode": "SUPP",
"accountNumber": "1000011101001000",
"bankCode": "73000",
"addressLine1": "123 Business Avenue",
"addressLine2": "Suite 7",
"city": "Vilnius",
"stateProvince": "Vilnius County",
"postalCode": "LT-01001",
"organizationId": "123e4567-e89b-12d3-a456-426614174010",
"customerId": "123e4567-e89b-12d3-a456-426614174011",
"firstName": "Jane",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"lastName": "Doe",
"name": "Jane Doe",
"targetCustomerId": "123e4567-e89b-12d3-a456-426614174012",
"type": "EXTERNAL",
"bankAddress": "1 Bank Street, Vilnius",
"bic": "HABALT22",
"allowedOperations": [
"SEPA_TRANSFER"
]
}
'import requests
url = "https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries"
payload = {
"partyType": "INDIVIDUAL_CUSTOMER",
"companyName": "Acme Supplier Ltd",
"shortName": "Acme Supplier",
"iban": "LT121000011101001000",
"currency": "EUR",
"country": "LT",
"email": "payments@acme-supplier.test",
"phoneNumber": "+37060012345",
"bicSwiftCode": "HABALT22",
"networkName": "SEPA",
"bankName": "Sample Bank",
"purposeCode": "SUPP",
"accountNumber": "1000011101001000",
"bankCode": "73000",
"addressLine1": "123 Business Avenue",
"addressLine2": "Suite 7",
"city": "Vilnius",
"stateProvince": "Vilnius County",
"postalCode": "LT-01001",
"organizationId": "123e4567-e89b-12d3-a456-426614174010",
"customerId": "123e4567-e89b-12d3-a456-426614174011",
"firstName": "Jane",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"lastName": "Doe",
"name": "Jane Doe",
"targetCustomerId": "123e4567-e89b-12d3-a456-426614174012",
"type": "EXTERNAL",
"bankAddress": "1 Bank Street, Vilnius",
"bic": "HABALT22",
"allowedOperations": ["SEPA_TRANSFER"]
}
headers = {
"X-Tenant-ID": "<x-tenant-id>",
"X-Forwarded-For": "<x-forwarded-for>",
"X-Forwarded-From": "<x-forwarded-from>",
"platform": "<platform>",
"deviceId": "<deviceid>",
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant-ID': '<x-tenant-id>',
'X-Forwarded-For': '<x-forwarded-for>',
'X-Forwarded-From': '<x-forwarded-from>',
platform: '<platform>',
deviceId: '<deviceid>',
Authorization: '<authorization>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
partyType: 'INDIVIDUAL_CUSTOMER',
companyName: 'Acme Supplier Ltd',
shortName: 'Acme Supplier',
iban: 'LT121000011101001000',
currency: 'EUR',
country: 'LT',
email: 'payments@acme-supplier.test',
phoneNumber: '+37060012345',
bicSwiftCode: 'HABALT22',
networkName: 'SEPA',
bankName: 'Sample Bank',
purposeCode: 'SUPP',
accountNumber: '1000011101001000',
bankCode: '73000',
addressLine1: '123 Business Avenue',
addressLine2: 'Suite 7',
city: 'Vilnius',
stateProvince: 'Vilnius County',
postalCode: 'LT-01001',
organizationId: '123e4567-e89b-12d3-a456-426614174010',
customerId: '123e4567-e89b-12d3-a456-426614174011',
firstName: 'Jane',
dateOfBirth: '1990-01-15T00:00:00.000Z',
lastName: 'Doe',
name: 'Jane Doe',
targetCustomerId: '123e4567-e89b-12d3-a456-426614174012',
type: 'EXTERNAL',
bankAddress: '1 Bank Street, Vilnius',
bic: 'HABALT22',
allowedOperations: ['SEPA_TRANSFER']
})
};
fetch('https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'partyType' => 'INDIVIDUAL_CUSTOMER',
'companyName' => 'Acme Supplier Ltd',
'shortName' => 'Acme Supplier',
'iban' => 'LT121000011101001000',
'currency' => 'EUR',
'country' => 'LT',
'email' => 'payments@acme-supplier.test',
'phoneNumber' => '+37060012345',
'bicSwiftCode' => 'HABALT22',
'networkName' => 'SEPA',
'bankName' => 'Sample Bank',
'purposeCode' => 'SUPP',
'accountNumber' => '1000011101001000',
'bankCode' => '73000',
'addressLine1' => '123 Business Avenue',
'addressLine2' => 'Suite 7',
'city' => 'Vilnius',
'stateProvince' => 'Vilnius County',
'postalCode' => 'LT-01001',
'organizationId' => '123e4567-e89b-12d3-a456-426614174010',
'customerId' => '123e4567-e89b-12d3-a456-426614174011',
'firstName' => 'Jane',
'dateOfBirth' => '1990-01-15T00:00:00.000Z',
'lastName' => 'Doe',
'name' => 'Jane Doe',
'targetCustomerId' => '123e4567-e89b-12d3-a456-426614174012',
'type' => 'EXTERNAL',
'bankAddress' => '1 Bank Street, Vilnius',
'bic' => 'HABALT22',
'allowedOperations' => [
'SEPA_TRANSFER'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"X-Forwarded-For: <x-forwarded-for>",
"X-Forwarded-From: <x-forwarded-from>",
"X-Tenant-ID: <x-tenant-id>",
"deviceId: <deviceid>",
"platform: <platform>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries"
payload := strings.NewReader("{\n \"partyType\": \"INDIVIDUAL_CUSTOMER\",\n \"companyName\": \"Acme Supplier Ltd\",\n \"shortName\": \"Acme Supplier\",\n \"iban\": \"LT121000011101001000\",\n \"currency\": \"EUR\",\n \"country\": \"LT\",\n \"email\": \"payments@acme-supplier.test\",\n \"phoneNumber\": \"+37060012345\",\n \"bicSwiftCode\": \"HABALT22\",\n \"networkName\": \"SEPA\",\n \"bankName\": \"Sample Bank\",\n \"purposeCode\": \"SUPP\",\n \"accountNumber\": \"1000011101001000\",\n \"bankCode\": \"73000\",\n \"addressLine1\": \"123 Business Avenue\",\n \"addressLine2\": \"Suite 7\",\n \"city\": \"Vilnius\",\n \"stateProvince\": \"Vilnius County\",\n \"postalCode\": \"LT-01001\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174010\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426614174011\",\n \"firstName\": \"Jane\",\n \"dateOfBirth\": \"1990-01-15T00:00:00.000Z\",\n \"lastName\": \"Doe\",\n \"name\": \"Jane Doe\",\n \"targetCustomerId\": \"123e4567-e89b-12d3-a456-426614174012\",\n \"type\": \"EXTERNAL\",\n \"bankAddress\": \"1 Bank Street, Vilnius\",\n \"bic\": \"HABALT22\",\n \"allowedOperations\": [\n \"SEPA_TRANSFER\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant-ID", "<x-tenant-id>")
req.Header.Add("X-Forwarded-For", "<x-forwarded-for>")
req.Header.Add("X-Forwarded-From", "<x-forwarded-from>")
req.Header.Add("platform", "<platform>")
req.Header.Add("deviceId", "<deviceid>")
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries")
.header("X-Tenant-ID", "<x-tenant-id>")
.header("X-Forwarded-For", "<x-forwarded-for>")
.header("X-Forwarded-From", "<x-forwarded-from>")
.header("platform", "<platform>")
.header("deviceId", "<deviceid>")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"partyType\": \"INDIVIDUAL_CUSTOMER\",\n \"companyName\": \"Acme Supplier Ltd\",\n \"shortName\": \"Acme Supplier\",\n \"iban\": \"LT121000011101001000\",\n \"currency\": \"EUR\",\n \"country\": \"LT\",\n \"email\": \"payments@acme-supplier.test\",\n \"phoneNumber\": \"+37060012345\",\n \"bicSwiftCode\": \"HABALT22\",\n \"networkName\": \"SEPA\",\n \"bankName\": \"Sample Bank\",\n \"purposeCode\": \"SUPP\",\n \"accountNumber\": \"1000011101001000\",\n \"bankCode\": \"73000\",\n \"addressLine1\": \"123 Business Avenue\",\n \"addressLine2\": \"Suite 7\",\n \"city\": \"Vilnius\",\n \"stateProvince\": \"Vilnius County\",\n \"postalCode\": \"LT-01001\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174010\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426614174011\",\n \"firstName\": \"Jane\",\n \"dateOfBirth\": \"1990-01-15T00:00:00.000Z\",\n \"lastName\": \"Doe\",\n \"name\": \"Jane Doe\",\n \"targetCustomerId\": \"123e4567-e89b-12d3-a456-426614174012\",\n \"type\": \"EXTERNAL\",\n \"bankAddress\": \"1 Bank Street, Vilnius\",\n \"bic\": \"HABALT22\",\n \"allowedOperations\": [\n \"SEPA_TRANSFER\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = '<x-tenant-id>'
request["X-Forwarded-For"] = '<x-forwarded-for>'
request["X-Forwarded-From"] = '<x-forwarded-from>'
request["platform"] = '<platform>'
request["deviceId"] = '<deviceid>'
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partyType\": \"INDIVIDUAL_CUSTOMER\",\n \"companyName\": \"Acme Supplier Ltd\",\n \"shortName\": \"Acme Supplier\",\n \"iban\": \"LT121000011101001000\",\n \"currency\": \"EUR\",\n \"country\": \"LT\",\n \"email\": \"payments@acme-supplier.test\",\n \"phoneNumber\": \"+37060012345\",\n \"bicSwiftCode\": \"HABALT22\",\n \"networkName\": \"SEPA\",\n \"bankName\": \"Sample Bank\",\n \"purposeCode\": \"SUPP\",\n \"accountNumber\": \"1000011101001000\",\n \"bankCode\": \"73000\",\n \"addressLine1\": \"123 Business Avenue\",\n \"addressLine2\": \"Suite 7\",\n \"city\": \"Vilnius\",\n \"stateProvince\": \"Vilnius County\",\n \"postalCode\": \"LT-01001\",\n \"organizationId\": \"123e4567-e89b-12d3-a456-426614174010\",\n \"customerId\": \"123e4567-e89b-12d3-a456-426614174011\",\n \"firstName\": \"Jane\",\n \"dateOfBirth\": \"1990-01-15T00:00:00.000Z\",\n \"lastName\": \"Doe\",\n \"name\": \"Jane Doe\",\n \"targetCustomerId\": \"123e4567-e89b-12d3-a456-426614174012\",\n \"type\": \"EXTERNAL\",\n \"bankAddress\": \"1 Bank Street, Vilnius\",\n \"bic\": \"HABALT22\",\n \"allowedOperations\": [\n \"SEPA_TRANSFER\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 201,
"data": {
"id": "<string>",
"name": "<string>",
"iban": "<string>",
"bic": "<string>",
"type": "<string>",
"status": "<string>",
"currency": "<string>",
"country": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"shortName": "<string>",
"networkName": "<string>",
"bankName": "<string>",
"purposeCode": "<string>",
"assetId": "<string>",
"message": "<string>"
},
"message": "Success"
}Sample cURL
curl --request POST \
--url 'https://sandbox.finhub.cloud/api/v2.1/fintrans/{accountId}/beneficiaries' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'X-Tenant-Id: <TENANT_ID>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'User-Agent: <USER_AGENT>' \
--header 'X-Forwarded-From: <FORWARDED_FROM>' \
--header 'platform: Web' \
--header 'deviceId: <DEVICE_ID>' \
--data '{
"name": "Acme Corporation",
"shortName": "Acme Corp",
"iban": "DE89370400440532013000",
"bicSwiftCode": "DEUTDEFF",
"currency": "EUR",
"country": "DE",
"networkName": "SEPA",
"bankName": "Deutsche Bank AG",
"bankAddress": "Taunusanlage 12, 60325 Frankfurt am Main, Germany",
"purposeCode": "SUPP",
"email": "finance@acme.com",
"phoneNumber": "+4912345678"
}'
Response Example
{
"code": 200,
"data": {
"id": "df019bb3-ad7f-440c-ba01-b79e27ef8a3f",
"name": "Acme Corporation",
"shortName": "Acme Corp",
"iban": "DE89370400440532013000",
"status": "ACTIVE",
"currency": "EUR",
"country": "DE",
"networkName": "SEPA",
"bankName": "Deutsche Bank AG",
"email": "finance@acme.com",
"phoneNumber": "+4912345678",
"purposeCode": "SUPP"
},
"message": "Success"
}
The returned
id is the beneficiaryId used in subsequent transfer operations (prepare/execute).Headers
Example:
"tenant-demo-001"
Client IP address
Example:
"127.0.0.1"
Client source identifier
Example:
"client-app"
Client platform
Example:
"mobile"
Device identifier
Example:
"device-demo-001"
Bearer JWT
Example:
"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkZW1vLXVzZXIifQ.demo-signature"
Path Parameters
Example:
"00000000-0000-0000-0000-000000000000"
Body
application/json
Beneficiary creation payload
Create beneficiary request
Party type
Available options:
INDIVIDUAL_CUSTOMER, BUSINESS_CUSTOMER Example:
"INDIVIDUAL_CUSTOMER"
Beneficiary company name
Example:
"Acme Supplier Ltd"
Short display name
Example:
"Acme Supplier"
Beneficiary IBAN
Example:
"LT121000011101001000"
Transaction currency
Example:
"EUR"
Beneficiary country code
Example:
"LT"
Beneficiary email
Example:
"payments@acme-supplier.test"
Beneficiary phone number
Example:
"+37060012345"
BIC/SWIFT code
Example:
"HABALT22"
Payment network name
Example:
"SEPA"
Beneficiary bank name
Example:
"Sample Bank"
Purpose code
Example:
"SUPP"
Bank account number
Example:
"1000011101001000"
Bank code
Example:
"73000"
Address line 1
Example:
"123 Business Avenue"
Address line 2
Example:
"Suite 7"
City
Example:
"Vilnius"
State or province
Example:
"Vilnius County"
Postal code
Example:
"LT-01001"
Organization identifier
Example:
"123e4567-e89b-12d3-a456-426614174010"
Customer identifier
Example:
"123e4567-e89b-12d3-a456-426614174011"
Beneficiary first name
Example:
"Jane"
Date of birth (INDIVIDUAL party type)
Example:
"1990-01-15T00:00:00.000Z"
Beneficiary last name
Example:
"Doe"
Beneficiary full name
Example:
"Jane Doe"
Target customer identifier
Example:
"123e4567-e89b-12d3-a456-426614174012"
Beneficiary type
Example:
"EXTERNAL"
Bank address
Example:
"1 Bank Street, Vilnius"
BIC code
Example:
"HABALT22"
Allowed operation types
Example:
["SEPA_TRANSFER"]
⌘I