Create a counterparty
curl --request POST \
--url https://api.ledger.so/v1/counterparties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerId": "<string>",
"currency": "<string>",
"accountOwnerName": "<string>",
"accountOwnerType": "<string>",
"bankName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessName": "<string>",
"account": "<string>",
"iban": "<string>",
"clabe": "<string>",
"pixKey": "<string>",
"brCode": "<string>",
"address": {},
"details": {}
}
'import requests
url = "https://api.ledger.so/v1/counterparties"
payload = {
"customerId": "<string>",
"currency": "<string>",
"accountOwnerName": "<string>",
"accountOwnerType": "<string>",
"bankName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessName": "<string>",
"account": "<string>",
"iban": "<string>",
"clabe": "<string>",
"pixKey": "<string>",
"brCode": "<string>",
"address": {},
"details": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerId: '<string>',
currency: '<string>',
accountOwnerName: '<string>',
accountOwnerType: '<string>',
bankName: '<string>',
accountName: '<string>',
firstName: '<string>',
lastName: '<string>',
businessName: '<string>',
account: '<string>',
iban: '<string>',
clabe: '<string>',
pixKey: '<string>',
brCode: '<string>',
address: {},
details: {}
})
};
fetch('https://api.ledger.so/v1/counterparties', 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.ledger.so/v1/counterparties",
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([
'customerId' => '<string>',
'currency' => '<string>',
'accountOwnerName' => '<string>',
'accountOwnerType' => '<string>',
'bankName' => '<string>',
'accountName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'businessName' => '<string>',
'account' => '<string>',
'iban' => '<string>',
'clabe' => '<string>',
'pixKey' => '<string>',
'brCode' => '<string>',
'address' => [
],
'details' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.ledger.so/v1/counterparties"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"currency\": \"<string>\",\n \"accountOwnerName\": \"<string>\",\n \"accountOwnerType\": \"<string>\",\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"businessName\": \"<string>\",\n \"account\": \"<string>\",\n \"iban\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"brCode\": \"<string>\",\n \"address\": {},\n \"details\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.ledger.so/v1/counterparties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"currency\": \"<string>\",\n \"accountOwnerName\": \"<string>\",\n \"accountOwnerType\": \"<string>\",\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"businessName\": \"<string>\",\n \"account\": \"<string>\",\n \"iban\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"brCode\": \"<string>\",\n \"address\": {},\n \"details\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ledger.so/v1/counterparties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"<string>\",\n \"currency\": \"<string>\",\n \"accountOwnerName\": \"<string>\",\n \"accountOwnerType\": \"<string>\",\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"businessName\": \"<string>\",\n \"account\": \"<string>\",\n \"iban\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"brCode\": \"<string>\",\n \"address\": {},\n \"details\": {}\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"id": "<string>",
"customerId": "<string>",
"currency": "<string>",
"status": "<string>",
"accountOwnerName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"bankName": "<string>",
"accountName": "<string>",
"accountOwnerType": "<string>",
"last4": "<string>",
"details": {}
}
}{
"ok": false,
"error": {
"code": "INVALID_REQUEST",
"message": "Validation failed"
}
}{
"ok": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"ok": false,
"error": {
"code": "CONFLICT",
"message": "Resource already exists"
}
}{
"ok": false,
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests"
}
}{
"ok": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}Counterparties
Create a counterparty
Creates a new counterparty (external payout account) for a customer.
POST
/
v1
/
counterparties
Create a counterparty
curl --request POST \
--url https://api.ledger.so/v1/counterparties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerId": "<string>",
"currency": "<string>",
"accountOwnerName": "<string>",
"accountOwnerType": "<string>",
"bankName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessName": "<string>",
"account": "<string>",
"iban": "<string>",
"clabe": "<string>",
"pixKey": "<string>",
"brCode": "<string>",
"address": {},
"details": {}
}
'import requests
url = "https://api.ledger.so/v1/counterparties"
payload = {
"customerId": "<string>",
"currency": "<string>",
"accountOwnerName": "<string>",
"accountOwnerType": "<string>",
"bankName": "<string>",
"accountName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"businessName": "<string>",
"account": "<string>",
"iban": "<string>",
"clabe": "<string>",
"pixKey": "<string>",
"brCode": "<string>",
"address": {},
"details": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerId: '<string>',
currency: '<string>',
accountOwnerName: '<string>',
accountOwnerType: '<string>',
bankName: '<string>',
accountName: '<string>',
firstName: '<string>',
lastName: '<string>',
businessName: '<string>',
account: '<string>',
iban: '<string>',
clabe: '<string>',
pixKey: '<string>',
brCode: '<string>',
address: {},
details: {}
})
};
fetch('https://api.ledger.so/v1/counterparties', 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.ledger.so/v1/counterparties",
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([
'customerId' => '<string>',
'currency' => '<string>',
'accountOwnerName' => '<string>',
'accountOwnerType' => '<string>',
'bankName' => '<string>',
'accountName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'businessName' => '<string>',
'account' => '<string>',
'iban' => '<string>',
'clabe' => '<string>',
'pixKey' => '<string>',
'brCode' => '<string>',
'address' => [
],
'details' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.ledger.so/v1/counterparties"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"currency\": \"<string>\",\n \"accountOwnerName\": \"<string>\",\n \"accountOwnerType\": \"<string>\",\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"businessName\": \"<string>\",\n \"account\": \"<string>\",\n \"iban\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"brCode\": \"<string>\",\n \"address\": {},\n \"details\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.ledger.so/v1/counterparties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"currency\": \"<string>\",\n \"accountOwnerName\": \"<string>\",\n \"accountOwnerType\": \"<string>\",\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"businessName\": \"<string>\",\n \"account\": \"<string>\",\n \"iban\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"brCode\": \"<string>\",\n \"address\": {},\n \"details\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ledger.so/v1/counterparties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"<string>\",\n \"currency\": \"<string>\",\n \"accountOwnerName\": \"<string>\",\n \"accountOwnerType\": \"<string>\",\n \"bankName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"businessName\": \"<string>\",\n \"account\": \"<string>\",\n \"iban\": \"<string>\",\n \"clabe\": \"<string>\",\n \"pixKey\": \"<string>\",\n \"brCode\": \"<string>\",\n \"address\": {},\n \"details\": {}\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"id": "<string>",
"customerId": "<string>",
"currency": "<string>",
"status": "<string>",
"accountOwnerName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"bankName": "<string>",
"accountName": "<string>",
"accountOwnerType": "<string>",
"last4": "<string>",
"details": {}
}
}{
"ok": false,
"error": {
"code": "INVALID_REQUEST",
"message": "Validation failed"
}
}{
"ok": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"ok": false,
"error": {
"code": "CONFLICT",
"message": "Resource already exists"
}
}{
"ok": false,
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests"
}
}{
"ok": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}Authorizations
BearerAuthApiKeyAuth
Pass your API key as a Bearer token: Authorization: Bearer ld_live_...
Body
application/json
The customer ID
Currency code (e.g. "usd", "eur", "mxn")
Type of external account
Available options:
us_bank, iban, clabe, pix, gb_bank, mobile_money, ghipss, nip, swift Name of the account owner
Type of account owner (e.g. "individual", "business")
Name of the bank
Friendly name for the account
Account owner's first name
Account owner's last name
Business name (for business accounts)
Account number (for us_bank, gb_bank, etc.)
IBAN (for iban account type)
CLABE number (for clabe account type)
PIX key (for pix account type)
BR code (for pix account type)
Address of the account owner
Additional account-type-specific details
⌘I