POST/transactions/{userId}/stablecoin/withdraw/preview

Preview Stablecoin Payment

Previews a stablecoin withdrawal payment without executing it.

Path variables

FieldTypeRequiredPossible valuesDescription
userIdstringRequired

Unique user ID initiating the stablecoin withdrawal.

Headers

FieldTypeRequiredPossible valuesDescription
session-tokenstringRequired

SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

FieldTypeRequiredPossible valuesDescription
AmountstringRequired

Stablecoin amount to withdraw.

InstrumentIdstringRequired

Stablecoin instrument ID.

DescriptionstringRequired

Description for the withdrawal.

Example request

{
  "Amount": "100.00",
  "InstrumentId": "{{instrumentId}}",
  "Description": "Test stablecoin withdraw preview"
}

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503

API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).

ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity

Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.

ResponseDataobjectPlease refer to below example for response body

Stablecoin withdrawal preview details.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Amount": "100.00",
    "Currency": "USD",
    "Description": "Test stablecoin withdraw preview",
    "Fees": 25,
    "From": "John Doe",
    "To": "0xa0b8****...****b481",
    "TotalAmount": "100.00"
  }
}

Use Perform Stablecoin Payment to execute after previewing.

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose