Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

List Balance Transfers

Copy
Copied
curl https://finix.sandbox-payments-api.com/balance_transfers/ \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99

Example Response:

Copy
Copied
{
  "_embedded" : {
    "balance_transfers" : [ {
      "id" : "BT_9ekAWwwRmYRiV3qsJu4LdP",
      "created_at" : "2022-10-07T18:31:29.68Z",
      "updated_at" : "2022-10-07T18:31:30.04Z",
      "amount" : 4000,
      "currency" : "USD",
      "description" : "Need to increase buffer given the high number of NSFs on merchant fee debits",
      "destination" : "FOR_BENEFIT_OF_ACCOUNT",
      "external_reference_id" : "83990053209359998",
      "processor_type" : "LITLE_V1",
      "reference_id" : "FNXmLWbZnC6WShhTmFm8rHt1Z",
      "source" : "OPERATING_ACCOUNT",
      "state" : "SUCCEEDED",
      "tags" : {
        "example" : "documentation tag"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/balance_transfers/BT_9ekAWwwRmYRiV3qsJu4LdP"
        }
      }
    }, {
      "id" : "BT_gzV3mfapk4Xbm5AQikePdH",
      "created_at" : "2022-09-27T20:46:42.62Z",
      "updated_at" : "2022-09-27T20:46:43.27Z",
      "amount" : 22725,
      "currency" : "USD",
      "description" : "Test Balance Transfer",
      "destination" : "FOR_BENEFIT_OF_ACCOUNT",
      "external_reference_id" : "83989991725547757",
      "processor_type" : "LITLE_V1",
      "reference_id" : "FNXb2NDL7b7eukZj4uqQ7UAnC",
      "source" : "OPERATING_ACCOUNT",
      "state" : "SUCCEEDED",
      "tags" : null,
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/balance_transfers/BT_gzV3mfapk4Xbm5AQikePdH"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/balance_transfers/?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/balance_transfers/?offset=20&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "last" : {
      "href" : "https://finix.sandbox-payments-api.com/balance_transfers/?offset=1280&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1283
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/balance_transfers