Skip to main content


Put Funds on Hold

Put a hold on funds in the wallet. Sandbox only.

This action transfers funds from the available balance to the on-hold balance. If the wallet does not have enough funds in the available balance in the specified currency, the transfer fails.

This method triggers the Transfer Funds Between Balances webhook. This webhook contains the same information as the response.

The customer cannot move funds that are on hold until the client releases the hold.

This method is relevant for person and company wallets.

    • amount

    • Amount of the transfer. Decimal.

    • currency

    • Three-letter ISO 4217 code for the currency used in the amount field.

    • ewallet

    • ID of the wallet associated with the contact. String starting with ewallet_.

  • /v1/account/balance/hold

  • Put Funds on Hold

  • curl -X post
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
      "ewallet": "ewallet_4f8009d08b7b41e5d3b356494101d83b",
      "amount": 22,
      "currency": "USD"
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "5dd7c271-c859-4060-9fad-f94b55ca1e42"
        "data": {
            "id": "5f521c70-a1ae-45ec-9dcf-26cb810767ef",
            "source_transaction_id": "8e1fc8d9-4765-48a9-9a99-1d4309d08709",
            "destination_transaction_id": "394e249f-e6ae-4b5a-8745-127ab572d4fa",
            "source_user_profile_id": "4b791777-4c06-11ea-833c-02e199f7f6f5",
            "destination_user_profile_id": "4b791777-4c06-11ea-833c-02e199f7f6f5",
            "source_account_id": "f8a849ea-4c0a-11ea-833c-02e199f7f6f5",
            "destination_account_id": "f8a849ea-4c0a-11ea-833c-02e199f7f6f5",
            "source_balance_type": "available_balance",
            "destination_balance_type": "on_hold_balance",
            "currency_code": "USD",
            "amount": 22