Skip to navigation
Penny BankingAccountsCapital

Transfer between capital accounts

Transfer funds between two capital accounts.

Required permissions: transaction:create.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Idempotency-Keystring or nullOptional1-255 characters

A unique key you generate, such as a UUID, so a retried request is applied only once. Optional but strongly advised. Penny keeps each key for 7 days per business and operation: a retry with the same key and body returns the original result, the same key with a different body returns 422, and a retry while the original request is still processing returns 409. Maximum 255 characters.

Request

This endpoint expects an object.
from_account_idstringRequired
Unique identifier of the source capital account from which funds will be transferred.
to_account_idstringRequired
Unique identifier of the destination capital account to which funds will be transferred.
amountdouble or stringRequired
The amount of funds to transfer between the source and destination capital accounts.
currencyenumOptionalDefaults to USD

Currency of the transfer amount (USD). Must match both accounts’ currency.

Allowed values:
descriptionstring or nullOptional<=256 characters
Optional description of the transfer's purpose or context.
client_referencestring or nullOptional

Your own reference, copied onto both transactions. Use it with GET /transactions/by-client-reference.

Response

The source and destination transactions created by the transfer.
source_transactionobject
The transaction representing the debit from the source capital account.
destination_transactionobject
The transaction representing the credit to the destination capital account.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error