​
Débito al usuario origen

El endpoint de débito se invoca al inicio del procesamiento de una transferencia, con el objetivo de debitar la cuenta del usuario origen. Este endpoint debe garantizar que la cuenta esté activa y sea válida, y debe reservar los fondos necesarios para que la operación pueda ejecutarse.
Los bancos pueden optar por registrar la transacción de forma definitiva o simplemente realizar una reserva de fondos.
En cualquiera de los casos, esta operación debe ser finalizada una vez que la transferencia se haya completado, o bien los fondos deben ser liberados obligatoriamente en caso de que ocurra un error durante el proceso. En Transfiya, una operación de débito se representa como una acción de tipo UPLOAD. Si esta acción se marca como COMPLETED exitosamente, pero más adelante ocurre un error en el procesamiento, Transfiya ejecutará una operación opuesta (de tipo credit) para revertir el movimiento de saldo y restablecer el estado original de la cuenta. Flujo de debito al usuario origen

​
Proceso de débito paso a paso

A continuación, se describe detalladamente el flujo de procesamiento para una transferencia tipo SEND, enfocándonos en la etapa de débito al usuario origen. Este flujo se ejecuta en múltiples etapas, combinando interacciones entre Transfiya y el banco originador, tanto en fases síncronas como asincrónicas. El objetivo principal de este proceso es asegurar que los fondos del usuario origen estén disponibles y sean reservados o debitados correctamente antes de avanzar con el resto de la operación. El flujo también contempla los mecanismos necesarios para revertir movimientos en caso de errores, así como el uso de pruebas criptográficas (IOU) y el cumplimiento de los tiempos regulatorios. Cada paso está alineado con los lineamientos del nuevo modelo SPI (Sistema de Pagos Inmediatos) y busca mantener la compatibilidad con la arquitectura existente de Transfiya. A continuación se detallan las acciones involucradas, junto con ejemplos prácticos y consideraciones técnicas relevantes.
1

Transfiya llama al banco origen para procesar la operación de débito

Transfiya inicia el proceso mediante una solicitud POST al endpoint de débito del banco origen, con la información completa de la transferencia.
POST https://ban.co/transfiya/debit
{
"source": "wXxwpxB32saqfmfMxAQD4SVWWhhn6akLC2",
"target": "wRFmYXS2sP9ho9VCZ3j4FuP1j55ABeFvsF",
"amount": "100.00",
"symbol": "$tin",
"labels": {
    "hash": "PENDING",
    "type": "SENDMOL",
    "domain": "tin",
    "flowId": "Lf13jsK83omPv3bOt",
    "status": "PENDING",
    "tx_ref": "Lf13jsK83omPv3bOt",
    "tx_id": "20250114890915944TFY123456789012345",
    "created": "2025-01-14T20:40:57.322-05:00",
    "updated": "2025-01-14T20:40:57.322-05:00",
    "description": "Payment for lunch",
    "sourceChannel": "APP",
    "deviceFingerPrint": {
    "city": "Bogotá",
    "hash": "26fff5af6441f8e15a71e8d62c361714484b1b308c99e8eb68ca85e2a7e0dc58",
    "model": "Huawei Mate 20 Pro",
    "country": "Colombia",
    "operator": "Bharti Airtel Limited",
    "SIMCardId": "8991101200003204510",
    "ipAddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "mobileDevice": "990000862471854"
    }
},
"snapshot": {
    "source": {
    "signer": {
        "handle": "wXxwpxB32saqfmfMxAQD4SVWWhhn6akLC2",
        "labels": {
        "name": "Maria Fernanda Gomez",
        "proprietary": "CC",
            "identification": "2020202020",
        "bankAccountType": "SVGS",
        "bankAccountNumber": "95445654254",
        "bankId": "895554821",
        "targetSpbviCode": "TFY"
        }
    },
    },
    "symbol": {
    "signer": {
        "handle": "wMxKCAzsQBiUURDU3xD3xuSbVo1S9jmf3d",
        "labels": {
        "created": "2018-10-19T20:23:22.041Z",
        "createdBy": "ZhrQA3vcm17h2RRO4LrJ"
        }
    }
    },
    "target": {
    "signer": {
        "handle": "wRFmYXS2sP9ho9VCZ3j4FuP1j55ABeFvsF",
        "labels": {
        "name": "Jorge Alejandro Fernandez Garcia",
        "proprietary": "CC",
            "identification": "1010101010",
        "bankAccountType": "SVGS",
        "bankAccountNumber": "12345654321",
        "bankId": "891234918",
        "targetSpbviCode": "TFY"
        }
    },
    }
},
"error": {
    "code": 0,
    "message": "Success"
},
"action_id": "35de4d3d-3aba-4fb3-b110-d004ce2aabb2",
"id": "35de4d3d-3aba-4fb3-b110-d004ce2aabb2"
}
2

