Formularios

Esta es la forma de conocer los campos necesarios para realizar un retiro a un determinado país (nota: tenga en cuenta que estos campos pueden variar en algún momento)

Get Withdrawal Rules

GET api.vitawallet.io/api/businesses/withdrawal_rules

Este método permite obtener el formulario con los campos necesarios para realizar un retiro a un país determinado.

200: OK Request OK

{
     "rules": {
         "cl": {
             "fields": [
                {
                    "type": "select",
                    "name": "Tipo de beneficiario",
                    "key": "beneficiary_type",
                    "options": [
                        {
                           "label": "Individual",
                           "value": "Individual"
                        },
                        {
                           "label": "Corporativo",
                           "value": "Corporate"
                        }
                    ]
                },
                {
                    "type": "text",
                    "name": "Nombres",
                    "key": "beneficiary_first_name",
                    "max": 50,
                    "when": {
                         "key": "beneficiary_type",
                         "value": "Individual"
                    }
                },
                {
                    "type": "text",
                    "name": "Apellidos",
                    "key": "beneficiary_last_name",
                    "max": 50,
                    "when": {
                         "key": "beneficiary_type",
                         "value": "Individual"
                    }
                },
                {
                    "type": "email",
                    "name": "Correo",
                    "key": "beneficiary_email",
                    "max": 50
                },
                {
                    "type": "text",
                    "name": "Número de cuenta",
                    "key": "account_bank",
                    "min": 5,
                    "max": 18
                },
             ],
             "name": "Chile",
             "currency_iso_code": "CLP",
             "currency_name": "Peso chileno",
             "flag_url": "https://api.vitawallet.io/mailers/flags/CL.png"
         }
     }
}

Descripción

Un formulario esta compuesto por algunas claves con significado.

Clave	Descripción
type	Define el tipo de campo, pudiendo ser text (texto), select (selección de opción), email (correo).
name	Nombre del campo
key	Clave de campo que debe enviarse en el cuerpo del request del retiro.
options	Opciones del campo cuando el tipo de campo es select, algunas de estas opciones estan condicionadas a los valores de otros campos, en el siguiente ejemplo, podrá observar como el Banco Sofitasa, está disponible cuando el campo transfer_type tiene valores "Pago movil" y "Transferencia bancaria" { "label": "Banco Sofitasa", "value": 32, "visible": { "key":"transfer_type", "value":["Pago movil","Transferencia bancaria"] } }
min	Cantidad mínima de caracteres que debe contener el campo
max	Cantidad máxima de caracteres que debe contener el campo
when	Validación de presencia del campo en el formulario. { "key": "beneficiarytype", "value": "Individual" } El campo será requerido solo cuando el campo con key "beneficiary_type" contiene el valor "Individual"

Advertencia Tenga en cuenta que los campos de un formulario pueden cambiar, recomendamos crear su aplicativo teniendo en cuenta esta información.

SDK

Node

Puede hacer uso del método getWithdrawalRules del proveedor de reglas, para conocer los formularios de un retiro para un determinado país.

import Business from 'vita-business-node';

try {
    await Business.rulesProvider.getWithdrawalRules();
} catch {}