Move money between two legal entities of one multi-entity group: a book transfer between their accounts recorded with its purpose; both must be members of an active group whose policy lets the initiator act, and the paying account's approval policy applies
POST
/transfers/inter-entityHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
amountintegerRequiredMinor units of the currency (cents for USD)
currency_codestringRequiredISO 4217 code
descriptionstringRequiredfrom_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
initiated_bystringOptionalThe member entity acting; the paying entity by default
purposestringRequiredLoan, repayment, capital, dividend, management_fee, settlement or other
requested_bystringRequiredto_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
Returns
200 OK
amountintegerRequiredbook_transfer_idstringRequiredExample acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredcurrency_codestringRequireddescriptionstringRequiredfrom_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
from_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
group_idstringRequiredidstringRequiredinitiated_bystringRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
purposestringRequiredrequested_bystringRequiredstatusstringRequiredto_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
to_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503