List custodial balances

GET

/v1/balances

package main

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

func main() {

  url := "https://api.feitpay.com/v1/balances"

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

  req.Header.Add("Gryphem-Environment", "test")
  req.Header.Add("Authorization", "Bearer <token>")

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

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

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.feitpay.com/v1/balances';
const options = {
  method: 'GET',
  headers: {'Gryphem-Environment': 'test', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.feitpay.com/v1/balances \
  --header 'Authorization: Bearer <token>' \
  --header 'Gryphem-Environment: test'

Funds received through the platform’s Bitcart account and owed to the organization, per asset. available excludes amounts held for payouts that were not sent yet. API keys restricted to one store cannot read organization balances.

Authorizations

ApiKey
Session

Parameters

Header Parameters

Gryphem-Organization

string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Gryphem-Environment

string

default: test

Allowed values: test live

test (default) or live for dashboard sessions. API keys determine the environment.

Responses

200

Balances per asset.

application/json

object

object

required

string

Allowed value: list

data

required

Array<object>

object

object

required

string

Allowed value: balance

asset

required

string

livemode

required

boolean

divisibility

required

integer

available

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

available_units

required

Integer amount in the asset’s smallest unit.

string

/^[0-9]+$/

pending_payouts

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

pending_payouts_units

required

Integer amount in the asset’s smallest unit.

string

/^[0-9]+$/

total_received

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

total_received_units

required

Integer amount in the asset’s smallest unit.

string

/^[0-9]+$/

custodial

required

boolean

has_more

required

boolean

next_cursor

required

string | null

processor_active

required

Live payments are processed through the platform Bitcart account.

boolean

payouts_active

required

Withdrawals are enabled on the platform.

boolean

Example

{
  "object": "list",
  "data": [
    {
      "object": "balance",
      "available": "59.90",
      "available_units": "99834",
      "pending_payouts": "59.90",
      "pending_payouts_units": "99834",
      "total_received": "59.90",
      "total_received_units": "99834",
      "custodial": true
    }
  ]
}

401

Missing or invalid credentials.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer