Sign in
Transfer requests

Ask the account's owners to approve a transfer

File a transfer for an acting seat on the paying account to authorize.

This is the path for a seat that may not move money itself: nothing is sent until an owner approves by signing the transfer.

post/api/v1/transfer_requests

Headers

Idempotency-Keystring nullable
x-api-keystring nullable

Request body

contactIdstring uuid nullable
quoteIdstring nullable
invoiceIdstring uuid nullable
amountnumber nullable
memostring nullable
accountIdstring uuid nullable

Response

Successful Response

idstring uuid nullable
status'requested' | 'approved' | 'declined' | 'failed'

Client-facing status of a transfer_request proposal.

The record is a proposal (seven statuses); this is the short vocabulary the API keeps for the agent and the web app, mapped from ProposalStatus by :meth:from_proposal.

txHashstring nullable
transactionIdstring nullable
accountIdstring uuid nullable
appIdstring uuid nullable
requestedByUserIdstring uuid nullable
contactIdstring uuid nullable
quoteIdstring nullable
invoiceIdstring uuid nullable
amountnumber nullable
memostring nullable
requestedTimestring date-time nullable
chatIdstring uuid nullable
approvalUrlstring nullable

Changes