v1

latestOpenAPI 3.0.02026-07-247150151.6 KB
Transfer

Create a Transfer

Create a new transfer.

post/transfers

Request body

origination_account_idstring required
destination_account_idstring required
descriptionstring
amountinteger required

Transfer amount as an integer amount in cents "$10.00" is 1000. Only currency in USD is supported.

Example request

{
  "origination_account_id": "6f0e7dcb-6073-42df-bf02-ce71bd5fac3b",
  "destination_account_id": "225641a5-f6e4-4ae1-b5e0-326e6b98842e",
  "description": "PAYROLL",
  "amount": 100000
}

Response

OK

transfer_idstring
transaction_idstring
created_timestring required

System defined based on the date this transfer was created

updated_timestring required

System defined based on any updates that were made to this transfer

settled_timestring required

System defined based on the date this transfer settles.

origination_account_idstring required

account_id for the origination Account

destination_account_idstring required

account_id for the destination Account

descriptionstring

Description for what the transfer is about, for ACH this is the memo field.

amountinteger required

Amount in cents

status'submitted'

Example response

{
  "transfer_id": "f46e97f2-a582-4918-8992-fb10da9573d9",
  "transaction_id": "7e7205c6-82c9-4789-adef-c07104025b39",
  "created_time": "2022-08-24T14:15:22Z",
  "updated_time": "2022-08-24T14:18:22Z",
  "settled_time": "2022-08-25T12:15:23Z",
  "origination_account_id": "6f0e7dcb-6073-42df-bf02-ce71bd5fac3b",
  "destination_account_id": "225641a5-f6e4-4ae1-b5e0-326e6b98842e",
  "description": "PAYROLL",
  "amount": 1000
}