How to transfer funds

Transfer funds between accounts

Funds can be transferred between accounts if the accounts can be accessed by the same user or the sending account is whitelisted to deposit to the receiving account and the user has full-control or manage level access to the sending account. If the receiving account is not controlled by the same user then the receiving account must whitelist the receiving account via account transfer authorizations.

For the sake of this guide it will be assumed that the user has access to both accounts. Funds can then be as transferred using account-cash-transfers as seen below. Based on the account-policy the transfer will settle instantly or will need to be reviewed via account-cash-transfer-reviews. Once an account-cash-transfer settles corresponding cash transactions will be created for both accounts.

Request

POST v2/account-cash-transfers?include=from-account-cash-totals,to-account-cash-totals
{
"data" : {
"type" : "account-cash-transfers",
"attributes" : {
"amount" : "100",
"from-account-id" : "{{account-id}}",
"to-account-id" : "{{account-id-2}}"
}
}
}

Response

{
"data": {
"type": "account-cash-transfers",
"id": "80ab5f75-cbce-4cca-8d3a-41aa022d1c9a",
"attributes": {
"amount": 100,
"created-at": "2019-12-03T19:54:48Z",
"currency-type": "USD",
"reference": null,
"status": "settled",
"updated-at": "2019-12-03T19:54:48Z",
"reversal-details": null
},
"links": {
"self": "/v2/account-cash-transfers/80ab5f75-cbce-4cca-8d3a-41aa022d1c9a"
},
"relationships": {
"from-account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"from-account-cash-totals": {
"data": [
{
"type": "account-cash-totals",
"id": "a9a90c79-cf69-ff1c-a3f5-d6cfcab18169"
}
]
},
"from-cash-transaction": {
"links": {
"related": "/v2/cash-transactions/b718b654-e516-43af-a754-86e80bee7b15"
}
},
"from-reversed-cash-transaction": {
"data": null
},
"to-account": {
"links": {
"related": "/v2/accounts/df4277d8-cd12-4c5c-94c6-c25cff6cec7f"
}
},
"to-account-cash-totals": {
"data": [
{
"type": "account-cash-totals",
"id": "a301ba53-ac47-23db-f95b-a0dede9d1eda"
}
]
},
"to-cash-transaction": {
"links": {
"related": "/v2/cash-transactions/3178d17f-483c-4c7f-b9a7-0afa5c2d3f6d"
}
},
"to-reversed-cash-transaction": {
"data": null
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
}
}
},
"included": [
{
"type": "account-cash-totals",
"id": "a9a90c79-cf69-ff1c-a3f5-d6cfcab18169",
"attributes": {
"contingent-hold": 0,
"currency-type": "USD",
"disbursable": 50200,
"pending-transfer": 0,
"settled": 50200,
"updated-at": "2019-12-03T19:54:48Z"
},
"links": {
"self": "/v2/account-cash-totals/a9a90c79-cf69-ff1c-a3f5-d6cfcab18169"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
}
}
},
{
"type": "account-cash-totals",
"id": "a301ba53-ac47-23db-f95b-a0dede9d1eda",
"attributes": {
"contingent-hold": 0,
"currency-type": "USD",
"disbursable": 300,
"pending-transfer": 0,
"settled": 300,
"updated-at": "2019-12-03T19:54:48Z"
},
"links": {
"self": "/v2/account-cash-totals/a301ba53-ac47-23db-f95b-a0dede9d1eda"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/df4277d8-cd12-4c5c-94c6-c25cff6cec7f"
}
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
}
}
}
]
}

See also

  • Account Cash Transfers

  • Account Transfer Authorizations

  • Account Cash Transfer Reviews

  • Account Cash Totals

  • Cash Transactions

  • Sandbox

Last updated on