Get bank transaction - Light API documentation

GET

/

v1

/

bank-accounts

/

{bankAccountId}

/

bank-transactions

/

{bankTransactionId}

Get bank transaction

curl --request GET \
  --url https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}', 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.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}"

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

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "amount": 123,
  "name": "<string>",
  "memo": "<string>",
  "reference": "<string>",
  "transactionId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

bankAccountId

string<uuid>

required

bankTransactionId

string<uuid>

required

Response

default - application/json;charset=UTF-8

default response

id

string<uuid>

Unique identifier for the bank transaction

bankAccountId

string<uuid>

ID of the bank account this transaction belongs to

date

string<date>

Transaction date

amount

integer<int64>

Transaction amount in minor units (e.g. cents)

dcSign

enum<string>

Debit/credit sign

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

D,

C

reconciliationStatus

enum<string>

Reconciliation status

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

EXCLUDED,

MATCHED,

UNMATCHED

name

string | null

Transaction name / payee

memo

string | null

Transaction memo / description

reference

string | null

Transaction reference

transactionId

string | null

External transaction identifier for idempotency

createdAt

string<date-time>

Timestamp when the transaction was created

⌘I

Get bank transaction

curl --request GET \
  --url https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}', 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.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}"

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

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/bank-accounts/{bankAccountId}/bank-transactions/{bankTransactionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "amount": 123,
  "name": "<string>",
  "memo": "<string>",
  "reference": "<string>",
  "transactionId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}