Acciones de echeqs

Custodiar

• Servicio que permite poner en custodia un Echeq en Banco Comafi por parte del tenedor. El Echeq previamente debe haber sido recibido por el beneficiario.

Características de la API:

Estado Inicial requerido del echeq: ACTIVO

Estado Final: CUSTODIA

Flujo de ejecución obligatoria para el uso del servicio de custodia:

Una vez ejecutado el endpoint [PUT]:/v1/echeqs/custody ante la recepción de una respuesta con status code 200 deberá realizar el uso del servicio [GET]:/v1/echeqs/:id para ir conociendo el estado del Echeq en particular.

El servicio debería ser consultado una vez finalizada la ejecución del PUT (poner en custodia) de acuerdo con la fecha de vencimiento del Echeq.

Ante un error 500/503/504/5XX en el PUT /v1/echeqs/custody debe reportar el incidente a [email protected] ingresando y proporcionando fecha y hora de ejecución, body request enviado y trace-id enviado en el header.

Aclaración sobre algunos códigos de errores:

http status code 412: error debido a que no se especificó bien el recurso buscado.

• invalid_lot_id:

Aclaración sobre algunos códigos de errores:

http status code 412: Error debido a alguna condición y/o validación que no se cumple.

• invalid_echeq: este error ocurre cuando el ID del Echeq proporcionado no existe o el cliente no tiene los permisos necesarios para realizar una acción sobre ese Echeq en particular.

• invalid_echeq_status: este error aparece cuando se intenta realizar una acción en un Echeq que no se encuentra en el estado adecuado para permitir dicha operación. Para poder realizar la custodia de un Echeq el mismo debe encontrarse en estado ACTIVO.

• invalid_account_key: este error indica que la account_key proporcionada a realizar el depósito del Echeq pasada la fecha de custodia no existe o no está habilitada para realizar la transacción solicitada.

Api para poner en custodia un echeq

PUT

/v1/echeqs/custody

Custodia de un cheque en el banco por parte del tenedor, El cheque debe haber sido recibido por el beneficiario

Autorizaciones

bearerAuth

Tipo

HTTP (bearer)

Parámetros

Header Parameters

User-Agent*

Header de identificación de cliente que envía la petición.

Tipo

string

Requerido

Ejemplo"nombre-cliente"

trace-id*

Id único de la petición

Tipo

string

Requerido

Ejemplo"416f4961-f677-4c8b-aafa-be6384a035c2"

Formato

"uuid"

Cuerpo de la petición

application/json

{

  

"id": "2BTP90K043P4EGJ",

  

"preapproved": false,

  

"account_key": "2990000000001266490008",

  

"signatories": [

  

  

{

  

  

  

"document_type": "DNI",

  

  

  

"document_number": "401238493"

  

  

}

  

]

}

Respuestas

Respuesta exitosa

Content-Type

application/json

{

  

"id": "2BTP90K043P4EGJ",

  

"status": "ECHEQ_CUSTODIED"

}

PUT

/v1/echeqs/custody

Playground

Servidor

Autorización

bearerAuth

Headers

User-Agent*

trace-id*

Cuerpo

Ejemplos

Powered by VitePress OpenAPI