Annulment

Constituye la solicitud de anulación o reembolso de una transacción

POST /transaction/annulment

Solicitud de anulación o cancelación de una transacción y por lo tanto del pago. - Se puede enviar una vez ha expirado la transacción, después de haber recibido una respuesta de confirmación con estado PENDING. - Valor es inconsistente en la confirmación con respecto al valor enviado en Transaction. - Se puede enviar máximo 30 minutos después de haber recibido una respuesta de confirmación con estado APPROVED. El endpoint debe ser expuesto por el medio de pago digital y será invocado por payválida.

Headers

Name	Type	Description
Accept*	String	Utilizado para definir que tipo de contenido puede procesar el cliente. El valor siempre debe ser application/json.
Content-Type*	String	Utilizado para identificar el media-type del cuerpo de la solicitud. El valor siempre debe ser application/json.
Authorization	String	Token Oauth2 obtenido en el endpoint Oauth2 expuesto por el medio de pago digital. En caso de que el token tenga un scope, se debe definir previamente. Debe seguir el formato 'token_type access_token'.

Request Body

Name	Type	Description
transaction*	Object	Información de la transacción anulada.
id*	String	Parte del object transaction. Identificador de la transacción.
value*	String	Parte del object transaction. Monto de la transacción. Si se recibió en confirmation un valor distinto a el de transaction, la anulación se enviará por el valor recibido en transaction.

200: OK Solicitud procesada correctamente

transaction* (object): Información de la transacción anulada.

id* (string): Parte del objeto transaction. Identificador de la transacción.

status* (string): Parte del objeto transaction. Estado de transacción tras anulación. Valor permitido: REVERSED. REVERSED significa que se realizó la anulación de la transacción. Cualquier otro status se tomará como fallido.

annulment_result (string): Parte del objeto transaction. Descripción del estado o resultado de anulación. Es opcional y se utiliza por registro y trazabilidad.

400: Bad Request La solicitud o los claims del token no tienen la estructura esperada.

403: Forbidden No fue posible identificar al cliente de la solicitud. Asociado a la validación y verificación del token.

404: Not Found La transacción asociada no existe o no se encuentra.

409: Conflict La solicitud entra en conflicto con el estado actual de la transacción.

500: Internal Server Error Error del servidor al procesar la solicitud.

Request ejemplo

{
  "transaction": {
    "id": "0427dfac-ffd8-44f4-be96-5d442c1c1bed",
    "value": "10.25"
  }
}

Response ejemplo

{
  "transaction": {
    "id": "0427dfac-ffd8-44f4-be96-5d442c1c1bed",
    "status": "REVERSED",
    "annulment_result": "Reembolso efectuado"
  }
}