Corgi BankDocumentation
OpenAPI

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-entity

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

descriptionstringRequired
from_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

initiated_bystringOptional

The member entity acting; the paying entity by default

purposestringRequired

Loan, repayment, capital, dividend, management_fee, settlement or other

requested_bystringRequired
to_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Returns

200 OK

amountintegerRequired
book_transfer_idstringRequired

Example acht_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired
currency_codestringRequired
descriptionstringRequired
from_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

from_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

group_idstringRequired
idstringRequired
initiated_bystringRequired
journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

purposestringRequired
requested_bystringRequired
statusstringRequired
to_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

to_customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close