Book Transfer
Book transfer between two routable bank accounts (any entity pairing supported).
Authentication: send the program API key either in the api_key HTTP header or as an api_key JSON body field.
Authorizations
Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.
Body
Monetary amount as a decimal string with two decimal places (for example "100.00"). Must be positive.
"100.00"
Identifier of the source entity. Matches source_entity_type: a user-* id when type is user, a buss-* id when business, or a prog-* id when program.
Type of the source entity.
user, business, program Source routable bank account identifier. Must belong to the source_entity_id.
"rbac-2b1c0e44-4f2d-9a11-7b23-cc90d1ef8f3a"
Identifier of the destination entity. Matches destination_entity_type: a user-* id when type is user, a buss-* id when business, or a prog-* id when program.
Type of the destination entity.
user, business, program Destination routable bank account identifier. Must belong to the destination_entity_id.
"rbac-2b1c0e44-4f2d-9a11-7b23-cc90d1ef8f3a"
Free-form description attached to the resulting transaction.
Client-supplied idempotency token. Submitting the same key twice returns the first response rather than creating a duplicate transaction.
Program API key. Accepted either in the api_key HTTP header or as this body field.
Optional external reference string stored on the resulting transaction.
Arbitrary key/value metadata object attached to the operation.