Create a Transaction without passing to distribution

POST /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/outflow

Create a Transaction without passing to distribution

cURL

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/outflow \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "pending": true,
  "send": {
    "asset": "BRL",
    "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": "WITHDRAWAL",
  "code": "TR12345",
  "description": "New Outflow Transaction",
  "route": "00000000-0000-0000-0000-000000000000",
  "routeId": "00000000-0000-0000-0000-000000000000",
  "transactionDate": "2021-01-01T00:00:00Z"
}
'

201

{
  "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"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency · string

Idempotency key to safely retry the create; an identical retry returns the original transaction, a different request under the same key answers 409 (0084)

X-TTL · string

Idempotency slot TTL in seconds (default 300)

Parâmetros de caminho

organization_id · string · obrigatório

Organization ID (UUID)

ledger_id · string · obrigatório

Ledger ID (UUID)

Corpo

application/json

metadata · object · obrigatório

Show child attributes

pending · boolean · padrão: false · obrigatório

Exemplo:

true

send · object · obrigatório

Show child attributes

chartOfAccountsGroupName · string

Maximum string length: 256

Exemplo:

"WITHDRAWAL"

code · string

Maximum string length: 100

Exemplo:

"TR12345"

description · string

Maximum string length: 256

Exemplo:

"New Outflow Transaction"

route · string

Exemplo:

"00000000-0000-0000-0000-000000000000"

routeId · string<uuid>

Exemplo:

"00000000-0000-0000-0000-000000000000"

transactionDate · string<date-time>

Exemplo:

"2021-01-01T00:00:00Z"

Resposta

201

application/json

Created

amount · string | null · obrigatório

Exemplo:

"1500"

assetCode · string · obrigatório

Required string length: 2 - 10

Exemplo:

"BRL"

chartOfAccountsGroupName · string · obrigatório

Maximum string length: 256

Exemplo:

"Chart of accounts group name"

createdAt · string<date-time> · obrigatório

Exemplo:

"2021-01-01T00:00:00Z"

deletedAt · string<date-time> | null · obrigatório

Exemplo:

"2021-01-01T00:00:00Z"

description · string · obrigatório

Maximum string length: 256

Exemplo:

"Transaction description"

destination · string[] | null · obrigatório

Exemplo:

["@person2"]

id · string<uuid> · obrigatório

Exemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId · string<uuid> · obrigatório

Exemplo:

"00000000-0000-0000-0000-000000000000"

operations · object[] | null · obrigatório

Show child attributes

organizationId · string<uuid> · obrigatório

Exemplo:

"00000000-0000-0000-0000-000000000000"

route · string · obrigatório

Maximum string length: 250

Exemplo:

"00000000-0000-0000-0000-000000000000"

source · string[] | null · obrigatório

Exemplo:

["@person1"]

status · object · obrigatório

Show child attributes

updatedAt · string<date-time> · obrigatório

Exemplo:

"2021-01-01T00:00:00Z"

groupId · string<uuid>

Exemplo:

"00000000-0000-0000-0000-000000000000"

metadata · object

Show child attributes

parentTransactionId · string<uuid>

Exemplo:

"00000000-0000-0000-0000-000000000000"

routeId · string<uuid>

Exemplo:

"00000000-0000-0000-0000-000000000000"