Saltar al contenido principal

Migración de destinatarios TEF Sandbox

En el sandbox se pueden forzar respuestas distintas enviando el parámetro responseType en el query string de la url de determinados endpoints.

Ejemplo de cómo aplicar esta funcionalidad:

curl -X POST "https://${URL}/api/v1/tasks?responseType={responseType}"

A continuación se detallan los endpoints junto con los posibles valores de responseType y las respuestas y códigos HTTP que se obtendrán:

1.- Iniciar proceso de extracción​

Endpoint: POST /api/v1/tasks

Las respuestas preconfiguradas para ese endpoint son las siguientes:

1.1.- Expiración del token​

responseType:jwtExpired

  • Respuesta: Jwt is expired
  • Http Code: 401

1.2.- Usuario y Entidad bloqueado temporalmente para realizar proceso de extracción​

responseType: temporarilyRestricted

  • Respuesta: Username/action pair has been temporarily restricted due to multiple failed authentication attempts
  • Http Code: 403

1.3.- No tienes permiso para ejecutar la acción​

responseType: forbidden

  • Respuesta: You don't have sufficient permissions to perform this action
  • Http Code: 403

1.4.- Existe un proceso de extracción para el par usuario y entidad​

responseType: processAlreadyRunning

  • Respuesta: Another request for this user is currently running
  • Http Code: 429

1.5.- No posees suficiente crédito para realizar procesos de extracción​

Nota: Esta restricción solo aplica para planes free.

responseType: notEnoughCredits

  • Respuesta: Request monthly quota reached
  • Http Code: 429

2.- Consultar el estado del proceso de extracción​

Endpoint: GET /api/v1/tasks/${TASKID}

Las respuestas preconfiguradas para ese endpoint son las siguientes:

2.2.- Resultado exitoso pero con error de autentificación.​

responseType: successWrongLoginResults

  • Respuesta: Responde un tipo 200 con taskStatus wrong_login y taskStatusCode 401
    {
      "taskStatus": "wrong_login",
      "taskStatusCode": 401,
      "results": {}
    }
  • Http Code: 200

2.3.- Resultado exitoso pero el usuario tiene la cuenta bloquada.​

responseType: successLockedResults

  • Respuesta: Responde un tipo 200 con taskStatus locked y taskStatusCode 401
    {
      "taskStatus": "locked",
      "taskStatusCode": 401,
      "results": {}
    }
  • Http Code: 200

2.4.- Resultado exitoso pero la entidad presenta problemas​

responseType: successErrorResults

  • Respuesta: Responde un tipo 200 con taskStatus error y taskStatusCode 500
    {
      "taskStatus": "error",
      "taskStatusCode": 500,
      "results": {}
    }
  • Http Code: 200

2.5.- Resultado exitoso pero sin registros.​

responseType: successEmptyResults

  • Respuesta: Responde un tipo 200 con la llave data vacía.
    {
      "taskStatus": "success",
      "taskStatusCode": 200,
      "results": {
        "username": "11.111.111-1",
        "entityId": "banco-santander",
        "data": []
      }
    }
  • Http Code: 200

2.6.- Resultado exitoso pero con alias de TEF vacíos​

responseType: successEmptyAlias

  • Respuesta:
    {
      "taskStatusCode": 200,
      "taskStatus": "success",
      "results": {
        "username": "11.111.111-1",
        "entityId": "banco-santander",
        "data": [
          {
            "name": "Carmen Zayas",
            "rut": "77.129.260-7",
            "bankName": "banco-estado",
            "bankCode": "012",
            "accountNumber": "29987287",
            "accountType": "corriente",
            "email": "Monserrat10@corpfolder.com",
            "alias": ""
          }
        ]
      }
    }
  • Http Code: 200

2.7.- Resultado exitoso pero con rut mal formateado​

responseType: tefWithValidRutWrongFormat

  • Respuesta:
    {
      "taskStatusCode": 200,
      "taskStatus": "success",
      "results": {
        "username": "11.111.111-1",
        "entityId": "banco-santander",
        "data": [
          {
            "name": "Rebecca Quiroz",
            "rut": "861442152",
            "bankName": "banco-itau",
            "bankCode": "039",
            "accountNumber": "64203519",
            "accountType": "vista",
            "email": "Aarn_Ros@yahoo.com",
            "alias": ""
          },
          {
            "name": "Lorene Posada",
            "rut": "39821885-K",
            "bankName": "banco-falabella",
            "bankCode": "051",
            "accountNumber": "39713331",
            "accountType": "vista",
            "email": "Juan_Mena@gmail.com",
            "alias": ""
          }
        ]
      }
    }
  • Http Code: 200

