Create a fiat provider withdrawal request

post

https://your-protect-instance.example.com/api/rest/v1/requests/fiat_provider/withdrawal

This endpoint creates a fiat provider withdrawal request.
Required role: RequestCreator.
This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestID attribute

Body Params

amount

string

required

numeric; Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places)

fromAccountID

string

required

The ID of the fiat provider account from which the funds will be withdrawn. This is the Taurus-PROTECT Account ID.

toAddressID

string

The ID of the internal address that the withdrawal will be sent to, if applicable (ex. Circle USDC). Depending on the provider, this address might be whitelisted as a recipient address on the provider.

toAccountID

string

The ID of the fiat provider account that the withdrawal will be sent to, if applicable (ex. Cubnet).

comment

string

externalRequestID

string

Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestID will do nothing and return the originally created request. The excternalRequestID is passed to fiat providers as an idempotency key.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.