Skip to content

Transfer Funds

Request

Transfer funds from one account to another. Additionally, can auto-create a premium distribution if a Funding_Key of 0 is sent.

Security
apiKeyAuth and bearerAuth
Path
fundingKeyinteger, (int32)required

Funding Key

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
payor_IDstring or null
account_Keyinteger or null, (int32)
issue_Amountnumber or null, (double)
issue_Typestring or null
issue_IDstring or null
issue_Namestring or null
issue_Datestring or null, (date-time)
received_Datestring or null, (date-time)
funding_Typestring or null
transfer_Funding_Typestring or null
transfer_Payor_IDstring or null
transfer_Account_Keyinteger or null, (int32)
create_Checkboolean
expense_Typestring or null
payee_IDstring or null
user_IDstring or null
curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/funding/{fundingKey}/transfer' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "payor_ID": "string",
    "account_Key": 0,
    "issue_Amount": 0.1,
    "issue_Type": "string",
    "issue_ID": "string",
    "issue_Name": "string",
    "issue_Date": "2019-08-24T14:15:22Z",
    "received_Date": "2019-08-24T14:15:22Z",
    "funding_Type": "string",
    "transfer_Funding_Type": "string",
    "transfer_Payor_ID": "string",
    "transfer_Account_Key": 0,
    "create_Check": true,
    "expense_Type": "string",
    "payee_ID": "string",
    "user_ID": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{ "data": { … }, "error": { … }, "debug": { … } }