Método para ejecutar un retiro de dinero. Es necesario especificar la moneda, el contacto y la cantidad a retirar.

Request

Los siguientes atributos son necesarios para el body de la petición:

FieldTypeValue
currencyIdstringIdentificador de la moneda a transferir
quantitystringCantidad a retirar (sin considerar comisión de retiro)
contactIdstringIdentificador del contacto a transferir
contactReferencestringReferencia del contacto a transferir

🏷️

ContactId y contactReference

Para identificar el contacto a transferir damos dos opciones, usar el contactId o el contactReference. Es necesario especificar sólo uno de estos dos atributos, si se incluyen ambos el método retornara error con status 400.

Para agregar un reference a un contacto en particular revisar el detalle del método aquí

💸

Quantity y comisión de retiro

Es importante considerar que la cantidad (quantity) a transferir es exactamente lo que recibirá el destinatario, es decir, este monto no considera la comisión de retiro. Para los retiros que tienen comisión, como los del tipo EXTERNAL_CRYPTO, esta se descontará a parte del monto especificado en quantity.

Response

Los siguientes corresponden a los atributos del objeto:

FieldTypeValue
transactionIdstringIdentificador de la transacción
typestringTipo de transacción, en este caso siempre "WITHDRAWAL"
subTypestringTipo de retiro, puede ser "EXTERNAL_CRYPTO", "EXTERNAL_FIAT_BANK", "INTERNAL" o "EXTERNAL_FIAT_REDPAY"
currencyIdstringIdentificador de la moneda a transferir
quantitystringMonto transferido
feestringComisión de retiro
totalstringTotal gastado (monto transferido + comisión de retiro)
statusstringEstado de la transferencia, puede ser "IN_PROGRESS", "PENDING", "COMPLETED", "FAILED"
createdAtDatetime ISO8601Fecha de ejecución del retiro
withdrawalDataObjectDepende del tipo de retiro

  • withdrawalData para contacto tipo EXTERNAL_CRYPTO:
FieldTypeValue
contactIdstringIdentificador del contacto
contactAliasstringAlias del contacto
destinationAddressstringDirección de destino de la transferencia
transactionHashstringHash de la transacción en blockchain
assetIdstringidentificador del asset
  • withdrawalData para contacto tipo EXTERNAL_FIAT_BANK:
FieldTypeValue
contactIdstringIdentificador del contacto
contactAliasstringAlias del contacto
  • withdrawalData para contacto tipo INTERNAL:
FieldTypeValue
contactIdstringIdentificador del contacto
contactAliasstringAlias del contacto
  • withdrawalData para contacto tipo EXTERNAL_FIAT_REDPAY:
FieldTypeValue
destinationstringNombre del comercio
detailstringDetalle del pago


Language
Credentials
Header