Get credit line details

Provides overall credit line details, including status, available limit, and outstanding balance.

GET /v1/credit

Get credit line details

cURL

curl --request GET \
  --url https://api-sandbox.circle.com/v1/credit \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-sandbox.circle.com/v1/credit"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.circle.com/v1/credit', 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-sandbox.circle.com/v1/credit",
  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: Bearer <token>"
  ],
]);

$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-sandbox.circle.com/v1/credit"

	req, _ := http.NewRequest("GET", 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))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.circle.com/v1/credit")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/credit")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

Line of Credit

{
  "data": {
    "id": "b3d9d2d5-4c12-4946-a09d-953e82fae2b0",
    "product": "lineOfCredit",
    "status": "active",
    "limit": {
      "amount": "1000000.00",
      "currency": "USD"
    },
    "used": {
      "amount": "250000.00",
      "currency": "USD"
    },
    "available": {
      "amount": "750000.00",
      "currency": "USD"
    },
    "outstandingTransfers": 2,
    "feeRates": {
      "recurringFee": "0.0003"
    },
    "unpaidFees": {
      "amount": "150.00",
      "currency": "USD"
    },
    "minBalance": {
      "amount": "100000.00",
      "currency": "USD"
    },
    "feeCadence": "daily",
    "validationErrors": [],
    "createDate": "2024-01-15T10:30:00.000Z",
    "updateDate": "2024-03-20T14:22:00.000Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Successfully retrieved credit line details.

data · object

Credit line details including status, available limit, and outstanding balance.

Show child attributes