Withdraw cash

Create a cash withdrawal request, currently documented for Efecty.

This contract is based on legacy Cobru materials for Efecty withdrawals. Validate the provider name, callback behavior, and final error contract in sandbox before relying on it in production.

Endpoint

POST /cashwithdraw/

Request fields

FieldTypeRequiredNotes
methodstringyesBest-known provider selector. Legacy materials document efecty.
documentstringyesRecipient document number.
amountnumberyesRequested payout amount.
exp_daysnumberyesDays until the withdrawal expires.
namestringyesRecipient full name shown in the payout request.
couponstringnoOptional coupon or promo code when supported.
callbackstringnoOptional callback URL for result updates.
estimatebooleannoWhen true, may request an estimate rather than a live withdrawal.

Example body

{
  "amount": 10000,
  "document": "213232323",
  "estimate": false,
  "exp_days": 30,
  "method": "efecty",
  "name": "Testeo efecty"
}

Example response

{
  "status": "ok",
  "document": "213232323",
  "ref": 123456,
  "amount": 9700
}

Callback behavior

Legacy materials show a callback field on creation and list records. Treat callback delivery as an optional operational integration until Cobru confirms:

  • retry behavior
  • signature or verification model
  • terminal states that trigger callbacks

Error signals seen in older materials

ResponseMeaning
400 {"error":"not enough balance"}The sender balance is insufficient.
200 {"error":"BAD_USER"}User validation failed.
200 {"error":"EXPIRED"}Coupon or promotional benefit expired.
200 {"error":"ALL_USED"}Coupon or benefit already exhausted.
200 {"error":"NOT_FOUND"}Referenced coupon or object was not found.
400 {"message":"unknown method"}Unsupported withdrawal provider or method value.

Production notes

  • Reconcile the net amount returned by Cobru, not only the requested amount, because fees may affect the final payout amount.
  • Do not assume every created withdrawal is immediately claimable; build for asynchronous provider behavior.
  • If you expose cancellation, store Cobru's reference identifiers at creation time.

On this page