El banco origen crea una acción tipo `UPLOAD` en Transfiya

Esto representa la reserva o débito de fondos. Se debe generar una acción usando el API de Transfiya, referenciando la transferencia original.
curl -X POST \
-H "Content-Type: application/json" \
-H "x-api-key: <API_KEY>" \
-H "Authorization: Bearer <TOKEN>" \
-d '{
    "source": "wSjXPK5uocHQdY81THFG3VL8G5vN6mU7Ro",
    "target": "wXxwpxB32saqfmfMxAQD4SVWWhhn6akLC2",
    "symbol": "$tin",
    "amount": "100.00",
    "labels": {
    "type": "UPLOAD",
    "tx_ref": "Lf13jsK83omPv3bOt"
    }
}' "URL/v1/action"
AtributoValor
sourcebankSigner.handle — Bank settlement signer.
targetmainAction.snapshot.source.signer.handle — Source of the transfer (bank user).
symbolmainAction.symbol — Currency of the transfer.
labels.typeUPLOAD — Always UPLOAD for debits.
labels.tx_refmainAction.labels.tx_ref — Transfer reference.
mainAction en los valores se utiliza al hacer referencia a los datos de la acción principal recibida desde TransfiYa. En otras palabras, representa el cuerpo de una llamada POST a https://ban.co/transfiya/debit.
bankSigner representa el firmante de liquidación que es registrado por el banco durante el proceso de incorporación con TransfiYa. Este firmante mantiene el balance total disponible para el banco dentro del sistema.
3

El banco origen responde a la solicitud inicial de débito

Esta respuesta marca el cierre de la fase síncrona. El campo obligatorio es action_id.
{
  "source": "wNbBi3CcZzggFJ9dvDWk35srVGgaAVLzUr",
  "target": "wLd9MEASjQQTYywoXnDNwTRpgwiDfyHj6U",
  "amount": "200.00",
  "symbol": "$tin",
  "labels": {
    "hash": "PENDING",
    "type": "UPLOAD",
    "domain": "tin",
    "status": "PENDING",
    "tx_ref": "Ss84Vb42kGa6gPV57",
    "created": "2022-08-04T07:05:26-05:00",
    "updated": "2022-08-04T07:05:26-05:00",
    "description": "",
    "deviceFingerPrint": {
      "city": "Bogotá",
      "hash": "26fff5af6441f8e15a71e8d62c361714484b1b308c99e8eb68ca85e2a7e0dc58",
      "model": "Huawei Mate 20 Pro",
      "country": "Colombia",
      "operator": "Bharti Airtel Limited",
      "SIMCardId": "8991101200003204510",
      "ipAddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "mobileDevice": "990000862471854"
    }
  },
  "snapshot": {
    "source": {
      "signer": {
        "handle": "wNbBi3CcZzggFJ9dvDWk35srVGgaAVLzUr",
        "labels": {
          "type": "TROUPE",
          "created": "2022-06-10T10:46:35-05:00",
          "bankName": "bancosanti",
          "bankBicfi": "9574",
          "createdBy": "A16iU3t38Tygr70uO1qf",
          "description": "Bank",
          "routerReference": "$bancosanti",
          "bankAccountNumber": "160101"
        }
      },
      "wallet": {
        "handle": "$bancosanti",
        "labels": {
          "url": "http://bancosanti.com",
          "type": "TROUPE",
          "domain": "tin",
          "created": "2022-06-09T14:55:38-05:00",
          "updated": "2022-08-04T07:03:45-05:00",
          "bankName": "bancosanti",
          "bankBicfi": "9574",
          "createdBy": "A16iU3t38Tygr70uO1qf",
          "entityType": "Bancos",
          "limitAlert": "5000000",
          "routerAction": "https://3ad0-186-170-222-190.ngrok.io/action",
          "routerStatus": "https://3ad0-186-170-222-190.ngrok.io/status",
          "routerUpload": "https://3ad0-186-170-222-190.ngrok.io/debit",
          "routerDownload": "https://3ad0-186-170-222-190.ngrok.io/credit",
          "routerAuthMethod": "NONE",
          "routerAuthParams": {}
        },
        "signer": [
          "wcyq8otjHN789tVTMQ4Xx7Dyk7GB9FUsUj",
          "wNbBi3CcZzggFJ9dvDWk35srVGgaAVLzUr"
        ],
        "default": "wNbBi3CcZzggFJ9dvDWk35srVGgaAVLzUr"
      }
    },
    "symbol": {
      "signer": {
        "handle": "wMxKCAzsQBiUURDU3xD3xuSbVo1S9jmf3d",
        "labels": {
          "created": "2018-10-19T20:23:22.041Z",
          "createdBy": "ZhrQA3vcm17h2RRO4LrJ"
        }
      },
      "wallet": {
        "handle": "$tin",
        "labels": {
          "type": "SYMBOL",
          "created": "2018-10-19T20:22:48.350Z",
          "updated": "1970-01-01T15:38:20-05:00",
          "createdBy": "ZhrQA3vcm17h2RRO4LrJ"
        },
        "signer": ["wMxKCAzsQBiUURDU3xD3xuSbVo1S9jmf3d"],
        "default": "wMxKCAzsQBiUURDU3xD3xuSbVo1S9jmf3d"
      }
    },
    "target": {
      "signer": {
        "handle": "wLd9MEASjQQTYywoXnDNwTRpgwiDfyHj6U",
        "labels": {
          "type": "PERSON",
          "email": "Florida_Sawayn@yahoo.com",
          "mobile": "573123224352",
          "created": "2022-06-10T09:50:25-05:00",
          "bankName": "bancosanti",
          "lastName": "Sanford",
          "bankBicfi": "9574",
          "createdBy": "A16iU3t38Tygr70uO1qf",
          "firstName": "Cale",
          "description": "Investor",
          "proprietary": "CC",
          "identification": "1231231",
          "bankAccountType": "SVGS",
          "routerReference": "$bancosanti",
          "bankAccountNumber": "689",
          "countryOfResidence": "CO"
        }
      },
      "wallet": {
        "handle": "$573123224352",
        "labels": {
          "type": "PERSON",
          "created": "2022-06-10T09:54:42-05:00",
          "updated": "2022-06-10T09:54:42-05:00",
          "channelSms": "573123224352"
        },
        "signer": ["wLd9MEASjQQTYywoXnDNwTRpgwiDfyHj6U"]
      }
    }
  },
  "action_id": "5954ac04-b4db-4c6f-86f6-43df30f6bacb",
  "error": {
    "code": 0,
    "message": "Success"
  }
}
Se pueden incluir campos adicionales en la respuesta, pero solo action_id es obligatorio.
4

