Public API - Deposits

Cancel a pending deposit

Cancels a deposit that is in PENDING status (status = 0). Returns an error if the deposit is already SUCCESS, FAILED, EXPIRED, or REFUNDED. If the deposit was already paid but not yet confirmed, the balance will be refunded.

put/v1/public/deposits/cancel/{id}

Request

  • Base URL: https://api.sms-virtual.net
  • URL: https://api.sms-virtual.net/v1/public/deposits/cancel/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Deposit UUID from POST /v1/public/deposits/request

Response

Deposit cancelled successfully. Status changed to FAILED (2).

Changes

No recorded changes to this operation across all 1 revision of this API.