Esquemas
Un esquema, en el contexto del libro mayor, es simplemente otro registro que puede ser creado utilizando la API.
El registro del esquema define un conjunto de reglas y restricciones que se usarán para validar el registro al cual se le aplica el esquema.
Consulta Acerca de los Esquemas para obtener más información.
Intents
transfer
Se usa para todas las operaciones que cambian los saldos de dos billeteras, por ejemplo, una transferencia de tipo SEND o SOLICITAR.
| Nombre del campo | Descripción | Tipo |
|---|---|---|
| schema* | Conjunto de reglas para validar la intención | Cadena: 'transfer' |
| action* | Tipo de intención | enum: ['transfer'] |
| amount* | Cantidad de fondos a retirar | Entero |
| source* | Para un SEND, el origen es el nombre de tu billetera de dominio, ejemplo: kamin.one. Para un REQUEST, el origen es el usuario final, ejemplo: tel:573XXXXXXX@transfiya | Cadena |
| symbol* | La moneda que se va a usar | enum: ['cop'] |
| target* | Para un SEND, el destino es el usuario final, ejemplo: tel:573XXXXXXX@transfiya. Para un REQUEST, el destino es el nombre de tu billetera de dominio, ejemplo: kamin.one | Cadena |
| custom.description | Descripción de la transferencia | Cadena (255) |
| custom.transactionPurpose | Se usa solo para intenciones de tipo ONBOARDING | enum: ['ONBOARDING'] |
| labels.acceptSms | Esta etiqueta debe usarse solo para intenciones de tipo REQUEST. Permite al remitente personalizar el mensaje SMS que leerá el usuario final al recibir la transferencia | Cadena (150) |
withdraw
Se utiliza para retirar fondos del sistema, es decir, cuando los fondos se transfieren desde la billetera a una cuenta bancaria.
| Nombre del campo | Descripción | Tipo |
|---|---|---|
| schema* | Conjunto de reglas para validar la intención | Cadena: 'withdraw' |
| action* | Tipo de intención | enum: ['transfer'] |
| amount* | Cantidad de fondos a retirar | Entero |
| source* | Nombre de tu billetera de dominio, ejemplo: kamin.one | Cadena |
| symbol* | La moneda que se va a usar | enum: ['cop'] |
| target* | Cuenta bancaria a la que se enviará el dinero | enum: ['bancolombia-clients', 'bbva-clients', 'bogota-clients'] |
Historial de cambios
- Agregado• Versión inicial