2.8.- Resultado exitoso pero con rut invalido​

responseType: tefWithInvalidRut

  • Respuesta:
    {
      "taskStatusCode": 200,
      "taskStatus": "success",
      "results": {
        "username": "11.111.111-1",
        "entityId": "banco-santander",
        "data": [
          {
            "name": "Rebecca Quiroz",
            "rut": "10.469.010-7",
            "bankName": "banco-itau",
            "bankCode": "039",
            "accountNumber": "64203519",
            "accountType": "vista",
            "email": "Aarn_Ros@yahoo.com",
            "alias": ""
          },
          {
            "name": "Lorene Posada",
            "rut": "3.011.194-0",
            "bankName": "banco-falabella",
            "bankCode": "051",
            "accountNumber": "39713331",
            "accountType": "vista",
            "email": "Juan_Mena@gmail.com",
            "alias": ""
          }
        ]
      }
    }
  • Http Code: 200

2.9.- Resultado exitoso pero con rut vacío​

responseType: tefWithEmptyRut

  • Respuesta:
    {
      "taskStatusCode": 200,
      "taskStatus": "success",
      "results": {
        "username": "11.111.111-1",
        "entityId": "banco-santander",
        "data": [
          {
            "name": "Rebecca Quiroz",
            "rut": "",
            "bankName": "banco-itau",
            "bankCode": "039",
            "accountNumber": "64203519",
            "accountType": "vista",
            "email": "Aarn_Ros@yahoo.com",
            "alias": ""
          }
        ]
      }
    }
  • Http Code: 200

3- Obtén el estado de las entidades​

Endpoint: GET https://${URL}/api/v1/entities

Las respuestas preconfiguradas para ese endpoint son las siguientes:

3.1.- Banco Santander desactivado​

responseType: disabledSantander

  • Respuesta: Responde un tipo 200
    [
        {
            "name": "Banco Santander",
            "id": "banco-santander",
            "enabled": false,
            "actions": [
                {
                    "name": "banco-santander:tef",
                    "actionType": "tef",
                    "enabled": true
                },
                {
                    "name": "banco-santander:bill",
                    "actionType": "bill",
                    "enabled": true
                }
            ]
        },
        {
            "name": "Banco BCI",
            "id": "banco-bci",
            "enabled": true,
            "actions": [
                {
                    "name": "banco-bci:tef",
                    "actionType": "tef",
                    "enabled": true
                },
                {
                    "name": "banco-bci:bill",
                    "actionType": "bill",
                    "enabled": true
                }
            ]
        },
    }
  • Http Code: 200

3.2.- Banco Santander Activado pero acción TEF desactivada​

responseType: disabledSantanderTef

  • Respuesta: Responde un tipo 200
    [
        {
            "name": "Banco Santander",
            "id": "banco-santander",
            "enabled": true,
            "actions": [
                {
                    "name": "banco-santander:tef",
                    "actionType": "tef",
                    "enabled": false
                },
                {
                    "name": "banco-santander:bill",
                    "actionType": "bill",
                    "enabled": true
                }
            ]
        },
        {
            "name": "Banco BCI",
            "id": "banco-bci",
            "enabled": true,
            "actions": [
                {
                    "name": "banco-bci:tef",
                    "actionType": "tef",
                    "enabled": true
                },
                {
                    "name": "banco-bci:bill",
                    "actionType": "bill",
                    "enabled": true
                }
            ]
        },
    }
  • Http Code: 200

4- Obtén el estado del usuario por entidad​

Endpoint: POST https://${URL}/api/v1/users/status/by-entity

Las respuestas preconfiguradas para ese endpoint son las siguientes:

4.1.- Usuario y Entidad deshabilitado.​

responseType: disabledUsername

  • Respuesta: Responde un tipo 200
    {
      "enabled": false,
      "retryAfter": "2021-07-22T09:52:15.606Z"
    }
  • Http Code: 200