Get payments
Retrieve all payments for the authenticated user's organization.
query Parameters
start_dateStart date for filtering payments (ISO 8601 format)
end_dateEnd date for filtering payments (ISO 8601 format)
pagePage number for pagination (1-based)
limitNumber of items per page (default: 20)
Get payments › Responses
Successfully retrieved team payments
Create payment
Create a payment. Returns the created payment details.
Create payment › Request Body
Caller's stated intent for the payment.
organization_reference_idOptional external reference ID for tracking.
funding_account_idFunding account ID. Optional at POST to support the two-step PATCH creation flow; required together with desired.from.account_id and desired.to.account_id once any of the three is supplied.
Create payment › Responses
Payment created successfully
Update payment
Update a payment with accounts.
path Parameters
paymentIdUnique identifier of the payment to update
Update payment › Request Body
funding_account_idFunding account ID for the payment.
Account-only update to the payment's desired overlay (two-step PATCH flow).
organization_reference_idOptional external reference ID for tracking.
Update payment › Responses
Payment updated successfully
Submit risk review
Manually review and approve or reject a payment requiring risk review.
path Parameters
paymentIdUnique identifier of the payment to review
Submit risk review › Request Body
is_approvedApprove (true) or reject (false) the payment.
Submit risk review › Responses
Payment review completed successfully
Sign payment step
Submit a signature for a self-custodial payment step. Webhook updates will be sent as the signature is validated and submitted onchain.
path Parameters
paymentIdUnique identifier of the payment
stepIdUnique identifier of the payment step to sign
Sign payment step › Request Body
signatureBase64-encoded JSON envelope { body, stamp } where body is the JSON-encoded Turnkey ACTIVITY_TYPE_SIGN_TRANSACTION_V2 activity and stamp is the X-Stamp header value produced by stamping that body. Wire format: base64(JSON.stringify({ body, stamp })).
Sign payment step › Responses
Signature submitted successfully