Spanish

Retiros

Esta es la forma de realizar el retiro de dinero a una cuenta bancaria.

Caso de uso

Considere el cliente desea retirar su dinero del e-commerce hacia su cuenta bancaria personal, para tal fin Vita Business provee el servicio de retiro, el cual se descuenta dinero de la wallet del cliente y la envía a la cuenta bancaria.

Tenga en cuenta, que los campos que requiere el endpoint para realizar un retiro a un país, son ahora dinámicos, puedes ver más información en la sección formularios.

Create Withdrawal Transaction

POST api.vitawallet.io/api/businesses/transactions

Este método permite crear una transacción de tipo retiro con el uso de una wallet, el monto sera reflejado de forma negativa en el balance de la wallet.

Request Body

NameTypeDescription

url_notify*

string

Url bajo el protocolo HTTPS, a la cual enviaremos nuestro IPN.

beneficiary_document_type

string

Tipo de documento del beneficiario. Nota: Te facilitamos todos los tipos de documento, dependiendo del país a retirar, visita la sección formularios.

beneficiary_document_number

string

Numero de documento del beneficiario. Para Chile Puedes enviar este campo de las siguientes alternativas: 11.111.111-1 11.111.111-K 11111111K Para el resto SOLO NUMEROS

account_type_bank

string

Tipo de cuenta bancaria. Tipos soportados: País que no sea México CA Cuenta de ahorros CC Cuenta corriente CLABE Solo si es México

Nota: Te facilitamos todos los tipos de cuenta bancaria, dependiendo del país a retirar, visita la sección formularios.

account_bank

string

Numero de cuenta bancaria, solo NÚMEROS, se verifica la cantidad de dígitos dependiendo del banco.

bank_code

string

Código del banco al cual se hará el pago. Nota: Te facilitamos todos códigos de los bancos, dependiendo del país a retirar, visita la sección formularios.

beneficiary_email

string

Correo electrónico del beneficiario.

beneficiary_address

string

Dirección de residencia del beneficiario.

beneficiary_last_name

string

Apellido del beneficiario.

beneficiary_first_name

string

Nombre del beneficiario.

purpose_comentary*

string

Descripción del retiro.

purpose*

string

Código del propósito del retiro.

country*

string

Código ISO del país al cual se hace el retiro. Países soportados: CL Chile CO Colombia MX México VE Venezuela Nota: Te facilitamos todos los países disponibles para retiros, visita la sección formularios.

currency*

string

[clp, usd]

order*

string

Orden de pago único, con el cual se identifica una transacción.

amount*

number

Monto de la operación. Monto mínimo de 1000 CLP

transactions_type*

string

withdrawal

wallet*

string

UUID de la wallet con la que vas a ejecutar una transacción.

city

string

Ciudad del beneficiario. Nota: Te facilitamos todos los campos requeridos por un país, visita la sección formularios.

phone

string

Teléfono del beneficiario.

Nota: Te facilitamos todos los campos requeridos por un país, visita la sección formularios.

{
    "transaction": {
        "id": "27",
        "type": "business_transaction",
        "attributes": {
            "recipient_wallet": null,
            "sender_wallet": {
                "token": "1234567890",
                "uuid": "5cb344ae-7479-4c96-b17c-f469b12a7e8b",
                "balances": {
                    "clp": 884500.0
                },
                "is_master": false,
                "created_at": "2020-01-15T20:37:17.926Z"
            },
            "status": "pending",
            "order": "12345678978945612s3181a014234",
            "currency": "clp",
            "category": "withdrawal",
            "amount": "15000.0",
            "total": "15000.0",
            "fee_value": "0.0",
            "total_fee": "0.0",
            "created_at": "2020-05-01T15:45:56.197Z"
        }
    }
}

Nota:

Por cuestiones de seguridad, no es posible crear más de una transacción en un período de 5 segundos. Se debe tomar en cuenta esta validación para la integración.

Formularios

Los campos que no son requeridos, se deben obtener del método /withdrawal_rules en la sección formularios, ya que pueden variar a lo largo del tiempo.

Formularios

SDK

Para realizar un retiro, el módulo wallets recibe el uuid de la wallet con la cual se desea hacer el retiro mediante el método withdrawal.

import Business from 'vita-business-code';

try {
    // Debe actualizar precios, recuerde que 
    // los precios deben ser actualizados cada cierto
    // tiempo, dependiendo del campo valid_until
    // Para conocer el monto final en el país destino
    
    await Business.wallets(uuid).updatePrices();
} catch {}

try {
    const response = await Business.wallets(uuid).withdrawal({
        url_notify: "https://example.com/notify",
        beneficiary_document_type: "CC",
        beneficiary_document_number: "1487498569",
        account_type_bank: "CA",
        account_bank: "874895988",
        bank_code: "000050",
        beneficiary_email: "example@example.com",
        beneficiary_address: "example address #33-37",
        beneficiary_last_name: "Toledo Parra",
        beneficiary_first_name: "Juan Victor",
        purpose_comentary: "send for friend",
        purpose: "EPTOUR",
        country: "CO",
        currency: "clp",
        order: "order",
        amount: 1000,
    });
} catch {}

Monto mínimo a retirar

El monto mínimo a retirar es de 1000 CLP

AnteriorEnvíos a VitaSiguienteFormularios

Última actualización