Skip to main content
POST
Create an account transfer

Authorizations

Authorization
string
header
required

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

Headers

X-Sca-Challenge-Id
string<uuid>

The challengeId returned by POST /v1/accounts/passkeys/challenges. Required for end users under EEA/FR legal entities (PSD2 SCA). Omit for all other end users.

Example:

"b2c3d4e5-f6a7-8901-bc23-def456789012"

X-Sca-Assertion
string

The signed assertion string returned by the DAA web SDK's sca.approve method. Required for end users under EEA/FR legal entities (PSD2 SCA). Pass the value through unchanged — do not base64-encode or re-serialize it.

X-Device-Authorization
string

Compact ES256 JWS that the Digital Asset Accounts SDK creates on the end user's device. It signs this request's method, path, and exact body bytes with the authorization key the end user registered. The SDK creates a new value for every call. To retry a request, resend the original body and header unchanged when you can. Operations where a retry with a new header returns 409 (error code 420034) explain in that response how to find the original request.

Required when the request acts on a non-custodial account (custodyType self), and not used for other accounts. A missing value on a non-custodial request returns 400 (error code 420031). A value that isn't a well-formed compact JWS returns 401 (error code 420031) on any account.

The SDK gives each value an expiry at most 5 minutes after it signs it. Circle rejects a value whose expiry has passed or whose signing time is in the future, allowing 60 seconds of clock difference either way, with 400 (error code 420031). A device clock that's off by more than 60 seconds causes the same error. Retry within the value's lifetime, or let the SDK sign the request again.

Your backend relay must forward this header, and the request body, exactly as the SDK sent them. Don't parse, reformat, or re-serialize the body. If the bytes change, Circle rejects the request.

Compact ES256 JWS created by the Digital Asset Accounts SDK on the end user's device.

Required string length: 64 - 8192
Example:

"eyJhbGciOiJFUzI1NiJ9.e30.AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0-Pw"

Body

application/json
idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

destination
object
required

The destination of a transfer. Can be a verified blockchain address or another account.

amount
object
required
riskSignals
object
required

Risk metadata for the end user initiating the request. All three fields must be present.

deviceId must be the identifier returned by checkDevice() in the @circle-fin/device-checks SDK. Circle resolves it against the device check that produced it, so an identifier you generate yourself does not resolve. When it does not resolve, the request is accepted and then declined: the endpoint returns 201, and the transaction later settles as failed with errorCode transfer_denied. See Collect device risk signals.

source
object

The source of the transfer. The type must be account.

Response

Successfully created a transfer.

data
object

A transfer of funds returned by the create transfer endpoint.