Validate external crypto withdrawal

POST 
/api/withdrawal/validation/crypto-external

Validates withdrawal to an external crypto destination with currency exchange without creating a transaction.

Request

application/json

Body

Bodyrequired

External crypto withdrawal validation payload.

srcWalletIdstringnullable
Src Wallet Id.
Example: USD880390848110
amountnumberrequired
Amount.
Possible values: >= 0
Example: 10.25
actionstringrequired
Action.
Possible values: [GIVE, GET]
Example: GIVE
notestringnullable
Note.
Possible values: <= 255 characters
Example: Sandbox transfer note
destCurrencystringrequired
Dest Currency.
Possible values: [BTC, ETH, SOL, TRX, XRP, TON, LTC, AVAX, BNB, POL, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, USDT_TON, USDC, USDC_ERC20, USDC_BEP20, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Example: USD
address objectrequired
Merchant Crypto Address schema.
addressstringrequired
Address.
Example: test-value
memostringnullable
Memo.
Example: test-value
receiverInfo object
Merchant Receiver Info schema.
firstNamestring
First Name.
Possible values: <= 30 characters
Example: Leo
lastNamestring
Last Name.
Possible values: <= 30 characters
Example: Peo
emailstring
Email.
Possible values: <= 50 characters
Example: [email protected]
dateOfBirthstring
Date Of Birth.
Example: 30/01/1991
companyNamestring
Company Name.
Possible values: >= 3 characters and <= 100 characters
Example: PotterCompany
srcCurrencystringnullable
Src Currency.
Possible values: [USD, EUR, USDT, USDC, BTC, ETH, SOL, TRX, XRP, TON, LTC]
Example: USD

Example

{
  "srcWalletId": "USD880390848110",
  "amount": 10.25,
  "action": "GIVE",
  "note": "Sandbox transfer note",
  "destCurrency": "BTC",
  "address": {
    "address": "TLxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "memo": null
  },
  "receiverInfo": {
    "firstName": "Leo",
    "lastName": "Peo",
    "email": "[email protected]"
  },
  "srcCurrency": "USD"
}

Responses

200

OK

400

Bad request. The request is malformed or contains invalid parameters.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: disabled
errorTypestringrequired
Error category.
Example: FORM
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Unauthorized. Merchant authentication headers are missing or invalid.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: userDoesNotExistException
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Not found. The requested resource does not exist.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: resourceNotFound
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Resource not found
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Internal server error. Unexpected error please contact support

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: internalServerError
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Internal server error
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}