Sign in
ledger-transfer

Performs crypto transfer

This operation allow the client to perform crypto transfer to an external wallet.

N.B. The amount field is the withdrawal amount only (fees are not included). The applicable fee, including any platform fee, is computed server-side and is not a client-supplied input.

post/ledger/crypto-transfer

Request body

sourceAccountIdstring uuid required

The source account ID from which funds will be debited. This can be a main account or sub-account.

amountnumber required

Transaction amount, specified in the source account's currency.

narrationstring

Notes

twoFaMethod'AUTHENTICATOR_APP' | 'EMAIL' | 'SMS'

Example request

{
  "destination": {
    "tokenNetworkCode": "BUSD_BSC",
    "address": "0x7BCc5bCBa19DE3C903F062D8fB5fF8d9f818173E",
    "memo": "405070"
  }
}

Response

Request received, do 2FA

idstring required
status'PENDING' | 'IN_PROGRESS' | 'FAILED' | 'SUCCESS' required

Status of the transaction, indicating its current state in the processing lifecycle.

  • PENDING: The transaction has been created but not yet processed.
  • IN_PROGRESS: The transaction is currently being processed.
  • FAILED: The transaction processing has failed.
  • SUCCESS: The transaction has been successfully processed.
awaiting2fAboolean required

Indicates if transfer is awaiting 2FA confirmation. This applies mostly to transaction initiated via dashboard

twoFaMethodUser2FAMethod[]

List of 2fa enabled

Example response

{
  "id": "P12005E1DV"
}

Changes

Changed in 2 of the 6 revisions of this API.3

  • 29661adc1ffc1See the full diff
    • ○

      added the new optional request property twoFaMethod

      new-optional-request-property

  • a3c4e27426152See the full diff
    • ○

      the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog