Skip to main content

​
Cómo consultar una cuenta - Versión 1

Esta guía está destinada para que las Entidades Participantes que desean validar si un usuario receptor se encuentra creado en de Transfiya (signer). Un Signer es una representación de una credencial de pago en Transfiya, dentro de cada creación de Signer se almacena la información del usuario y la información de la cuenta, y debido a esto, las Entidades pueden hacer una búsqueda con la información del usuario y del banco para obtener el signer registrado.

​
Filtros disponibles para obtener un signer por datos del beneficiario:

Puedes usar los siguientes filtros en el endpoint POST [baseUrl]/v1/signer/lookup:
  • labels.proprietary
  • labels.identification
  • labels.bankAccountNumber
  • labels.routerReference

​
Campos de entrada:

EtiquetaDescripciónTipoLongitudObligatoriedad
proprietaryTipo de documento, admite: CC,CE,PA,TI,NUIP,NIT,OTR,PPT y PEPTexto1-4Si
identificationNúmero de documentoTexto1-18 carácteresSi
bankAccounNumberNúmero de cuentaTexto1-Máximo 34 dígitosSi
routerReferenceIdentificador de billetera del banco en Transfiya.Texto1- Máximo 34 caracteres alfanuméricos, debe comenzar con $Si

​
Ejemplo de solicitud

curl --location 'https://ach-minka-stg.transferenciasinmediatas.com/v1/signer/lookup' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ****' \
--data '{
    "labels": {
        "proprietary": "NIT",
        "identification": "804153241",
        "bankAccountNumber": "335278945",
        "routerReference": "$bancoamarillo"
    }
}'
  • Response
{
    "pagination": {
        "pageNum": 0,
        "pageSize": 50
    },
    "error": {
        "code": 0,
        "message": "Success"
    },
    "entities": [
        {
            "handle": "wL62NznU8SPZavTRsy2G3bQ7E2qFL8jpcM",
            "wallets": []
        }
    ]
}

​
Cómo consultar una cuenta - Versión 2

Esta versión del Signer Lookup está destinada para que las Entidades Participantes que desean validar si un usuario receptor se encuentra creado en de Transfiya (signer). Usando como datos de entrada el tipo de identificación y número de identificación del beneficiario. Transfiya permite a las Entidades, relacionar el caso de uso para ejecutar la respectiva resolución de la información de manera eficiente. A continuación, se relaciona los valores que permite recibir el campo useCase:
ValorDescripción
b2p-sendCorresponde a una transacción tipo SEND de empresa a persona.
b2b-sendCorresponde a una transacción tipo SEND de empresa a empresa.

​
Campos de entrada:

EtiquetaDescripciónTipoLongitudObligatoriedad
useCaseCaso de uso. Admite: b2p-send y b2b-sendTexto1-8Si
proprietaryTipo de documento, admite: CC,CE,PA,TI,NUIP,NIT,OTR,PPT y PEPTexto1-4Si
identificationNúmero de documentoTexto1-18 carácteresSi

​
Ejemplo de solicitud

curl --location 'https://ach-minka-stg.transferenciasinmediatas.com/v2/signer/lookup' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ****' \
--data '{
    "useCase": "b2b-send",
    "labels": {
        "proprietary": "NIT",
        "identification": "804153241"
        
        
    }
}
Response 
{
    "entities": [
        {
            "handle": "wWZd85BW1kCj5RgeNET6EC55sG5uGDqpWB",
            "bankName": "Banco Amarillo",
            "bankBicfi": "3854",
            "proprietary": "NIT",
            "identification": "804153241",
            "routerReference": "$bancoamarillo",
            "bankAccountNumber": "335278944"
        },
        {
            "handle": "wL62NznU8SPZavTRsy2G3bQ7E2qFL8jpcM",
            "bankName": "Banco Amarillo",
            "bankBicfi": "3854",
            "proprietary": "NIT",
            "identification": "804153241",
            "routerReference": "$bancoamarillo",
            "bankAccountNumber": "335278945"
        }
    ],
    "error": {
        "code": 0,
        "message": "Success"
    }
}

​
Lista de códigos de error

A continuación se listan los códigos de error asociados a esta operación:
Código de errorDescripciónHTTP Status
99Error inesperado del servidor400
100No tienes permisos para acceder a este método403
102Etiquetas inválidas400
118Error de validación del esquema del recurso400