Create a counterparty
curl --request POST \
--url https://api.getivy.de/api/service/counterparty/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"financialAddress": {},
"accountHolderId": "<string>",
"name": "<string>",
"entityType": "business",
"isSelfOwned": false,
"dateOfBirth": "<string>",
"metadata": {}
}
'import requests
url = "https://api.getivy.de/api/service/counterparty/create"
payload = {
"financialAddress": {},
"accountHolderId": "<string>",
"name": "<string>",
"entityType": "business",
"isSelfOwned": False,
"dateOfBirth": "<string>",
"metadata": {}
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
financialAddress: {},
accountHolderId: '<string>',
name: '<string>',
entityType: 'business',
isSelfOwned: false,
dateOfBirth: '<string>',
metadata: {}
})
};
fetch('https://api.getivy.de/api/service/counterparty/create', 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://api.getivy.de/api/service/counterparty/create",
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([
'financialAddress' => [
],
'accountHolderId' => '<string>',
'name' => '<string>',
'entityType' => 'business',
'isSelfOwned' => false,
'dateOfBirth' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$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://api.getivy.de/api/service/counterparty/create"
payload := strings.NewReader("{\n \"financialAddress\": {},\n \"accountHolderId\": \"<string>\",\n \"name\": \"<string>\",\n \"entityType\": \"business\",\n \"isSelfOwned\": false,\n \"dateOfBirth\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
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://api.getivy.de/api/service/counterparty/create")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"financialAddress\": {},\n \"accountHolderId\": \"<string>\",\n \"name\": \"<string>\",\n \"entityType\": \"business\",\n \"isSelfOwned\": false,\n \"dateOfBirth\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/counterparty/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"financialAddress\": {},\n \"accountHolderId\": \"<string>\",\n \"name\": \"<string>\",\n \"entityType\": \"business\",\n \"isSelfOwned\": false,\n \"dateOfBirth\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "pending",
"id": "<string>",
"accountHolderId": "<string>",
"name": "<string>",
"entityType": "business",
"isSelfOwned": true,
"blocked": true,
"financialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"aba": {
"accountHolderName": "<string>",
"routingNumber": "<string>",
"accountNumber": "<string>"
},
"bic": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"bic": "<string>",
"localBankCode": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
}
},
"physicalAddress": {
"city": "<string>",
"countryCode": "DE",
"line1": "<string>",
"line2": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"dateOfBirth": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Counterparty
Create a counterparty
Create a counterparty owned by the merchant.
POST
/
api
/
service
/
counterparty
/
create
Create a counterparty
curl --request POST \
--url https://api.getivy.de/api/service/counterparty/create \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"financialAddress": {},
"accountHolderId": "<string>",
"name": "<string>",
"entityType": "business",
"isSelfOwned": false,
"dateOfBirth": "<string>",
"metadata": {}
}
'import requests
url = "https://api.getivy.de/api/service/counterparty/create"
payload = {
"financialAddress": {},
"accountHolderId": "<string>",
"name": "<string>",
"entityType": "business",
"isSelfOwned": False,
"dateOfBirth": "<string>",
"metadata": {}
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
financialAddress: {},
accountHolderId: '<string>',
name: '<string>',
entityType: 'business',
isSelfOwned: false,
dateOfBirth: '<string>',
metadata: {}
})
};
fetch('https://api.getivy.de/api/service/counterparty/create', 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://api.getivy.de/api/service/counterparty/create",
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([
'financialAddress' => [
],
'accountHolderId' => '<string>',
'name' => '<string>',
'entityType' => 'business',
'isSelfOwned' => false,
'dateOfBirth' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$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://api.getivy.de/api/service/counterparty/create"
payload := strings.NewReader("{\n \"financialAddress\": {},\n \"accountHolderId\": \"<string>\",\n \"name\": \"<string>\",\n \"entityType\": \"business\",\n \"isSelfOwned\": false,\n \"dateOfBirth\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
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://api.getivy.de/api/service/counterparty/create")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"financialAddress\": {},\n \"accountHolderId\": \"<string>\",\n \"name\": \"<string>\",\n \"entityType\": \"business\",\n \"isSelfOwned\": false,\n \"dateOfBirth\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/counterparty/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"financialAddress\": {},\n \"accountHolderId\": \"<string>\",\n \"name\": \"<string>\",\n \"entityType\": \"business\",\n \"isSelfOwned\": false,\n \"dateOfBirth\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "pending",
"id": "<string>",
"accountHolderId": "<string>",
"name": "<string>",
"entityType": "business",
"isSelfOwned": true,
"blocked": true,
"financialAddress": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
},
"aba": {
"accountHolderName": "<string>",
"routingNumber": "<string>",
"accountNumber": "<string>"
},
"bic": {
"accountHolderName": "<string>",
"accountNumber": "<string>",
"bic": "<string>",
"localBankCode": "<string>"
},
"sortCode": {
"accountHolderName": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>"
},
"bankCode": {
"accountHolderName": "<string>",
"code": "<string>",
"accountNumber": "<string>"
},
"bban": {
"accountHolderName": "<string>",
"bban": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>",
"blockchain": "BTC"
}
},
"physicalAddress": {
"city": "<string>",
"countryCode": "DE",
"line1": "<string>",
"line2": "<string>",
"postalCode": "<string>",
"state": "<string>"
},
"dateOfBirth": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Headers
Body
application/json
Response
200 - application/json
The created counterparty
Was this page helpful?