Skip to main content

FUNDS TRANSFER

This API allows users to transfer (add/move) funds between mapped trading products within their trading account.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

📑 Request Body Parameters

FieldTypeRequiredDescriptionExample
moveFromProductIDstringYesSource Product ID from which funds will be transferred"1"
moveToProductIDstringYesDestination Product ID to which funds will be transferred"2"
transferAmountstringYesAmount to be transferred"10000"

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Funds transferred successfully"
dataobjectFunds transfer response detailsRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
ResponseStringstringTransfer status/response message returned by the system"Funds transferred successfully"

📝 Notes

  • Allows transfer of available funds between mapped trading products.
  • moveFromProductID specifies the source product.
  • moveToProductID specifies the destination product.
  • Transfer is allowed only between products configured through the Funds Transfer Mapped Product API.