Cuentas

Servicio para la generación y obtención de un código de un solo uso.

Obtener OTP

El código OTP es utilizado para cierta acción que se quiera realizar. Dentro de la petición se deberá incluir el id de la tabla reason. Las opciones de dicha tabla las podrás ver a continuación.

Id	Name
1	Retiro de fondos
2	Asociar cuenta bancaria
3	Eliminar cuenta bancaria
4	Generar código QR 2FA
5	Pin de verificación

Generacion OTP

POST https://sandbox.apagar.co/api/v1/accounts/otp/get

Request Body

Name	Type	Description
data*	Object	Datos principales
reason*	Object	reason data
id*	int	identificador de la razón o motivo de la generación del código.

200 Exitoso

Request

{
  "data": {
    "expTime": 30,
    "timeType": "minutes"
  },
  "signature": "****cfa08ffdf4da05dc44d4f65406f1fbeef050",
  "date": ****585707519,
  "status": 200,
  "message": "El código se acaba de enviar a su celular en un SMS. Recuerde que tiene 30 minutos para su uso"
}

401: Unauthorized Sin permisos

Response

{
    "signature": "c0a318c437e6cc22c45ff50f8924039448904c8a",
    "path": "/otp/get",
    "date": 1655859778558,
    "status": 401,
    "errorCode": "auth.notPermission",
    "message": "Sin permisos"
}

401: Unauthorized Sesión terminada

Response

{
    "signature": null,
    "path": "/otp/get",
    "date": 1655859846323,
    "status": 401,
    "errorCode": "auth.sessionEnded",
    "message": "Sesión terminada"
}

Agregar cuenta bancaria

En este punto es necesario ya tener nuestro código OTP para poder realizar nuestra petición y adicionar nuestra cuenta bancaria.

Servicio para adicionar cuenta bancaria

POST https://sandbox.apagar.co/api/v1/accounts/add

Request Body

Name	Type	Description
data*	Object	Datos principales
account*	Object	data de cuenta
number*	string	Numero de cuenta bancaria
otp*	string	codigo de un solo uso
Bank*	Object	Datos de bancos
id*	int	identificador de banco asociado
Type*	string	representa el tipo de cuenta
id*	int	identificador del tipo de cuenta

200 Cuenta bancaria agregada

Request

{
  "data": null,
  "signature": "4e589c3fb2f19b21dbdddb4d036205748f7626b0",
  "date": 1618587860139,
  "status": 200,
  "message": "Cuenta agregada exitosamente"
}

400: Bad Request Código no existe

Response

{
    "signature": "ea89d59aa6cf6655f854b9fe8571f8238fe853ee",
    "path": "/add",
    "date": 1655859973925,
    "status": 400,
    "errorCode": "otp.already.used",
    "message": "El código no existe o ya fue utilizado, debe generar otro"
}

Eliminar cuenta bancaria

Servicio para eliminar cuenta bancaria

POST https://sandbox.apagar.co/api/v1/accounts/delete

Request Body

Name	Type	Description
data*	Object	Datos principales
account*	Object	data de cuenta
id*	int	identificador de la cuenta asociada

200 Cuenta eliminada

Request

{
    "data": null,
    "signature": "b9c94caceb1ad73d06ed901a6d1b11d871abf77a",
    "date": 1655***170209,
    "status": 200,
    "message": "Cuenta eliminada con éxito"
}

400: Bad Request Cuenta no existe

Response

{
    "signature": "9293059c881e51f0704e036993884d8c691a825e",
    "path": "/delete",
    "date": 1655860231493,
    "status": 400,
    "errorCode": "account.notFound",
    "message": "La cuenta no existe"
}