Skip to main content

Transaction Manager

Handles all transaction processing, including deposits, withdrawals, and transfers.

Base URL: https://api.ledgerlink.ai/v1

Transaction Operations​

List Transactions​

GET /transactions

Query Parameters:

  • limit (integer, optional): Results per page
  • offset (integer, optional): Results to skip
  • search (string, optional): Search transactions
  • status (array, optional): Filter by status
  • type (array, optional): Filter by transaction type
  • sortBy (string, optional): Sort field
  • sortDirection (string, optional): Sort direction

Response:

{
  "data": [
    {
      "id": "uuid",
      "type": "DEPOSIT",
      "status": "PENDING",
      "amount": "1000.00",
      "currency": "USD",
      "fromParticipant": "Sender Bank",
      "toParticipant": "Receiver Bank",
      "createdAt": "2025-06-17T10:00:00Z",
      "updatedAt": "2025-06-17T10:00:00Z"
    }
  ],
  "pageInfo": {
    "limit": 20,
    "offset": 0,
    "total": 100
  }
}

Get Transaction Details​

GET /transactions/{transactionId}

Add Additional Request to Transaction​

POST /transactions/additional-request/{transactionId}

Get Transaction by Hash​

GET /transactions/hash/{transactionHash}

Deposits​

Create Deposit Request​

POST /deposit

Request Body:

{
  "amount": "1000.00",
  "currency": "USD",
  "participantBankId": "bank-uuid",
  "reference": "DEP-2025-001",
  "description": "Initial deposit"
}

Response:

{
  "data": {
    "id": "uuid",
    "reference": "DEP-2025-001",
    "amount": "1000.00",
    "currency": "USD",
    "status": "PENDING",
    "wireInstructions": {
      "accountNumber": "1234567890",
      "routingNumber": "021000021",
      "bankName": "Trust Bank Corp",
      "reference": "DEP-2025-001"
    }
  }
}

Get Pending Deposit​

GET /deposit/{reference}

Update Deposit Status​

PUT /deposit/{reference}

Update Deposit Details​

PUT /deposit/{transactionId}/update

Withdrawals​

Create Withdrawal Request​

POST /withdrawal

Request Body:

{
  "amount": "500.00",
  "currency": "USD",
  "participantBankId": "bank-uuid",
  "destinationAccount": {
    "accountNumber": "9876543210",
    "routingNumber": "021000021",
    "bankName": "Destination Bank"
  },
  "description": "Withdrawal request"
}

Update Withdrawal Status​

PUT /withdrawal/{transactionId}

Update Withdrawal Details​

PUT /withdrawal/{transactionId}/update

Transfers​

Create Transfer Request​

POST /transfer

Request Body:

{
  "amount": "250.00",
  "currency": "USD",
  "fromParticipantBankId": "from-bank-uuid",
  "toParticipantBankId": "to-bank-uuid",
  "description": "Transfer between participants",
  "reference": "TXN-2025-001"
}

Execute Multiple Transfers​

POST /transfer/execute-many-send-payment

Cancel Transfer​

POST /transfer/cancel

Update Transfer Status​

PUT /transfer/{transactionId}

Review Transfer​

PUT /transfer/{transactionId}/review

Digital Obligation Deposits​

Get Pending DO Deposit​

GET /do-deposit/{reference}

Update DO Deposit Status​

PUT /do-deposit/{reference}

Management Endpoints​

Create Deposit Request (Internal)​

POST /management/deposit