Skip to main content
POST
/
api
/
action
/
account
/
withdraw
Withdraw funds
curl --request POST \
  --url https://sandbox.soleaspay.com/api/action/account/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'operation: <operation>' \
  --header 'service: <service>' \
  --data '
{
  "wallet": "677347922",
  "amount": 250,
  "currency": "XAF"
}
'
{
  "success": true,
  "code": 201,
  "status": "PROCESSING",
  "created_at": "2024-12-16 10:05:01",
  "data": {
    "reference": "MLS109P",
    "external_reference": "withdraw reference",
    "transaction_reference": "partner transaction reference",
    "amount": 1000,
    "currency": "XAF",
    "operation": "WITHDRAW"
  },
  "message": "withdraw saved to queue"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
operation
integer
required

Operation type (must be 4 for withdrawal)

Example:

4

​
service
integer
required

The service through which the customer will receive funds

Example:

1

Body

application/json
​
wallet
string
required
Example:

"677347922"

​
amount
number<float>
required
Example:

250

​
currency
string

Optional. Currency for the transaction (e.g. XAF, CAD)

Example:

"XAF"

Response

Withdrawal request accepted and queued

​
success
boolean
Example:

true

​
code
integer
Example:

201

​
status
string
Example:

"PROCESSING"

​
created_at
string<date-time>
Example:

"2024-12-16 10:05:01"

​
data
object
​
message
string
Example:

"withdraw saved to queue"