Actualizar estado de pago de una orden

Método utilizado para actualizar el estado de pago de una orden para una tienda en particular.


PUT {env}/1/orders/:order_id

Headers


{
  "Authorization": "Bearer {access_token}",
  "X-Shop-Id": "12345"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
`Authorization`	string	Si	`Bearer` + access_token	Token obtenido mediante client_id y client_secret.
`X-Shop-Id`	string	Si	String numérico	Identificador único de la tienda a la cual se desea actualizar la orden.

Body


{
  "payment_status": 1,
  "main_reference_id": "some-main-code-22370fd1-e1ea-4dd6-bc27-8d3b081e8d4c",
  "extra_reference_id": "some-extra-code-22370fd1-e1ea-4dd6-bc27-8d3b081e8d4c"
}

Nombre	Tipo	Opcional	Descripción
`payment_status`	number	No	Identificador que permite determinar el estado del pago. Los valores permitidos son del -1 al 7: -1: Esperando pago, 0: Pendiente, 1: Finalizado, 2: En proceso, 3: En mediación, 4: Rechazada, 5: Cancelada, 6: Pago devuelto, 7: En contracargo.
`main_reference_id`	string	Si	Hace referencia al código de pago, en caso de ser enviado debe tener entre 0 y 300 caracteres como máximo.
`extra_reference_id`	string	Si	Hace referencia al código de pago adicional, en caso de ser enviado debe tener entre 0 y 300 caracteres como máximo.

Response exitosa: 201 Created

En caso de éxito, retorna HTTP Code 201 con payload vacío.

{}

Responses de error

En caso de que la respuesta HTTP no sea 201, entonces se debe considerar haber obtenido una respuesta de error.

Atributo	Tipo	Descripción
`status`	int	Http code de respuesta.
`code`	string	Código de error, indica la naturaleza del mismo.
`msg`	string	Mensaje de error.

Ejemplo response 401 Unauthorized:


{
  "status": 401,
  "code": "error",
  "msg": "Unauthorized"
}

Ejemplo response 400 Bad Request genérico:


{
  "status": 400,
  "code": "request_error",
  "msg": "Send valid data"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada requerido no es enviado:


{
  "status": 400,
  "code": "param_required",
  "msg": "invalid <param_name>. The value is required"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada es inválido:


{
  "status": 400,
  "code": "param_invalid",
  "msg": "Invalid <param_name>. The value is invalid"
}

Ejemplo response 404 Not Found si no existe la orden para la tienda especificada:


{
  "status": 404,
  "code": "not_found",
  "msg": "Unexisting resource"
}

Ejemplo response 500 Internal Server Error:


{
  "status": 500,
  "code": "server_error",
  "msg": "Something went wrong"
}