Transfers funds from a user's SubWallet to an EUSD wallet address.

The transfer uses the crypto payout endpoint. If both the source and destination wallet addresses are internal to LedgerBlock, an internal transfer is initiated.

Request

Method: POST

Endpoint:

{{base_url}}/api/v1/payout/wallet-crypto

Authentication & Headers

HeaderTypeRequiredDescription
AuthorizationStringYesBearer <token> — your activated authentication token.
x-merchant-refStringYesYour unique merchant reference.
Content-TypeStringYesMust be set to application/json.

Example Request

curl --location -g '{{base_url}}/api/v1/payout/wallet-crypto' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-merchant-ref: MERCHANT-REF-001' \
--data '{
  "user_ref": "USER-REF-001",
  "currency": "EUSD:MOB",
  "chain": "MOB",
  "wallet_type": "SUB_WALLET",
  "txn_merchant_ref": "EUSD-TXN-001",
  "amount": 1,
  "to_wallet_address": "EUSD-WALLET-ADDRESS",
  "notification_url": "https://example.com/webhook"
}'

Request Body

{
  "user_ref": "USER-REF-001",
  "currency": "EUSD:MOB",
  "chain": "MOB",
  "wallet_type": "SUB_WALLET",
  "txn_merchant_ref": "EUSD-TXN-001",
  "amount": 1,
  "to_wallet_address": "EUSD-WALLET-ADDRESS",
  "notification_url": "https://example.com/webhook"
}

Request Fields

FieldTypeRequiredDescription
user_refStringYesUnique reference identifying the user whose SubWallet will be debited.
currencyStringYesCurrency to be transferred. For EUSD payouts, use EUSD:MOB.
chainStringYesNetwork on which the EUSD transfer is processed. For EUSD, use MOB.
wallet_typeStringYesSpecifies the source wallet. For SubWallet payouts, use SUB_WALLET.
txn_merchant_refStringYesUnique merchant reference for the payout transaction.
amountNumberYesAmount of EUSD to transfer.
to_wallet_addressStringYesDestination EUSD wallet address.
notification_urlStringNoURL where LedgerBlock can send transaction status notifications.

Transfer Behavior

LedgerBlock determines how the transfer is processed based on the source and destination wallet addresses:

  • External Transfer: If the destination wallet is external to LedgerBlock, the transfer is processed as an external crypto transfer.
  • Internal Transfer: If both the source and destination wallet addresses are internal to LedgerBlock, an internal transfer is initiated.

Transfer Flow

User SubWallet → EUSD → Provide Destination Wallet Address → Authorize Transaction → Transfer Processing → EUSD Wallet Credited

For an internal LedgerBlock transfer:

SubWallet → Internal EUSD Wallet → Internal Transfer

For an external transfer:

SubWallet → External EUSD Wallet → External Transfer


Did this page help you?