Get a users's credit balances - Rain

Get a users's credit balances

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/users/{userId}/balances \
  --header 'Api-Key: <api-key>'

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

fetch('https://api-dev.rain.xyz/v1/issuing/users/{userId}/balances', 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-dev.rain.xyz/v1/issuing/users/{userId}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <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-dev.rain.xyz/v1/issuing/users/{userId}/balances"

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

	req.Header.Add("Api-Key", "<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-dev.rain.xyz/v1/issuing/users/{userId}/balances")

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

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

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

{
  "creditLimit": 123,
  "pendingCharges": 123,
  "postedCharges": 123,
  "balanceDue": 123,
  "spendingPower": 123,
  "spendingPowerWithWallet": 123
}

GET

/

issuing

/

users

/

{userId}

/

balances

Get a users's credit balances

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/users/{userId}/balances \
  --header 'Api-Key: <api-key>'

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

fetch('https://api-dev.rain.xyz/v1/issuing/users/{userId}/balances', 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-dev.rain.xyz/v1/issuing/users/{userId}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <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-dev.rain.xyz/v1/issuing/users/{userId}/balances"

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

	req.Header.Add("Api-Key", "<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-dev.rain.xyz/v1/issuing/users/{userId}/balances")

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

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

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

{
  "creditLimit": 123,
  "pendingCharges": 123,
  "postedCharges": 123,
  "balanceDue": 123,
  "spendingPower": 123,
  "spendingPowerWithWallet": 123
}

Authorizations

Api-Key

string

header

required

Path Parameters

userId

string<uuid>

required

Id of the user to get balances for

Response

Successful operation

creditLimit

integer

required

Credit limit of the user, in cents

pendingCharges

integer

required

Pending charges of the user, in cents

postedCharges

integer

required

Posted charges of the user, in cents

balanceDue

integer

required

Balance due of the user, in cents

spendingPower

integer

required

The amount of money the user can spend, in cents

spendingPowerWithWallet

integer

The user's total spending power including any USDC that can be pulled from their linked on-chain wallet at authorization time, in cents. This equals spendingPower plus the minimum of the user's wallet balance and approved allowance, summed across all supported chains. Only present for tenants using wallet allowance collateral sourcing.