Deprecated API Reference

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

Create a Balance Transfer

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 \
    -d '
	{
	    "amount": 4000,
	    "currency": "USD",
	    "description": "Need to increase buffer given the high number of NSFs on merchant fee debits",
	    "destination": "FOR_BENEFIT_OF_ACCOUNT",
	    "processor_type": "LITLE_V1",
	    "source": "OPERATING_ACCOUNT",
	    "tags": {
	        "example": "documentation tag"
	    }
	}'

Example Response:

Copy

Copied

{
  "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"
    }
  }
}

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