Create a Transaction using JSON
curl --request POST \
--url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {},
"pending": true,
"send": {
"asset": "BRL",
"distribute": {
"remaining": "<string>",
"to": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": true,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
]
},
"source": {
"from": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": true,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
],
"remaining": "remaining"
},
"value": "1000"
},
"chartOfAccountsGroupName": "FUNDING",
"code": "TR12345",
"description": "New Transaction",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"transactionDate": "2021-01-01T00:00:00Z"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json"
payload := strings.NewReader("{\n \"metadata\": {},\n \"pending\": true,\n \"send\": {\n \"asset\": \"BRL\",\n \"distribute\": {\n \"remaining\": \"<string>\",\n \"to\": [\n {\n \"chartOfAccounts\": \"1000\",\n \"metadata\": {},\n \"accountAlias\": \"@person1\",\n \"amount\": {\n \"asset\": \"BRL\",\n \"value\": \"1000\"\n },\n \"balanceKey\": \"asset-freeze\",\n \"description\": \"description\",\n \"isFrom\": true,\n \"remaining\": \"remaining\",\n \"route\": \"00000000-0000-0000-0000-000000000000\",\n \"routeId\": \"00000000-0000-0000-0000-000000000000\",\n \"share\": {\n \"percentage\": 123,\n \"percentageOfPercentage\": 123\n }\n }\n ]\n },\n \"source\": {\n \"from\": [\n {\n \"chartOfAccounts\": \"1000\",\n \"metadata\": {},\n \"accountAlias\": \"@person1\",\n \"amount\": {\n \"asset\": \"BRL\",\n \"value\": \"1000\"\n },\n \"balanceKey\": \"asset-freeze\",\n \"description\": \"description\",\n \"isFrom\": true,\n \"remaining\": \"remaining\",\n \"route\": \"00000000-0000-0000-0000-000000000000\",\n \"routeId\": \"00000000-0000-0000-0000-000000000000\",\n \"share\": {\n \"percentage\": 123,\n \"percentageOfPercentage\": 123\n }\n }\n ],\n \"remaining\": \"remaining\"\n },\n \"value\": \"1000\"\n },\n \"chartOfAccountsGroupName\": \"FUNDING\",\n \"code\": \"TR12345\",\n \"description\": \"New Transaction\",\n \"route\": \"00000000-0000-0000-0000-000000000000\",\n \"routeId\": \"00000000-0000-0000-0000-000000000000\",\n \"transactionDate\": \"2021-01-01T00:00:00Z\"\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))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {},
pending: true,
send: {
asset: 'BRL',
distribute: {
remaining: '<string>',
to: [
{
chartOfAccounts: '1000',
metadata: {},
accountAlias: '@person1',
amount: {asset: 'BRL', value: '1000'},
balanceKey: 'asset-freeze',
description: 'description',
isFrom: true,
remaining: 'remaining',
route: '00000000-0000-0000-0000-000000000000',
routeId: '00000000-0000-0000-0000-000000000000',
share: {percentage: 123, percentageOfPercentage: 123}
}
]
},
source: {
from: [
{
chartOfAccounts: '1000',
metadata: {},
accountAlias: '@person1',
amount: {asset: 'BRL', value: '1000'},
balanceKey: 'asset-freeze',
description: 'description',
isFrom: true,
remaining: 'remaining',
route: '00000000-0000-0000-0000-000000000000',
routeId: '00000000-0000-0000-0000-000000000000',
share: {percentage: 123, percentageOfPercentage: 123}
}
],
remaining: 'remaining'
},
value: '1000'
},
chartOfAccountsGroupName: 'FUNDING',
code: 'TR12345',
description: 'New Transaction',
route: '00000000-0000-0000-0000-000000000000',
routeId: '00000000-0000-0000-0000-000000000000',
transactionDate: '2021-01-01T00:00:00Z'
})
};
fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json"
payload = {
"metadata": {},
"pending": True,
"send": {
"asset": "BRL",
"distribute": {
"remaining": "<string>",
"to": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": True,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
]
},
"source": {
"from": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": True,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
],
"remaining": "remaining"
},
"value": "1000"
},
"chartOfAccountsGroupName": "FUNDING",
"code": "TR12345",
"description": "New Transaction",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"transactionDate": "2021-01-01T00:00:00Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"amount": "1500",
"assetCode": "BRL",
"chartOfAccountsGroupName": "Chart of accounts group name",
"createdAt": "2021-01-01T00:00:00Z",
"deletedAt": "2021-01-01T00:00:00Z",
"description": "Transaction description",
"destination": [
"@person2"
],
"id": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"operations": [
{
"accountAlias": "@person1",
"accountId": "00000000-0000-0000-0000-000000000000",
"amount": {
"value": "1500"
},
"assetCode": "BRL",
"balance": {
"available": "1500",
"onHold": "500",
"overdraftUsed": "130",
"version": 2
},
"balanceAffected": true,
"balanceAfter": {
"available": "1500",
"onHold": "500",
"overdraftUsed": "130",
"version": 2
},
"balanceId": "00000000-0000-0000-0000-000000000000",
"balanceKey": "asset-freeze",
"chartOfAccounts": "1000",
"createdAt": "2021-01-01T00:00:00Z",
"deletedAt": "2021-01-01T00:00:00Z",
"description": "Credit card operation",
"id": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"organizationId": "00000000-0000-0000-0000-000000000000",
"route": "00000000-0000-0000-0000-000000000000",
"status": {
"code": "ACTIVE",
"description": "Active status"
},
"transactionId": "00000000-0000-0000-0000-000000000000",
"type": "DEBIT",
"updatedAt": "2021-01-01T00:00:00Z",
"direction": "debit",
"routeCode": "ROUTE-001",
"routeDescription": "Settlement route for service charges",
"routeId": "00000000-0000-0000-0000-000000000000"
}
],
"organizationId": "00000000-0000-0000-0000-000000000000",
"route": "00000000-0000-0000-0000-000000000000",
"source": [
"@person1"
],
"status": {
"code": "ACTIVE",
"description": "Active status"
},
"updatedAt": "2021-01-01T00:00:00Z",
"groupId": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"parentTransactionId": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000"
}{
"code": "0065",
"message": "<string>",
"title": "Invalid Path Parameter",
"entityType": "Account",
"fields": {}
}{
"code": "0065",
"message": "<string>",
"title": "Invalid Path Parameter",
"entityType": "Account",
"fields": {}
}{
"code": "0065",
"message": "<string>",
"title": "Invalid Path Parameter",
"entityType": "Account",
"fields": {}
}Create a Transaction using JSON
deprecated
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
transactions
/
json
Create a Transaction using JSON
curl --request POST \
--url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {},
"pending": true,
"send": {
"asset": "BRL",
"distribute": {
"remaining": "<string>",
"to": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": true,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
]
},
"source": {
"from": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": true,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
],
"remaining": "remaining"
},
"value": "1000"
},
"chartOfAccountsGroupName": "FUNDING",
"code": "TR12345",
"description": "New Transaction",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"transactionDate": "2021-01-01T00:00:00Z"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json"
payload := strings.NewReader("{\n \"metadata\": {},\n \"pending\": true,\n \"send\": {\n \"asset\": \"BRL\",\n \"distribute\": {\n \"remaining\": \"<string>\",\n \"to\": [\n {\n \"chartOfAccounts\": \"1000\",\n \"metadata\": {},\n \"accountAlias\": \"@person1\",\n \"amount\": {\n \"asset\": \"BRL\",\n \"value\": \"1000\"\n },\n \"balanceKey\": \"asset-freeze\",\n \"description\": \"description\",\n \"isFrom\": true,\n \"remaining\": \"remaining\",\n \"route\": \"00000000-0000-0000-0000-000000000000\",\n \"routeId\": \"00000000-0000-0000-0000-000000000000\",\n \"share\": {\n \"percentage\": 123,\n \"percentageOfPercentage\": 123\n }\n }\n ]\n },\n \"source\": {\n \"from\": [\n {\n \"chartOfAccounts\": \"1000\",\n \"metadata\": {},\n \"accountAlias\": \"@person1\",\n \"amount\": {\n \"asset\": \"BRL\",\n \"value\": \"1000\"\n },\n \"balanceKey\": \"asset-freeze\",\n \"description\": \"description\",\n \"isFrom\": true,\n \"remaining\": \"remaining\",\n \"route\": \"00000000-0000-0000-0000-000000000000\",\n \"routeId\": \"00000000-0000-0000-0000-000000000000\",\n \"share\": {\n \"percentage\": 123,\n \"percentageOfPercentage\": 123\n }\n }\n ],\n \"remaining\": \"remaining\"\n },\n \"value\": \"1000\"\n },\n \"chartOfAccountsGroupName\": \"FUNDING\",\n \"code\": \"TR12345\",\n \"description\": \"New Transaction\",\n \"route\": \"00000000-0000-0000-0000-000000000000\",\n \"routeId\": \"00000000-0000-0000-0000-000000000000\",\n \"transactionDate\": \"2021-01-01T00:00:00Z\"\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))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {},
pending: true,
send: {
asset: 'BRL',
distribute: {
remaining: '<string>',
to: [
{
chartOfAccounts: '1000',
metadata: {},
accountAlias: '@person1',
amount: {asset: 'BRL', value: '1000'},
balanceKey: 'asset-freeze',
description: 'description',
isFrom: true,
remaining: 'remaining',
route: '00000000-0000-0000-0000-000000000000',
routeId: '00000000-0000-0000-0000-000000000000',
share: {percentage: 123, percentageOfPercentage: 123}
}
]
},
source: {
from: [
{
chartOfAccounts: '1000',
metadata: {},
accountAlias: '@person1',
amount: {asset: 'BRL', value: '1000'},
balanceKey: 'asset-freeze',
description: 'description',
isFrom: true,
remaining: 'remaining',
route: '00000000-0000-0000-0000-000000000000',
routeId: '00000000-0000-0000-0000-000000000000',
share: {percentage: 123, percentageOfPercentage: 123}
}
],
remaining: 'remaining'
},
value: '1000'
},
chartOfAccountsGroupName: 'FUNDING',
code: 'TR12345',
description: 'New Transaction',
route: '00000000-0000-0000-0000-000000000000',
routeId: '00000000-0000-0000-0000-000000000000',
transactionDate: '2021-01-01T00:00:00Z'
})
};
fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json"
payload = {
"metadata": {},
"pending": True,
"send": {
"asset": "BRL",
"distribute": {
"remaining": "<string>",
"to": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": True,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
]
},
"source": {
"from": [
{
"chartOfAccounts": "1000",
"metadata": {},
"accountAlias": "@person1",
"amount": {
"asset": "BRL",
"value": "1000"
},
"balanceKey": "asset-freeze",
"description": "description",
"isFrom": True,
"remaining": "remaining",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"share": {
"percentage": 123,
"percentageOfPercentage": 123
}
}
],
"remaining": "remaining"
},
"value": "1000"
},
"chartOfAccountsGroupName": "FUNDING",
"code": "TR12345",
"description": "New Transaction",
"route": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000",
"transactionDate": "2021-01-01T00:00:00Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"amount": "1500",
"assetCode": "BRL",
"chartOfAccountsGroupName": "Chart of accounts group name",
"createdAt": "2021-01-01T00:00:00Z",
"deletedAt": "2021-01-01T00:00:00Z",
"description": "Transaction description",
"destination": [
"@person2"
],
"id": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"operations": [
{
"accountAlias": "@person1",
"accountId": "00000000-0000-0000-0000-000000000000",
"amount": {
"value": "1500"
},
"assetCode": "BRL",
"balance": {
"available": "1500",
"onHold": "500",
"overdraftUsed": "130",
"version": 2
},
"balanceAffected": true,
"balanceAfter": {
"available": "1500",
"onHold": "500",
"overdraftUsed": "130",
"version": 2
},
"balanceId": "00000000-0000-0000-0000-000000000000",
"balanceKey": "asset-freeze",
"chartOfAccounts": "1000",
"createdAt": "2021-01-01T00:00:00Z",
"deletedAt": "2021-01-01T00:00:00Z",
"description": "Credit card operation",
"id": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"organizationId": "00000000-0000-0000-0000-000000000000",
"route": "00000000-0000-0000-0000-000000000000",
"status": {
"code": "ACTIVE",
"description": "Active status"
},
"transactionId": "00000000-0000-0000-0000-000000000000",
"type": "DEBIT",
"updatedAt": "2021-01-01T00:00:00Z",
"direction": "debit",
"routeCode": "ROUTE-001",
"routeDescription": "Settlement route for service charges",
"routeId": "00000000-0000-0000-0000-000000000000"
}
],
"organizationId": "00000000-0000-0000-0000-000000000000",
"route": "00000000-0000-0000-0000-000000000000",
"source": [
"@person1"
],
"status": {
"code": "ACTIVE",
"description": "Active status"
},
"updatedAt": "2021-01-01T00:00:00Z",
"groupId": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"parentTransactionId": "00000000-0000-0000-0000-000000000000",
"routeId": "00000000-0000-0000-0000-000000000000"
}{
"code": "0065",
"message": "<string>",
"title": "Invalid Path Parameter",
"entityType": "Account",
"fields": {}
}{
"code": "0065",
"message": "<string>",
"title": "Invalid Path Parameter",
"entityType": "Account",
"fields": {}
}{
"code": "0065",
"message": "<string>",
"title": "Invalid Path Parameter",
"entityType": "Account",
"fields": {}
}Authorizations
JWT bearer token issued by the identity provider.
Headers
Idempotency key to safely retry the create; an identical retry returns the original transaction, a different request under the same key answers 409 (0084)
Idempotency slot TTL in seconds (default 300)
Path Parameters
Organization ID (UUID)
Ledger ID (UUID)
Body
application/json
Show child attributes
Show child attributes
Example:
true
Show child attributes
Show child attributes
Maximum string length:
256Example:
"FUNDING"
Maximum string length:
100Example:
"TR12345"
Maximum string length:
256Example:
"New Transaction"
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"2021-01-01T00:00:00Z"
Response
Created
Example:
"1500"
Required string length:
2 - 10Example:
"BRL"
Maximum string length:
256Example:
"Chart of accounts group name"
Example:
"2021-01-01T00:00:00Z"
Example:
"2021-01-01T00:00:00Z"
Maximum string length:
256Example:
"Transaction description"
Example:
["@person2"]
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"00000000-0000-0000-0000-000000000000"
Show child attributes
Show child attributes
Example:
"00000000-0000-0000-0000-000000000000"
Maximum string length:
250Example:
"00000000-0000-0000-0000-000000000000"
Example:
["@person1"]
Show child attributes
Show child attributes
Example:
"2021-01-01T00:00:00Z"
Example:
"00000000-0000-0000-0000-000000000000"
Show child attributes
Show child attributes
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"00000000-0000-0000-0000-000000000000"
Was this page helpful?