Create a Balance Transfer

Copy
Copied
curl https://finix.sandbox-payments-api.com/balance_transfers/ \
    -H "Content-Type: application/vnd.json+api" \
    -u  USbkjk46XqUTQHN3i2jaVnc1:ac915962-2757-49ea-aeee-10960a408b99 \
    -d '
	{
	    "description": "Need to increase buffer given the high number of NSFs on merchant fee debits",
	    "tags": {
	        "example": "documentation tag"
	    },
	    "destination": "FOR_BENEFIT_OF_ACCOUNT",
	    "currency": "USD",
	    "amount": 4000,
	    "source": "OPERATING_ACCOUNT",
	    "processor_type": "LITLE_V1"
	}'

Example Response:

Copy
Copied
{
  "id" : "BT_v3KQqgpDPqskH8VH6isFyz",
  "created_at" : "2022-01-27T07:44:12.26Z",
  "updated_at" : "2022-01-27T07:44:13.18Z",
  "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" : "83988259008501532",
  "processor_type" : "LITLE_V1",
  "reference_id" : "FNX79EMBoateYXXePoYzCfsUi",
  "source" : "OPERATING_ACCOUNT",
  "state" : "SUCCEEDED",
  "tags" : {
    "example" : "documentation tag"
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/balance_transfers/BT_v3KQqgpDPqskH8VH6isFyz"
    }
  }
}

HTTP Request

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

Request Arguments

Field Type Description
amount integer, required The total amount that will be moved, in cents
currency string, required 3-letter ISO code designating the currency of the Balance Transfer
description string, required Reason for balance transfer
destination string, required FOR_BENEFIT_OF_ACCOUNT, OPERATING_ACCOUNT
processor_type string, required LITLE_V1
source string, required FOR_BENEFIT_OF_ACCOUNT,OPERATING_ACCOUNT
tags object, optional Key value pair for annotating custom metadata

Response Arguments

Field Type Description
id string, required id of the Balance Transfer
created_at string, required Timestamp of when the Balance Transfer was created
updated_at string, required Timestamp of when the Balance Transfer was last updated
amount integer, required The total amount that will be moved, in cents
currency string, required 3-letter ISO code designating the currency of the Balance Transfer
description string, required Descriptive reason for Balance Transfer money movement
destination string, required FOR_BENEFIT_OF_ACCOUNT, OPERATING_ACCOUNT
external_reference_id string, optional id generated by partner and returned to Finix
processor_type string, required LITLE_V1
reference_id string, required id generated by finix and sent to partner
source string, required FOR_BENEFIT_OF_ACCOUNT,OPERATING_ACCOUNT
state string, required CREATED, SUBMITTING, SUBMITTED, SUCCEEDED, FAILED, RETURNED, UKNOWN
tags object, optional Key value pair for annotating custom metadata