SOsoldo
Wallets

Make Internal Transfer

Changed on

Endpoint to transfer money between two Wallets within the same business account.

put/business/v2/wallets/internalTransfer/{fromWalletId}/{toWalletId}

Request

Path parameters

fromWalletIdstring required

The ID of the source Wallet, from which the amount is withdrawn. It must belong to the same business account as the destination Wallet.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7
toWalletIdstring required

The ID of the destination Wallet, to which the amount is credited. It must belong to the same business account as the source Wallet.

Example:2d65bd5e-3fdf-4002-b166-bde7fb8863fa

Headers

X-Soldo-Fingerprintstring required

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

Example:{{fingerprint}}
X-Soldo-Fingerprint-Signaturestring required

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Example:{{fingerprint_signature}}

Request body application/x-www-form-urlencoded

amountnumber required

The amount to move from the source Wallet to the destination Wallet. It must be greater than zero and have at most 2 decimal places. The source Wallet must have an available amount large enough to cover it.

currencyCode'EUR' | 'GBP' | 'USD' required

The ISO 4217 code of the currency of the Statement to search for.

notesstring

Free-text notes describing the reason of the transfer. They are stored as the notes of the resulting Transactions on both the source and the destination Wallets.

Example request

{
  "amount": 10.25,
  "currencyCode": "EUR",
  "notes": "Monthly top-up for travel expenses"
}

Response

The result is a TransferResult.

amountnumber

The amount moved from the source Wallet to the destination Wallet, as specified in the request.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
datetimestring

The date and time at which the InternalTransfer has been completed.

Example response

{
  "amount": 10.25,
  "datetime": "2017-06-01T12:48:40Z",
  "from_wallet": {
    "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "name": "CompanyWallet1",
    "available_amount": 100,
    "primary_user_type": "company",
    "primary_user_public_id": "XMPL1234-000001",
    "custom_reference_id": "123456-usa-1",
    "group_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "groups": [
      "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
    ],
    "label": "CompanyWallet1",
    "visible": true,
    "creation_time": "2017-06-01T12:48:40Z",
    "last_update": "2017-06-01T12:48:40Z",
    "deposit_account_info": [
      "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
    ],
    "description": "CompanyWallet1"
  },
  "to_wallet": {
    "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "name": "CompanyWallet1",
    "available_amount": 100,
    "primary_user_type": "company",
    "primary_user_public_id": "XMPL1234-000001",
    "custom_reference_id": "123456-usa-1",
    "group_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "groups": [
      "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
    ],
    "label": "CompanyWallet1",
    "visible": true,
    "creation_time": "2017-06-01T12:48:40Z",
    "last_update": "2017-06-01T12:48:40Z",
    "deposit_account_info": [
      "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
    ],
    "description": "CompanyWallet1"
  }
}

Changes

  • 23fc5d07b367Revision changes
    • info

      added the new optional request property

  • 5470d4c0eb01Revision changes
    • warning

      added the new ACCOUNT_NUMBER enum value to the /// response property for the response status

    • warning

      added the new ACCOUNT_NUMBER enum value to the /// response property for the response status