El banco valida la cuenta origen y debita el monto correspondiente

Se realizan validaciones sobre la cuenta y se ejecuta la operación interna de débito.
5

El banco actualiza la acción `UPLOAD` con el `tx_id` de la transacción interna

El identificador tx_id permite posteriores conciliaciones entre Transfiya y el banco.
curl -X PUT \
-H "Content-Type: application/json" \
-H "x-api-key: <API_KEY>" \
-H "Authorization: Bearer <TOKEN>" \
-d '{
    "labels": {
    "tx_id": "K3.392894.29480"
    }
}' "<TRANSFIYA URL>/v1/action/<upload_action_id>"
Field nameField value
<upload_action_id>The <upload_action_id> used in the URL is the ID of the UPLOAD action created in step 2. In our example, it is 5954ac04-b4db-4c6f-86f6-43df30f6bacb.
labels.tx_idUnique identifier of the transaction executed by the bank to debit the funds from the source account.
6

El banco crea y firma un objeto IOU como prueba criptográfica

Este IOU contiene la información de la transacción y su firma digital, generada con claves privadas del firmante.
Transfiya valida la firma del objeto IOU recibido y lo almacena en el libro mayor, si todo es válido. Esta operación también marca la acción UPLOAD como COMPLETED.
curl -X POST \
    -H "Content-Type: application/json" \
    -H "x-api-key: <API_KEY>" \
    -H "Authorization: Bearer <TOKEN>" \
    -d '{
        "hash": {
        "types": "sha256:sha256",
        "steps": "stringify:data",
        "value": "263b8cebe62473ad9bb6ca6a92db7e5c8b16492b359515375ae8bf05094c3a14"
        },
        "data": {
        "source": "wSjXPK5uocHQdY81THFG3VL8G5vN6mU7Ro",
        "target": "wXxwpxB32saqfmfMxAQD4SVWWhhn6akLC2",
        "symbol": "wMxKCAzsQBiUURDU3xD3xuSbVo1S9jmf3d",
        "amount": "100.00",
        "domain": "tin",
        "expiry": "2025-01-14T20:41:59.122-05:00",
        "random": "7f19c57edb362726da0c"
        },
        "meta": {
        "signatures": [
            {
            "scheme": "ecdsa-ed25519",
            "signer": "wSjXPK5uocHQdY81THFG3VL8G5vN6mU7Ro",
            "public": "046a23ccc4585f6105a199ec5202d4019d589a3370b52a783268016751e2db9281371fe2cc28901e24ece5d47b29ed0b7d741d17dd8221b9735bf922dc40a621b1",
            "string": "3043021f17472d781f6873203671439fc1277b085971f38928da9165ab4f386117966302200c518cfef98841aa353eb0832a87eca44929df7d2d475c70203effca27ca6241",
            }
        ]
        }
    }' "<TRANSFIYA URL>/v1/action/<upload_action_id>/sendit"
