Cardless Cash Withdrawal

Request Withdrawal Token via SMS

This endpoint is used to request a cardless cash withdrawal token via SMS.

Endpoint

POST https://api2.zipay.id/api/withdrawal/token/sms

Authorization

This endpoint requires authentication using Bearer Token.

Authorization: Bearer {your_token}

Request Body

Field	Type	Required	Description
amount	number	Yes	Amount to be withdrawn
currency	string	Yes	Currency (only IDR is supported)

Example Request

{
  "amount": 50000,
  "currency": "IDR"
}

Response Success

A successful response will return information about the token sent via SMS.

Example Response

{
  "success": true,
  "message": "Withdrawal token delivery accepted",
  "data": {
    "delivery_id": "241a2a89-1f4d-4fa8-8503-6ef658a8fa9b",
    "channel": "sms",
    "masked_destination": "08*******7737",
    "expires_at": "2025-12-21T16:52:38.201Z",
    "retry_after_seconds": 60
  }
}

Response Fields

Field	Type	Description
data	object	Token data that was sent
data.delivery_id	string	Unique ID for token delivery
data.channel	string	Delivery channel (sms)
data.masked_destination	string	Masked destination number for privacy
data.expires_at	string	Token expiration time (ISO 8601 format)
data.retry_after_seconds	number	Time in seconds before retry is allowed
success	boolean	Request success status
message	string	Response message

Error Response

If an error occurs, the response will return detailed error information.

Example Error Response

{
  "success": false,
  "message": "Validation error",
  "errors": [
    {
      "field": "currency",
      "code": "ISIN",
      "message": "Withdrawal token delivery only supports IDR"
    }
  ]
}

Error Fields

Field	Type	Description
success	boolean	Success status (always false)
message	string	General error message
errors	array	Array containing error details

Error Object Fields

Field	Type	Description
field	string	Field that caused the error
code	string	Error code
message	string	Detailed error message