Cancel a pending Transaction (v2)

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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>'}};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "amount": "1500",
  "assetCode": "BRL",
  "createdAt": "2021-01-01T00:00:00Z",
  "credit": [
    "@person2"
  ],
  "debit": [
    "@person1"
  ],
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Transaction description",
  "feesSkipped": false,
  "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",
      "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",
      "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",
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "tracerSkipped": false,
  "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",
  "scheme": "PIX"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

cancel

Cancel a pending Transaction (v2)

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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>'}};

fetch('https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "amount": "1500",
  "assetCode": "BRL",
  "createdAt": "2021-01-01T00:00:00Z",
  "credit": [
    "@person2"
  ],
  "debit": [
    "@person1"
  ],
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Transaction description",
  "feesSkipped": false,
  "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",
      "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",
      "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",
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "tracerSkipped": false,
  "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",
  "scheme": "PIX"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id

string

requerido

Organization ID (UUID)

ledger_id

string

requerido

Ledger ID (UUID)

transaction_id

string

requerido

Transaction ID (UUID)

Respuesta

Created

Option 1
Option 2

amount

string | null

requerido

Ejemplo:

"1500"

assetCode

string

requerido

Required string length: 2 - 10

Ejemplo:

"BRL"

createdAt

string<date-time>

requerido

Ejemplo:

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

credit

string[] | null

requerido

Ejemplo:

["@person2"]

debit

string[] | null

requerido

Ejemplo:

["@person1"]

deletedAt

string<date-time> | null

requerido

Ejemplo:

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

description

string

requerido

Maximum string length: 256

Ejemplo:

"Transaction description"

feesSkipped

boolean

requerido

Ejemplo:

false

string<uuid>

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId

string<uuid>

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

operations

object[] | null

requerido

Show child attributes

organizationId

string<uuid>

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

status

object

requerido

Show child attributes

tracerSkipped

boolean

requerido

Ejemplo:

false

updatedAt

string<date-time>

requerido

Ejemplo:

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

groupId

string<uuid>

Ejemplo:

"00000000-0000-0000-0000-000000000000"

metadata

object

Additional custom attributes. The ledger writes six fee keys on this field itself and reserves them: feeApplied is the string true when the fee engine actually charged this transaction; packageAppliedID is the identifier of the fee package the engine applied, written when that package charged a fee or recorded an exemption (including a package that priced the transaction at zero), and absent when no package applied, which includes a route whose packages all exclude the amount by their bounds, or when the applied package's fees only rounded down to zero; feeExemption is a string holding a JSON object with exempt, reason and message, present when every account on one side of the transaction is exempt from fees, which is how a caller tells an exemption apart from no package having matched; feeExemption is also present, with reason cross_ledger_bridge, when the only account on one side that would have paid a fee is the @external/ bridge closing a part of a cross-ledger group, because that bridge never pays a fee; feeExemption is also present, with reason zero_fee_amount, when the package priced the transaction at zero, for instance a band configured with no fee, so no fee leg was posted and feeApplied is absent; a transaction recorded before v4.1.1 stored feeExemption as that object itself, and a read returns it as the string too; feeDebtOpenings and feeDebtSettlements are strings holding a JSON array, in the order the ledger applied them, of the fee debts this transaction opened because its payer could not fund a deferrable fee (debtId, debtorRef, creditRef, opened, seq) and of the fee debts it settled (debtId, debtorRef, creditRef, amount, opened, seq), each absent when there is none; feeDebtCollection is the string true on a standalone fee-debt collection, whose amount is what it settled and which cannot be reverted. A request body carrying feeApplied, packageAppliedID, feeExemption, feeDebtOpenings, feeDebtSettlements, feeDebtCollection or feeDeferPair is refused with 400 naming the offending key, on every body that carries transaction metadata: a create, a metadata update and a fee estimate. A metadata update, including one that clears the metadata, never changes them. So a value present here is always the ledger's own word about the charge and never one a caller supplied. feeLeg and feeDeferPair, on operation metadata, are reserved the same way. Transaction-level metadata is additive, so caller-supplied keys on this field are preserved alongside the ledger keys.

Show child attributes

parentTransactionId

string<uuid>

Ejemplo:

"00000000-0000-0000-0000-000000000000"

routeId

string<uuid>

Ejemplo:

"00000000-0000-0000-0000-000000000000"

scheme

string

Payment scheme the transaction declared, normalized to upper case; absent when none.

Maximum string length: 50

Ejemplo:

"PIX"

Primeros pasos

Núcleo

CRM

Fees

Manejo de errores

Eventos

Cancel a pending Transaction (v2)

Autorizaciones

Parámetros de ruta

Respuesta