7

El banco realiza validaciones finales y llama al endpoint `continue`

Esta llamada debe incluir los campos received y dispatched. Se puede incluir un objeto error si aplica.
Para continuar con el procesamiento de la transferencia, es suficiente con llamar al endpoint continue y proporcionar las marcas de tiempo requeridas por la regulación.
curl -X POST \
    -H "Content-Type: application/json" \
    -H "x-api-key: <API_KEY>" \
    -H "Authorization: Bearer <TOKEN>" \
    -d 
'{
"source": "wXxwpxB32saqfmfMxAQD4SVWWhhn6akLC2",
"target": "wRFmYXS2sP9ho9VCZ3j4FuP1j55ABeFvsF",
"amount": "100.00",
"symbol": "$tin",
"labels": {
    "hash": "263b8cebe62473ad9bb6ca6a92db7e5c8b16492b359515375ae8bf05094c3a14",
    "type": "UPLOAD",
    "domain": "tin",
    "flowId": "Lf13jsK83omPv3bOt",
    "status": "COMPLETED",
    "tx_ref": "Lf13jsK83omPv3bOt",
    "tx_id": "20250114890915944TFY123456789012345",
	"received": "2025-01-14T20:40:57.322-05:00",
	"dispatched": "2025-01-14T20:40:58.322-05:00",
    "created": "2025-01-14T20:40:57.322-05:00",
    "updated": "2025-01-14T20:40:57.322-05:00",
    "description": "Payment for lunch",
    "sourceChannel": "APP",
    "deviceFingerPrint": {
    "city": "Bogotá",
    "hash": "26fff5af6441f8e15a71e8d62c361714484b1b308c99e8eb68ca85e2a7e0dc58",
    "model": "Huawei Mate 20 Pro",
    "country": "Colombia",
    "operator": "Bharti Airtel Limited",
    "SIMCardId": "8991101200003204510",
    "ipAddress": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "mobileDevice": "990000862471854"
    }
},
"snapshot": {
    "source": {
    "signer": {
        "handle": "wXxwpxB32saqfmfMxAQD4SVWWhhn6akLC2",
        "labels": {
        "name": "Maria Fernanda Gomez",
        "proprietary": "CC",
            "identification": "2020202020",
        "bankAccountType": "SVGS",
        "bankAccountNumber": "95445654254",
        "bankId": "895554821",
        "targetSpbviCode": "TFY"
        }
    },
    },
    "symbol": {
    "signer": {
        "handle": "wMxKCAzsQBiUURDU3xD3xuSbVo1S9jmf3d",
        "labels": {
        "created": "2018-10-19T20:23:22.041Z",
        "createdBy": "ZhrQA3vcm17h2RRO4LrJ"
        }
    }
    },
    "target": {
    "signer": {
        "handle": "wRFmYXS2sP9ho9VCZ3j4FuP1j55ABeFvsF",
        "labels": {
        "name": "Jorge Alejandro Fernandez Garcia",
        "proprietary": "CC",
            "identification": "1010101010",
        "bankAccountType": "SVGS",
        "bankAccountNumber": "12345654321",
        "bankId": "891234918",
        "targetSpbviCode": "TFY"
        }
    },
    }
},
"error": {
    "code": 0,
    "message": "Success"
},
"action_id": "35de4d3d-3aba-4fb3-b110-d004ce2aabb2",
"id": "35de4d3d-3aba-4fb3-b110-d004ce2aabb2"
}'
 "<TRANSFIYA URL>/v1/transfer/<tx_ref>/continue"
Field nameDescripción
<tx_ref>El campo <tx_ref> en la URL representa la referencia de la transferencia, que se encuentra en labels.tx_ref del mainAction.
receivedMarca de tiempo en formato ISO 8601. Representa el momento en que se recibió la última respuesta de Transfiya (llamada sendit).
dispatchedMarca de tiempo en formato ISO 8601. Representa el momento en que se envió la llamada continue a Transfiya.